| <?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>oauth2client.appengine.FlowProperty</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"> |
| <a href="oauth2client-module.html">Package oauth2client</a> :: |
| <a href="oauth2client.appengine-module.html">Module appengine</a> :: |
| Class FlowProperty |
| </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="oauth2client.appengine.FlowProperty-class.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS DESCRIPTION ==================== --> |
| <h1 class="epydoc">Class FlowProperty</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty">source code</a></span></p> |
| <center> |
| <center> <map id="class_hierarchy_for_flowproper" name="class_hierarchy_for_flowproper"> |
| <area shape="rect" href="javascript:void(0);" title="google.appengine.ext.db.Property" alt="" coords="5,5,221,32"/> |
| <area shape="rect" href="oauth2client.appengine.FlowProperty-class.html" title="FlowProperty" alt="" coords="65,61,161,88"/> |
| </map> |
| <img src="class_hierarchy_for_flowproper.gif" alt='' usemap="#class_hierarchy_for_flowproper" ismap="ismap" class="graph-without-title" /> |
| </center> |
| </center> |
| <hr /> |
| <pre class="literalblock"> |
| App Engine datastore Property for Flow. |
| |
| Utility property that allows easy storage and retreival of an |
| oauth2client.Flow |
| |
| </pre> |
| |
| <!-- ==================== NESTED CLASSES ==================== --> |
| <a name="section-NestedClasses"></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">Nested Classes</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-NestedClasses" |
| 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"> </span> |
| </td><td class="summary"> |
| <a href="oauth2client.client.Flow-class.html" class="summary-name">data_type</a><br /> |
| Base class for all Flow objects. |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== 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"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore" class="summary-sig-name">get_value_for_datastore</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">model_instance</span>)</span><br /> |
| Datastore representation of this property.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.get_value_for_datastore">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="oauth2client.appengine.FlowProperty-class.html#make_value_from_datastore" class="summary-sig-name">make_value_from_datastore</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span><br /> |
| Native representation of this property.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.make_value_from_datastore">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="oauth2client.appengine.FlowProperty-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span><br /> |
| Assert that provided value is compatible with this property.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.validate">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="oauth2client.appengine.FlowProperty-class.html#empty" class="summary-sig-name">empty</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">value</span>)</span><br /> |
| Determine if value is empty in the context of this property.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td colspan="2" class="summary"> |
| <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>: |
| <code>__get__</code>, |
| <code>__init__</code>, |
| <code>__property_config__</code>, |
| <code>__set__</code>, |
| <code>datastore_type</code>, |
| <code>default_value</code>, |
| <code>get_updated_value_for_datastore</code> |
| </p> |
| <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private): |
| <code>_attr_name</code>, |
| <code>_require_parameter</code> |
| </p></div> |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| <code>__delattr__</code>, |
| <code>__format__</code>, |
| <code>__getattribute__</code>, |
| <code>__hash__</code>, |
| <code>__new__</code>, |
| <code>__reduce__</code>, |
| <code>__reduce_ex__</code>, |
| <code>__repr__</code>, |
| <code>__setattr__</code>, |
| <code>__sizeof__</code>, |
| <code>__str__</code>, |
| <code>__subclasshook__</code> |
| </p> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS VARIABLES ==================== --> |
| <a name="section-ClassVariables"></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">Class Variables</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-ClassVariables" |
| 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>google.appengine.ext.db.Property</code></b>: |
| <code>creation_counter</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>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="get_value_for_datastore"></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">get_value_for_datastore</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">model_instance</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.get_value_for_datastore">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Datastore representation of this property. |
| |
| Looks for this property in the given model instance, and returns the proper |
| datastore representation of the value that can be stored in a datastore |
| entity. Most critically, it will fetch the datastore key value for |
| reference properties. |
| |
| Some properies (e.g. DateTimeProperty, UserProperty) optionally update their |
| value on every put(). This call must return the current value for such |
| properties (get_updated_value_for_datastore returns the new value). |
| |
| Args: |
| model_instance: Instance to fetch datastore value from. |
| |
| Returns: |
| Datastore representation of the model value in a form that is |
| appropriate for storing in the datastore. |
| |
| </pre> |
| <dl class="fields"> |
| <dt>Overrides: |
| google.appengine.ext.db.Property.get_value_for_datastore |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="make_value_from_datastore"></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">make_value_from_datastore</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">value</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.make_value_from_datastore">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Native representation of this property. |
| |
| Given a value retrieved from a datastore entity, return a value, |
| possibly converted, to be stored on the model instance. Usually |
| this returns the value unchanged, but a property class may |
| override this when it uses a different datatype on the model |
| instance than on the entity. |
| |
| This API is not quite symmetric with get_value_for_datastore(), |
| because the model instance on which to store the converted value |
| may not exist yet -- we may be collecting values to be passed to a |
| model constructor. |
| |
| Args: |
| value: value retrieved from the datastore entity. |
| |
| Returns: |
| The value converted for use as a model instance attribute. |
| |
| </pre> |
| <dl class="fields"> |
| <dt>Overrides: |
| google.appengine.ext.db.Property.make_value_from_datastore |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="validate"></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">validate</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">value</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.validate">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Assert that provided value is compatible with this property. |
| |
| Args: |
| value: Value to validate against this Property. |
| |
| Returns: |
| A valid value, either the input unchanged or adapted to the |
| required type. |
| |
| Raises: |
| BadValueError if the value is not appropriate for this |
| property in any way. |
| |
| </pre> |
| <dl class="fields"> |
| <dt>Overrides: |
| google.appengine.ext.db.Property.validate |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="empty"></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">empty</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">value</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Determine if value is empty in the context of this property. |
| |
| For most kinds, this is equivalent to "not value", but for kinds like |
| bool, the test is more subtle, so subclasses can override this method |
| if necessary. |
| |
| Args: |
| value: Value to validate against this Property. |
| |
| Returns: |
| True if this value is considered empty in the context of this Property |
| type, otherwise False. |
| |
| </pre> |
| <dl class="fields"> |
| <dt>Overrides: |
| google.appengine.ext.db.Property.empty |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </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 Thu Jul 12 10:44:11 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> |