1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>epydoc.objdoc.PropertyDoc</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.objdoc-module.html">Module objdoc</a> ::
Class PropertyDoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.objdoc.PropertyDoc-class.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.objdoc.PropertyDoc-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class PropertyDoc</h2>
<pre class="base-tree">
<a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a> --+
|
<b>PropertyDoc</b>
</pre><br />
<hr/>
The documentation for a property. This documentation consists of
standard pieces of documentation (as defined in <a
href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a>), and the following
property-specific pieces of documentation:
<ul>
<li>
<a name="index-fget"></a><i class="indexterm">fget</i>: The
property's get function
</li>
<li>
<a name="index-fset"></a><i class="indexterm">fset</i>: The
property's set function
</li>
<li>
<a name="index-fdel"></a><i class="indexterm">fdel</i>: The
property's delete function
</li>
<li>
<a name="index-type"></a><i class="indexterm">type</i>: The
property's type
</li>
</ul>
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>typ</span>,
<span class=summary-sig-arg>verbosity</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.objdoc.PropertyDoc-class.html#_make_uid" class="summary-sig-name"><code>_make_uid</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>func</span>,
<span class=summary-sig-arg>cls</span>,
<span class=summary-sig-arg>functype</span>)</span></code>
<br />
Return a UID for the given fget/fset/fdel function of the
property.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_sort"><code>_sort</code></a>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Accessors</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.PropertyDoc-class.html#type" class="summary-sig-name"><code>type</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a description of this property's type.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.PropertyDoc-class.html#fget" class="summary-sig-name"><code>fget</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the UID of this property's get function.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.PropertyDoc-class.html#fset" class="summary-sig-name"><code>fset</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the UID of this property's set function.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.PropertyDoc-class.html#fdel" class="summary-sig-name"><code>fdel</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the UID of this property's delete function.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="epydoc.objdoc.ObjDoc-class.html#by_group"><code>by_group</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#defines_groups"><code>defines_groups</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#descr"><code>descr</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#field_values"><code>field_values</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#fields"><code>fields</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#groups"><code>groups</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#has_docstring"><code>has_docstring</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#sortorder"><code>sortorder</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#summary"><code>summary</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#uid"><code>uid</code></a>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Error Handling</th></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_print_errors"><code>_print_errors</code></a>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Docstring Parsing</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.objdoc.PropertyDoc-class.html#_process_field" class="summary-sig-name"><code>_process_field</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>arg</span>,
<span class=summary-sig-arg>descr</span>,
<span class=summary-sig-arg>warnings</span>)</span></code>
<br />
Process a field from this object's docstring.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_uid"><code>_uid</code></a>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Error Handling</th></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_field_warnings"><code>_field_warnings</code></a>,
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_misc_warnings"><code>_misc_warnings</code></a>,
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_parse_errors"><code>_parse_errors</code></a>,
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_parse_warnings"><code>_parse_warnings</code></a>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Docstring Parsing</th></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_descr"><code>_descr</code></a>,
<a href="../private/epydoc.objdoc.ObjDoc-class.html#_fields"><code>_fields</code></a>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Docstring Parsing</th></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="epydoc.objdoc.ObjDoc-class.html#STANDARD_FIELDS"><code>STANDARD_FIELDS</code></a>
</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="type"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">type</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A description of this property's type.
<br /><i>
(type=<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fget"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fget</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The UID of this property's get function.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fset"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fset</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The UID of this property's set function.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fdel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fdel</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The UID of this property's delete function.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_make_uid"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_make_uid</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>func</span>,
<span class=sig-arg>cls</span>,
<span class=sig-arg>functype</span>)</span>
</h3>
Return a UID for the given fget/fset/fdel function of the property.
This is a heuristic function, which first looks for the function within
the current class (and its ancestors); and then looks for it as a
module-level function. If the function is actually defined somewhere
else (e.g., in an unrelated class), then it will be mistakenly
interpreted as a module- level function.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>func</b></code> -
The function to get a uid for.
<dd><code><b>cls</b></code> -
The UID for the class containing the property.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_process_field"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_process_field</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>tag</span>,
<span class=sig-arg>arg</span>,
<span class=sig-arg>descr</span>,
<span class=sig-arg>warnings</span>)</span>
</h3>
Process a field from this object's docstring.
<code>ObjDoc._process_field</code> be overridden by child classes of
<code>ObjDoc</code>, and called as the default case.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tag</b></code> -
The field's tag name
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>arg</b></code> -
The field's optional argument (or <code>None</code> if no
argument was specified).
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>descr</b></code> -
The field's body.
<br /><i>
(type=<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a>)</i>
<dd><code><b>warnings</b></code> -
A list of warnings that have been encountered. If any new
warnings are encountered, then they should be appended to this
list.
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="../private/epydoc.objdoc.ObjDoc-class.html#_process_field"><code>epydoc.objdoc.ObjDoc._process_field</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
