Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d37e76fad280dda7565e08efe6a0426e081fd542 / . / docs / epy / oauth2client.appengine.FlowProperty-class.html
blob: 765cf154283852bf91a304a4e4c6efd5dd87ebaf [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 Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]198 <code>get_updated_value_for_datastore</code>,
199 <code>make_value_from_datastore_index_value</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]200 </p>
201 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b> (private):
202 <code>_attr_name</code>,
203 <code>_require_parameter</code>
204 </p></div>
205 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
206 <code>__delattr__</code>,
207 <code>__format__</code>,
208 <code>__getattribute__</code>,
209 <code>__hash__</code>,
210 <code>__new__</code>,
211 <code>__reduce__</code>,
212 <code>__reduce_ex__</code>,
213 <code>__repr__</code>,
214 <code>__setattr__</code>,
215 <code>__sizeof__</code>,
216 <code>__str__</code>,
217 <code>__subclasshook__</code>
218 </p>
219 </td>
220 </tr>
221</table>
222<!-- ==================== CLASS VARIABLES ==================== -->
223<a name="section-ClassVariables"></a>
224<table class="summary" border="1" cellpadding="3"
225 cellspacing="0" width="100%" bgcolor="white">
226<tr bgcolor="#70b0f0" class="table-header">
227 <td colspan="2" class="table-header">
228 <table border="0" cellpadding="0" cellspacing="0" width="100%">
229 <tr valign="top">
230 <td align="left"><span class="table-header">Class Variables</span></td>
231 <td align="right" valign="top"
232 ><span class="options">[<a href="#section-ClassVariables"
233 class="privatelink" onclick="toggle_private();"
234 >hide private</a>]</span></td>
235 </tr>
236 </table>
237 </td>
238</tr>
239 <tr>
240 <td colspan="2" class="summary">
241 <p class="indent-wrapped-lines"><b>Inherited from <code>google.appengine.ext.db.Property</code></b>:
242 <code>creation_counter</code>
243 </p>
244 </td>
245 </tr>
246</table>
247<!-- ==================== PROPERTIES ==================== -->
248<a name="section-Properties"></a>
249<table class="summary" border="1" cellpadding="3"
250 cellspacing="0" width="100%" bgcolor="white">
251<tr bgcolor="#70b0f0" class="table-header">
252 <td colspan="2" class="table-header">
253 <table border="0" cellpadding="0" cellspacing="0" width="100%">
254 <tr valign="top">
255 <td align="left"><span class="table-header">Properties</span></td>
256 <td align="right" valign="top"
257 ><span class="options">[<a href="#section-Properties"
258 class="privatelink" onclick="toggle_private();"
259 >hide private</a>]</span></td>
260 </tr>
261 </table>
262 </td>
263</tr>
264 <tr>
265 <td colspan="2" class="summary">
266 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
267 <code>__class__</code>
268 </p>
269 </td>
270 </tr>
271</table>
272<!-- ==================== METHOD DETAILS ==================== -->
273<a name="section-MethodDetails"></a>
274<table class="details" border="1" cellpadding="3"
275 cellspacing="0" width="100%" bgcolor="white">
276<tr bgcolor="#70b0f0" class="table-header">
277 <td colspan="2" class="table-header">
278 <table border="0" cellpadding="0" cellspacing="0" width="100%">
279 <tr valign="top">
280 <td align="left"><span class="table-header">Method Details</span></td>
281 <td align="right" valign="top"
282 ><span class="options">[<a href="#section-MethodDetails"
283 class="privatelink" onclick="toggle_private();"
284 >hide private</a>]</span></td>
285 </tr>
286 </table>
287 </td>
288</tr>
289</table>
290<a name="get_value_for_datastore"></a>
291<div>
292<table class="details" border="1" cellpadding="3"
293 cellspacing="0" width="100%" bgcolor="white">
294<tr><td>
295 <table width="100%" cellpadding="0" cellspacing="0" border="0">
296 <tr valign="top"><td>
297 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value_for_datastore</span>(<span class="sig-arg">self</span>,
298 <span class="sig-arg">model_instance</span>)</span>
299 </h3>
300 </td><td align="right" valign="top"
301 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.get_value_for_datastore">source&nbsp;code</a></span>&nbsp;
302 </td>
303 </tr></table>
304
305 <pre class="literalblock">
306Datastore representation of this property.
307
308Looks for this property in the given model instance, and returns the proper
309datastore representation of the value that can be stored in a datastore
310entity. Most critically, it will fetch the datastore key value for
311reference properties.
312
313Some properies (e.g. DateTimeProperty, UserProperty) optionally update their
314value on every put(). This call must return the current value for such
315properties (get_updated_value_for_datastore returns the new value).
316
317Args:
318 model_instance: Instance to fetch datastore value from.
319
320Returns:
321 Datastore representation of the model value in a form that is
322 appropriate for storing in the datastore.
323
324</pre>
325 <dl class="fields">
326 <dt>Overrides:
327 google.appengine.ext.db.Property.get_value_for_datastore
328 <dd><em class="note">(inherited documentation)</em></dd>
329 </dt>
330 </dl>
331</td></tr></table>
332</div>
333<a name="make_value_from_datastore"></a>
334<div>
335<table class="details" border="1" cellpadding="3"
336 cellspacing="0" width="100%" bgcolor="white">
337<tr><td>
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr valign="top"><td>
340 <h3 class="epydoc"><span class="sig"><span class="sig-name">make_value_from_datastore</span>(<span class="sig-arg">self</span>,
341 <span class="sig-arg">value</span>)</span>
342 </h3>
343 </td><td align="right" valign="top"
344 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.make_value_from_datastore">source&nbsp;code</a></span>&nbsp;
345 </td>
346 </tr></table>
347
348 <pre class="literalblock">
349Native representation of this property.
350
351Given a value retrieved from a datastore entity, return a value,
352possibly converted, to be stored on the model instance. Usually
353this returns the value unchanged, but a property class may
354override this when it uses a different datatype on the model
355instance than on the entity.
356
357This API is not quite symmetric with get_value_for_datastore(),
358because the model instance on which to store the converted value
359may not exist yet -- we may be collecting values to be passed to a
360model constructor.
361
362Args:
363 value: value retrieved from the datastore entity.
364
365Returns:
366 The value converted for use as a model instance attribute.
367
368</pre>
369 <dl class="fields">
370 <dt>Overrides:
371 google.appengine.ext.db.Property.make_value_from_datastore
372 <dd><em class="note">(inherited documentation)</em></dd>
373 </dt>
374 </dl>
375</td></tr></table>
376</div>
377<a name="validate"></a>
378<div>
379<table class="details" border="1" cellpadding="3"
380 cellspacing="0" width="100%" bgcolor="white">
381<tr><td>
382 <table width="100%" cellpadding="0" cellspacing="0" border="0">
383 <tr valign="top"><td>
384 <h3 class="epydoc"><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,
385 <span class="sig-arg">value</span>)</span>
386 </h3>
387 </td><td align="right" valign="top"
388 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.validate">source&nbsp;code</a></span>&nbsp;
389 </td>
390 </tr></table>
391
392 <pre class="literalblock">
393Assert that provided value is compatible with this property.
394
395Args:
396 value: Value to validate against this Property.
397
398Returns:
399 A valid value, either the input unchanged or adapted to the
400 required type.
401
402Raises:
403 BadValueError if the value is not appropriate for this
404 property in any way.
405
406</pre>
407 <dl class="fields">
408 <dt>Overrides:
409 google.appengine.ext.db.Property.validate
410 <dd><em class="note">(inherited documentation)</em></dd>
411 </dt>
412 </dl>
413</td></tr></table>
414</div>
415<a name="empty"></a>
416<div>
417<table class="details" border="1" cellpadding="3"
418 cellspacing="0" width="100%" bgcolor="white">
419<tr><td>
420 <table width="100%" cellpadding="0" cellspacing="0" border="0">
421 <tr valign="top"><td>
422 <h3 class="epydoc"><span class="sig"><span class="sig-name">empty</span>(<span class="sig-arg">self</span>,
423 <span class="sig-arg">value</span>)</span>
424 </h3>
425 </td><td align="right" valign="top"
426 ><span class="codelink"><a href="oauth2client.appengine-pysrc.html#FlowProperty.empty">source&nbsp;code</a></span>&nbsp;
427 </td>
428 </tr></table>
429
430 <pre class="literalblock">
431Determine if value is empty in the context of this property.
432
433For most kinds, this is equivalent to &quot;not value&quot;, but for kinds like
434bool, the test is more subtle, so subclasses can override this method
435if necessary.
436
437Args:
438 value: Value to validate against this Property.
439
440Returns:
441 True if this value is considered empty in the context of this Property
442 type, otherwise False.
443
444</pre>
445 <dl class="fields">
446 <dt>Overrides:
447 google.appengine.ext.db.Property.empty
448 <dd><em class="note">(inherited documentation)</em></dd>
449 </dt>
450 </dl>
451</td></tr></table>
452</div>
453<br />
454<!-- ==================== NAVIGATION BAR ==================== -->
455<table class="navbar" border="0" width="100%" cellpadding="0"
456 bgcolor="#a0c0ff" cellspacing="0">
457 <tr valign="middle">
458
459 <!-- Tree link -->
460 <th>&nbsp;&nbsp;&nbsp;<a
461 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
462
463 <!-- Index link -->
464 <th>&nbsp;&nbsp;&nbsp;<a
465 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
466
467 <!-- Help link -->
468 <th>&nbsp;&nbsp;&nbsp;<a
469 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
470
471 <th class="navbar" width="100%"></th>
472 </tr>
473</table>
474<table border="0" cellpadding="0" cellspacing="0" width="100%%">
475 <tr>
476 <td align="left" class="footer">
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]477 Generated by Epydoc 3.0.1 on Fri Jun 15 13:13:24 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]478 </td>
479 <td align="right" class="footer">
480 <a target="mainFrame" href="http://epydoc.sourceforge.net"
481 >http://epydoc.sourceforge.net</a>
482 </td>
483 </tr>
484</table>
485
486<script type="text/javascript">
487 <!--
488 // Private objects are initially displayed (because if
489 // javascript is turned off then we want them to be
490 // visible); but by default, we want to hide them. So hide
491 // them unless we have a cookie that says to show them.
492 checkCookie();
493 // -->
494</script>
495</body>
496</html>