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