1
<?xml version="1.0" encoding="iso-8859-1"?>
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">
6
<title>epydoc.objdoc.FuncDoc</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="epydoc-module.html">Package epydoc</a> ::
33
<a href="epydoc.objdoc-module.html">Module objdoc</a> ::
37
<td><table cellpadding="0" cellspacing="0">
38
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.objdoc.FuncDoc-class.html">show private</a> | hide private]</font></td></tr>
39
<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>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Class FuncDoc</h2>
46
<pre class="base-tree">
47
<a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a> --+
54
The documentation for a function. This documentation consists of
55
standard pieces of documentation (as defined in <a
56
href="epydoc.objdoc.ObjDoc-class.html"
57
class="link"><code>ObjDoc</code></a>), and the following
58
function-specific pieces of documentation:
61
<a name="index-parameters"></a><i
62
class="indexterm">parameters</i>: A list of the function's positional
66
<a name="index-vararg"></a><i class="indexterm">vararg</i>: The
67
function's vararg parameter, or <code>None</code>.
70
<a name="index-kwarg"></a><i class="indexterm">kwarg</i>: The
71
function's keyword parameter, or <code>None</code>.
74
<a name="index-returns"></a><i class="indexterm">returns</i>: The
75
function's return value.
78
<a name="index-raises"></a><i class="indexterm">raises</i>: A list
79
of exceptions that may be raised by the function.
82
<a name="index-overrides"></a><i class="indexterm">overrides</i>:
83
The method that this method overrides.
89
<!-- =========== START OF METHOD SUMMARY =========== -->
90
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
91
<tr bgcolor="#70b0f0" class="summary">
92
<th colspan="2">Method Summary</th></tr>
93
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
94
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
95
<span class=summary-sig-arg>uid</span>,
96
<span class=summary-sig-arg>verbosity</span>)</span></code>
98
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
99
<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>
101
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
102
class="link"><code>Var</code></a>
104
<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>
106
Return the keyword parameters for the function/method documented by this
107
<code>FuncDoc</code>.</td></tr>
111
<tr bgcolor="#e8f0f8" class="group">
112
<th colspan="2"> Accessors</th></tr>
113
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
114
class="link"><code>Var</code></a>
116
<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>
118
Return the positional parameters for the function/method documented by this
119
<code>FuncDoc</code>.</td></tr>
120
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.Var-class.html"
121
class="link"><code>Var</code></a> or <code>None</code>
123
<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>
125
Return the vararg parameter for the function/method documented by this
126
<code>FuncDoc</code>, or <code>None</code> if it has no vararg
128
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.Var-class.html"
129
class="link"><code>Var</code></a> or <code>None</code>
131
<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>
133
Return the keyword parameter for the function/method documented by this
134
<code>FuncDoc</code>, or <code>None</code> if it has no keyword
136
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.Var-class.html"
137
class="link"><code>Var</code></a> or <code>None</code>
139
<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>
141
Return the return value for the function/method documented by this
142
<code>FuncDoc</code>, or <code>None</code> if it has no return value.</td></tr>
143
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Raise-class.html"
144
class="link"><code>Raise</code></a>
146
<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>
148
Return a list of exceptions that may be raised by the function/method
149
documented by this <code>FuncDoc</code>.</td></tr>
150
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.Link-class.html"
151
class="link"><code>Link</code></a> or <code>None</code>
153
<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>
155
Return the method overridden by the method documented by this
156
<code>FuncDoc</code>; or <code>None</code> if the method documented by
157
this <code>FuncDoc</code> does not override any method, or if this
158
<code>FuncDoc</code> documents a function.</td></tr>
159
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
161
<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>
163
Return true if the method documented by this <code>FuncDoc</code> overrides
164
another method, and its signature matches the signature of the overridden
166
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
167
class="link"><code>Var</code></a>
169
<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>
171
Return a (flat) list of all parameters for the function/method documented by
172
this <code>FuncDoc</code>.</td></tr>
174
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
175
<a href="epydoc.objdoc.ObjDoc-class.html#by_group"><code>by_group</code></a>,
176
<a href="epydoc.objdoc.ObjDoc-class.html#defines_groups"><code>defines_groups</code></a>,
177
<a href="epydoc.objdoc.ObjDoc-class.html#descr"><code>descr</code></a>,
178
<a href="epydoc.objdoc.ObjDoc-class.html#field_values"><code>field_values</code></a>,
179
<a href="epydoc.objdoc.ObjDoc-class.html#fields"><code>fields</code></a>,
180
<a href="epydoc.objdoc.ObjDoc-class.html#groups"><code>groups</code></a>,
181
<a href="epydoc.objdoc.ObjDoc-class.html#has_docstring"><code>has_docstring</code></a>,
182
<a href="epydoc.objdoc.ObjDoc-class.html#sortorder"><code>sortorder</code></a>,
183
<a href="epydoc.objdoc.ObjDoc-class.html#summary"><code>summary</code></a>,
184
<a href="epydoc.objdoc.ObjDoc-class.html#uid"><code>uid</code></a>
186
<tr bgcolor="#e8f0f8" class="group">
187
<th colspan="2"> Inheritance</th></tr>
188
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
189
<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>,
190
<span class=summary-sig-arg>bases</span>)</span></code>
192
Find the method that this method overrides.</td></tr>
196
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
197
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
198
<tr bgcolor="#70b0f0" class="summary">
199
<th colspan="2">Class Variable Summary</th></tr>
200
<tr bgcolor="#e8f0f8" class="group">
201
<th colspan="2"> Docstring Parsing</th></tr>
203
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
204
<a href="epydoc.objdoc.ObjDoc-class.html#STANDARD_FIELDS"><code>STANDARD_FIELDS</code></a>
209
<!-- =========== START OF METHOD DETAILS =========== -->
210
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
211
<tr bgcolor="#70b0f0" class="details">
212
<th colspan="2">Method Details</th></tr>
215
<a name="parameters"></a>
216
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
217
<h3><span class="sig"><span class="sig-name">parameters</span>(<span class=sig-arg>self</span>)</span>
220
<dl><dt><b>Returns:</b></dt>
222
The positional parameters for the function/method documented
223
by this <code>FuncDoc</code>. This is typically a list of
224
parameters, but it can contain sublists if the function/method's
225
signature contains sublists. For example, for the function:
226
<pre class="doctestblock">
227
<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>
228
<p>For this function, <code>parameters</code> will return a
229
three-element list, whose second element is a sublist containing
230
<code>Var</code>s for <code>b</code> and <code>c</code>.</p>
231
If you just want a list of all parameters used by the
232
function/method, use <a
233
href="epydoc.objdoc.FuncDoc-class.html#parameter_list"
234
class="link"><code>parameter_list</code></a> instead.
235
<br /><i>
236
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
237
class="link"><code>Var</code></a>)</i>
243
<a name="vararg"></a>
244
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
245
<h3><span class="sig"><span class="sig-name">vararg</span>(<span class=sig-arg>self</span>)</span>
248
<dl><dt><b>Returns:</b></dt>
250
The vararg parameter for the function/method documented by
251
this <code>FuncDoc</code>, or <code>None</code> if it has no
253
<br /><i>
254
(type=<a href="epydoc.objdoc.Var-class.html"
255
class="link"><code>Var</code></a> or <code>None</code>)</i>
262
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
263
<h3><span class="sig"><span class="sig-name">kwarg</span>(<span class=sig-arg>self</span>)</span>
266
<dl><dt><b>Returns:</b></dt>
268
The keyword parameter for the function/method documented by
269
this <code>FuncDoc</code>, or <code>None</code> if it has no
271
<br /><i>
272
(type=<a href="epydoc.objdoc.Var-class.html"
273
class="link"><code>Var</code></a> or <code>None</code>)</i>
279
<a name="returns"></a>
280
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
281
<h3><span class="sig"><span class="sig-name">returns</span>(<span class=sig-arg>self</span>)</span>
284
<dl><dt><b>Returns:</b></dt>
286
The return value for the function/method documented by this
287
<code>FuncDoc</code>, or <code>None</code> if it has no return
289
<br /><i>
290
(type=<a href="epydoc.objdoc.Var-class.html"
291
class="link"><code>Var</code></a> or <code>None</code>)</i>
297
<a name="raises"></a>
298
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
299
<h3><span class="sig"><span class="sig-name">raises</span>(<span class=sig-arg>self</span>)</span>
302
<dl><dt><b>Returns:</b></dt>
304
A list of exceptions that may be raised by the function/method
305
documented by this <code>FuncDoc</code>.
306
<br /><i>
307
(type=<code>list</code> of <a href="epydoc.objdoc.Raise-class.html"
308
class="link"><code>Raise</code></a>)</i>
314
<a name="overrides"></a>
315
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
316
<h3><span class="sig"><span class="sig-name">overrides</span>(<span class=sig-arg>self</span>)</span>
319
<dl><dt><b>Returns:</b></dt>
321
The method overridden by the method documented by this
322
<code>FuncDoc</code>; or <code>None</code> if the method
323
documented by this <code>FuncDoc</code> does not override any
324
method, or if this <code>FuncDoc</code> documents a function.
325
<br /><i>
326
(type=<a href="epydoc.uid.Link-class.html"
327
class="link"><code>Link</code></a> or <code>None</code>)</i>
333
<a name="matches_override"></a>
334
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
335
<h3><span class="sig"><span class="sig-name">matches_override</span>(<span class=sig-arg>self</span>)</span>
338
<dl><dt><b>Returns:</b></dt>
340
True if the method documented by this <code>FuncDoc</code>
341
overrides another method, and its signature matches the signature
342
of the overridden method.
343
<br /><i>
344
(type=<code>boolean</code>)</i>
350
<a name="parameter_list"></a>
351
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
352
<h3><span class="sig"><span class="sig-name">parameter_list</span>(<span class=sig-arg>self</span>)</span>
355
<dl><dt><b>Returns:</b></dt>
357
A (flat) list of all parameters for the function/method
358
documented by this <code>FuncDoc</code>. If you are interested in
359
the signature of the function/method, you should use <a
360
href="epydoc.objdoc.FuncDoc-class.html#parameters"
361
class="link"><code>parameters</code></a> instead. This list
362
includes vararg & keyword params, but does not include the
364
<br /><i>
365
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
366
class="link"><code>Var</code></a>)</i>
369
<p><b>See Also:</b> <a href="epydoc.objdoc.FuncDoc-class.html#parameters"
370
class="link"><code>parameters</code></a>
376
<a name="find_override"></a>
377
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
378
<h3><span class="sig"><span class="sig-name">find_override</span>(<span class=sig-arg>self</span>,
379
<span class=sig-arg>bases</span>)</span>
381
Find the method that this method overrides.
386
<a name="keywords"></a>
387
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
388
<h3><span class="sig"><span class="sig-name">keywords</span>(<span class=sig-arg>self</span>)</span>
391
<dl><dt><b>Returns:</b></dt>
393
The keyword parameters for the function/method documented by
394
this <code>FuncDoc</code>.
395
<br /><i>
396
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
397
class="link"><code>Var</code></a>)</i>
405
<!-- =========== START OF NAVBAR =========== -->
406
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
408
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
409
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
410
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
411
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
412
<th class="navbar" align="right" width="100%">
413
<table border="0" cellpadding="0" cellspacing="0">
414
<tr><th class="navbar" align="center">
416
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
417
</p></th></tr></table>
422
<table border="0" cellpadding="0" cellspacing="0" width="100%">
424
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:16 2004</font></td>
425
<td align="right"><a href="http://epydoc.sourceforge.net"
426
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
doc/api/public/epydoc.objdoc.FuncDoc-class.html
