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