blob: e2bc674c2f5d05a96491c9ebc8a2f11fb786f69b [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -04001<?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>
Joe Gregorio746096f2012-06-15 10:53:36 -040062<center> <map id="class_hierarchy_for_subfieldba" name="class_hierarchy_for_subfieldba">
63<area shape="rect" href="django.db.models.fields.subclassing.SubfieldBase-class.html" title="SubfieldBase" alt="" coords="5,61,101,88"/>
64<area shape="rect" href="javascript:void(0);" title="type" alt="" coords="31,5,76,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040065</map>
Joe Gregorio746096f2012-06-15 10:53:36 -040066 <img src="class_hierarchy_for_subfieldba.gif" alt='' usemap="#class_hierarchy_for_subfieldba" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040067</center>
68</center>
69<hr />
70<pre class="literalblock">
71
72A metaclass for custom Field subclasses. This ensures the model's attribute
73has the descriptor protocol attached to it.
74
75</pre>
76
77<!-- ==================== INSTANCE METHODS ==================== -->
78<a name="section-InstanceMethods"></a>
79<table class="summary" border="1" cellpadding="3"
80 cellspacing="0" width="100%" bgcolor="white">
81<tr bgcolor="#70b0f0" class="table-header">
82 <td colspan="2" class="table-header">
83 <table border="0" cellpadding="0" cellspacing="0" width="100%">
84 <tr valign="top">
85 <td align="left"><span class="table-header">Instance Methods</span></td>
86 <td align="right" valign="top"
87 ><span class="options">[<a href="#section-InstanceMethods"
88 class="privatelink" onclick="toggle_private();"
89 >hide private</a>]</span></td>
90 </tr>
91 </table>
92 </td>
93</tr>
94 <tr>
95 <td colspan="2" class="summary">
96 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
97 <code>__call__</code>,
98 <code>__delattr__</code>,
99 <code>__eq__</code>,
100 <code>__ge__</code>,
101 <code>__getattribute__</code>,
102 <code>__gt__</code>,
103 <code>__hash__</code>,
104 <code>__init__</code>,
105 <code>__le__</code>,
106 <code>__lt__</code>,
107 <code>__ne__</code>,
108 <code>__repr__</code>,
109 <code>__setattr__</code>,
110 <code>__subclasses__</code>,
111 <code>mro</code>
112 </p>
113 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
114 <code>__format__</code>,
115 <code>__reduce__</code>,
116 <code>__reduce_ex__</code>,
117 <code>__sizeof__</code>,
118 <code>__str__</code>,
119 <code>__subclasshook__</code>
120 </p>
121 </td>
122 </tr>
123</table>
124<!-- ==================== STATIC METHODS ==================== -->
125<a name="section-StaticMethods"></a>
126<table class="summary" border="1" cellpadding="3"
127 cellspacing="0" width="100%" bgcolor="white">
128<tr bgcolor="#70b0f0" class="table-header">
129 <td colspan="2" class="table-header">
130 <table border="0" cellpadding="0" cellspacing="0" width="100%">
131 <tr valign="top">
132 <td align="left"><span class="table-header">Static Methods</span></td>
133 <td align="right" valign="top"
134 ><span class="options">[<a href="#section-StaticMethods"
135 class="privatelink" onclick="toggle_private();"
136 >hide private</a>]</span></td>
137 </tr>
138 </table>
139 </td>
140</tr>
141<tr>
142 <td width="15%" align="right" valign="top" class="summary">
143 <span class="summary-type"><pre class="literalblock">
144a new object with type S, a subtype of T
145
146</pre></span>
147 </td><td class="summary">
148 <table width="100%" cellpadding="0" cellspacing="0" border="0">
149 <tr>
150 <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>,
151 <span class="summary-sig-arg">name</span>,
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400152 <span class="summary-sig-arg">bases</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400153 <span class="summary-sig-arg">attrs</span>)</span></td>
154 <td align="right" valign="top">
155
156
157 </td>
158 </tr>
159 </table>
160
161 </td>
162 </tr>
163</table>
164<!-- ==================== PROPERTIES ==================== -->
165<a name="section-Properties"></a>
166<table class="summary" border="1" cellpadding="3"
167 cellspacing="0" width="100%" bgcolor="white">
168<tr bgcolor="#70b0f0" class="table-header">
169 <td colspan="2" class="table-header">
170 <table border="0" cellpadding="0" cellspacing="0" width="100%">
171 <tr valign="top">
172 <td align="left"><span class="table-header">Properties</span></td>
173 <td align="right" valign="top"
174 ><span class="options">[<a href="#section-Properties"
175 class="privatelink" onclick="toggle_private();"
176 >hide private</a>]</span></td>
177 </tr>
178 </table>
179 </td>
180</tr>
181 <tr>
182 <td colspan="2" class="summary">
183 <p class="indent-wrapped-lines"><b>Inherited from <code>type</code></b>:
184 <code>__abstractmethods__</code>,
185 <code>__base__</code>,
186 <code>__bases__</code>,
187 <code>__basicsize__</code>,
188 <code>__dictoffset__</code>,
189 <code>__flags__</code>,
190 <code>__instancecheck__</code>,
191 <code>__itemsize__</code>,
192 <code>__mro__</code>,
193 <code>__name__</code>,
194 <code>__subclasscheck__</code>,
195 <code>__weakrefoffset__</code>
196 </p>
197 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
198 <code>__class__</code>
199 </p>
200 </td>
201 </tr>
202</table>
203<!-- ==================== METHOD DETAILS ==================== -->
204<a name="section-MethodDetails"></a>
205<table class="details" border="1" cellpadding="3"
206 cellspacing="0" width="100%" bgcolor="white">
207<tr bgcolor="#70b0f0" class="table-header">
208 <td colspan="2" class="table-header">
209 <table border="0" cellpadding="0" cellspacing="0" width="100%">
210 <tr valign="top">
211 <td align="left"><span class="table-header">Method Details</span></td>
212 <td align="right" valign="top"
213 ><span class="options">[<a href="#section-MethodDetails"
214 class="privatelink" onclick="toggle_private();"
215 >hide private</a>]</span></td>
216 </tr>
217 </table>
218 </td>
219</tr>
220</table>
221<a name="__new__"></a>
222<div>
223<table class="details" border="1" cellpadding="3"
224 cellspacing="0" width="100%" bgcolor="white">
225<tr><td>
226 <table width="100%" cellpadding="0" cellspacing="0" border="0">
227 <tr valign="top"><td>
228 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">cls</span>,
229 <span class="sig-arg">name</span>,
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400230 <span class="sig-arg">bases</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400231 <span class="sig-arg">attrs</span>)</span>
232 <br /><em class="fname">Static Method</em>
233 </h3>
234 </td><td align="right" valign="top"
235 >&nbsp;
236 </td>
237 </tr></table>
238
239 <pre class="literalblock">
240
241
242</pre>
243 <dl class="fields">
244 <dt>Returns: <pre class="literalblock">
245a new object with type S, a subtype of T
246
247</pre></dt>
248 <dt>Overrides:
249 object.__new__
250 <dd><em class="note">(inherited documentation)</em></dd>
251 </dt>
252 </dl>
253</td></tr></table>
254</div>
255<br />
256<!-- ==================== NAVIGATION BAR ==================== -->
257<table class="navbar" border="0" width="100%" cellpadding="0"
258 bgcolor="#a0c0ff" cellspacing="0">
259 <tr valign="middle">
260
261 <!-- Tree link -->
262 <th>&nbsp;&nbsp;&nbsp;<a
263 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
264
265 <!-- Index link -->
266 <th>&nbsp;&nbsp;&nbsp;<a
267 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
268
269 <!-- Help link -->
270 <th>&nbsp;&nbsp;&nbsp;<a
271 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
272
273 <th class="navbar" width="100%"></th>
274 </tr>
275</table>
276<table border="0" cellpadding="0" cellspacing="0" width="100%%">
277 <tr>
278 <td align="left" class="footer">
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400279 Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:44 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400280 </td>
281 <td align="right" class="footer">
282 <a target="mainFrame" href="http://epydoc.sourceforge.net"
283 >http://epydoc.sourceforge.net</a>
284 </td>
285 </tr>
286</table>
287
288<script type="text/javascript">
289 <!--
290 // Private objects are initially displayed (because if
291 // javascript is turned off then we want them to be
292 // visible); but by default, we want to hide them. So hide
293 // them unless we have a cookie that says to show them.
294 checkCookie();
295 // -->
296</script>
297</body>
298</html>