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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
|
<?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.FuncDoc</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 FuncDoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.objdoc.FuncDoc-class.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.objdoc.FuncDoc-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class FuncDoc</h2>
<pre class="base-tree">
<a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a> --+
|
<b>FuncDoc</b>
</pre><br />
<hr/>
The documentation for a function. 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
function-specific pieces of documentation:
<ul>
<li>
<a name="index-parameters"></a><i
class="indexterm">parameters</i>: A list of the function's positional
parameters.
</li>
<li>
<a name="index-vararg"></a><i class="indexterm">vararg</i>: The
function's vararg parameter, or <code>None</code>.
</li>
<li>
<a name="index-kwarg"></a><i class="indexterm">kwarg</i>: The
function's keyword parameter, or <code>None</code>.
</li>
<li>
<a name="index-returns"></a><i class="indexterm">returns</i>: The
function's return value.
</li>
<li>
<a name="index-raises"></a><i class="indexterm">raises</i>: A list
of exceptions that may be raised by the function.
</li>
<li>
<a name="index-overrides"></a><i class="indexterm">overrides</i>:
The method that this method overrides.
</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>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"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#keywords" class="summary-sig-name"><code>keywords</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the keyword parameters for the function/method documented by this
<code>FuncDoc</code>.</td></tr>
<tr><td colspan="2">
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Accessors</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#parameters" class="summary-sig-name"><code>parameters</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the positional parameters for the function/method documented by this
<code>FuncDoc</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#vararg" class="summary-sig-name"><code>vararg</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the vararg parameter for the function/method documented by this
<code>FuncDoc</code>, or <code>None</code> if it has no vararg
parameter.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#kwarg" class="summary-sig-name"><code>kwarg</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the keyword parameter for the function/method documented by this
<code>FuncDoc</code>, or <code>None</code> if it has no keyword
parameter.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#returns" class="summary-sig-name"><code>returns</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the return value for the function/method documented by this
<code>FuncDoc</code>, or <code>None</code> if it has no return value.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Raise-class.html"
class="link"><code>Raise</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#raises" class="summary-sig-name"><code>raises</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of exceptions that may be raised by the function/method
documented by this <code>FuncDoc</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#overrides" class="summary-sig-name"><code>overrides</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the method overridden by the method documented by this
<code>FuncDoc</code>; or <code>None</code> if the method documented by
this <code>FuncDoc</code> does not override any method, or if this
<code>FuncDoc</code> documents a function.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#matches_override" class="summary-sig-name"><code>matches_override</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return true if the method documented by this <code>FuncDoc</code> overrides
another method, and its signature matches the signature of the overridden
method.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#parameter_list" class="summary-sig-name"><code>parameter_list</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a (flat) list of all parameters for the function/method documented by
this <code>FuncDoc</code>.</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"> Inheritance</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.FuncDoc-class.html#find_override" class="summary-sig-name"><code>find_override</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>bases</span>)</span></code>
<br />
Find the method that this method overrides.</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="parameters"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parameters</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The positional parameters for the function/method documented
by this <code>FuncDoc</code>. This is typically a list of
parameters, but it can contain sublists if the function/method's
signature contains sublists. For example, for the function:
<pre class="doctestblock">
<span class="py-src"><span class="py-prompt">>>> </span><span class="py-keyword">def</span> f(a, (b, c), d): <span class="py-keyword">pass</span></span></pre>
<p>For this function, <code>parameters</code> will return a
three-element list, whose second element is a sublist containing
<code>Var</code>s for <code>b</code> and <code>c</code>.</p>
If you just want a list of all parameters used by the
function/method, use <a
href="epydoc.objdoc.FuncDoc-class.html#parameter_list"
class="link"><code>parameter_list</code></a> instead.
<br /><i>
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="vararg"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">vararg</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The vararg parameter for the function/method documented by
this <code>FuncDoc</code>, or <code>None</code> if it has no
vararg parameter.
<br /><i>
(type=<a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="kwarg"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">kwarg</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The keyword parameter for the function/method documented by
this <code>FuncDoc</code>, or <code>None</code> if it has no
keyword parameter.
<br /><i>
(type=<a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="returns"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">returns</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The return value for the function/method documented by this
<code>FuncDoc</code>, or <code>None</code> if it has no return
value.
<br /><i>
(type=<a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="raises"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">raises</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of exceptions that may be raised by the function/method
documented by this <code>FuncDoc</code>.
<br /><i>
(type=<code>list</code> of <a href="epydoc.objdoc.Raise-class.html"
class="link"><code>Raise</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="overrides"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">overrides</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The method overridden by the method documented by this
<code>FuncDoc</code>; or <code>None</code> if the method
documented by this <code>FuncDoc</code> does not override any
method, or if this <code>FuncDoc</code> documents a function.
<br /><i>
(type=<a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="matches_override"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">matches_override</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if the method documented by this <code>FuncDoc</code>
overrides another method, and its signature matches the signature
of the overridden method.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parameter_list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parameter_list</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A (flat) list of all parameters for the function/method
documented by this <code>FuncDoc</code>. If you are interested in
the signature of the function/method, you should use <a
href="epydoc.objdoc.FuncDoc-class.html#parameters"
class="link"><code>parameters</code></a> instead. This list
includes vararg & keyword params, but does not include the
return value.
<br /><i>
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</i>
</dd>
</dl>
<p><b>See Also:</b> <a href="epydoc.objdoc.FuncDoc-class.html#parameters"
class="link"><code>parameters</code></a>
</p>
</dd></dl>
</td></tr></table>
<a name="find_override"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">find_override</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>bases</span>)</span>
</h3>
Find the method that this method overrides.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="keywords"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">keywords</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The keyword parameters for the function/method documented by
this <code>FuncDoc</code>.
<br /><i>
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</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:16 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>
|
