Index: docs/epy/google.appengine.ext.db.PropertiedClass-class.html |
=================================================================== |
new file mode 100644 |
--- /dev/null |
+++ b/docs/epy/google.appengine.ext.db.PropertiedClass-class.html |
@@ -0,0 +1,344 @@ |
+<?xml version="1.0" encoding="ascii"?> |
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
+ "DTD/xhtml1-transitional.dtd"> |
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
+<head> |
+ <title>google.appengine.ext.db.PropertiedClass</title> |
+ <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
+ <script type="text/javascript" src="epydoc.js"></script> |
+</head> |
+ |
+<body bgcolor="white" text="black" link="blue" vlink="#204080" |
+ alink="#204080"> |
+<!-- ==================== NAVIGATION BAR ==================== --> |
+<table class="navbar" border="0" width="100%" cellpadding="0" |
+ bgcolor="#a0c0ff" cellspacing="0"> |
+ <tr valign="middle"> |
+ |
+ <!-- Tree link --> |
+ <th> <a |
+ href="module-tree.html">Trees</a> </th> |
+ |
+ <!-- Index link --> |
+ <th> <a |
+ href="identifier-index.html">Indices</a> </th> |
+ |
+ <!-- Help link --> |
+ <th> <a |
+ href="help.html">Help</a> </th> |
+ |
+ <th class="navbar" width="100%"></th> |
+ </tr> |
+</table> |
+<table width="100%" cellpadding="0" cellspacing="0"> |
+ <tr valign="top"> |
+ <td width="100%"> |
+ <span class="breadcrumbs"> |
+ google :: |
+ appengine :: |
+ ext :: |
+ db :: |
+ PropertiedClass :: |
+ Class PropertiedClass |
+ </span> |
+ </td> |
+ <td> |
+ <table cellpadding="0" cellspacing="0"> |
+ <!-- hide/show private --> |
+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
+ onclick="toggle_private();">hide private</a>]</span></td></tr> |
+ <tr><td align="right"><span class="options" |
+ >[<a href="frames.html" target="_top">frames</a |
+ >] | <a href="google.appengine.ext.db.PropertiedClass-class.html" |
+ target="_top">no frames</a>]</span></td></tr> |
+ </table> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== TYPE DESCRIPTION ==================== --> |
+<h1 class="epydoc">Type PropertiedClass</h1><p class="nomargin-top"></p> |
+<center> |
+<center> <map id="uml_class_diagram_for_google_a" name="uml_class_diagram_for_google_a"> |
+<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"/> |
+<area shape="rect" href="google.appengine.ext.db.PropertiedClass-class.html" title="Meta-class for initializing Model classes properties." alt="" coords="16,565,301,611"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__abstractmethods__" alt="" coords="93,28,224,47"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__base__" alt="" coords="93,47,224,65"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__bases__" alt="" coords="93,65,224,84"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__basicsize__" alt="" coords="93,84,224,103"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__dictoffset__" alt="" coords="93,103,224,121"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__flags__" alt="" coords="93,121,224,140"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__instancecheck__" alt="" coords="93,140,224,159"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__itemsize__" alt="" coords="93,159,224,177"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__mro__" alt="" coords="93,177,224,196"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__name__" alt="" coords="93,196,224,215"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__subclasscheck__" alt="" coords="93,215,224,233"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__weakrefoffset__" alt="" coords="93,233,224,252"/> |
+<area shape="rect" href="javascript:void(0);" title="x(...)" alt="" coords="93,255,224,273"/> |
+<area shape="rect" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="93,273,224,292"/> |
+<area shape="rect" href="javascript:void(0);" title="x==y" alt="" coords="93,292,224,311"/> |
+<area shape="rect" href="javascript:void(0);" title="x>=y" alt="" coords="93,311,224,329"/> |
+<area shape="rect" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="93,329,224,348"/> |
+<area shape="rect" href="javascript:void(0);" title="x>y" alt="" coords="93,348,224,367"/> |
+<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="93,367,224,385"/> |
+<area shape="rect" href="javascript:void(0);" title="x<=y" alt="" coords="93,385,224,404"/> |
+<area shape="rect" href="javascript:void(0);" title="x<y" alt="" coords="93,404,224,423"/> |
+<area shape="rect" href="javascript:void(0);" title="x!=y" alt="" coords="93,423,224,441"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__new__" alt="" coords="93,441,224,460"/> |
+<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="93,460,224,479"/> |
+<area shape="rect" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="93,479,224,497"/> |
+<area shape="rect" href="javascript:void(0);" title="type.__subclasses__" alt="" coords="93,497,224,516"/> |
+<area shape="rect" href="javascript:void(0);" title="return a type's method resolution order" alt="" coords="93,516,224,535"/> |
+<area shape="rect" href="javascript:void(0);" title="type(object) -> the object's type..." alt="" coords="92,11,225,536"/> |
+</map> |
+ <img src="uml_class_diagram_for_google_a.gif" alt='' usemap="#uml_class_diagram_for_google_a" ismap="ismap" class="graph-without-title" /> |
+</center> |
+</center> |
+<hr /> |
+<pre class="literalblock"> |
+Meta-class for initializing Model classes properties. |
+ |
+Used for initializing Properties defined in the context of a model. |
+By using a meta-class much of the configuration of a Property |
+descriptor becomes implicit. By using this meta-class, descriptors |
+that are of class Model are notified about which class they |
+belong to and what attribute they are associated with and can |
+do appropriate initialization via __property_config__. |
+ |
+Duplicate properties are not permitted. |
+ |
+</pre> |
+ |
+<!-- ==================== INSTANCE METHODS ==================== --> |
+<a name="section-InstanceMethods"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Instance Methods</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-InstanceMethods" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"><pre class="literalblock"> |
+the object's type |
+ |
+</pre></span> |
+ </td><td class="summary"> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr> |
+ <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>, |
+ <span class="summary-sig-arg">name</span>, |
+ <span class="summary-sig-arg">bases</span>, |
+ <span class="summary-sig-arg">dct</span>, |
+ <span class="summary-sig-arg">map_kind</span>=<span class="summary-sig-default">True</span>)</span><br /> |
+ Initializes a class that might have property definitions.</td> |
+ <td align="right" valign="top"> |
+ |
+ |
+ </td> |
+ </tr> |
+ </table> |
+ |
+ </td> |
+ </tr> |
+ <tr> |
+ <td colspan="2" class="summary"> |
+ <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>: |
+ <code>__call__</code>, |
+ <code>__delattr__</code>, |
+ <code>__eq__</code>, |
+ <code>__ge__</code>, |
+ <code>__getattribute__</code>, |
+ <code>__gt__</code>, |
+ <code>__hash__</code>, |
+ <code>__le__</code>, |
+ <code>__lt__</code>, |
+ <code>__ne__</code>, |
+ <code>__new__</code>, |
+ <code>__repr__</code>, |
+ <code>__setattr__</code>, |
+ <code>__subclasses__</code>, |
+ <code>mro</code> |
+ </p> |
+ <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
+ <code>__format__</code>, |
+ <code>__reduce__</code>, |
+ <code>__reduce_ex__</code>, |
+ <code>__sizeof__</code>, |
+ <code>__str__</code>, |
+ <code>__subclasshook__</code> |
+ </p> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== PROPERTIES ==================== --> |
+<a name="section-Properties"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Properties</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-Properties" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+ <tr> |
+ <td colspan="2" class="summary"> |
+ <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>: |
+ <code>__abstractmethods__</code>, |
+ <code>__base__</code>, |
+ <code>__bases__</code>, |
+ <code>__basicsize__</code>, |
+ <code>__dictoffset__</code>, |
+ <code>__flags__</code>, |
+ <code>__instancecheck__</code>, |
+ <code>__itemsize__</code>, |
+ <code>__mro__</code>, |
+ <code>__name__</code>, |
+ <code>__subclasscheck__</code>, |
+ <code>__weakrefoffset__</code> |
+ </p> |
+ <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
+ <code>__class__</code> |
+ </p> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== METHOD DETAILS ==================== --> |
+<a name="section-MethodDetails"></a> |
+<table class="details" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Method Details</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-MethodDetails" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+</table> |
+<a name="__init__"></a> |
+<div> |
+<table class="details" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr><td> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr valign="top"><td> |
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">cls</span>, |
+ <span class="sig-arg">name</span>, |
+ <span class="sig-arg">bases</span>, |
+ <span class="sig-arg">dct</span>, |
+ <span class="sig-arg">map_kind</span>=<span class="sig-default">True</span>)</span> |
+ <br /><em class="fname">(Constructor)</em> |
+ </h3> |
+ </td><td align="right" valign="top" |
+ > |
+ </td> |
+ </tr></table> |
+ |
+ <pre class="literalblock"> |
+Initializes a class that might have property definitions. |
+ |
+This method is called when a class is created with the PropertiedClass |
+meta-class. |
+ |
+Loads all properties for this model and its base classes in to a dictionary |
+for easy reflection via the 'properties' method. |
+ |
+Configures each property defined in the new class. |
+ |
+Duplicate properties, either defined in the new class or defined separately |
+in two base classes are not permitted. |
+ |
+Properties may not assigned to names which are in the list of |
+_RESERVED_WORDS. It is still possible to store a property using a reserved |
+word in the datastore by using the 'name' keyword argument to the Property |
+constructor. |
+ |
+Args: |
+ cls: Class being initialized. |
+ name: Name of new class. |
+ bases: Base classes of new class. |
+ dct: Dictionary of new definitions for class. |
+ |
+Raises: |
+ DuplicatePropertyError when a property is duplicated either in the new |
+ class or separately in two base classes. |
+ ReservedWordError when a property is given a name that is in the list of |
+ reserved words, attributes of Model and names of the form '__.*__'. |
+ |
+</pre> |
+ <dl class="fields"> |
+ <dt>Returns: <pre class="literalblock"> |
+the object's type |
+ |
+</pre></dt> |
+ <dt>Overrides: |
+ object.__init__ |
+ </dt> |
+ </dl> |
+</td></tr></table> |
+</div> |
+<br /> |
+<!-- ==================== NAVIGATION BAR ==================== --> |
+<table class="navbar" border="0" width="100%" cellpadding="0" |
+ bgcolor="#a0c0ff" cellspacing="0"> |
+ <tr valign="middle"> |
+ |
+ <!-- Tree link --> |
+ <th> <a |
+ href="module-tree.html">Trees</a> </th> |
+ |
+ <!-- Index link --> |
+ <th> <a |
+ href="identifier-index.html">Indices</a> </th> |
+ |
+ <!-- Help link --> |
+ <th> <a |
+ href="help.html">Help</a> </th> |
+ |
+ <th class="navbar" width="100%"></th> |
+ </tr> |
+</table> |
+<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
+ <tr> |
+ <td align="left" class="footer"> |
+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012 |
+ </td> |
+ <td align="right" class="footer"> |
+ <a target="mainFrame" href="http://epydoc.sourceforge.net" |
+ >http://epydoc.sourceforge.net</a> |
+ </td> |
+ </tr> |
+</table> |
+ |
+<script type="text/javascript"> |
+ <!-- |
+ // Private objects are initially displayed (because if |
+ // javascript is turned off then we want them to be |
+ // visible); but by default, we want to hide them. So hide |
+ // them unless we have a cookie that says to show them. |
+ checkCookie(); |
+ // --> |
+</script> |
+</body> |
+</html> |