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
|
<?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.DocMap</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 DocMap
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.objdoc.DocMap-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.DocMap-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class DocMap</h2>
<pre class="base-tree">
<a href="UserDict.UserDict-class.html"><code>UserDict</code></a> --+
|
<b>DocMap</b>
</pre><br />
<hr/>
A dictionary mapping each object to the object's documentation.
Typically, modules or classes are added to the <code>DocMap</code> using
<code>add</code>, which adds an object and everything it contains. For
example, the following code constructs a documentation map, adds the
module "epydoc.epytext" to it, and looks up the documentation
for "epydoc.epytext.parse":
<pre class="doctestblock">
<span class="py-src"><span class="py-prompt">>>> </span>docmap = DocMap() <span class="py-comment"># Construct a docmap</span>
<span class="py-prompt">>>> </span>docmap.add(epydoc.epytext) <span class="py-comment"># Add epytext to it</span>
<span class="py-prompt">>>> </span>docmap[epydoc.epytext.parse] <span class="py-comment"># Look up epytext.parse</span></span>
<span class="py-output"><FuncDoc: epydoc.epytext.parse (3 parameters; 1 exceptions)></span></pre>
<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><span class="summary-sig"><a href="epydoc.objdoc.DocMap-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>verbosity</span>,
<span class=summary-sig-arg>document_bases</span>,
<span class=summary-sig-arg>document_autogen_vars</span>,
<span class=summary-sig-arg>inheritance_groups</span>,
<span class=summary-sig-arg>inherit_groups</span>)</span></code>
<br />
Create a new empty documentation map.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>ObjDoc</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.DocMap-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
<br />
Return the documentation for the given object; or the object identified by
<code>key</code>, if <code>key</code> is a <a
href="epydoc.uid.UID-class.html" class="link"><code>UID</code></a>.</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>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.DocMap-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>obj</span>)</span></code>
<br />
Add the documentation for an object, and everything contained by that
object, to this documentation map.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.DocMap-class.html#add_one" class="summary-sig-name"><code>add_one</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>objID</span>)</span></code>
<br />
Add an object's documentation to this documentation map.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.DocMap-class.html#documented_ancestor" class="summary-sig-name"><code>documented_ancestor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>method_uid</span>)</span></code>
<br />
Returns the documentation for the closest ancestor of
<code>method_uid</code> that defines a docstring.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="sorted_keys"></a><span class="summary-sig"><span class="summary-sig-name">sorted_keys</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.uid.UID-class.html"
class="link"><code>UID</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.DocMap-class.html#top" class="summary-sig-name"><code>top</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the list of top-level objects documented by this documentation
map.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_add"></a><span class="summary-sig"><span class="summary-sig-name">_add</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>objID</span>)</span></code>
</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="../private/epydoc.objdoc.DocMap-class.html#_toplevel" class="summary-sig-name"><code>_toplevel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Return true if the object identified by <code>uid</code> is not contained (as
a sub-package, module contents, class contents, etc.) by any other object
in this docmap.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="UserDict.UserDict-class.html"><code>UserDict</code></a>:</b>
<a href="UserDict.UserDict-class.html#__cmp__"><code>__cmp__</code></a>,
<a href="UserDict.UserDict-class.html#__contains__"><code>__contains__</code></a>,
<a href="UserDict.UserDict-class.html#__delitem__"><code>__delitem__</code></a>,
<a href="UserDict.UserDict-class.html#__len__"><code>__len__</code></a>,
<a href="UserDict.UserDict-class.html#__setitem__"><code>__setitem__</code></a>,
<a href="UserDict.UserDict-class.html#clear"><code>clear</code></a>,
<a href="UserDict.UserDict-class.html#copy"><code>copy</code></a>,
<a href="UserDict.UserDict-class.html#get"><code>get</code></a>,
<a href="UserDict.UserDict-class.html#has_key"><code>has_key</code></a>,
<a href="UserDict.UserDict-class.html#items"><code>items</code></a>,
<a href="UserDict.UserDict-class.html#iteritems"><code>iteritems</code></a>,
<a href="UserDict.UserDict-class.html#iterkeys"><code>iterkeys</code></a>,
<a href="UserDict.UserDict-class.html#itervalues"><code>itervalues</code></a>,
<a href="UserDict.UserDict-class.html#keys"><code>keys</code></a>,
<a href="UserDict.UserDict-class.html#popitem"><code>popitem</code></a>,
<a href="UserDict.UserDict-class.html#setdefault"><code>setdefault</code></a>,
<a href="UserDict.UserDict-class.html#update"><code>update</code></a>,
<a href="UserDict.UserDict-class.html#values"><code>values</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="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>verbosity</span>=<span class=sig-default>0</span>,
<span class=sig-arg>document_bases</span>=<span class=sig-default>1</span>,
<span class=sig-arg>document_autogen_vars</span>=<span class=sig-default>1</span>,
<span class=sig-arg>inheritance_groups</span>=<span class=sig-default>0</span>,
<span class=sig-arg>inherit_groups</span>=<span class=sig-default>1</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Create a new empty documentation map.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>verbosity</b></code> -
The verbosity of output produced when creating documentation
for objects. More positive numbers produce more verbose output;
negative numbers supress warnings and errors.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>document_bases</b></code> -
Whether or not documentation should automatically be built for
the bases of classes that are added to the documentation map.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>inheritance_groups</b></code> -
If true, then create a group for each base ancestor,
containing the members that are inherited from that base. These
groups have names of the form <code>'Inherited from <i
class="math">base</i>'</code>.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>inherit_groups</b></code> -
If true, then inherit groups from the base ancestors.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="UserDict.UserDict-class.html#__init__"><code>UserDict.UserDict.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="__getitem__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__getitem__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>key</span>)</span>
<br /><i>(Indexing operator)</i>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>key</b></code> -
The object whose documentation should be returned.
<br /><i>
(type=any)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The documentation for the given object; or the object
identified by <code>key</code>, if <code>key</code> is a <a
href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>.
<br /><i>
(type=<code>ObjDoc</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>KeyError</b></code> -
If the documentation for the object identified by
<code>key</code> is not contained in this documentation map.
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="UserDict.UserDict-class.html#__getitem__"><code>UserDict.UserDict.__getitem__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>obj</span>)</span>
</h3>
Add the documentation for an object, and everything contained by
that object, to this documentation map.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>obj</b></code> -
The object whose documentation should be added to this
documentation map.
<br /><i>
(type=any)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_one"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_one</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>objID</span>)</span>
</h3>
Add an object's documentation to this documentation map. If you also
want to include the objects contained by <code>obj</code>, then use <a
href="epydoc.objdoc.DocMap-class.html#add"
class="link"><code>add</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>objID</b></code> -
The UID of the object whose documentation should be added to
this documentation map.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="documented_ancestor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">documented_ancestor</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>method_uid</span>)</span>
</h3>
Returns the documentation for the closest ancestor of
<code>method_uid</code> that defines a docstring. In particular, search
through the set of methods that <code>method_uid</code> overrides
(starting with <code>method_uid</code> itself), and return the first
method that:
<ul>
<li>
defines a docstring
</li>
<li>
matches the signature of <code>method_uid</code>
</li>
</ul>
If no such method is found, or if <code>method_uid</code> itself is
not documented by this docmap, then this function returns
<code>None</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>method_uid</b></code>
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a> or <code>None</code>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ValueError</b></code> -
If <code>method_uid</code> is not the UID for a method.
</dl>
</dd></dl>
</td></tr></table>
<a name="top"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">top</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The list of top-level objects documented by this documentation
map. The top-level objects are those that are not contained (as
sub-packages, module contents, class contents, etc) by any other
objects in the documentation map.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_toplevel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_toplevel</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>uid</b></code> -
The <code>UID</code> to check.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
True if the object identified by <code>uid</code> is not
contained (as a sub-package, module contents, class contents,
etc.) by any other object in this docmap.
<br /><i>
(type=<code>boolean</code>)</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:19 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>
|
