Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: module apiclient.ext.appengine</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| 7 | <tr bgcolor="#7799ee"> |
| 8 | <td valign=bottom> <br> |
| 9 | <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.ext.html"><font color="#ffffff">ext</font></a>.appengine</strong></big></big></font></td |
| 10 | ><td align=right valign=bottom |
Joe Gregorio | 0250385 | 2011-08-31 09:07:55 -0400 | [diff] [blame] | 11 | ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/ext/appengine.py">/home/jcgregorio/projects/google-api-python-client/apiclient/ext/appengine.py</a></font></td></tr></table> |
Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 12 | <p><tt>Utilities for Google App Engine<br> |
| 13 | <br> |
| 14 | Utilities for making it easier to use the<br> |
| 15 | Google API Client for Python on Google App Engine.</tt></p> |
| 16 | <p> |
| 17 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 18 | <tr bgcolor="#aa55cc"> |
| 19 | <td colspan=3 valign=bottom> <br> |
| 20 | <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| 21 | |
| 22 | <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| 23 | <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="google.appengine.ext.db.html">google.appengine.ext.db</a><br> |
| 24 | </td><td width="25%" valign=top><a href="pickle.html">pickle</a><br> |
| 25 | </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| 26 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 27 | <tr bgcolor="#ee77aa"> |
| 28 | <td colspan=3 valign=bottom> <br> |
| 29 | <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| 30 | |
| 31 | <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| 32 | <td width="100%"><dl> |
Joe Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame] | 33 | <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> |
| 34 | </font></dt><dd> |
| 35 | <dl> |
| 36 | <dt><font face="helvetica, arial"><a href="apiclient.ext.appengine.html#StorageByKeyName">StorageByKeyName</a> |
| 37 | </font></dt></dl> |
| 38 | </dd> |
Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 39 | <dt><font face="helvetica, arial"><a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>(<a href="__builtin__.html#object">__builtin__.object</a>) |
| 40 | </font></dt><dd> |
| 41 | <dl> |
| 42 | <dt><font face="helvetica, arial"><a href="apiclient.ext.appengine.html#FlowThreeLeggedProperty">FlowThreeLeggedProperty</a> |
| 43 | </font></dt><dt><font face="helvetica, arial"><a href="apiclient.ext.appengine.html#OAuthCredentialsProperty">OAuthCredentialsProperty</a> |
| 44 | </font></dt></dl> |
| 45 | </dd> |
| 46 | </dl> |
| 47 | <p> |
| 48 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 49 | <tr bgcolor="#ffc8d8"> |
| 50 | <td colspan=3 valign=bottom> <br> |
| 51 | <font color="#000000" face="helvetica, arial"><a name="FlowThreeLeggedProperty">class <strong>FlowThreeLeggedProperty</strong></a>(<a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>)</font></td></tr> |
| 52 | |
| 53 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 54 | <td colspan=2><tt>Utility property that allows easy<br> |
| 55 | storage and retreival of an<br> |
| 56 | apiclient.oauth.FlowThreeLegged<br> </tt></td></tr> |
| 57 | <tr><td> </td> |
| 58 | <td width="100%"><dl><dt>Method resolution order:</dt> |
| 59 | <dd><a href="apiclient.ext.appengine.html#FlowThreeLeggedProperty">FlowThreeLeggedProperty</a></dd> |
| 60 | <dd><a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a></dd> |
| 61 | <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| 62 | </dl> |
| 63 | <hr> |
| 64 | Methods defined here:<br> |
| 65 | <dl><dt><a name="FlowThreeLeggedProperty-empty"><strong>empty</strong></a>(self, value)</dt></dl> |
| 66 | |
| 67 | <dl><dt><a name="FlowThreeLeggedProperty-get_value_for_datastore"><strong>get_value_for_datastore</strong></a>(self, model_instance)</dt><dd><tt># For writing to datastore.</tt></dd></dl> |
| 68 | |
| 69 | <dl><dt><a name="FlowThreeLeggedProperty-make_value_from_datastore"><strong>make_value_from_datastore</strong></a>(self, value)</dt><dd><tt># For reading from datastore.</tt></dd></dl> |
| 70 | |
| 71 | <dl><dt><a name="FlowThreeLeggedProperty-validate"><strong>validate</strong></a>(self, value)</dt></dl> |
| 72 | |
| 73 | <hr> |
| 74 | Data and other attributes defined here:<br> |
| 75 | <dl><dt><strong>data_type</strong> = <class 'apiclient.oauth.FlowThreeLegged'><dd><tt>Does the Three Legged Dance for OAuth 1.0a.</tt></dl> |
| 76 | |
| 77 | <hr> |
| 78 | Methods inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br> |
| 79 | <dl><dt><a name="FlowThreeLeggedProperty-__get__"><strong>__get__</strong></a>(self, model_instance, model_class)</dt><dd><tt>Returns the value for this property on the given model instance.<br> |
| 80 | <br> |
| 81 | See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of<br> |
| 82 | the arguments to this class and what they mean.</tt></dd></dl> |
| 83 | |
| 84 | <dl><dt><a name="FlowThreeLeggedProperty-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, default<font color="#909090">=None</font>, required<font color="#909090">=False</font>, validator<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, indexed<font color="#909090">=True</font>)</dt><dd><tt>Initializes this <a href="google.appengine.ext.db.html#Property">Property</a> with the given options.<br> |
| 85 | <br> |
| 86 | Args:<br> |
| 87 | verbose_name: User friendly name of property.<br> |
| 88 | name: Storage name for property. By default, uses attribute name<br> |
| 89 | as it is assigned in the Model sub-class.<br> |
| 90 | default: Default value for property if none is assigned.<br> |
| 91 | required: Whether property is required.<br> |
| 92 | validator: User provided method used for validation.<br> |
| 93 | choices: User provided set of valid property values.<br> |
| 94 | indexed: Whether property is indexed.</tt></dd></dl> |
| 95 | |
| 96 | <dl><dt><a name="FlowThreeLeggedProperty-__property_config__"><strong>__property_config__</strong></a>(self, model_class, property_name)</dt><dd><tt>Configure property, connecting it to its model.<br> |
| 97 | <br> |
| 98 | Configure the property so that it knows its property name and what class<br> |
| 99 | it belongs to.<br> |
| 100 | <br> |
| 101 | Args:<br> |
| 102 | model_class: Model class which <a href="google.appengine.ext.db.html#Property">Property</a> will belong to.<br> |
| 103 | property_name: Name of property within Model instance to store property<br> |
| 104 | values in. By default this will be the property name preceded by<br> |
| 105 | an underscore, but may change for different subclasses.</tt></dd></dl> |
| 106 | |
| 107 | <dl><dt><a name="FlowThreeLeggedProperty-__set__"><strong>__set__</strong></a>(self, model_instance, value)</dt><dd><tt>Sets the value for this property on the given model instance.<br> |
| 108 | <br> |
| 109 | See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of<br> |
| 110 | the arguments to this class and what they mean.</tt></dd></dl> |
| 111 | |
| 112 | <dl><dt><a name="FlowThreeLeggedProperty-datastore_type"><strong>datastore_type</strong></a>(self)</dt><dd><tt>Deprecated backwards-compatible accessor method for self.<strong>data_type</strong>.</tt></dd></dl> |
| 113 | |
| 114 | <dl><dt><a name="FlowThreeLeggedProperty-default_value"><strong>default_value</strong></a>(self)</dt><dd><tt>Default value for unassigned values.<br> |
| 115 | <br> |
| 116 | Returns:<br> |
| 117 | Default value as provided by <a href="#FlowThreeLeggedProperty-__init__">__init__</a>(default).</tt></dd></dl> |
| 118 | |
| 119 | <hr> |
| 120 | Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br> |
| 121 | <dl><dt><strong>__dict__</strong></dt> |
| 122 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 123 | </dl> |
| 124 | <dl><dt><strong>__weakref__</strong></dt> |
| 125 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 126 | </dl> |
| 127 | <hr> |
| 128 | Data and other attributes inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br> |
| 129 | <dl><dt><strong>creation_counter</strong> = 0</dl> |
| 130 | |
| 131 | </td></tr></table> <p> |
| 132 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 133 | <tr bgcolor="#ffc8d8"> |
| 134 | <td colspan=3 valign=bottom> <br> |
| 135 | <font color="#000000" face="helvetica, arial"><a name="OAuthCredentialsProperty">class <strong>OAuthCredentialsProperty</strong></a>(<a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>)</font></td></tr> |
| 136 | |
| 137 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 138 | <td colspan=2><tt>Utility property that allows easy<br> |
| 139 | storage and retrieval of<br> |
| 140 | apiclient.oath.OAuthCredentials<br> </tt></td></tr> |
| 141 | <tr><td> </td> |
| 142 | <td width="100%"><dl><dt>Method resolution order:</dt> |
| 143 | <dd><a href="apiclient.ext.appengine.html#OAuthCredentialsProperty">OAuthCredentialsProperty</a></dd> |
| 144 | <dd><a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a></dd> |
| 145 | <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| 146 | </dl> |
| 147 | <hr> |
| 148 | Methods defined here:<br> |
| 149 | <dl><dt><a name="OAuthCredentialsProperty-empty"><strong>empty</strong></a>(self, value)</dt></dl> |
| 150 | |
| 151 | <dl><dt><a name="OAuthCredentialsProperty-get_value_for_datastore"><strong>get_value_for_datastore</strong></a>(self, model_instance)</dt><dd><tt># For writing to datastore.</tt></dd></dl> |
| 152 | |
| 153 | <dl><dt><a name="OAuthCredentialsProperty-make_value_from_datastore"><strong>make_value_from_datastore</strong></a>(self, value)</dt><dd><tt># For reading from datastore.</tt></dd></dl> |
| 154 | |
| 155 | <dl><dt><a name="OAuthCredentialsProperty-validate"><strong>validate</strong></a>(self, value)</dt></dl> |
| 156 | |
| 157 | <hr> |
| 158 | Data and other attributes defined here:<br> |
Joe Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame] | 159 | <dl><dt><strong>data_type</strong> = <class 'apiclient.oauth.OAuthCredentials'><dd><tt>Credentials <a href="__builtin__.html#object">object</a> for OAuth 1.0a</tt></dl> |
Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 160 | |
| 161 | <hr> |
| 162 | Methods inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br> |
| 163 | <dl><dt><a name="OAuthCredentialsProperty-__get__"><strong>__get__</strong></a>(self, model_instance, model_class)</dt><dd><tt>Returns the value for this property on the given model instance.<br> |
| 164 | <br> |
| 165 | See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of<br> |
| 166 | the arguments to this class and what they mean.</tt></dd></dl> |
| 167 | |
| 168 | <dl><dt><a name="OAuthCredentialsProperty-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, default<font color="#909090">=None</font>, required<font color="#909090">=False</font>, validator<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, indexed<font color="#909090">=True</font>)</dt><dd><tt>Initializes this <a href="google.appengine.ext.db.html#Property">Property</a> with the given options.<br> |
| 169 | <br> |
| 170 | Args:<br> |
| 171 | verbose_name: User friendly name of property.<br> |
| 172 | name: Storage name for property. By default, uses attribute name<br> |
| 173 | as it is assigned in the Model sub-class.<br> |
| 174 | default: Default value for property if none is assigned.<br> |
| 175 | required: Whether property is required.<br> |
| 176 | validator: User provided method used for validation.<br> |
| 177 | choices: User provided set of valid property values.<br> |
| 178 | indexed: Whether property is indexed.</tt></dd></dl> |
| 179 | |
| 180 | <dl><dt><a name="OAuthCredentialsProperty-__property_config__"><strong>__property_config__</strong></a>(self, model_class, property_name)</dt><dd><tt>Configure property, connecting it to its model.<br> |
| 181 | <br> |
| 182 | Configure the property so that it knows its property name and what class<br> |
| 183 | it belongs to.<br> |
| 184 | <br> |
| 185 | Args:<br> |
| 186 | model_class: Model class which <a href="google.appengine.ext.db.html#Property">Property</a> will belong to.<br> |
| 187 | property_name: Name of property within Model instance to store property<br> |
| 188 | values in. By default this will be the property name preceded by<br> |
| 189 | an underscore, but may change for different subclasses.</tt></dd></dl> |
| 190 | |
| 191 | <dl><dt><a name="OAuthCredentialsProperty-__set__"><strong>__set__</strong></a>(self, model_instance, value)</dt><dd><tt>Sets the value for this property on the given model instance.<br> |
| 192 | <br> |
| 193 | See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of<br> |
| 194 | the arguments to this class and what they mean.</tt></dd></dl> |
| 195 | |
| 196 | <dl><dt><a name="OAuthCredentialsProperty-datastore_type"><strong>datastore_type</strong></a>(self)</dt><dd><tt>Deprecated backwards-compatible accessor method for self.<strong>data_type</strong>.</tt></dd></dl> |
| 197 | |
| 198 | <dl><dt><a name="OAuthCredentialsProperty-default_value"><strong>default_value</strong></a>(self)</dt><dd><tt>Default value for unassigned values.<br> |
| 199 | <br> |
| 200 | Returns:<br> |
| 201 | Default value as provided by <a href="#OAuthCredentialsProperty-__init__">__init__</a>(default).</tt></dd></dl> |
| 202 | |
| 203 | <hr> |
| 204 | Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br> |
| 205 | <dl><dt><strong>__dict__</strong></dt> |
| 206 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 207 | </dl> |
| 208 | <dl><dt><strong>__weakref__</strong></dt> |
| 209 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 210 | </dl> |
| 211 | <hr> |
| 212 | Data and other attributes inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:<br> |
| 213 | <dl><dt><strong>creation_counter</strong> = 0</dl> |
| 214 | |
Joe Gregorio | 6e53703 | 2011-02-09 23:04:26 -0500 | [diff] [blame] | 215 | </td></tr></table> <p> |
| 216 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 217 | <tr bgcolor="#ffc8d8"> |
| 218 | <td colspan=3 valign=bottom> <br> |
| 219 | <font color="#000000" face="helvetica, arial"><a name="StorageByKeyName">class <strong>StorageByKeyName</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| 220 | |
| 221 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 222 | <td colspan=2><tt>Store and retrieve a single credential to and from<br> |
| 223 | the App Engine datastore.<br> |
| 224 | <br> |
| 225 | This Storage helper presumes the Credentials<br> |
| 226 | have been stored as a CredenialsProperty<br> |
| 227 | on a datastore model class, and that entities<br> |
| 228 | are stored by key_name.<br> </tt></td></tr> |
| 229 | <tr><td> </td> |
| 230 | <td width="100%">Methods defined here:<br> |
| 231 | <dl><dt><a name="StorageByKeyName-__init__"><strong>__init__</strong></a>(self, model, key_name, property_name)</dt><dd><tt>Constructor for Storage.<br> |
| 232 | <br> |
| 233 | Args:<br> |
| 234 | model: db.Model, model class<br> |
| 235 | key_name: string, key name for the entity that has the credentials<br> |
| 236 | property_name: string, name of the property that is a CredentialsProperty</tt></dd></dl> |
| 237 | |
| 238 | <dl><dt><a name="StorageByKeyName-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve Credential from datastore.<br> |
| 239 | <br> |
| 240 | Returns:<br> |
| 241 | Credentials</tt></dd></dl> |
| 242 | |
| 243 | <dl><dt><a name="StorageByKeyName-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write a Credentials to the datastore.<br> |
| 244 | <br> |
| 245 | Args:<br> |
| 246 | credentials: Credentials, the credentials to store.</tt></dd></dl> |
| 247 | |
| 248 | <hr> |
| 249 | Data descriptors defined here:<br> |
| 250 | <dl><dt><strong>__dict__</strong></dt> |
| 251 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 252 | </dl> |
| 253 | <dl><dt><strong>__weakref__</strong></dt> |
| 254 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 255 | </dl> |
Joe Gregorio | 30dfdc3 | 2010-12-09 16:34:22 -0500 | [diff] [blame] | 256 | </td></tr></table></td></tr></table><p> |
| 257 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 258 | <tr bgcolor="#55aa55"> |
| 259 | <td colspan=3 valign=bottom> <br> |
| 260 | <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| 261 | |
| 262 | <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| 263 | <td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p> |
| 264 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 265 | <tr bgcolor="#7799ee"> |
| 266 | <td colspan=3 valign=bottom> <br> |
| 267 | <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| 268 | |
| 269 | <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| 270 | <td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table> |
| 271 | </body></html> |