Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / django.db.models.fields.subclassing.SubfieldBase-class.html
blob: e7e995cc056d99f4cfacc279ea8ee6b1d4eb8478 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>django.db.models.fields.subclassing.SubfieldBase</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 django ::
38 db ::
39 models ::
40 fields ::
41 subclassing ::
42 SubfieldBase ::
43 Class&nbsp;SubfieldBase
44 </span>
45 </td>
46 <td>
47 <table cellpadding="0" cellspacing="0">
48 <!-- hide/show private -->
49 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
50 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
51 <tr><td align="right"><span class="options"
52 >[<a href="frames.html" target="_top">frames</a
53 >]&nbsp;|&nbsp;<a href="django.db.models.fields.subclassing.SubfieldBase-class.html"
54 target="_top">no&nbsp;frames</a>]</span></td></tr>
55 </table>
56 </td>
57 </tr>
58</table>
59<!-- ==================== TYPE DESCRIPTION ==================== -->
60<h1 class="epydoc">Type SubfieldBase</h1><p class="nomargin-top"></p>
61<center>
62<center> <map id="uml_class_diagram_for_django_d" name="uml_class_diagram_for_django_d">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]63<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,209,609"/>
64<area shape="rect" href="django.db.models.fields.subclassing.SubfieldBase-class.html" title="A metaclass for custom Field subclasses." alt="" coords="16,565,211,611"/>
65<area shape="rect" href="javascript:void(0);" title="type.__abstractmethods__" alt="" coords="48,28,179,47"/>
66<area shape="rect" href="javascript:void(0);" title="type.__base__" alt="" coords="48,47,179,65"/>
67<area shape="rect" href="javascript:void(0);" title="type.__bases__" alt="" coords="48,65,179,84"/>
68<area shape="rect" href="javascript:void(0);" title="type.__basicsize__" alt="" coords="48,84,179,103"/>
69<area shape="rect" href="javascript:void(0);" title="type.__dictoffset__" alt="" coords="48,103,179,121"/>
70<area shape="rect" href="javascript:void(0);" title="type.__flags__" alt="" coords="48,121,179,140"/>
71<area shape="rect" href="javascript:void(0);" title="type.__instancecheck__" alt="" coords="48,140,179,159"/>
72<area shape="rect" href="javascript:void(0);" title="type.__itemsize__" alt="" coords="48,159,179,177"/>
73<area shape="rect" href="javascript:void(0);" title="type.__mro__" alt="" coords="48,177,179,196"/>
74<area shape="rect" href="javascript:void(0);" title="type.__name__" alt="" coords="48,196,179,215"/>
75<area shape="rect" href="javascript:void(0);" title="type.__subclasscheck__" alt="" coords="48,215,179,233"/>
76<area shape="rect" href="javascript:void(0);" title="type.__weakrefoffset__" alt="" coords="48,233,179,252"/>
77<area shape="rect" href="javascript:void(0);" title="x(...)" alt="" coords="48,255,179,273"/>
78<area shape="rect" href="javascript:void(0);" title="x.__delattr__(&#39;name&#39;) &lt;==&gt; del x.name" alt="" coords="48,273,179,292"/>
79<area shape="rect" href="javascript:void(0);" title="x==y" alt="" coords="48,292,179,311"/>
80<area shape="rect" href="javascript:void(0);" title="x&gt;=y" alt="" coords="48,311,179,329"/>
81<area shape="rect" href="javascript:void(0);" title="x.__getattribute__(&#39;name&#39;) &lt;==&gt; x.name" alt="" coords="48,329,179,348"/>
82<area shape="rect" href="javascript:void(0);" title="x&gt;y" alt="" coords="48,348,179,367"/>
83<area shape="rect" href="javascript:void(0);" title="hash(x)" alt="" coords="48,367,179,385"/>
84<area shape="rect" href="javascript:void(0);" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="48,385,179,404"/>
85<area shape="rect" href="javascript:void(0);" title="x&lt;=y" alt="" coords="48,404,179,423"/>
86<area shape="rect" href="javascript:void(0);" title="x&lt;y" alt="" coords="48,423,179,441"/>
87<area shape="rect" href="javascript:void(0);" title="x!=y" alt="" coords="48,441,179,460"/>
88<area shape="rect" href="javascript:void(0);" title="repr(x)" alt="" coords="48,460,179,479"/>
89<area shape="rect" href="javascript:void(0);" title="x.__setattr__(&#39;name&#39;, value) &lt;==&gt; x.name = value" alt="" coords="48,479,179,497"/>
90<area shape="rect" href="javascript:void(0);" title="type.__subclasses__" alt="" coords="48,497,179,516"/>
91<area shape="rect" href="javascript:void(0);" title="return a type&#39;s method resolution order" alt="" coords="48,516,179,535"/>
92<area shape="rect" href="javascript:void(0);" title="type(object) &#45;&gt; the object&#39;s type..." alt="" coords="47,11,180,536"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]93</map>
94 <img src="uml_class_diagram_for_django_d.gif" alt='' usemap="#uml_class_diagram_for_django_d" ismap="ismap" class="graph-without-title" />
95</center>
96</center>
97<hr />
98<pre class="literalblock">
99
100A metaclass for custom Field subclasses. This ensures the model's attribute
101has the descriptor protocol attached to it.
102
103</pre>
104
105<!-- ==================== INSTANCE METHODS ==================== -->
106<a name="section-InstanceMethods"></a>
107<table class="summary" border="1" cellpadding="3"
108 cellspacing="0" width="100%" bgcolor="white">
109<tr bgcolor="#70b0f0" class="table-header">
110 <td colspan="2" class="table-header">
111 <table border="0" cellpadding="0" cellspacing="0" width="100%">
112 <tr valign="top">
113 <td align="left"><span class="table-header">Instance Methods</span></td>
114 <td align="right" valign="top"
115 ><span class="options">[<a href="#section-InstanceMethods"
116 class="privatelink" onclick="toggle_private();"
117 >hide private</a>]</span></td>
118 </tr>
119 </table>
120 </td>
121</tr>
122 <tr>
123 <td colspan="2" class="summary">
124 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
125 <code>__call__</code>,
126 <code>__delattr__</code>,
127 <code>__eq__</code>,
128 <code>__ge__</code>,
129 <code>__getattribute__</code>,
130 <code>__gt__</code>,
131 <code>__hash__</code>,
132 <code>__init__</code>,
133 <code>__le__</code>,
134 <code>__lt__</code>,
135 <code>__ne__</code>,
136 <code>__repr__</code>,
137 <code>__setattr__</code>,
138 <code>__subclasses__</code>,
139 <code>mro</code>
140 </p>
141 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
142 <code>__format__</code>,
143 <code>__reduce__</code>,
144 <code>__reduce_ex__</code>,
145 <code>__sizeof__</code>,
146 <code>__str__</code>,
147 <code>__subclasshook__</code>
148 </p>
149 </td>
150 </tr>
151</table>
152<!-- ==================== STATIC METHODS ==================== -->
153<a name="section-StaticMethods"></a>
154<table class="summary" border="1" cellpadding="3"
155 cellspacing="0" width="100%" bgcolor="white">
156<tr bgcolor="#70b0f0" class="table-header">
157 <td colspan="2" class="table-header">
158 <table border="0" cellpadding="0" cellspacing="0" width="100%">
159 <tr valign="top">
160 <td align="left"><span class="table-header">Static Methods</span></td>
161 <td align="right" valign="top"
162 ><span class="options">[<a href="#section-StaticMethods"
163 class="privatelink" onclick="toggle_private();"
164 >hide private</a>]</span></td>
165 </tr>
166 </table>
167 </td>
168</tr>
169<tr>
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type"><pre class="literalblock">
172a new object with type S, a subtype of T
173
174</pre></span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
177 <tr>
178 <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>,
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]179 <span class="summary-sig-arg">base</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]180 <span class="summary-sig-arg">name</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]181 <span class="summary-sig-arg">attrs</span>)</span></td>
182 <td align="right" valign="top">
183
184
185 </td>
186 </tr>
187 </table>
188
189 </td>
190 </tr>
191</table>
192<!-- ==================== PROPERTIES ==================== -->
193<a name="section-Properties"></a>
194<table class="summary" border="1" cellpadding="3"
195 cellspacing="0" width="100%" bgcolor="white">
196<tr bgcolor="#70b0f0" class="table-header">
197 <td colspan="2" class="table-header">
198 <table border="0" cellpadding="0" cellspacing="0" width="100%">
199 <tr valign="top">
200 <td align="left"><span class="table-header">Properties</span></td>
201 <td align="right" valign="top"
202 ><span class="options">[<a href="#section-Properties"
203 class="privatelink" onclick="toggle_private();"
204 >hide private</a>]</span></td>
205 </tr>
206 </table>
207 </td>
208</tr>
209 <tr>
210 <td colspan="2" class="summary">
211 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
212 <code>__abstractmethods__</code>,
213 <code>__base__</code>,
214 <code>__bases__</code>,
215 <code>__basicsize__</code>,
216 <code>__dictoffset__</code>,
217 <code>__flags__</code>,
218 <code>__instancecheck__</code>,
219 <code>__itemsize__</code>,
220 <code>__mro__</code>,
221 <code>__name__</code>,
222 <code>__subclasscheck__</code>,
223 <code>__weakrefoffset__</code>
224 </p>
225 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
226 <code>__class__</code>
227 </p>
228 </td>
229 </tr>
230</table>
231<!-- ==================== METHOD DETAILS ==================== -->
232<a name="section-MethodDetails"></a>
233<table class="details" border="1" cellpadding="3"
234 cellspacing="0" width="100%" bgcolor="white">
235<tr bgcolor="#70b0f0" class="table-header">
236 <td colspan="2" class="table-header">
237 <table border="0" cellpadding="0" cellspacing="0" width="100%">
238 <tr valign="top">
239 <td align="left"><span class="table-header">Method Details</span></td>
240 <td align="right" valign="top"
241 ><span class="options">[<a href="#section-MethodDetails"
242 class="privatelink" onclick="toggle_private();"
243 >hide private</a>]</span></td>
244 </tr>
245 </table>
246 </td>
247</tr>
248</table>
249<a name="__new__"></a>
250<div>
251<table class="details" border="1" cellpadding="3"
252 cellspacing="0" width="100%" bgcolor="white">
253<tr><td>
254 <table width="100%" cellpadding="0" cellspacing="0" border="0">
255 <tr valign="top"><td>
256 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">cls</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]257 <span class="sig-arg">base</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]258 <span class="sig-arg">name</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]259 <span class="sig-arg">attrs</span>)</span>
260 <br /><em class="fname">Static Method</em>
261 </h3>
262 </td><td align="right" valign="top"
263 >&nbsp;
264 </td>
265 </tr></table>
266
267 <pre class="literalblock">
268
269
270</pre>
271 <dl class="fields">
272 <dt>Returns: <pre class="literalblock">
273a new object with type S, a subtype of T
274
275</pre></dt>
276 <dt>Overrides:
277 object.__new__
278 <dd><em class="note">(inherited documentation)</em></dd>
279 </dt>
280 </dl>
281</td></tr></table>
282</div>
283<br />
284<!-- ==================== NAVIGATION BAR ==================== -->
285<table class="navbar" border="0" width="100%" cellpadding="0"
286 bgcolor="#a0c0ff" cellspacing="0">
287 <tr valign="middle">
288
289 <!-- Tree link -->
290 <th>&nbsp;&nbsp;&nbsp;<a
291 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
292
293 <!-- Index link -->
294 <th>&nbsp;&nbsp;&nbsp;<a
295 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
296
297 <!-- Help link -->
298 <th>&nbsp;&nbsp;&nbsp;<a
299 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
300
301 <th class="navbar" width="100%"></th>
302 </tr>
303</table>
304<table border="0" cellpadding="0" cellspacing="0" width="100%%">
305 <tr>
306 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]307 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]308 </td>
309 <td align="right" class="footer">
310 <a target="mainFrame" href="http://epydoc.sourceforge.net"
311 >http://epydoc.sourceforge.net</a>
312 </td>
313 </tr>
314</table>
315
316<script type="text/javascript">
317 <!--
318 // Private objects are initially displayed (because if
319 // javascript is turned off then we want them to be
320 // visible); but by default, we want to hide them. So hide
321 // them unless we have a cookie that says to show them.
322 checkCookie();
323 // -->
324</script>
325</body>
326</html>