Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(3)

Unified Diff: docs/epy/oauth2client.django_orm.FlowField-class.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)
Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: docs/epy/oauth2client.django_orm.FlowField-class.html
===================================================================
new file mode 100644
--- /dev/null
+++ b/docs/epy/oauth2client.django_orm.FlowField-class.html
@@ -0,0 +1,495 @@
+<?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>&nbsp;&nbsp;&nbsp;<a
+ href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Index link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Help link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;oauth2client</a> ::
+ <a href="oauth2client.django_orm-module.html">Module&nbsp;django_orm</a> ::
+ Class&nbsp;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&nbsp;private</a>]</span></td></tr>
+ <tr><td align="right"><span class="options"
+ >[<a href="frames.html" target="_top">frames</a
+ >]&nbsp;|&nbsp;<a href="oauth2client.django_orm.FlowField-class.html"
+ target="_top">no&nbsp;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&nbsp;code</a></span></p>
+<center>
+<center> <map id="uml_class_diagram_for_oauth2cl_32" name="uml_class_diagram_for_oauth2cl_32">
+<area shape="rect" href="django.db.models.fields.subclassing.SubfieldBase-class.html" title="A metaclass for custom Field subclasses." alt="" coords="1183,527,1529,545"/>
+<area shape="rect" href="oauth2client.django_orm.FlowField-class.html#get_internal_type" title="oauth2client.django_orm.FlowField.get_internal_type" alt="" coords="1183,548,1529,567"/>
+<area shape="rect" href="oauth2client.django_orm.FlowField-class.html#to_python" title="Converts the input value into the expected Python data type, raising django.core.exceptions.ValidationError if the data can&#39;t be converted." alt="" coords="1183,567,1529,585"/>
+<area shape="rect" href="oauth2client.django_orm.FlowField-class.html#get_db_prep_value" title="Returns field&#39;s value prepared for interacting with the database backend." alt="" coords="1183,585,1529,604"/>
+<area shape="rect" href="oauth2client.django_orm.FlowField-class.html#contribute_to_class" title="oauth2client.django_orm.FlowField.contribute_to_class" alt="" coords="1183,604,1529,623"/>
+<area shape="rect" href="oauth2client.django_orm.FlowField-class.html" title="oauth2client.django_orm.FlowField" alt="" coords="1181,509,1531,624"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.auto_creation_counter" alt="" coords="17,28,2695,47"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.choices" alt="" coords="17,47,2695,65"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.creation_counter" alt="" coords="17,65,2695,84"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.default_error_messages" alt="" coords="17,84,2695,103"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.default_validators" alt="" coords="17,103,2695,121"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.description" alt="" coords="17,121,2695,140"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.empty_strings_allowed" alt="" coords="17,140,2695,159"/>
+<area shape="rect" href="javascript:void(0);" title="Flattened version of choices tuple." alt="" coords="17,159,2695,177"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.unique" alt="" coords="17,177,2695,196"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.__cmp__" alt="" coords="17,199,2695,217"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.__deepcopy__" alt="" coords="17,217,2695,236"/>
+<area shape="rect" href="javascript:void(0);" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,236,2695,255"/>
+<area shape="rect" href="javascript:void(0);" title="Displays the module, class and name of the field." alt="" coords="17,255,2695,273"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.bind" alt="" coords="17,273,2695,292"/>
+<area shape="rect" href="javascript:void(0);" title="Convert the value&#39;s type and run validation." alt="" coords="17,292,2695,311"/>
+<area shape="rect" href="javascript:void(0);" title="Returns the database column data type for this field, for the provided connection." alt="" coords="17,311,2695,329"/>
+<area shape="rect" href="javascript:void(0);" title="Returns a django.forms.Field instance for this database Field." alt="" coords="17,329,2695,348"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.get_attname" alt="" coords="17,348,2695,367"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.get_attname_column" alt="" coords="17,367,2695,385"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.get_cache_name" alt="" coords="17,385,2695,404"/>
+<area shape="rect" href="javascript:void(0);" title="Returns choices with a default blank choices included, for use as SelectField choices for this field." alt="" coords="17,404,2695,423"/>
+<area shape="rect" href="javascript:void(0);" title="django.db.models.fields.Field.get_choices_default" alt="" coords="17,423,2695,441"/>
+<area shape="rect" href="javascript:void(0);" title="Returns a string value of this field from the passed obj." alt="" coords="17,460,2695,479"/>
+<area shape="rect" href="javascript:void(0);" title="Base class for all field types" alt="" coords="16,11,2696,480"/>
+</map>
+ <img src="uml_class_diagram_for_oauth2cl_32.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_32" 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">&nbsp;</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">&nbsp;</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&nbsp;code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</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&nbsp;code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</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&nbsp;code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type">&nbsp;</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>__init__</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="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&nbsp;code</a></span>&nbsp;
+ </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&nbsp;code</a></span>&nbsp;
+ </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&nbsp;code</a></span>&nbsp;
+ </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"
+ >&nbsp;
+ </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>&nbsp;&nbsp;&nbsp;<a
+ href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Index link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Help link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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 Tue Jun 5 09:03:11 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>
« no previous file with comments | « docs/epy/oauth2client.django_orm.CredentialsField-class.html ('k') | docs/epy/oauth2client.django_orm.Storage-class.html » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b