Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / google.appengine.ext.db.PropertiedClass-class.html
blob: 13e0de440c236c08e1c1a2464dc57f2f49ab81b1 [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>
61<center> <map id="uml_class_diagram_for_google_a" name="uml_class_diagram_for_google_a">
62<area shape="rect" href="google.appengine.ext.db.PropertiedClass-class.html#__init__" title="Initializes a class that might have property definitions." alt="" coords="17,591,300,609"/>
63<area shape="rect" href="google.appengine.ext.db.PropertiedClass-class.html" title="Meta&#45;class for initializing Model classes properties." alt="" coords="16,565,301,611"/>
64<area shape="rect" href="javascript:void(0);" title="type.__abstractmethods__" alt="" coords="93,28,224,47"/>
65<area shape="rect" href="javascript:void(0);" title="type.__base__" alt="" coords="93,47,224,65"/>
66<area shape="rect" href="javascript:void(0);" title="type.__bases__" alt="" coords="93,65,224,84"/>
67<area shape="rect" href="javascript:void(0);" title="type.__basicsize__" alt="" coords="93,84,224,103"/>
68<area shape="rect" href="javascript:void(0);" title="type.__dictoffset__" alt="" coords="93,103,224,121"/>
69<area shape="rect" href="javascript:void(0);" title="type.__flags__" alt="" coords="93,121,224,140"/>
70<area shape="rect" href="javascript:void(0);" title="type.__instancecheck__" alt="" coords="93,140,224,159"/>
71<area shape="rect" href="javascript:void(0);" title="type.__itemsize__" alt="" coords="93,159,224,177"/>
72<area shape="rect" href="javascript:void(0);" title="type.__mro__" alt="" coords="93,177,224,196"/>
73<area shape="rect" href="javascript:void(0);" title="type.__name__" alt="" coords="93,196,224,215"/>
74<area shape="rect" href="javascript:void(0);" title="type.__subclasscheck__" alt="" coords="93,215,224,233"/>
75<area shape="rect" href="javascript:void(0);" title="type.__weakrefoffset__" alt="" coords="93,233,224,252"/>
76<area shape="rect" href="javascript:void(0);" title="x(...)" alt="" coords="93,255,224,273"/>
77<area shape="rect" href="javascript:void(0);" title="x.__delattr__(&#39;name&#39;) &lt;==&gt; del x.name" alt="" coords="93,273,224,292"/>
78<area shape="rect" href="javascript:void(0);" title="x==y" alt="" coords="93,292,224,311"/>
79<area shape="rect" href="javascript:void(0);" title="x&gt;=y" alt="" coords="93,311,224,329"/>
80<area shape="rect" href="javascript:void(0);" title="x.__getattribute__(&#39;name&#39;) &lt;==&gt; x.name" alt="" coords="93,329,224,348"/>
81<area shape="rect" href="javascript:void(0);" title="x&gt;y" alt="" coords="93,348,224,367"/>
82<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="93,367,224,385"/>
83<area shape="rect" href="javascript:void(0);" title="x&lt;=y" alt="" coords="93,385,224,404"/>
84<area shape="rect" href="javascript:void(0);" title="x&lt;y" alt="" coords="93,404,224,423"/>
85<area shape="rect" href="javascript:void(0);" title="x!=y" alt="" coords="93,423,224,441"/>
86<area shape="rect" href="javascript:void(0);" title="type.__new__" alt="" coords="93,441,224,460"/>
87<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="93,460,224,479"/>
88<area shape="rect" href="javascript:void(0);" title="x.__setattr__(&#39;name&#39;, value) &lt;==&gt; x.name = value" alt="" coords="93,479,224,497"/>
89<area shape="rect" href="javascript:void(0);" title="type.__subclasses__" alt="" coords="93,497,224,516"/>
90<area shape="rect" href="javascript:void(0);" title="return a type&#39;s method resolution order" alt="" coords="93,516,224,535"/>
91<area shape="rect" href="javascript:void(0);" title="type(object) &#45;&gt; the object&#39;s type..." alt="" coords="92,11,225,536"/>
92</map>
93 <img src="uml_class_diagram_for_google_a.gif" alt='' usemap="#uml_class_diagram_for_google_a" ismap="ismap" class="graph-without-title" />
94</center>
95</center>
96<hr />
97<pre class="literalblock">
98Meta-class for initializing Model classes properties.
99
100Used for initializing Properties defined in the context of a model.
101By using a meta-class much of the configuration of a Property
102descriptor becomes implicit. By using this meta-class, descriptors
103that are of class Model are notified about which class they
104belong to and what attribute they are associated with and can
105do appropriate initialization via __property_config__.
106
107Duplicate properties are not permitted.
108
109</pre>
110
111<!-- ==================== INSTANCE METHODS ==================== -->
112<a name="section-InstanceMethods"></a>
113<table class="summary" border="1" cellpadding="3"
114 cellspacing="0" width="100%" bgcolor="white">
115<tr bgcolor="#70b0f0" class="table-header">
116 <td colspan="2" class="table-header">
117 <table border="0" cellpadding="0" cellspacing="0" width="100%">
118 <tr valign="top">
119 <td align="left"><span class="table-header">Instance Methods</span></td>
120 <td align="right" valign="top"
121 ><span class="options">[<a href="#section-InstanceMethods"
122 class="privatelink" onclick="toggle_private();"
123 >hide private</a>]</span></td>
124 </tr>
125 </table>
126 </td>
127</tr>
128<tr>
129 <td width="15%" align="right" valign="top" class="summary">
130 <span class="summary-type"><pre class="literalblock">
131the object's type
132
133</pre></span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <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>,
138 <span class="summary-sig-arg">name</span>,
139 <span class="summary-sig-arg">bases</span>,
140 <span class="summary-sig-arg">dct</span>,
141 <span class="summary-sig-arg">map_kind</span>=<span class="summary-sig-default">True</span>)</span><br />
142 Initializes a class that might have property definitions.</td>
143 <td align="right" valign="top">
144
145
146 </td>
147 </tr>
148 </table>
149
150 </td>
151 </tr>
152 <tr>
153 <td colspan="2" class="summary">
154 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
155 <code>__call__</code>,
156 <code>__delattr__</code>,
157 <code>__eq__</code>,
158 <code>__ge__</code>,
159 <code>__getattribute__</code>,
160 <code>__gt__</code>,
161 <code>__hash__</code>,
162 <code>__le__</code>,
163 <code>__lt__</code>,
164 <code>__ne__</code>,
165 <code>__new__</code>,
166 <code>__repr__</code>,
167 <code>__setattr__</code>,
168 <code>__subclasses__</code>,
169 <code>mro</code>
170 </p>
171 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
172 <code>__format__</code>,
173 <code>__reduce__</code>,
174 <code>__reduce_ex__</code>,
175 <code>__sizeof__</code>,
176 <code>__str__</code>,
177 <code>__subclasshook__</code>
178 </p>
179 </td>
180 </tr>
181</table>
182<!-- ==================== PROPERTIES ==================== -->
183<a name="section-Properties"></a>
184<table class="summary" border="1" cellpadding="3"
185 cellspacing="0" width="100%" bgcolor="white">
186<tr bgcolor="#70b0f0" class="table-header">
187 <td colspan="2" class="table-header">
188 <table border="0" cellpadding="0" cellspacing="0" width="100%">
189 <tr valign="top">
190 <td align="left"><span class="table-header">Properties</span></td>
191 <td align="right" valign="top"
192 ><span class="options">[<a href="#section-Properties"
193 class="privatelink" onclick="toggle_private();"
194 >hide private</a>]</span></td>
195 </tr>
196 </table>
197 </td>
198</tr>
199 <tr>
200 <td colspan="2" class="summary">
201 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
202 <code>__abstractmethods__</code>,
203 <code>__base__</code>,
204 <code>__bases__</code>,
205 <code>__basicsize__</code>,
206 <code>__dictoffset__</code>,
207 <code>__flags__</code>,
208 <code>__instancecheck__</code>,
209 <code>__itemsize__</code>,
210 <code>__mro__</code>,
211 <code>__name__</code>,
212 <code>__subclasscheck__</code>,
213 <code>__weakrefoffset__</code>
214 </p>
215 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
216 <code>__class__</code>
217 </p>
218 </td>
219 </tr>
220</table>
221<!-- ==================== METHOD DETAILS ==================== -->
222<a name="section-MethodDetails"></a>
223<table class="details" border="1" cellpadding="3"
224 cellspacing="0" width="100%" bgcolor="white">
225<tr bgcolor="#70b0f0" class="table-header">
226 <td colspan="2" class="table-header">
227 <table border="0" cellpadding="0" cellspacing="0" width="100%">
228 <tr valign="top">
229 <td align="left"><span class="table-header">Method Details</span></td>
230 <td align="right" valign="top"
231 ><span class="options">[<a href="#section-MethodDetails"
232 class="privatelink" onclick="toggle_private();"
233 >hide private</a>]</span></td>
234 </tr>
235 </table>
236 </td>
237</tr>
238</table>
239<a name="__init__"></a>
240<div>
241<table class="details" border="1" cellpadding="3"
242 cellspacing="0" width="100%" bgcolor="white">
243<tr><td>
244 <table width="100%" cellpadding="0" cellspacing="0" border="0">
245 <tr valign="top"><td>
246 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">cls</span>,
247 <span class="sig-arg">name</span>,
248 <span class="sig-arg">bases</span>,
249 <span class="sig-arg">dct</span>,
250 <span class="sig-arg">map_kind</span>=<span class="sig-default">True</span>)</span>
251 <br /><em class="fname">(Constructor)</em>
252 </h3>
253 </td><td align="right" valign="top"
254 >&nbsp;
255 </td>
256 </tr></table>
257
258 <pre class="literalblock">
259Initializes a class that might have property definitions.
260
261This method is called when a class is created with the PropertiedClass
262meta-class.
263
264Loads all properties for this model and its base classes in to a dictionary
265for easy reflection via the 'properties' method.
266
267Configures each property defined in the new class.
268
269Duplicate properties, either defined in the new class or defined separately
270in two base classes are not permitted.
271
272Properties may not assigned to names which are in the list of
273_RESERVED_WORDS. It is still possible to store a property using a reserved
274word in the datastore by using the 'name' keyword argument to the Property
275constructor.
276
277Args:
278 cls: Class being initialized.
279 name: Name of new class.
280 bases: Base classes of new class.
281 dct: Dictionary of new definitions for class.
282
283Raises:
284 DuplicatePropertyError when a property is duplicated either in the new
285 class or separately in two base classes.
286 ReservedWordError when a property is given a name that is in the list of
287 reserved words, attributes of Model and names of the form '__.*__'.
288
289</pre>
290 <dl class="fields">
291 <dt>Returns: <pre class="literalblock">
292the object's type
293
294</pre></dt>
295 <dt>Overrides:
296 object.__init__
297 </dt>
298 </dl>
299</td></tr></table>
300</div>
301<br />
302<!-- ==================== NAVIGATION BAR ==================== -->
303<table class="navbar" border="0" width="100%" cellpadding="0"
304 bgcolor="#a0c0ff" cellspacing="0">
305 <tr valign="middle">
306
307 <!-- Tree link -->
308 <th>&nbsp;&nbsp;&nbsp;<a
309 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
310
311 <!-- Index link -->
312 <th>&nbsp;&nbsp;&nbsp;<a
313 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
314
315 <!-- Help link -->
316 <th>&nbsp;&nbsp;&nbsp;<a
317 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
318
319 <th class="navbar" width="100%"></th>
320 </tr>
321</table>
322<table border="0" cellpadding="0" cellspacing="0" width="100%%">
323 <tr>
324 <td align="left" class="footer">
325 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012
326 </td>
327 <td align="right" class="footer">
328 <a target="mainFrame" href="http://epydoc.sourceforge.net"
329 >http://epydoc.sourceforge.net</a>
330 </td>
331 </tr>
332</table>
333
334<script type="text/javascript">
335 <!--
336 // Private objects are initially displayed (because if
337 // javascript is turned off then we want them to be
338 // visible); but by default, we want to hide them. So hide
339 // them unless we have a cookie that says to show them.
340 checkCookie();
341 // -->
342</script>
343</body>
344</html>