515 lines
19 KiB
HTML
515 lines
19 KiB
HTML
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>oauth2client.django_orm.FlowField</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="oauth2client-module.html">Package oauth2client</a> ::
|
|
<a href="oauth2client.django_orm-module.html">Module django_orm</a> ::
|
|
Class FlowField
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
|
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="oauth2client.django_orm.FlowField-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class FlowField</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField">source code</a></span></p>
|
|
<center>
|
|
<center> <map id="class_hierarchy_for_flowfield" name="class_hierarchy_for_flowfield">
|
|
<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field" alt="" coords="5,5,195,32"/>
|
|
<area shape="rect" href="oauth2client.django_orm.FlowField-class.html" title="FlowField" alt="" coords="63,61,137,88"/>
|
|
</map>
|
|
<img src="class_hierarchy_for_flowfield.gif" alt='' usemap="#class_hierarchy_for_flowfield" ismap="ismap" class="graph-without-title" />
|
|
</center>
|
|
</center>
|
|
<hr />
|
|
<!-- ==================== NESTED CLASSES ==================== -->
|
|
<a name="section-NestedClasses"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Nested Classes</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-NestedClasses"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<a href="django.db.models.fields.subclassing.SubfieldBase-class.html" class="summary-name">__metaclass__</a><br />
|
|
A metaclass for custom Field subclasses.
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Instance Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-InstanceMethods"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.django_orm.FlowField-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">*args</span>,
|
|
<span class="summary-sig-arg">**kwargs</span>)</span><br />
|
|
x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.__init__">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.django_orm.FlowField-class.html#get_internal_type" class="summary-sig-name">get_internal_type</a>(<span class="summary-sig-arg">self</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.get_internal_type">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.django_orm.FlowField-class.html#to_python" class="summary-sig-name">to_python</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">value</span>)</span><br />
|
|
Converts the input value into the expected Python data type, raising
|
|
django.core.exceptions.ValidationError if the data can't be converted.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.to_python">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.django_orm.FlowField-class.html#get_db_prep_value" class="summary-sig-name">get_db_prep_value</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">value</span>,
|
|
<span class="summary-sig-arg">connection</span>,
|
|
<span class="summary-sig-arg">prepared</span>=<span class="summary-sig-default">False</span>)</span><br />
|
|
Returns field's value prepared for interacting with the database
|
|
backend.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.get_db_prep_value">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="oauth2client.django_orm.FlowField-class.html#contribute_to_class" class="summary-sig-name">contribute_to_class</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">cls</span>,
|
|
<span class="summary-sig-arg">name</span>)</span></td>
|
|
<td align="right" valign="top">
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>django.db.models.fields.Field</code></b>:
|
|
<code>__cmp__</code>,
|
|
<code>__deepcopy__</code>,
|
|
<code>__repr__</code>,
|
|
<code>bind</code>,
|
|
<code>clean</code>,
|
|
<code>db_type</code>,
|
|
<code>formfield</code>,
|
|
<code>get_attname</code>,
|
|
<code>get_attname_column</code>,
|
|
<code>get_cache_name</code>,
|
|
<code>get_choices</code>,
|
|
<code>get_choices_default</code>,
|
|
<code>get_db_prep_lookup</code>,
|
|
<code>get_db_prep_save</code>,
|
|
<code>get_default</code>,
|
|
<code>get_flatchoices</code>,
|
|
<code>get_prep_lookup</code>,
|
|
<code>get_prep_value</code>,
|
|
<code>get_validator_unique_lookup_type</code>,
|
|
<code>has_default</code>,
|
|
<code>pre_save</code>,
|
|
<code>run_validators</code>,
|
|
<code>save_form_data</code>,
|
|
<code>set_attributes_from_name</code>,
|
|
<code>validate</code>,
|
|
<code>value_from_object</code>,
|
|
<code>value_to_string</code>
|
|
</p>
|
|
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>django.db.models.fields.Field</code></b> (private):
|
|
<code>_description</code>,
|
|
<code>_get_choices</code>,
|
|
<code>_get_flatchoices</code>,
|
|
<code>_get_val_from_obj</code>
|
|
</p></div>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__delattr__</code>,
|
|
<code>__format__</code>,
|
|
<code>__getattribute__</code>,
|
|
<code>__hash__</code>,
|
|
<code>__new__</code>,
|
|
<code>__reduce__</code>,
|
|
<code>__reduce_ex__</code>,
|
|
<code>__setattr__</code>,
|
|
<code>__sizeof__</code>,
|
|
<code>__str__</code>,
|
|
<code>__subclasshook__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS VARIABLES ==================== -->
|
|
<a name="section-ClassVariables"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Class Variables</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-ClassVariables"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>django.db.models.fields.Field</code></b>:
|
|
<code>auto_creation_counter</code>,
|
|
<code>creation_counter</code>,
|
|
<code>default_error_messages</code>,
|
|
<code>default_validators</code>,
|
|
<code>empty_strings_allowed</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== PROPERTIES ==================== -->
|
|
<a name="section-Properties"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Properties</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-Properties"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2" class="summary">
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>django.db.models.fields.Field</code></b>:
|
|
<code>choices</code>,
|
|
<code>description</code>,
|
|
<code>flatchoices</code>,
|
|
<code>unique</code>
|
|
</p>
|
|
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
|
|
<code>__class__</code>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Method Details</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-MethodDetails"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="__init__"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">*args</span>,
|
|
<span class="sig-arg">**kwargs</span>)</span>
|
|
<br /><em class="fname">(Constructor)</em>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.__init__">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
object.__init__
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="get_internal_type"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_internal_type</span>(<span class="sig-arg">self</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.get_internal_type">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
django.db.models.fields.Field.get_internal_type
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="to_python"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">to_python</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">value</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.to_python">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
|
|
Converts the input value into the expected Python data type, raising
|
|
django.core.exceptions.ValidationError if the data can't be converted.
|
|
Returns the converted value. Subclasses should override this.
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
django.db.models.fields.Field.to_python
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="get_db_prep_value"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_db_prep_value</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">value</span>,
|
|
<span class="sig-arg">connection</span>,
|
|
<span class="sig-arg">prepared</span>=<span class="sig-default">False</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="oauth2client.django_orm-pysrc.html#FlowField.get_db_prep_value">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<pre class="literalblock">
|
|
Returns field's value prepared for interacting with the database
|
|
backend.
|
|
|
|
Used by the default implementations of ``get_db_prep_save``and
|
|
`get_db_prep_lookup```
|
|
|
|
</pre>
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
django.db.models.fields.Field.get_db_prep_value
|
|
<dd><em class="note">(inherited documentation)</em></dd>
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="contribute_to_class"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">contribute_to_class</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">cls</span>,
|
|
<span class="sig-arg">name</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
>
|
|
</td>
|
|
</tr></table>
|
|
|
|
|
|
<dl class="fields">
|
|
<dt>Overrides:
|
|
django.db.models.fields.Field.contribute_to_class
|
|
</dt>
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:30 2012
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|