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