Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / bf14cefd46694f592da422d1977d434d09e49f3f / . / docs / oauth2client.django_orm.html
blob: aa5ca50003eb2d66b32a054a32a123fd2b497992 [file] [log] [blame]
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module oauth2client.django_orm</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.django_orm</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/clean/oauth2client/django_orm.py">/usr/local/google/home/jcgregorio/projects/clean/oauth2client/django_orm.py</a></font></td></tr></table>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]12 <p><tt>OAuth&nbsp;2.0&nbsp;utilities&nbsp;for&nbsp;Django.<br>
13&nbsp;<br>
14Utilities&nbsp;for&nbsp;using&nbsp;OAuth&nbsp;2.0&nbsp;in&nbsp;conjunction&nbsp;with<br>
15the&nbsp;Django&nbsp;datastore.</tt></p>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18<tr bgcolor="#aa55cc">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
21
22<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="base64.html">base64</a><br>
24</td><td width="25%" valign=top><a href="django.db.models.html">django.db.models</a><br>
25</td><td width="25%" valign=top><a href="oauth2client.html">oauth2client</a><br>
26</td><td width="25%" valign=top><a href="pickle.html">pickle</a><br>
27</td></tr></table></td></tr></table><p>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]28<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
29<tr bgcolor="#ee77aa">
30<td colspan=3 valign=bottom>&nbsp;<br>
31<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
32
33<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
34<td width="100%"><dl>
35<dt><font face="helvetica, arial"><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
36</font></dt><dd>
37<dl>
38<dt><font face="helvetica, arial"><a href="oauth2client.django_orm.html#CredentialsField">CredentialsField</a>
39</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.django_orm.html#FlowField">FlowField</a>
40</font></dt></dl>
41</dd>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]42<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
43</font></dt><dd>
44<dl>
45<dt><font face="helvetica, arial"><a href="oauth2client.django_orm.html#Storage">Storage</a>
46</font></dt></dl>
47</dd>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]48</dl>
49 <p>
50<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
51<tr bgcolor="#ffc8d8">
52<td colspan=3 valign=bottom>&nbsp;<br>
53<font color="#000000" face="helvetica, arial"><a name="CredentialsField">class <strong>CredentialsField</strong></a>(<a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>)</font></td></tr>
54
55<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
56<td width="100%"><dl><dt>Method resolution order:</dt>
57<dd><a href="oauth2client.django_orm.html#CredentialsField">CredentialsField</a></dd>
58<dd><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a></dd>
59<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
60</dl>
61<hr>
62Methods defined here:<br>
63<dl><dt><a name="CredentialsField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
64
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]65<dl><dt><a name="CredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a>(self, value, connection, prepared<font color="#909090">=False</font>)</dt></dl>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]66
67<dl><dt><a name="CredentialsField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]68
69<dl><dt><a name="CredentialsField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
70
71<hr>
72Data and other attributes defined here:<br>
73<dl><dt><strong>__metaclass__</strong> = &lt;class 'django.db.models.fields.subclassing.SubfieldBase'&gt;<dd><tt>A&nbsp;metaclass&nbsp;for&nbsp;custom&nbsp;<a href="django.db.models.fields.html#Field">Field</a>&nbsp;subclasses.&nbsp;This&nbsp;ensures&nbsp;the&nbsp;model's&nbsp;attribute<br>
74has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
75
76<hr>
77Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
78<dl><dt><a name="CredentialsField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
79
80<dl><dt><a name="CredentialsField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
81
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]82<dl><dt><a name="CredentialsField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=&lt;class django.db.models.fields.NOT_PROVIDED&gt;</font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>, validators<font color="#909090">=[]</font>, error_messages<font color="#909090">=None</font>)</dt></dl>
83
84<dl><dt><a name="CredentialsField-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Displays&nbsp;the&nbsp;module,&nbsp;class&nbsp;and&nbsp;name&nbsp;of&nbsp;the&nbsp;field.</tt></dd></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]85
86<dl><dt><a name="CredentialsField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
87
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]88<dl><dt><a name="CredentialsField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert&nbsp;the&nbsp;value's&nbsp;type&nbsp;and&nbsp;run&nbsp;validation.&nbsp;Validation&nbsp;errors<br>
89from&nbsp;to_python&nbsp;and&nbsp;validate&nbsp;are&nbsp;propagated.&nbsp;The&nbsp;correct&nbsp;value&nbsp;is<br>
90returned&nbsp;if&nbsp;no&nbsp;error&nbsp;is&nbsp;raised.</tt></dd></dl>
91
92<dl><dt><a name="CredentialsField-db_type"><strong>db_type</strong></a>(self, connection)</dt><dd><tt>Returns&nbsp;the&nbsp;database&nbsp;column&nbsp;data&nbsp;type&nbsp;for&nbsp;this&nbsp;field,&nbsp;for&nbsp;the&nbsp;provided<br>
93connection.</tt></dd></dl>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]94
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]95<dl><dt><a name="CredentialsField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=&lt;class 'django.forms.fields.CharField'&gt;</font>, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;django.forms.<a href="django.db.models.fields.html#Field">Field</a>&nbsp;instance&nbsp;for&nbsp;this&nbsp;database&nbsp;<a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
96
97<dl><dt><a name="CredentialsField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
98
99<dl><dt><a name="CredentialsField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
100
101<dl><dt><a name="CredentialsField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
102
103<dl><dt><a name="CredentialsField-get_choices"><strong>get_choices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choices&nbsp;included,&nbsp;for&nbsp;use<br>
104as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
105
106<dl><dt><a name="CredentialsField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
107
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]108<dl><dt><a name="CredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value, connection, prepared<font color="#909090">=False</font>)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;database&nbsp;lookup.</tt></dd></dl>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]109
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]110<dl><dt><a name="CredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value, connection)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;saving&nbsp;into&nbsp;a&nbsp;database.</tt></dd></dl>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]111
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]112<dl><dt><a name="CredentialsField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;default&nbsp;value&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
113
114<dl><dt><a name="CredentialsField-get_flatchoices"><strong>get_flatchoices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns&nbsp;flattened&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choice&nbsp;included.</tt></dd></dl>
115
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]116<dl><dt><a name="CredentialsField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;lookup&nbsp;checks&nbsp;and&nbsp;conversions</tt></dd></dl>
117
118<dl><dt><a name="CredentialsField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;value&nbsp;checks&nbsp;and&nbsp;conversions.</tt></dd></dl>
119
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]120<dl><dt><a name="CredentialsField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
121
122<dl><dt><a name="CredentialsField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;boolean&nbsp;of&nbsp;whether&nbsp;this&nbsp;field&nbsp;has&nbsp;a&nbsp;default&nbsp;value.</tt></dd></dl>
123
124<dl><dt><a name="CredentialsField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;just&nbsp;before&nbsp;saving.</tt></dd></dl>
125
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]126<dl><dt><a name="CredentialsField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
127
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]128<dl><dt><a name="CredentialsField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
129
130<dl><dt><a name="CredentialsField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
131
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]132<dl><dt><a name="CredentialsField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates&nbsp;value&nbsp;and&nbsp;throws&nbsp;ValidationError.&nbsp;Subclasses&nbsp;should&nbsp;override<br>
133this&nbsp;to&nbsp;provide&nbsp;validation&nbsp;logic.</tt></dd></dl>
134
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]135<dl><dt><a name="CredentialsField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;the&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;in&nbsp;the&nbsp;given&nbsp;model&nbsp;instance.</tt></dd></dl>
136
137<dl><dt><a name="CredentialsField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;from&nbsp;the&nbsp;passed&nbsp;obj.<br>
138This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
139
140<hr>
141Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
142<dl><dt><strong>__dict__</strong></dt>
143<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
144</dl>
145<dl><dt><strong>__weakref__</strong></dt>
146<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
147</dl>
148<dl><dt><strong>choices</strong></dt>
149</dl>
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]150<dl><dt><strong>description</strong></dt>
151</dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]152<dl><dt><strong>flatchoices</strong></dt>
153<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
154</dl>
155<dl><dt><strong>unique</strong></dt>
156</dl>
157<hr>
158Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
159<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
160
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]161<dl><dt><strong>creation_counter</strong> = 2</dl>
162
163<dl><dt><strong>default_error_messages</strong> = {'blank': &lt;django.utils.functional.__proxy__ object&gt;, 'invalid_choice': &lt;django.utils.functional.__proxy__ object&gt;, 'null': &lt;django.utils.functional.__proxy__ object&gt;, 'unique': &lt;django.utils.functional.__proxy__ object&gt;}</dl>
164
165<dl><dt><strong>default_validators</strong> = []</dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]166
167<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
168
169</td></tr></table> <p>
170<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
171<tr bgcolor="#ffc8d8">
172<td colspan=3 valign=bottom>&nbsp;<br>
173<font color="#000000" face="helvetica, arial"><a name="FlowField">class <strong>FlowField</strong></a>(<a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>)</font></td></tr>
174
175<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
176<td width="100%"><dl><dt>Method resolution order:</dt>
177<dd><a href="oauth2client.django_orm.html#FlowField">FlowField</a></dd>
178<dd><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a></dd>
179<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
180</dl>
181<hr>
182Methods defined here:<br>
183<dl><dt><a name="FlowField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
184
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]185<dl><dt><a name="FlowField-get_db_prep_value"><strong>get_db_prep_value</strong></a>(self, value, connection, prepared<font color="#909090">=False</font>)</dt></dl>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]186
187<dl><dt><a name="FlowField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]188
189<dl><dt><a name="FlowField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
190
191<hr>
192Data and other attributes defined here:<br>
193<dl><dt><strong>__metaclass__</strong> = &lt;class 'django.db.models.fields.subclassing.SubfieldBase'&gt;<dd><tt>A&nbsp;metaclass&nbsp;for&nbsp;custom&nbsp;<a href="django.db.models.fields.html#Field">Field</a>&nbsp;subclasses.&nbsp;This&nbsp;ensures&nbsp;the&nbsp;model's&nbsp;attribute<br>
194has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
195
196<hr>
197Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
198<dl><dt><a name="FlowField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
199
200<dl><dt><a name="FlowField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
201
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]202<dl><dt><a name="FlowField-__init__"><strong>__init__</strong></a>(self, verbose_name<font color="#909090">=None</font>, name<font color="#909090">=None</font>, primary_key<font color="#909090">=False</font>, max_length<font color="#909090">=None</font>, unique<font color="#909090">=False</font>, blank<font color="#909090">=False</font>, null<font color="#909090">=False</font>, db_index<font color="#909090">=False</font>, rel<font color="#909090">=None</font>, default<font color="#909090">=&lt;class django.db.models.fields.NOT_PROVIDED&gt;</font>, editable<font color="#909090">=True</font>, serialize<font color="#909090">=True</font>, unique_for_date<font color="#909090">=None</font>, unique_for_month<font color="#909090">=None</font>, unique_for_year<font color="#909090">=None</font>, choices<font color="#909090">=None</font>, help_text<font color="#909090">=''</font>, db_column<font color="#909090">=None</font>, db_tablespace<font color="#909090">=None</font>, auto_created<font color="#909090">=False</font>, validators<font color="#909090">=[]</font>, error_messages<font color="#909090">=None</font>)</dt></dl>
203
204<dl><dt><a name="FlowField-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Displays&nbsp;the&nbsp;module,&nbsp;class&nbsp;and&nbsp;name&nbsp;of&nbsp;the&nbsp;field.</tt></dd></dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]205
206<dl><dt><a name="FlowField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
207
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]208<dl><dt><a name="FlowField-clean"><strong>clean</strong></a>(self, value, model_instance)</dt><dd><tt>Convert&nbsp;the&nbsp;value's&nbsp;type&nbsp;and&nbsp;run&nbsp;validation.&nbsp;Validation&nbsp;errors<br>
209from&nbsp;to_python&nbsp;and&nbsp;validate&nbsp;are&nbsp;propagated.&nbsp;The&nbsp;correct&nbsp;value&nbsp;is<br>
210returned&nbsp;if&nbsp;no&nbsp;error&nbsp;is&nbsp;raised.</tt></dd></dl>
211
212<dl><dt><a name="FlowField-db_type"><strong>db_type</strong></a>(self, connection)</dt><dd><tt>Returns&nbsp;the&nbsp;database&nbsp;column&nbsp;data&nbsp;type&nbsp;for&nbsp;this&nbsp;field,&nbsp;for&nbsp;the&nbsp;provided<br>
213connection.</tt></dd></dl>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]214
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]215<dl><dt><a name="FlowField-formfield"><strong>formfield</strong></a>(self, form_class<font color="#909090">=&lt;class 'django.forms.fields.CharField'&gt;</font>, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;django.forms.<a href="django.db.models.fields.html#Field">Field</a>&nbsp;instance&nbsp;for&nbsp;this&nbsp;database&nbsp;<a href="django.db.models.fields.html#Field">Field</a>.</tt></dd></dl>
216
217<dl><dt><a name="FlowField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
218
219<dl><dt><a name="FlowField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
220
221<dl><dt><a name="FlowField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
222
223<dl><dt><a name="FlowField-get_choices"><strong>get_choices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choices&nbsp;included,&nbsp;for&nbsp;use<br>
224as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
225
226<dl><dt><a name="FlowField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
227
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]228<dl><dt><a name="FlowField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a>(self, lookup_type, value, connection, prepared<font color="#909090">=False</font>)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;database&nbsp;lookup.</tt></dd></dl>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]229
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]230<dl><dt><a name="FlowField-get_db_prep_save"><strong>get_db_prep_save</strong></a>(self, value, connection)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;prepared&nbsp;for&nbsp;saving&nbsp;into&nbsp;a&nbsp;database.</tt></dd></dl>
Joe Gregorio6121dd92012-04-13 07:50:04 -0400[diff] [blame]231
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]232<dl><dt><a name="FlowField-get_default"><strong>get_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;default&nbsp;value&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
233
234<dl><dt><a name="FlowField-get_flatchoices"><strong>get_flatchoices</strong></a>(self, include_blank<font color="#909090">=True</font>, blank_choice<font color="#909090">=[('', '---------')]</font>)</dt><dd><tt>Returns&nbsp;flattened&nbsp;choices&nbsp;with&nbsp;a&nbsp;default&nbsp;blank&nbsp;choice&nbsp;included.</tt></dd></dl>
235
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]236<dl><dt><a name="FlowField-get_prep_lookup"><strong>get_prep_lookup</strong></a>(self, lookup_type, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;lookup&nbsp;checks&nbsp;and&nbsp;conversions</tt></dd></dl>
237
238<dl><dt><a name="FlowField-get_prep_value"><strong>get_prep_value</strong></a>(self, value)</dt><dd><tt>Perform&nbsp;preliminary&nbsp;non-db&nbsp;specific&nbsp;value&nbsp;checks&nbsp;and&nbsp;conversions.</tt></dd></dl>
239
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]240<dl><dt><a name="FlowField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
241
242<dl><dt><a name="FlowField-has_default"><strong>has_default</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;boolean&nbsp;of&nbsp;whether&nbsp;this&nbsp;field&nbsp;has&nbsp;a&nbsp;default&nbsp;value.</tt></dd></dl>
243
244<dl><dt><a name="FlowField-pre_save"><strong>pre_save</strong></a>(self, model_instance, add)</dt><dd><tt>Returns&nbsp;field's&nbsp;value&nbsp;just&nbsp;before&nbsp;saving.</tt></dd></dl>
245
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]246<dl><dt><a name="FlowField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
247
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]248<dl><dt><a name="FlowField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
249
250<dl><dt><a name="FlowField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
251
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]252<dl><dt><a name="FlowField-validate"><strong>validate</strong></a>(self, value, model_instance)</dt><dd><tt>Validates&nbsp;value&nbsp;and&nbsp;throws&nbsp;ValidationError.&nbsp;Subclasses&nbsp;should&nbsp;override<br>
253this&nbsp;to&nbsp;provide&nbsp;validation&nbsp;logic.</tt></dd></dl>
254
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]255<dl><dt><a name="FlowField-value_from_object"><strong>value_from_object</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;the&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;in&nbsp;the&nbsp;given&nbsp;model&nbsp;instance.</tt></dd></dl>
256
257<dl><dt><a name="FlowField-value_to_string"><strong>value_to_string</strong></a>(self, obj)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;value&nbsp;of&nbsp;this&nbsp;field&nbsp;from&nbsp;the&nbsp;passed&nbsp;obj.<br>
258This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
259
260<hr>
261Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
262<dl><dt><strong>__dict__</strong></dt>
263<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
264</dl>
265<dl><dt><strong>__weakref__</strong></dt>
266<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
267</dl>
268<dl><dt><strong>choices</strong></dt>
269</dl>
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]270<dl><dt><strong>description</strong></dt>
271</dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]272<dl><dt><strong>flatchoices</strong></dt>
273<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
274</dl>
275<dl><dt><strong>unique</strong></dt>
276</dl>
277<hr>
278Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
279<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
280
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame^]281<dl><dt><strong>creation_counter</strong> = 2</dl>
282
283<dl><dt><strong>default_error_messages</strong> = {'blank': &lt;django.utils.functional.__proxy__ object&gt;, 'invalid_choice': &lt;django.utils.functional.__proxy__ object&gt;, 'null': &lt;django.utils.functional.__proxy__ object&gt;, 'unique': &lt;django.utils.functional.__proxy__ object&gt;}</dl>
284
285<dl><dt><strong>default_validators</strong> = []</dl>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]286
287<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
288
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]289</td></tr></table> <p>
290<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
291<tr bgcolor="#ffc8d8">
292<td colspan=3 valign=bottom>&nbsp;<br>
293<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>)</font></td></tr>
294
295<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
296<td colspan=2><tt>Store&nbsp;and&nbsp;retrieve&nbsp;a&nbsp;single&nbsp;credential&nbsp;to&nbsp;and&nbsp;from<br>
297the&nbsp;datastore.<br>
298&nbsp;<br>
299This&nbsp;<a href="#Storage">Storage</a>&nbsp;helper&nbsp;presumes&nbsp;the&nbsp;Credentials<br>
300have&nbsp;been&nbsp;stored&nbsp;as&nbsp;a&nbsp;CredenialsField<br>
301on&nbsp;a&nbsp;db&nbsp;model&nbsp;class.<br>&nbsp;</tt></td></tr>
302<tr><td>&nbsp;</td>
303<td width="100%"><dl><dt>Method resolution order:</dt>
304<dd><a href="oauth2client.django_orm.html#Storage">Storage</a></dd>
305<dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd>
306<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
307</dl>
308<hr>
309Methods defined here:<br>
310<dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, model_class, key_name, key_value, property_name)</dt><dd><tt>Constructor&nbsp;for&nbsp;<a href="#Storage">Storage</a>.<br>
311&nbsp;<br>
312Args:<br>
313&nbsp;&nbsp;model:&nbsp;db.Model,&nbsp;model&nbsp;class<br>
314&nbsp;&nbsp;key_name:&nbsp;string,&nbsp;key&nbsp;name&nbsp;for&nbsp;the&nbsp;entity&nbsp;that&nbsp;has&nbsp;the&nbsp;credentials<br>
315&nbsp;&nbsp;key_value:&nbsp;string,&nbsp;key&nbsp;value&nbsp;for&nbsp;the&nbsp;entity&nbsp;that&nbsp;has&nbsp;the&nbsp;credentials<br>
316&nbsp;&nbsp;property_name:&nbsp;string,&nbsp;name&nbsp;of&nbsp;the&nbsp;property&nbsp;that&nbsp;is&nbsp;an&nbsp;CredentialsProperty</tt></dd></dl>
317
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]318<dl><dt><a name="Storage-locked_delete"><strong>locked_delete</strong></a>(self)</dt><dd><tt>Delete&nbsp;Credentials&nbsp;from&nbsp;the&nbsp;datastore.</tt></dd></dl>
319
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]320<dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;datastore.<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]321&nbsp;<br>
322Returns:<br>
323&nbsp;&nbsp;oauth2client.Credentials</tt></dd></dl>
324
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]325<dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;Credentials&nbsp;to&nbsp;the&nbsp;datastore.<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]326&nbsp;<br>
327Args:<br>
328&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
329
330<hr>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]331Methods inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
332<dl><dt><a name="Storage-acquire_lock"><strong>acquire_lock</strong></a>(self)</dt><dd><tt>Acquires&nbsp;any&nbsp;lock&nbsp;necessary&nbsp;to&nbsp;access&nbsp;this&nbsp;<a href="#Storage">Storage</a>.<br>
333&nbsp;<br>
334This&nbsp;lock&nbsp;is&nbsp;not&nbsp;reentrant.</tt></dd></dl>
335
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]336<dl><dt><a name="Storage-delete"><strong>delete</strong></a>(self)</dt><dd><tt>Delete&nbsp;credential.<br>
337&nbsp;<br>
338Frees&nbsp;any&nbsp;resources&nbsp;associated&nbsp;with&nbsp;storing&nbsp;the&nbsp;credential.<br>
339The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;*not*&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
340&nbsp;<br>
341Returns:<br>
342&nbsp;&nbsp;None</tt></dd></dl>
343
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]344<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;credential.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]345&nbsp;<br>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]346The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;*not*&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]347&nbsp;<br>
348Returns:<br>
349&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
350
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]351<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;credential.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame]352&nbsp;<br>
353The&nbsp;<a href="#Storage">Storage</a>&nbsp;lock&nbsp;must&nbsp;be&nbsp;held&nbsp;when&nbsp;this&nbsp;is&nbsp;called.<br>
354&nbsp;<br>
355Args:<br>
356&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
357
358<dl><dt><a name="Storage-release_lock"><strong>release_lock</strong></a>(self)</dt><dd><tt>Release&nbsp;the&nbsp;<a href="#Storage">Storage</a>&nbsp;lock.<br>
359&nbsp;<br>
360Trying&nbsp;to&nbsp;release&nbsp;a&nbsp;lock&nbsp;that&nbsp;isn't&nbsp;held&nbsp;will&nbsp;result&nbsp;in&nbsp;a<br>
361RuntimeError.</tt></dd></dl>
362
363<hr>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]364Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
365<dl><dt><strong>__dict__</strong></dt>
366<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
367</dl>
368<dl><dt><strong>__weakref__</strong></dt>
369<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
370</dl>
371</td></tr></table></td></tr></table><p>
372<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
373<tr bgcolor="#55aa55">
374<td colspan=3 valign=bottom>&nbsp;<br>
375<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
376
377<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
378<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
379<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
380<tr bgcolor="#7799ee">
381<td colspan=3 valign=bottom>&nbsp;<br>
382<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
383
384<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
385<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
Joe Gregorioded54c52011-02-11 20:36:10 -0500[diff] [blame]386</body></html>