Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7578da5dc1ea87d1992fda18898270eb8253a2c6 / . / docs / epy / google.appengine.ext.db.PropertiedClass-class.html
blob: 6f7d24e979329ecb57ede47c27f8d9367eb08209 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>google.appengine.ext.db.PropertiedClass</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 google ::
38 appengine ::
39 ext ::
40 db ::
41 PropertiedClass ::
42 Class&nbsp;PropertiedClass
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="google.appengine.ext.db.PropertiedClass-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57</table>
58<!-- ==================== TYPE DESCRIPTION ==================== -->
59<h1 class="epydoc">Type PropertiedClass</h1><p class="nomargin-top"></p>
60<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]61<center> <map id="class_hierarchy_for_propertied" name="class_hierarchy_for_propertied">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]62<area shape="rect" href="google.appengine.ext.db.PropertiedClass-class.html" title="PropertiedClass" alt="" coords="5,5,117,32"/>
63<area shape="rect" href="javascript:void(0);" title="type" alt="" coords="141,5,187,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]65 <img src="class_hierarchy_for_propertied.gif" alt='' usemap="#class_hierarchy_for_propertied" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]66</center>
67</center>
68<hr />
69<pre class="literalblock">
70Meta-class for initializing Model classes properties.
71
72Used for initializing Properties defined in the context of a model.
73By using a meta-class much of the configuration of a Property
74descriptor becomes implicit. By using this meta-class, descriptors
75that are of class Model are notified about which class they
76belong to and what attribute they are associated with and can
77do appropriate initialization via __property_config__.
78
79Duplicate properties are not permitted.
80
81</pre>
82
83<!-- ==================== INSTANCE METHODS ==================== -->
84<a name="section-InstanceMethods"></a>
85<table class="summary" border="1" cellpadding="3"
86 cellspacing="0" width="100%" bgcolor="white">
87<tr bgcolor="#70b0f0" class="table-header">
88 <td colspan="2" class="table-header">
89 <table border="0" cellpadding="0" cellspacing="0" width="100%">
90 <tr valign="top">
91 <td align="left"><span class="table-header">Instance Methods</span></td>
92 <td align="right" valign="top"
93 ><span class="options">[<a href="#section-InstanceMethods"
94 class="privatelink" onclick="toggle_private();"
95 >hide private</a>]</span></td>
96 </tr>
97 </table>
98 </td>
99</tr>
100<tr>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type"><pre class="literalblock">
103the object's type
104
105</pre></span>
106 </td><td class="summary">
107 <table width="100%" cellpadding="0" cellspacing="0" border="0">
108 <tr>
109 <td><span class="summary-sig"><a href="google.appengine.ext.db.PropertiedClass-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">cls</span>,
110 <span class="summary-sig-arg">name</span>,
111 <span class="summary-sig-arg">bases</span>,
112 <span class="summary-sig-arg">dct</span>,
113 <span class="summary-sig-arg">map_kind</span>=<span class="summary-sig-default">True</span>)</span><br />
114 Initializes a class that might have property definitions.</td>
115 <td align="right" valign="top">
116
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124 <tr>
125 <td colspan="2" class="summary">
126 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
127 <code>__call__</code>,
128 <code>__delattr__</code>,
129 <code>__eq__</code>,
130 <code>__ge__</code>,
131 <code>__getattribute__</code>,
132 <code>__gt__</code>,
133 <code>__hash__</code>,
134 <code>__le__</code>,
135 <code>__lt__</code>,
136 <code>__ne__</code>,
137 <code>__new__</code>,
138 <code>__repr__</code>,
139 <code>__setattr__</code>,
140 <code>__subclasses__</code>,
141 <code>mro</code>
142 </p>
143 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
144 <code>__format__</code>,
145 <code>__reduce__</code>,
146 <code>__reduce_ex__</code>,
147 <code>__sizeof__</code>,
148 <code>__str__</code>,
149 <code>__subclasshook__</code>
150 </p>
151 </td>
152 </tr>
153</table>
154<!-- ==================== PROPERTIES ==================== -->
155<a name="section-Properties"></a>
156<table class="summary" border="1" cellpadding="3"
157 cellspacing="0" width="100%" bgcolor="white">
158<tr bgcolor="#70b0f0" class="table-header">
159 <td colspan="2" class="table-header">
160 <table border="0" cellpadding="0" cellspacing="0" width="100%">
161 <tr valign="top">
162 <td align="left"><span class="table-header">Properties</span></td>
163 <td align="right" valign="top"
164 ><span class="options">[<a href="#section-Properties"
165 class="privatelink" onclick="toggle_private();"
166 >hide private</a>]</span></td>
167 </tr>
168 </table>
169 </td>
170</tr>
171 <tr>
172 <td colspan="2" class="summary">
173 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
174 <code>__abstractmethods__</code>,
175 <code>__base__</code>,
176 <code>__bases__</code>,
177 <code>__basicsize__</code>,
178 <code>__dictoffset__</code>,
179 <code>__flags__</code>,
180 <code>__instancecheck__</code>,
181 <code>__itemsize__</code>,
182 <code>__mro__</code>,
183 <code>__name__</code>,
184 <code>__subclasscheck__</code>,
185 <code>__weakrefoffset__</code>
186 </p>
187 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
188 <code>__class__</code>
189 </p>
190 </td>
191 </tr>
192</table>
193<!-- ==================== METHOD DETAILS ==================== -->
194<a name="section-MethodDetails"></a>
195<table class="details" border="1" cellpadding="3"
196 cellspacing="0" width="100%" bgcolor="white">
197<tr bgcolor="#70b0f0" class="table-header">
198 <td colspan="2" class="table-header">
199 <table border="0" cellpadding="0" cellspacing="0" width="100%">
200 <tr valign="top">
201 <td align="left"><span class="table-header">Method Details</span></td>
202 <td align="right" valign="top"
203 ><span class="options">[<a href="#section-MethodDetails"
204 class="privatelink" onclick="toggle_private();"
205 >hide private</a>]</span></td>
206 </tr>
207 </table>
208 </td>
209</tr>
210</table>
211<a name="__init__"></a>
212<div>
213<table class="details" border="1" cellpadding="3"
214 cellspacing="0" width="100%" bgcolor="white">
215<tr><td>
216 <table width="100%" cellpadding="0" cellspacing="0" border="0">
217 <tr valign="top"><td>
218 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">cls</span>,
219 <span class="sig-arg">name</span>,
220 <span class="sig-arg">bases</span>,
221 <span class="sig-arg">dct</span>,
222 <span class="sig-arg">map_kind</span>=<span class="sig-default">True</span>)</span>
223 <br /><em class="fname">(Constructor)</em>
224 </h3>
225 </td><td align="right" valign="top"
226 >&nbsp;
227 </td>
228 </tr></table>
229
230 <pre class="literalblock">
231Initializes a class that might have property definitions.
232
233This method is called when a class is created with the PropertiedClass
234meta-class.
235
236Loads all properties for this model and its base classes in to a dictionary
237for easy reflection via the 'properties' method.
238
239Configures each property defined in the new class.
240
241Duplicate properties, either defined in the new class or defined separately
242in two base classes are not permitted.
243
244Properties may not assigned to names which are in the list of
245_RESERVED_WORDS. It is still possible to store a property using a reserved
246word in the datastore by using the 'name' keyword argument to the Property
247constructor.
248
249Args:
250 cls: Class being initialized.
251 name: Name of new class.
252 bases: Base classes of new class.
253 dct: Dictionary of new definitions for class.
254
255Raises:
256 DuplicatePropertyError when a property is duplicated either in the new
257 class or separately in two base classes.
258 ReservedWordError when a property is given a name that is in the list of
259 reserved words, attributes of Model and names of the form '__.*__'.
260
261</pre>
262 <dl class="fields">
263 <dt>Returns: <pre class="literalblock">
264the object's type
265
266</pre></dt>
267 <dt>Overrides:
268 object.__init__
269 </dt>
270 </dl>
271</td></tr></table>
272</div>
273<br />
274<!-- ==================== NAVIGATION BAR ==================== -->
275<table class="navbar" border="0" width="100%" cellpadding="0"
276 bgcolor="#a0c0ff" cellspacing="0">
277 <tr valign="middle">
278
279 <!-- Tree link -->
280 <th>&nbsp;&nbsp;&nbsp;<a
281 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
282
283 <!-- Index link -->
284 <th>&nbsp;&nbsp;&nbsp;<a
285 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
286
287 <!-- Help link -->
288 <th>&nbsp;&nbsp;&nbsp;<a
289 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
290
291 <th class="navbar" width="100%"></th>
292 </tr>
293</table>
294<table border="0" cellpadding="0" cellspacing="0" width="100%%">
295 <tr>
296 <td align="left" class="footer">
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame^]297 Generated by Epydoc 3.0.1 on Tue Oct 30 14:36:19 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]298 </td>
299 <td align="right" class="footer">
300 <a target="mainFrame" href="http://epydoc.sourceforge.net"
301 >http://epydoc.sourceforge.net</a>
302 </td>
303 </tr>
304</table>
305
306<script type="text/javascript">
307 <!--
308 // Private objects are initially displayed (because if
309 // javascript is turned off then we want them to be
310 // visible); but by default, we want to hide them. So hide
311 // them unless we have a cookie that says to show them.
312 checkCookie();
313 // -->
314</script>
315</body>
316</html>