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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
|
<?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.ModuleDoc</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 ModuleDoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/epydoc.objdoc.ModuleDoc-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.ModuleDoc-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ModuleDoc</h2>
<pre class="base-tree">
<a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a> --+
|
<b>ModuleDoc</b>
</pre><br />
<hr/>
The documentation for a module or package. 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 module-specific
pieces of documentation:
<ul>
<li>
<a name="index-classes"></a><i class="indexterm">classes</i>: A
list of all classes contained in the module/package.
</li>
<li>
<a name="index-functions"></a><i class="indexterm">functions</i>:
A list of all functions contained in the module/package.
</li>
<li>
<a name="index-variables"></a><i class="indexterm">variables</i>:
A list of all variables contained in the module/package.
</li>
<li>
<a name="index-modules"></a><i class="indexterm">modules</i>: A
list of all modules contained in the package (packages only).
</li>
<li>
<a name="index-imported_objects"></a><i class="indexterm">imported
objects</i>: Lists of imported objects, sorted by 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>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 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"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#functions" class="summary-sig-name"><code>functions</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all functions defined by the module/package documented by
this <code>ModuleDoc</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#classes" class="summary-sig-name"><code>classes</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all classes defined by the module/package documented by this
<code>ModuleDoc</code>, sorted by name.</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.ModuleDoc-class.html#variables" class="summary-sig-name"><code>variables</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all variables defined by the module/package documented by
this <code>ModuleDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#imported_functions" class="summary-sig-name"><code>imported_functions</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all functions contained in the module/package documented by
this <code>ModuleDoc</code> that are not defined by that module/package,
sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#imported_classes" class="summary-sig-name"><code>imported_classes</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all classes contained in the module/package documented by
this <code>ModuleDoc</code> that are not defined by that module/package,
sorted by name.</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> or <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#package" class="summary-sig-name"><code>package</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the package that contains the module documented by this
<code>ModuleDoc</code>, or <code>None</code> if no package contains the
module.</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.ModuleDoc-class.html#ispackage" class="summary-sig-name"><code>ispackage</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return true if this <code>ModuleDoc</code> documents a package (not a
module).</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.ModuleDoc-class.html#ismodule" class="summary-sig-name"><code>ismodule</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return true if this <code>ModuleDoc</code> documents a module (not a
package).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#modules" class="summary-sig-name"><code>modules</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of the known modules and subpackages conained in the package
documented by this <code>ModuleDoc</code>, sorted by name.</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.ModuleDoc-class.html#imported_variables" class="summary-sig-name"><code>imported_variables</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all variables contained in the module/package documented by
this <code>ModuleDoc</code> that are not defined by that module/package,
sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ModuleDoc-class.html#imported_modules" class="summary-sig-name"><code>imported_modules</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all modules that are imported by the module/package
documented by this <code>ModuleDoc</code>, sorted by name.</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"> Modifiers</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remove_autogenerated_variables"></a><span class="summary-sig"><span class="summary-sig-name">remove_autogenerated_variables</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.ModuleDoc-class.html#add_modules" class="summary-sig-name"><code>add_modules</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>modules</span>)</span></code>
<br />
Register submodules for the package doumented by this
<code>ModuleDoc</code>.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Import Detection</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.ModuleDoc-class.html#_find_defined_vars" class="summary-sig-name"><code>_find_defined_vars</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>lhs_testlist</span>,
<span class=summary-sig-arg>defined_variables</span>)</span></code>
<br />
A helper function for <a
href="../private/epydoc.objdoc.ModuleDoc-class.html#_find_imported_variables"
class="link"><code>_find_imported_variables</code></a>: for every
variable <code><i class="math">v</i></code> set by the given
left-hand-side of an equation, set <code>defined_variables[<i
class="math">v</i>]=1</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.ModuleDoc-class.html#_find_imported_variables" class="summary-sig-name"><code>_find_imported_variables</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
If possible, read the module's python documentation, and try to figure
out which variables were imported.</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.ModuleDoc-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 align="right" valign="top" width="15%"><font size="-1"><code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a></font></td>
<td><b><a href="../private/epydoc.objdoc.ModuleDoc-class.html#_classes"><code>_classes</code></a></b>: A list of all classes contained in the module/package.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a></font></td>
<td><b><a href="../private/epydoc.objdoc.ModuleDoc-class.html#_functions"><code>_functions</code></a></b>: A list of all functions contained in the module/package.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a></font></td>
<td><b><a href="../private/epydoc.objdoc.ModuleDoc-class.html#_modules"><code>_modules</code></a></b>: A list of all modules conained in the package (package only).</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><b><a href="../private/epydoc.objdoc.ModuleDoc-class.html#_variables"><code>_variables</code></a></b>: A list of all variables defined by this module/package.</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#_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><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="../private/epydoc.objdoc.ModuleDoc-class.html#_EXPR_STMT_PATTERN"><code>_EXPR_STMT_PATTERN</code></a></b> = <span title="(264, (265, (266, ['expr_stmt']), (4, '')))"><code>(264, (265, (266, ['expr_stmt']), (<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="../private/epydoc.objdoc.ModuleDoc-class.html#_LHS_PATTERN"><code>_LHS_PATTERN</code></a></b> = <span title="(292, (293, (294, (295, (297, (298, (299, (300, (301, (302, (303, (304, ['lhs_atom']))))))))))))"><code>(292, (293, (294, (295, (297, (298, (299,<span class="variable-ellipsis">...</span></code>
</span></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="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="functions"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">functions</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all functions defined by the module/package
documented by this <code>ModuleDoc</code>.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="classes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">classes</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all classes defined by the module/package documented
by this <code>ModuleDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="variables"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">variables</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all variables defined by the module/package
documented by this <code>ModuleDoc</code>, sorted by name.
<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="imported_functions"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">imported_functions</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all functions contained in the module/package
documented by this <code>ModuleDoc</code> that are not defined by
that module/package, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="imported_classes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">imported_classes</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all classes contained in the module/package
documented by this <code>ModuleDoc</code> that are not defined by
that module/package, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="package"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">package</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The package that contains the module documented by this
<code>ModuleDoc</code>, or <code>None</code> if no package
contains the module.
<br /><i>
(type=<a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a> or <code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="ispackage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">ispackage</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if this <code>ModuleDoc</code> documents a package (not a
module).
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="ismodule"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">ismodule</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if this <code>ModuleDoc</code> documents a module (not a
package).
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="modules"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">modules</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of the known modules and subpackages conained in the
package documented by this <code>ModuleDoc</code>, sorted by
name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>TypeError</b></code> -
If this <code>ModuleDoc</code> does not document a
package.
</dl>
</dd></dl>
</td></tr></table>
<a name="imported_variables"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">imported_variables</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all variables contained in the module/package
documented by this <code>ModuleDoc</code> that are not defined by
that module/package, sorted by name.
<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="imported_modules"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">imported_modules</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all modules that are imported by the module/package
documented by this <code>ModuleDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_modules"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_modules</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>modules</span>)</span>
</h3>
Register submodules for the package doumented by this
<code>ModuleDoc</code>. This must be done externally, since we can't
determine the submodules of a package through introspection alone. This
is automatically called by <a
href="epydoc.objdoc.DocMap-class.html#add"
class="link"><code>DocMap.add</code></a> when new modules are added to
a <code>DocMap</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>modules</b></code> -
A list of modules or subpackages.
<br /><i>
(type=<code>list</code> of <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="_find_defined_vars"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_find_defined_vars</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>lhs_testlist</span>,
<span class=sig-arg>defined_variables</span>)</span>
</h3>
A helper function for <a
href="../private/epydoc.objdoc.ModuleDoc-class.html#_find_imported_variables"
class="link"><code>_find_imported_variables</code></a>: for every
variable <code><i class="math">v</i></code> set by the given
left-hand-side of an equation, set <code>defined_variables[<i
class="math">v</i>]=1</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>lhs_testlist</b></code> -
An AST tuple containing a <code>testlist</code> element from
the left hand side of an equation.
<dd><code><b>defined_variables</b></code> -
The output dictionary.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_find_imported_variables"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_find_imported_variables</span>(<span class=sig-arg>self</span>)</span>
</h3>
If possible, read the module's python documentation, and try to
figure out which variables were imported. To decide which variables
were imported, we use the following heuristic: if a variable isn't
defined in the lhs of a top-level statement, then it's probably
imported. Note that this isn't 100% effective. E.g., if someone uses
<code>global</code>, uses a <code>try</code>/<code>except</code> block,
or directly modifies their modules' <code>__dict__</code>, then we'll
be fooled.
<dl><dt></dt><dd>
<p><b>Bug:</b> If you define class C with method g, and then at the top level you say
'h=C.g', then this method will think that is an imported variable (since
the var's name is derived from its uid, and the uid will be C.g, not
h).
</p>
</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 INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_classes"></a>
<h3>_classes</h3>
A list of all classes contained in the module/package.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_functions"></a>
<h3>_functions</h3>
A list of all functions contained in the module/package.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_modules"></a>
<h3>_modules</h3>
A list of all modules conained in the package (package only).
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_variables"></a>
<h3>_variables</h3>
A list of all variables defined by this module/package.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_EXPR_STMT_PATTERN"></a>
<h3>_EXPR_STMT_PATTERN</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(264, (265, (266, ['expr_stmt']), (4, '')))"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(264, (265, (266, ['expr_stmt']), (4, ''))) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_LHS_PATTERN"></a>
<h3>_LHS_PATTERN</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(292, (293, (294, (295, (297, (298, (299, (300, (301, (302, (303, (304, ['lhs_atom']))))))))))))"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(292,
(293,
(294,
(295,
(297, (298, (299, (300, (301, (302, (303, (304, ['lhs_atom']))))))<span class="variable-linewrap">\</span>
)))))) </pre>
</td></tr></table></dd>
</span> </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:10 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>
|
