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
|
<?xml version="1.0" encoding="ascii"?>
<!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.apidoc</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
Module apidoc
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.apidoc-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module apidoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html">source code</a></span></p>
<p>Classes for encoding API documentation about Python programs. These
classes are used as a common representation for combining information
derived from introspection and from parsing.</p>
<p>The API documentation for a Python program is encoded using a graph of
<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>
objects, each of which encodes information about a single Python variable
or value. <code>APIDoc</code> has two direct subclasses: <a
href="epydoc.apidoc.VariableDoc-class.html" class="link">VariableDoc</a>,
for documenting variables; and <a
href="epydoc.apidoc.ValueDoc-class.html" class="link">ValueDoc</a>, for
documenting values. The <code>ValueDoc</code> class is subclassed
further, to define the different pieces of information that should be
recorded about each value type:</p>
<p></p>
<center><table border="0" cellpadding="0" cellspacing="0" class="graph">
<tr><td align="center">
<map id="class_hierarchy_for_apidoc" name="class_hierarchy_for_apidoc">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="APIDoc" alt="" coords="299,7,368,31" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html" title="ValueDoc" alt="" coords="239,63,319,87" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html" title="VariableDoc" alt="" coords="343,63,436,87" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html" title="ClassDoc" alt="" coords="97,175,175,199" />
<area shape="rect" href="epydoc.apidoc.ClassMethodDoc-class.html" title="ClassMethodDoc" alt="" coords="369,175,492,199" />
<area shape="rect" href="epydoc.apidoc.GenericValueDoc-class.html" title="GenericValueDoc" alt="" coords="5,119,131,143" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html" title="ModuleDoc" alt="" coords="199,175,287,199" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html" title="NamespaceDoc" alt="" coords="155,119,272,143" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html" title="PropertyDoc" alt="" coords="296,119,392,143" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html" title="RoutineDoc" alt="" coords="416,119,507,143" />
<area shape="rect" href="epydoc.apidoc.StaticMethodDoc-class.html" title="StaticMethodDoc" alt="" coords="516,175,639,199" />
</map>
<img src="class_hierarchy_for_apidoc.gif" alt='Class Hierarchy for APIDoc' usemap="#class_hierarchy_for_apidoc" ismap="ismap" class="graph-with-title" />
</td></tr>
<tr><td align='center'>
<span class="graph-title">Class Hierarchy for APIDoc</span>
</td></tr>
</table><br /></center> <p></p>
<p>The distinction between variables and values is intentionally made
explicit. This allows us to distinguish information about a variable
itself (such as whether it should be considered 'public' in its
containing namespace) from information about the value it contains (such
as what type the value has). This distinction is also important because
several variables can contain the same value: each variable should be
described by a separate <code>VariableDoc</code>; but we only need one
<code>ValueDoc</code>, since they share a single value.</p>
<hr />
<div class="fields"> <p><strong>To Do:</strong>
Add a cache to canonical name lookup?
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.DottedName-class.html" class="summary-name">DottedName</a><br />
A sequence of identifiers, separated by periods, used to name a
Python variable, value, or argument.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc._Sentinel-class.html" class="summary-name" onclick="show_private();">_Sentinel</a><br />
A unique value that won't compare equal to any other value.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.APIDoc-class.html" class="summary-name">APIDoc</a><br />
API documentation information for a single element of a Python
program.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.VariableDoc-class.html" class="summary-name">VariableDoc</a><br />
API documentation information about a single Python variable.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.ValueDoc-class.html" class="summary-name">ValueDoc</a><br />
API documentation information about a single Python value.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.GenericValueDoc-class.html" class="summary-name">GenericValueDoc</a><br />
API documentation about a 'generic' value, i.e., one that does not
have its own docstring or any information other than its value and
parse representation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.NamespaceDoc-class.html" class="summary-name">NamespaceDoc</a><br />
API documentation information about a singe Python namespace value.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.ModuleDoc-class.html" class="summary-name">ModuleDoc</a><br />
API documentation information about a single module.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.ClassDoc-class.html" class="summary-name">ClassDoc</a><br />
API documentation information about a single class.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html" class="summary-name">RoutineDoc</a><br />
API documentation information about a single routine.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.ClassMethodDoc-class.html" class="summary-name">ClassMethodDoc</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.StaticMethodDoc-class.html" class="summary-name">StaticMethodDoc</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.PropertyDoc-class.html" class="summary-name">PropertyDoc</a><br />
API documentation information about a single property.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc.DocIndex-class.html" class="summary-name">DocIndex</a><br />
[xx] out of date.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.apidoc-module.html#reachable_valdocs" class="summary-sig-name">reachable_valdocs</a>(<span class="summary-sig-arg">root</span>,
<span class="summary-sig-arg">**filters</span>)</span><br />
Return a list of all <code>ValueDoc</code>s that can be reached,
directly or indirectly from the given root list of
<code>ValueDoc</code>s.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#reachable_valdocs">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_reachable_valdo-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_reachable_valdo-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_reachable_valdo" name="call_graph_for_reachable_valdo">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="559,6,729,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="APIDoc.__hash__()" alt="" coords="559,62,729,94" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" title="ClassDoc.apidoc_links()" alt="" coords="541,118,747,150" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" title="DocIndex.reachable_valdocs()" alt="" coords="7,174,257,206" />
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="307,174,480,206" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#apidoc_links" title="ModuleDoc.apidoc_links()" alt="" coords="532,174,756,206" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links" title="PropertyDoc.apidoc_links()" alt="" coords="529,230,759,262" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#apidoc_links" title="ValueDoc.apidoc_links()" alt="" coords="539,286,749,318" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#apidoc_links" title="VariableDoc.apidoc_links()" alt="" coords="529,342,759,374" />
</map>
<img src="call_graph_for_reachable_valdo.gif" alt='' usemap="#call_graph_for_reachable_valdo" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_flatten"></a><span class="summary-sig-name">_flatten</span>(<span class="summary-sig-arg">lst</span>,
<span class="summary-sig-arg">out</span>=<span class="summary-sig-default">None</span>)</span><br />
Return a flattened version of <code>lst</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#_flatten">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__flatten-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__flatten-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__flatten" name="call_graph_for__flatten">
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#all_args" title="RoutineDoc.all_args()" alt="" coords="7,6,193,38" />
<area shape="rect" href="epydoc.apidoc-module.html#_flatten" title="_flatten()" alt="" coords="244,6,335,38" />
</map>
<img src="call_graph_for__flatten.gif" alt='' usemap="#call_graph_for__flatten" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.apidoc-module.html#pp_apidoc" class="summary-sig-name">pp_apidoc</a>(<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">doublespace</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">depth</span>=<span class="summary-sig-default">5</span>,
<span class="summary-sig-arg">exclude</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="summary-sig-arg">include</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="summary-sig-arg">backpointers</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
A multiline pretty-printed string representation for the given
<code>APIDoc</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#pp_apidoc">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_pp_list"></a><span class="summary-sig-name">_pp_list</span>(<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">items</span>,
<span class="summary-sig-arg">doublespace</span>,
<span class="summary-sig-arg">depth</span>,
<span class="summary-sig-arg">exclude</span>,
<span class="summary-sig-arg">include</span>,
<span class="summary-sig-arg">backpointers</span>,
<span class="summary-sig-arg">is_last</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#_pp_list">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_pp_dict"></a><span class="summary-sig-name">_pp_dict</span>(<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">dict</span>,
<span class="summary-sig-arg">doublespace</span>,
<span class="summary-sig-arg">depth</span>,
<span class="summary-sig-arg">exclude</span>,
<span class="summary-sig-arg">include</span>,
<span class="summary-sig-arg">backpointers</span>,
<span class="summary-sig-arg">is_last</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#_pp_dict">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_pp_apidoc"></a><span class="summary-sig-name">_pp_apidoc</span>(<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">val</span>,
<span class="summary-sig-arg">doublespace</span>,
<span class="summary-sig-arg">depth</span>,
<span class="summary-sig-arg">exclude</span>,
<span class="summary-sig-arg">include</span>,
<span class="summary-sig-arg">backpointers</span>,
<span class="summary-sig-arg">is_last</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#_pp_apidoc">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_pp_val"></a><span class="summary-sig-name">_pp_val</span>(<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">val</span>,
<span class="summary-sig-arg">doublespace</span>,
<span class="summary-sig-arg">depth</span>,
<span class="summary-sig-arg">exclude</span>,
<span class="summary-sig-arg">include</span>,
<span class="summary-sig-arg">backpointers</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#_pp_val">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.apidoc-module.html#UNKNOWN" class="summary-name">UNKNOWN</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A special value used to indicate that a given piece of information
about an object is unknown.
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="reachable_valdocs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">reachable_valdocs</span>(<span class="sig-arg">root</span>,
<span class="sig-arg">**filters</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#reachable_valdocs">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_reachable_valdo-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_reachable_valdo-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_reachable_valdo" name="call_graph_for_reachable_valdo">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="559,6,729,38" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="APIDoc.__hash__()" alt="" coords="559,62,729,94" />
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" title="ClassDoc.apidoc_links()" alt="" coords="541,118,747,150" />
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" title="DocIndex.reachable_valdocs()" alt="" coords="7,174,257,206" />
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="307,174,480,206" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#apidoc_links" title="ModuleDoc.apidoc_links()" alt="" coords="532,174,756,206" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links" title="PropertyDoc.apidoc_links()" alt="" coords="529,230,759,262" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#apidoc_links" title="ValueDoc.apidoc_links()" alt="" coords="539,286,749,318" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#apidoc_links" title="VariableDoc.apidoc_links()" alt="" coords="529,342,759,374" />
</map>
<img src="call_graph_for_reachable_valdo.gif" alt='' usemap="#call_graph_for_reachable_valdo" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return a list of all <code>ValueDoc</code>s that can be reached,
directly or indirectly from the given root list of
<code>ValueDoc</code>s.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filters</code></strong> - A set of filters that can be used to prevent
<code>reachable_valdocs</code> from following specific link types
when looking for <code>ValueDoc</code>s that can be reached from
the root set. See <code>APIDoc.apidoc_links</code> for a more
complete description.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="pp_apidoc"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">pp_apidoc</span>(<span class="sig-arg">api_doc</span>,
<span class="sig-arg">doublespace</span>=<span class="sig-default">0</span>,
<span class="sig-arg">depth</span>=<span class="sig-default">5</span>,
<span class="sig-arg">exclude</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="sig-arg">include</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
<span class="sig-arg">backpointers</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#pp_apidoc">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doublespace</code></strong> - If true, then extra lines will be inserted to make the output
more readable.</li>
<li><strong class="pname"><code>depth</code></strong> - The maximum depth that pp_apidoc will descend into descendent
VarDocs. To put no limit on depth, use <code>depth=-1</code>.</li>
<li><strong class="pname"><code>exclude</code></strong> - A list of names of attributes whose values should not be shown.</li>
<li><strong class="pname"><code>backpointers</code></strong> - For internal use.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>A multiline pretty-printed string representation for the given
<code>APIDoc</code>.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-VariablesDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="UNKNOWN"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">UNKNOWN</h3>
<p>A special value used to indicate that a given piece of information
about an object is unknown. This is used as the default value for all
instance variables.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:05:47 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
