Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / oauth2client.appengine.FlowProperty-class.html
blob: 311d5ce598bf9a161da4a5104c931ba8840d8cbd [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>oauth2client.appengine.FlowProperty</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 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.appengine-module.html">Module&nbsp;appengine</a> ::
39 Class&nbsp;FlowProperty
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.appengine.FlowProperty-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class FlowProperty</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_oauth2cl_4" name="uml_class_diagram_for_oauth2cl_4">
59<area shape="rect" href="oauth2client.client.Flow-class.html" title="Base class for all Flow objects." alt="" coords="249,228,519,247"/>
60<area shape="rect" href="oauth2client.appengine.FlowProperty-class.html#get_value_for_datastore" title="Datastore representation of this property." alt="" coords="249,249,519,268"/>
61<area shape="rect" href="oauth2client.appengine.FlowProperty-class.html#make_value_from_datastore" title="Native representation of this property." alt="" coords="249,268,519,287"/>
62<area shape="rect" href="oauth2client.appengine.FlowProperty-class.html#validate" title="Assert that provided value is compatible with this property." alt="" coords="249,287,519,305"/>
63<area shape="rect" href="oauth2client.appengine.FlowProperty-class.html#empty" title="Determine if value is empty in the context of this property." alt="" coords="249,305,519,324"/>
64<area shape="rect" href="oauth2client.appengine.FlowProperty-class.html" title="App Engine datastore Property for Flow." alt="" coords="248,211,520,325"/>
65<area shape="rect" href="javascript:void(0);" title="google.appengine.ext.db.Property.creation_counter" alt="" coords="17,28,751,47"/>
66<area shape="rect" href="javascript:void(0);" title="Initializes this Property with the given options." alt="" coords="17,49,751,68"/>
67<area shape="rect" href="javascript:void(0);" title="Configure property, connecting it to its model." alt="" coords="17,68,751,87"/>
68<area shape="rect" href="javascript:void(0);" title="Returns the value for this property on the given model instance." alt="" coords="17,87,751,105"/>
69<area shape="rect" href="javascript:void(0);" title="Sets the value for this property on the given model instance." alt="" coords="17,105,751,124"/>
70<area shape="rect" href="javascript:void(0);" title="Default value for unassigned values." alt="" coords="17,124,751,143"/>
71<area shape="rect" href="javascript:void(0);" title="Determine new value for auto&#45;updated property." alt="" coords="17,143,751,161"/>
72<area shape="rect" href="javascript:void(0);" title="Deprecated backwards&#45;compatible accessor method for self.data_type." alt="" coords="17,161,751,180"/>
73<area shape="rect" href="javascript:void(0);" title="A Property is an attribute of a Model." alt="" coords="16,11,752,181"/>
74</map>
75 <img src="uml_class_diagram_for_oauth2cl_4.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_4" ismap="ismap" class="graph-without-title" />
76</center>
77</center>
78<hr />
79<pre class="literalblock">
80App Engine datastore Property for Flow.
81
82Utility property that allows easy storage and retreival of an
83oauth2client.Flow
84
85</pre>
86
87<!-- ==================== NESTED CLASSES ==================== -->
88<a name="section-NestedClasses"></a>
89<table class="summary" border="1" cellpadding="3"
90 cellspacing="0" width="100%" bgcolor="white">
91<tr bgcolor="#70b0f0" class="table-header">
92 <td colspan="2" class="table-header">
93 <table border="0" cellpadding="0" cellspacing="0" width="100%">
94 <tr valign="top">
95 <td align="left"><span class="table-header">Nested Classes</span></td>
96 <td align="right" valign="top"
97 ><span class="options">[<a href="#section-NestedClasses"
98 class="privatelink" onclick="toggle_private();"
99 >hide private</a>]</span></td>
100 </tr>
101 </table>
102 </td>
103</tr>
104<tr>
105 <td width="15%" align="right" valign="top" class="summary">
106 <span class="summary-type">&nbsp;</span>
107 </td><td class="summary">
108 <a href="oauth2client.client.Flow-class.html" class="summary-name">data_type</a><br />
109 Base class for all Flow objects.
110 </td>
111 </tr>
112</table>
113<!-- ==================== INSTANCE METHODS ==================== -->
114<a name="section-InstanceMethods"></a>
115<table class="summary" border="1" cellpadding="3"
116 cellspacing="0" width="100%" bgcolor="white">
117<tr bgcolor="#70b0f0" class="table-header">
118 <td colspan="2" class="table-header">
119 <table border="0" cellpadding="0" cellspacing="0" width="100%">
120 <tr valign="top">
121 <td align="left"><span class="table-header">Instance Methods</span></td>
122 <td align="right" valign="top"
123 ><span class="options">[<a href="#section-InstanceMethods"
124 class="privatelink" onclick="toggle_private();"
125 >hide private</a>]</span></td>
126 </tr>
127 </table>
128 </td>
129</tr>
130<tr>
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type">&nbsp;</span>
133 </td><td class="summary">
134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <tr>
136 <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>,
137 <span class="summary-sig-arg">model_instance</span>)</span><br />
138 Datastore representation of this property.</td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.get_value_for_datastore">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <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>,
155 <span class="summary-sig-arg">value</span>)</span><br />
156 Native representation of this property.</td>
157 <td align="right" valign="top">
158 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.make_value_from_datastore">source&nbsp;code</a></span>
159
160 </td>
161 </tr>
162 </table>
163
164 </td>
165 </tr>
166<tr>
167 <td width="15%" align="right" valign="top" class="summary">
168 <span class="summary-type">&nbsp;</span>
169 </td><td class="summary">
170 <table width="100%" cellpadding="0" cellspacing="0" border="0">
171 <tr>
172 <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>,
173 <span class="summary-sig-arg">value</span>)</span><br />
174 Assert that provided value is compatible with this property.</td>
175 <td align="right" valign="top">
176 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.validate">source&nbsp;code</a></span>
177
178 </td>
179 </tr>
180 </table>
181
182 </td>
183 </tr>
184<tr>
185 <td width="15%" align="right" valign="top" class="summary">
186 <span class="summary-type">&nbsp;</span>
187 </td><td class="summary">
188 <table width="100%" cellpadding="0" cellspacing="0" border="0">
189 <tr>
190 <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>,
191 <span class="summary-sig-arg">value</span>)</span><br />
192 Determine if value is empty in the context of this property.</td>
193 <td align="right" valign="top">
194 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source&nbsp;code</a></span>
195
196 </td>
197 </tr>
198 </table>
199
200 </td>
201 </tr>
202 <tr>
203 <td colspan="2" class="summary">
204 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
205 <code>__get__</code>,
206 <code>__init__</code>,
207 <code>__property_config__</code>,
208 <code>__set__</code>,
209 <code>datastore_type</code>,
210 <code>default_value</code>,
211 <code>get_updated_value_for_datastore</code>
212 </p>
213 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private):
214 <code>_attr_name</code>,
215 <code>_require_parameter</code>
216 </p></div>
217 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
218 <code>__delattr__</code>,
219 <code>__format__</code>,
220 <code>__getattribute__</code>,
221 <code>__hash__</code>,
222 <code>__new__</code>,
223 <code>__reduce__</code>,
224 <code>__reduce_ex__</code>,
225 <code>__repr__</code>,
226 <code>__setattr__</code>,
227 <code>__sizeof__</code>,
228 <code>__str__</code>,
229 <code>__subclasshook__</code>
230 </p>
231 </td>
232 </tr>
233</table>
234<!-- ==================== CLASS VARIABLES ==================== -->
235<a name="section-ClassVariables"></a>
236<table class="summary" border="1" cellpadding="3"
237 cellspacing="0" width="100%" bgcolor="white">
238<tr bgcolor="#70b0f0" class="table-header">
239 <td colspan="2" class="table-header">
240 <table border="0" cellpadding="0" cellspacing="0" width="100%">
241 <tr valign="top">
242 <td align="left"><span class="table-header">Class Variables</span></td>
243 <td align="right" valign="top"
244 ><span class="options">[<a href="#section-ClassVariables"
245 class="privatelink" onclick="toggle_private();"
246 >hide private</a>]</span></td>
247 </tr>
248 </table>
249 </td>
250</tr>
251 <tr>
252 <td colspan="2" class="summary">
253 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
254 <code>creation_counter</code>
255 </p>
256 </td>
257 </tr>
258</table>
259<!-- ==================== PROPERTIES ==================== -->
260<a name="section-Properties"></a>
261<table class="summary" border="1" cellpadding="3"
262 cellspacing="0" width="100%" bgcolor="white">
263<tr bgcolor="#70b0f0" class="table-header">
264 <td colspan="2" class="table-header">
265 <table border="0" cellpadding="0" cellspacing="0" width="100%">
266 <tr valign="top">
267 <td align="left"><span class="table-header">Properties</span></td>
268 <td align="right" valign="top"
269 ><span class="options">[<a href="#section-Properties"
270 class="privatelink" onclick="toggle_private();"
271 >hide private</a>]</span></td>
272 </tr>
273 </table>
274 </td>
275</tr>
276 <tr>
277 <td colspan="2" class="summary">
278 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
279 <code>__class__</code>
280 </p>
281 </td>
282 </tr>
283</table>
284<!-- ==================== METHOD DETAILS ==================== -->
285<a name="section-MethodDetails"></a>
286<table class="details" border="1" cellpadding="3"
287 cellspacing="0" width="100%" bgcolor="white">
288<tr bgcolor="#70b0f0" class="table-header">
289 <td colspan="2" class="table-header">
290 <table border="0" cellpadding="0" cellspacing="0" width="100%">
291 <tr valign="top">
292 <td align="left"><span class="table-header">Method Details</span></td>
293 <td align="right" valign="top"
294 ><span class="options">[<a href="#section-MethodDetails"
295 class="privatelink" onclick="toggle_private();"
296 >hide private</a>]</span></td>
297 </tr>
298 </table>
299 </td>
300</tr>
301</table>
302<a name="get_value_for_datastore"></a>
303<div>
304<table class="details" border="1" cellpadding="3"
305 cellspacing="0" width="100%" bgcolor="white">
306<tr><td>
307 <table width="100%" cellpadding="0" cellspacing="0" border="0">
308 <tr valign="top"><td>
309 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value_for_datastore</span>(<span class="sig-arg">self</span>,
310 <span class="sig-arg">model_instance</span>)</span>
311 </h3>
312 </td><td align="right" valign="top"
313 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.get_value_for_datastore">source&nbsp;code</a></span>&nbsp;
314 </td>
315 </tr></table>
316
317 <pre class="literalblock">
318Datastore representation of this property.
319
320Looks for this property in the given model instance, and returns the proper
321datastore representation of the value that can be stored in a datastore
322entity. Most critically, it will fetch the datastore key value for
323reference properties.
324
325Some properies (e.g. DateTimeProperty, UserProperty) optionally update their
326value on every put(). This call must return the current value for such
327properties (get_updated_value_for_datastore returns the new value).
328
329Args:
330 model_instance: Instance to fetch datastore value from.
331
332Returns:
333 Datastore representation of the model value in a form that is
334 appropriate for storing in the datastore.
335
336</pre>
337 <dl class="fields">
338 <dt>Overrides:
339 google.appengine.ext.db.Property.get_value_for_datastore
340 <dd><em class="note">(inherited documentation)</em></dd>
341 </dt>
342 </dl>
343</td></tr></table>
344</div>
345<a name="make_value_from_datastore"></a>
346<div>
347<table class="details" border="1" cellpadding="3"
348 cellspacing="0" width="100%" bgcolor="white">
349<tr><td>
350 <table width="100%" cellpadding="0" cellspacing="0" border="0">
351 <tr valign="top"><td>
352 <h3 class="epydoc"><span class="sig"><span class="sig-name">make_value_from_datastore</span>(<span class="sig-arg">self</span>,
353 <span class="sig-arg">value</span>)</span>
354 </h3>
355 </td><td align="right" valign="top"
356 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.make_value_from_datastore">source&nbsp;code</a></span>&nbsp;
357 </td>
358 </tr></table>
359
360 <pre class="literalblock">
361Native representation of this property.
362
363Given a value retrieved from a datastore entity, return a value,
364possibly converted, to be stored on the model instance. Usually
365this returns the value unchanged, but a property class may
366override this when it uses a different datatype on the model
367instance than on the entity.
368
369This API is not quite symmetric with get_value_for_datastore(),
370because the model instance on which to store the converted value
371may not exist yet -- we may be collecting values to be passed to a
372model constructor.
373
374Args:
375 value: value retrieved from the datastore entity.
376
377Returns:
378 The value converted for use as a model instance attribute.
379
380</pre>
381 <dl class="fields">
382 <dt>Overrides:
383 google.appengine.ext.db.Property.make_value_from_datastore
384 <dd><em class="note">(inherited documentation)</em></dd>
385 </dt>
386 </dl>
387</td></tr></table>
388</div>
389<a name="validate"></a>
390<div>
391<table class="details" border="1" cellpadding="3"
392 cellspacing="0" width="100%" bgcolor="white">
393<tr><td>
394 <table width="100%" cellpadding="0" cellspacing="0" border="0">
395 <tr valign="top"><td>
396 <h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,
397 <span class="sig-arg">value</span>)</span>
398 </h3>
399 </td><td align="right" valign="top"
400 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.validate">source&nbsp;code</a></span>&nbsp;
401 </td>
402 </tr></table>
403
404 <pre class="literalblock">
405Assert that provided value is compatible with this property.
406
407Args:
408 value: Value to validate against this Property.
409
410Returns:
411 A valid value, either the input unchanged or adapted to the
412 required type.
413
414Raises:
415 BadValueError if the value is not appropriate for this
416 property in any way.
417
418</pre>
419 <dl class="fields">
420 <dt>Overrides:
421 google.appengine.ext.db.Property.validate
422 <dd><em class="note">(inherited documentation)</em></dd>
423 </dt>
424 </dl>
425</td></tr></table>
426</div>
427<a name="empty"></a>
428<div>
429<table class="details" border="1" cellpadding="3"
430 cellspacing="0" width="100%" bgcolor="white">
431<tr><td>
432 <table width="100%" cellpadding="0" cellspacing="0" border="0">
433 <tr valign="top"><td>
434 <h3 class="epydoc"><span class="sig"><span class="sig-name">empty</span>(<span class="sig-arg">self</span>,
435 <span class="sig-arg">value</span>)</span>
436 </h3>
437 </td><td align="right" valign="top"
438 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source&nbsp;code</a></span>&nbsp;
439 </td>
440 </tr></table>
441
442 <pre class="literalblock">
443Determine if value is empty in the context of this property.
444
445For most kinds, this is equivalent to &quot;not value&quot;, but for kinds like
446bool, the test is more subtle, so subclasses can override this method
447if necessary.
448
449Args:
450 value: Value to validate against this Property.
451
452Returns:
453 True if this value is considered empty in the context of this Property
454 type, otherwise False.
455
456</pre>
457 <dl class="fields">
458 <dt>Overrides:
459 google.appengine.ext.db.Property.empty
460 <dd><em class="note">(inherited documentation)</em></dd>
461 </dt>
462 </dl>
463</td></tr></table>
464</div>
465<br />
466<!-- ==================== NAVIGATION BAR ==================== -->
467<table class="navbar" border="0" width="100%" cellpadding="0"
468 bgcolor="#a0c0ff" cellspacing="0">
469 <tr valign="middle">
470
471 <!-- Tree link -->
472 <th>&nbsp;&nbsp;&nbsp;<a
473 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
474
475 <!-- Index link -->
476 <th>&nbsp;&nbsp;&nbsp;<a
477 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
478
479 <!-- Help link -->
480 <th>&nbsp;&nbsp;&nbsp;<a
481 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
482
483 <th class="navbar" width="100%"></th>
484 </tr>
485</table>
486<table border="0" cellpadding="0" cellspacing="0" width="100%%">
487 <tr>
488 <td align="left" class="footer">
489 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:08 2012
490 </td>
491 <td align="right" class="footer">
492 <a target="mainFrame" href="http://epydoc.sourceforge.net"
493 >http://epydoc.sourceforge.net</a>
494 </td>
495 </tr>
496</table>
497
498<script type="text/javascript">
499 <!--
500 // Private objects are initially displayed (because if
501 // javascript is turned off then we want them to be
502 // visible); but by default, we want to hide them. So hide
503 // them unless we have a cookie that says to show them.
504 checkCookie();
505 // -->
506</script>
507</body>
508</html>