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