blob: d9224e24e100e7656e8d8b8bc4a6ffd855256452 [file] [log] [blame]
<?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>django.db.models.fields.subclassing.SubfieldBase</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">
django ::
db ::
models ::
fields ::
subclassing ::
SubfieldBase ::
Class&nbsp;SubfieldBase
</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="django.db.models.fields.subclassing.SubfieldBase-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== TYPE DESCRIPTION ==================== -->
<h1 class="epydoc">Type SubfieldBase</h1><p class="nomargin-top"></p>
<center>
<center> <map id="uml_class_diagram_for_django_d" name="uml_class_diagram_for_django_d">
<area shape="rect" href="django.db.models.fields.subclassing.SubfieldBase-class.html#__new__" title="django.db.models.fields.subclassing.SubfieldBase.__new__" alt="" coords="17,591,217,609"/>
<area shape="rect" href="django.db.models.fields.subclassing.SubfieldBase-class.html" title="A metaclass for custom Field subclasses." alt="" coords="16,565,219,611"/>
<area shape="rect" href="javascript:void(0);" title="type.__abstractmethods__" alt="" coords="52,28,183,47"/>
<area shape="rect" href="javascript:void(0);" title="type.__base__" alt="" coords="52,47,183,65"/>
<area shape="rect" href="javascript:void(0);" title="type.__bases__" alt="" coords="52,65,183,84"/>
<area shape="rect" href="javascript:void(0);" title="type.__basicsize__" alt="" coords="52,84,183,103"/>
<area shape="rect" href="javascript:void(0);" title="type.__dictoffset__" alt="" coords="52,103,183,121"/>
<area shape="rect" href="javascript:void(0);" title="type.__flags__" alt="" coords="52,121,183,140"/>
<area shape="rect" href="javascript:void(0);" title="type.__instancecheck__" alt="" coords="52,140,183,159"/>
<area shape="rect" href="javascript:void(0);" title="type.__itemsize__" alt="" coords="52,159,183,177"/>
<area shape="rect" href="javascript:void(0);" title="type.__mro__" alt="" coords="52,177,183,196"/>
<area shape="rect" href="javascript:void(0);" title="type.__name__" alt="" coords="52,196,183,215"/>
<area shape="rect" href="javascript:void(0);" title="type.__subclasscheck__" alt="" coords="52,215,183,233"/>
<area shape="rect" href="javascript:void(0);" title="type.__weakrefoffset__" alt="" coords="52,233,183,252"/>
<area shape="rect" href="javascript:void(0);" title="x(...)" alt="" coords="52,255,183,273"/>
<area shape="rect" href="javascript:void(0);" title="x.__delattr__(&#39;name&#39;) &lt;==&gt; del x.name" alt="" coords="52,273,183,292"/>
<area shape="rect" href="javascript:void(0);" title="x==y" alt="" coords="52,292,183,311"/>
<area shape="rect" href="javascript:void(0);" title="x&gt;=y" alt="" coords="52,311,183,329"/>
<area shape="rect" href="javascript:void(0);" title="x.__getattribute__(&#39;name&#39;) &lt;==&gt; x.name" alt="" coords="52,329,183,348"/>
<area shape="rect" href="javascript:void(0);" title="x&gt;y" alt="" coords="52,348,183,367"/>
<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="52,367,183,385"/>
<area shape="rect" href="javascript:void(0);" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="52,385,183,404"/>
<area shape="rect" href="javascript:void(0);" title="x&lt;=y" alt="" coords="52,404,183,423"/>
<area shape="rect" href="javascript:void(0);" title="x&lt;y" alt="" coords="52,423,183,441"/>
<area shape="rect" href="javascript:void(0);" title="x!=y" alt="" coords="52,441,183,460"/>
<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="52,460,183,479"/>
<area shape="rect" href="javascript:void(0);" title="x.__setattr__(&#39;name&#39;, value) &lt;==&gt; x.name = value" alt="" coords="52,479,183,497"/>
<area shape="rect" href="javascript:void(0);" title="type.__subclasses__" alt="" coords="52,497,183,516"/>
<area shape="rect" href="javascript:void(0);" title="return a type&#39;s method resolution order" alt="" coords="52,516,183,535"/>
<area shape="rect" href="javascript:void(0);" title="type(object) &#45;&gt; the object&#39;s type..." alt="" coords="51,11,184,536"/>
</map>
<img src="uml_class_diagram_for_django_d.gif" alt='' usemap="#uml_class_diagram_for_django_d" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<pre class="literalblock">
A metaclass for custom Field subclasses. This ensures the model's attribute
has the descriptor protocol attached to it.
</pre>
<!-- ==================== 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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
<code>__call__</code>,
<code>__delattr__</code>,
<code>__eq__</code>,
<code>__ge__</code>,
<code>__getattribute__</code>,
<code>__gt__</code>,
<code>__hash__</code>,
<code>__init__</code>,
<code>__le__</code>,
<code>__lt__</code>,
<code>__ne__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__subclasses__</code>,
<code>mro</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__format__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></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">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
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"><pre class="literalblock">
a new object with type S, a subtype of T
</pre></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="django.db.models.fields.subclassing.SubfieldBase-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">cls</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">bases</span>,
<span class="summary-sig-arg">attrs</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</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>type</code></b>:
<code>__abstractmethods__</code>,
<code>__base__</code>,
<code>__bases__</code>,
<code>__basicsize__</code>,
<code>__dictoffset__</code>,
<code>__flags__</code>,
<code>__instancecheck__</code>,
<code>__itemsize__</code>,
<code>__mro__</code>,
<code>__name__</code>,
<code>__subclasscheck__</code>,
<code>__weakrefoffset__</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="__new__"></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">__new__</span>(<span class="sig-arg">cls</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">bases</span>,
<span class="sig-arg">attrs</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
</pre>
<dl class="fields">
<dt>Returns: <pre class="literalblock">
a new object with type S, a subtype of T
</pre></dt>
<dt>Overrides:
object.__new__
<dd><em class="note">(inherited documentation)</em></dd>
</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:07 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>