Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b9a80929f88cb2a276010a1f1f9500e54cadace9 / . / docs / apiclient.ext.django_orm.html
blob: ef8c9654b2e0c3ae32ce44dc8f5fef4ce37a7d34 [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.ext.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="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.ext.html"><font color="#ffffff">ext</font></a>.django_orm</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/ext/django_orm.py">/home/jcgregorio/projects/apiclient-release/apiclient/ext/django_orm.py</a></font></td></tr></table>
12 <p><tt>#&nbsp;Copyright&nbsp;(C)&nbsp;2010&nbsp;Google&nbsp;Inc.<br>
13#<br>
14#&nbsp;Licensed&nbsp;under&nbsp;the&nbsp;Apache&nbsp;License,&nbsp;Version&nbsp;2.0&nbsp;(the&nbsp;"License");<br>
15#&nbsp;you&nbsp;may&nbsp;not&nbsp;use&nbsp;this&nbsp;file&nbsp;except&nbsp;in&nbsp;compliance&nbsp;with&nbsp;the&nbsp;License.<br>
16#&nbsp;You&nbsp;may&nbsp;obtain&nbsp;a&nbsp;copy&nbsp;of&nbsp;the&nbsp;License&nbsp;at<br>
17#<br>
18#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
19#<br>
20#&nbsp;Unless&nbsp;required&nbsp;by&nbsp;applicable&nbsp;law&nbsp;or&nbsp;agreed&nbsp;to&nbsp;in&nbsp;writing,&nbsp;software<br>
21#&nbsp;distributed&nbsp;under&nbsp;the&nbsp;License&nbsp;is&nbsp;distributed&nbsp;on&nbsp;an&nbsp;"AS&nbsp;IS"&nbsp;BASIS,<br>
22#&nbsp;WITHOUT&nbsp;WARRANTIES&nbsp;OR&nbsp;CONDITIONS&nbsp;OF&nbsp;ANY&nbsp;KIND,&nbsp;either&nbsp;express&nbsp;or&nbsp;implied.<br>
23#&nbsp;See&nbsp;the&nbsp;License&nbsp;for&nbsp;the&nbsp;specific&nbsp;language&nbsp;governing&nbsp;permissions&nbsp;and<br>
24#&nbsp;limitations&nbsp;under&nbsp;the&nbsp;License.</tt></p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]25<p>
26<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
27<tr bgcolor="#aa55cc">
28<td colspan=3 valign=bottom>&nbsp;<br>
29<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
30
31<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio93841702011-03-02 16:12:05 -0800[diff] [blame]32<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="apiclient.html">apiclient</a><br>
33</td><td width="25%" valign=top><a href="base64.html">base64</a><br>
34</td><td width="25%" valign=top><a href="django.db.models.html">django.db.models</a><br>
35</td><td width="25%" valign=top><a href="pickle.html">pickle</a><br>
36</td></tr></table></td></tr></table><p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]37<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
38<tr bgcolor="#ee77aa">
39<td colspan=3 valign=bottom>&nbsp;<br>
40<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
41
42<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
43<td width="100%"><dl>
44<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>)
45</font></dt><dd>
46<dl>
47<dt><font face="helvetica, arial"><a href="apiclient.ext.django_orm.html#FlowThreeLeggedField">FlowThreeLeggedField</a>
48</font></dt><dt><font face="helvetica, arial"><a href="apiclient.ext.django_orm.html#OAuthCredentialsField">OAuthCredentialsField</a>
49</font></dt></dl>
50</dd>
51</dl>
52 <p>
53<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
54<tr bgcolor="#ffc8d8">
55<td colspan=3 valign=bottom>&nbsp;<br>
56<font color="#000000" face="helvetica, arial"><a name="FlowThreeLeggedField">class <strong>FlowThreeLeggedField</strong></a>(<a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>)</font></td></tr>
57
58<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
59<td width="100%"><dl><dt>Method resolution order:</dt>
60<dd><a href="apiclient.ext.django_orm.html#FlowThreeLeggedField">FlowThreeLeggedField</a></dd>
61<dd><a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a></dd>
62<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
63</dl>
64<hr>
65Methods defined here:<br>
66<dl><dt><a name="FlowThreeLeggedField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
67
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]68<dl><dt><a name="FlowThreeLeggedField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]69
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]70<dl><dt><a name="FlowThreeLeggedField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
71
72<dl><dt><a name="FlowThreeLeggedField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
73
74<dl><dt><a name="FlowThreeLeggedField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]75
76<dl><dt><a name="FlowThreeLeggedField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
77
78<hr>
79Data and other attributes defined here:<br>
80<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>
81has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
82
83<hr>
84Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
85<dl><dt><a name="FlowThreeLeggedField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
86
87<dl><dt><a name="FlowThreeLeggedField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
88
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]89<dl><dt><a name="FlowThreeLeggedField-__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>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]90
91<dl><dt><a name="FlowThreeLeggedField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
92
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]93<dl><dt><a name="FlowThreeLeggedField-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&nbsp;from&nbsp;to_python<br>
94and&nbsp;validate&nbsp;are&nbsp;propagated.&nbsp;The&nbsp;correct&nbsp;value&nbsp;is&nbsp;returned&nbsp;if&nbsp;no&nbsp;error&nbsp;is<br>
95raised.</tt></dd></dl>
96
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]97<dl><dt><a name="FlowThreeLeggedField-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>
98
99<dl><dt><a name="FlowThreeLeggedField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
100
101<dl><dt><a name="FlowThreeLeggedField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
102
103<dl><dt><a name="FlowThreeLeggedField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
104
105<dl><dt><a name="FlowThreeLeggedField-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>
106as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
107
108<dl><dt><a name="FlowThreeLeggedField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
109
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]110<dl><dt><a name="FlowThreeLeggedField-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>
111
112<dl><dt><a name="FlowThreeLeggedField-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>
113
114<dl><dt><a name="FlowThreeLeggedField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
115
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]116<dl><dt><a name="FlowThreeLeggedField-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="FlowThreeLeggedField-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 Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]120<dl><dt><a name="FlowThreeLeggedField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
121
122<dl><dt><a name="FlowThreeLeggedField-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="FlowThreeLeggedField-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 Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]126<dl><dt><a name="FlowThreeLeggedField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
127
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]128<dl><dt><a name="FlowThreeLeggedField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
129
130<dl><dt><a name="FlowThreeLeggedField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
131
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]132<dl><dt><a name="FlowThreeLeggedField-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 Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]135<dl><dt><a name="FlowThreeLeggedField-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="FlowThreeLeggedField-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 Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]150<dl><dt><strong>description</strong></dt>
151</dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -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
161<dl><dt><strong>creation_counter</strong> = 0</dl>
162
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]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;}</dl>
164
165<dl><dt><strong>default_validators</strong> = []</dl>
166
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]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="OAuthCredentialsField">class <strong>OAuthCredentialsField</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="apiclient.ext.django_orm.html#OAuthCredentialsField">OAuthCredentialsField</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="OAuthCredentialsField-contribute_to_class"><strong>contribute_to_class</strong></a>(self, cls, name)</dt></dl>
184
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]185<dl><dt><a name="OAuthCredentialsField-db_type"><strong>db_type</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]186
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]187<dl><dt><a name="OAuthCredentialsField-get_db_prep_lookup"><strong>get_db_prep_lookup</strong></a> = inner(*args, **kwargs)</dt></dl>
188
189<dl><dt><a name="OAuthCredentialsField-get_db_prep_save"><strong>get_db_prep_save</strong></a> = inner(*args, **kwargs)</dt></dl>
190
191<dl><dt><a name="OAuthCredentialsField-get_db_prep_value"><strong>get_db_prep_value</strong></a> = inner(*args, **kwargs)</dt></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]192
193<dl><dt><a name="OAuthCredentialsField-to_python"><strong>to_python</strong></a>(self, value)</dt></dl>
194
195<hr>
196Data and other attributes defined here:<br>
197<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>
198has&nbsp;the&nbsp;descriptor&nbsp;protocol&nbsp;attached&nbsp;to&nbsp;it.</tt></dl>
199
200<hr>
201Methods inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
202<dl><dt><a name="OAuthCredentialsField-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
203
204<dl><dt><a name="OAuthCredentialsField-__deepcopy__"><strong>__deepcopy__</strong></a>(self, memodict)</dt></dl>
205
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]206<dl><dt><a name="OAuthCredentialsField-__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>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]207
208<dl><dt><a name="OAuthCredentialsField-bind"><strong>bind</strong></a>(self, fieldmapping, original, bound_field_class)</dt></dl>
209
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]210<dl><dt><a name="OAuthCredentialsField-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&nbsp;from&nbsp;to_python<br>
211and&nbsp;validate&nbsp;are&nbsp;propagated.&nbsp;The&nbsp;correct&nbsp;value&nbsp;is&nbsp;returned&nbsp;if&nbsp;no&nbsp;error&nbsp;is<br>
212raised.</tt></dd></dl>
213
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]214<dl><dt><a name="OAuthCredentialsField-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>
215
216<dl><dt><a name="OAuthCredentialsField-get_attname"><strong>get_attname</strong></a>(self)</dt></dl>
217
218<dl><dt><a name="OAuthCredentialsField-get_attname_column"><strong>get_attname_column</strong></a>(self)</dt></dl>
219
220<dl><dt><a name="OAuthCredentialsField-get_cache_name"><strong>get_cache_name</strong></a>(self)</dt></dl>
221
222<dl><dt><a name="OAuthCredentialsField-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>
223as&nbsp;SelectField&nbsp;choices&nbsp;for&nbsp;this&nbsp;field.</tt></dd></dl>
224
225<dl><dt><a name="OAuthCredentialsField-get_choices_default"><strong>get_choices_default</strong></a>(self)</dt></dl>
226
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]227<dl><dt><a name="OAuthCredentialsField-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>
228
229<dl><dt><a name="OAuthCredentialsField-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>
230
231<dl><dt><a name="OAuthCredentialsField-get_internal_type"><strong>get_internal_type</strong></a>(self)</dt></dl>
232
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]233<dl><dt><a name="OAuthCredentialsField-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>
234
235<dl><dt><a name="OAuthCredentialsField-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>
236
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]237<dl><dt><a name="OAuthCredentialsField-get_validator_unique_lookup_type"><strong>get_validator_unique_lookup_type</strong></a>(self)</dt></dl>
238
239<dl><dt><a name="OAuthCredentialsField-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>
240
241<dl><dt><a name="OAuthCredentialsField-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>
242
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]243<dl><dt><a name="OAuthCredentialsField-run_validators"><strong>run_validators</strong></a>(self, value)</dt></dl>
244
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]245<dl><dt><a name="OAuthCredentialsField-save_form_data"><strong>save_form_data</strong></a>(self, instance, data)</dt></dl>
246
247<dl><dt><a name="OAuthCredentialsField-set_attributes_from_name"><strong>set_attributes_from_name</strong></a>(self, name)</dt></dl>
248
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]249<dl><dt><a name="OAuthCredentialsField-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>
250this&nbsp;to&nbsp;provide&nbsp;validation&nbsp;logic.</tt></dd></dl>
251
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]252<dl><dt><a name="OAuthCredentialsField-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>
253
254<dl><dt><a name="OAuthCredentialsField-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>
255This&nbsp;is&nbsp;used&nbsp;by&nbsp;the&nbsp;serialization&nbsp;framework.</tt></dd></dl>
256
257<hr>
258Data descriptors inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
259<dl><dt><strong>__dict__</strong></dt>
260<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
261</dl>
262<dl><dt><strong>__weakref__</strong></dt>
263<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
264</dl>
265<dl><dt><strong>choices</strong></dt>
266</dl>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]267<dl><dt><strong>description</strong></dt>
268</dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]269<dl><dt><strong>flatchoices</strong></dt>
270<dd><tt>Flattened&nbsp;version&nbsp;of&nbsp;choices&nbsp;tuple.</tt></dd>
271</dl>
272<dl><dt><strong>unique</strong></dt>
273</dl>
274<hr>
275Data and other attributes inherited from <a href="django.db.models.fields.html#Field">django.db.models.fields.Field</a>:<br>
276<dl><dt><strong>auto_creation_counter</strong> = -1</dl>
277
278<dl><dt><strong>creation_counter</strong> = 0</dl>
279
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]280<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;}</dl>
281
282<dl><dt><strong>default_validators</strong> = []</dl>
283
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]284<dl><dt><strong>empty_strings_allowed</strong> = True</dl>
285
286</td></tr></table></td></tr></table>
287</body></html>