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
|
<?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.PropertyDoc</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> ::
<a href="epydoc.apidoc-module.html">Module apidoc</a> ::
Class PropertyDoc
</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.PropertyDoc-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PropertyDoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html#PropertyDoc">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_epydoc_a_8" name="uml_class_diagram_for_epydoc_a_8">
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html" title="A standard intermediate representation for parsed docstrings that can be used to generate output." alt="" coords="25,723,209,760" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring" title="The documented item's docstring." alt="" coords="363,28,736,47" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring_lineno" title="The line number on which the documented item's docstring begins." alt="" coords="363,47,736,65" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#other_docs" title="A flag indicating if the entire docstring body (except tags if any) is entirely included in the summary." alt="" coords="363,65,736,84" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#metadata" title="Metadata about the documented item, extracted from fields in its docstring." alt="" coords="363,84,736,103" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by" title="Information about where the information contained by this APIDoc came from." alt="" coords="363,103,736,121" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="Construct a new APIDoc object." alt="" coords="363,124,736,143" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__setattr__" title="Modify an APIDoc's attribute." alt="" coords="363,143,736,161" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#pp" title="Return a pretty-printed string representation for the information contained in this APIDoc." alt="" coords="363,161,736,180" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__str__" title="Return a pretty-printed string representation for the information contained in this APIDoc." alt="" coords="363,180,736,199" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="Change self's class to cls." alt="" coords="363,199,736,217" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="hash(x)" alt="" coords="363,217,736,236" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="epydoc.apidoc.APIDoc.__cmp__" alt="" coords="363,236,736,255" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" title="Combine self and other into a merged object, such that any changes made to one will affect the other." alt="" coords="363,255,736,273" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="API documentation information for a single element of a Python program." alt="" coords="351,5,748,280" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="epydoc.apidoc.APIDoc.descr" alt="" coords="49,585,82,599" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="357,180,365,188" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="101,724,109,732" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="epydoc.apidoc.APIDoc.summary" alt="" coords="95,585,151,599" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="357,176,365,184" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="109,724,117,732" />
<area shape="rect" href="epydoc.docstringparser.DocstringField-class.html" title="A simple docstring field, which can be used to describe specific information about an object, such as its author or its version." alt="" coords="163,427,379,464" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="epydoc.apidoc.APIDoc.extra_docstring_fields" alt="" coords="412,291,543,306" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="423,271,431,279" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="279,428,287,436" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval" title="A pointer to the actual Python object described by this ValueDoc." alt="" coords="420,340,679,359" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#parse_repr" title="A text representation of this value, extracted from parsing its source code." alt="" coords="420,359,679,377" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES" title="The maximum number of lines of text that should be generated by pyval_repr()." alt="" coords="420,377,679,396" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN" title="The maximum number of characters for lines of text that should be generated by pyval_repr()." alt="" coords="420,396,679,415" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN" title="The maximum number of characters for the single-line text representation generated by summary_pyval_repr()." alt="" coords="420,415,679,433" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE" title="The minimum score that a value representation based on pyval should have in order to be used instead of parse_repr as the canonical representation for this ValueDoc's value." alt="" coords="420,433,679,452" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#toktree" title="This is currently used to extract values from __all__, etc, in the docparser module; maybe I should specialize process_assignment and extract it there? Although, for __all__, it's not clear where I'd put the value, since I just use it to set private/public/imported attribs on other vars (that might not exist yet at the time.)" alt="" coords="420,452,679,471" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__repr__" title="repr(x)" alt="" coords="420,473,679,492" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__setstate__" title="epydoc.apidoc.ValueDoc.__setstate__" alt="" coords="420,492,679,511" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__getstate__" title="State serializer for the pickle module." alt="" coords="420,511,679,529" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval_repr" title="Return a formatted representation of the Python object described by this ValueDoc." alt="" coords="420,529,679,548" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr" title="Return a single-line formatted representation of the Python object described by this ValueDoc." alt="" coords="420,548,679,567" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html" title="API documentation information about a single Python value." alt="" coords="408,317,691,573" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html" title="API documentation information about a single routine." alt="" coords="496,723,603,760" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links" title="Return a list of all APIDocs that are directly linked from this APIDoc (i.e., are contained or pointed to by one or more of this APIDoc's attributes.)" alt="" coords="469,641,629,660" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#is_detailed" title="Does this object deserve a box with extra details?" alt="" coords="469,660,629,679" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html" title="API documentation information about a single property." alt="" coords="457,611,641,685" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#type_descr" title="epydoc.apidoc.PropertyDoc.type_descr" alt="" coords="333,697,400,711" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#type_descr" title="type_descr" alt="" coords="464,661,472,669" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#type_descr" title="type_descr" alt="" coords="176,724,184,732" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fget" title="epydoc.apidoc.PropertyDoc.fget" alt="" coords="490,697,513,711" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fget" title="fget" alt="" coords="493,676,501,684" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fget" title="fget" alt="" coords="503,724,511,732" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fset" title="epydoc.apidoc.PropertyDoc.fset" alt="" coords="549,697,571,711" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fset" title="fset" alt="" coords="545,676,553,684" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fset" title="fset" alt="" coords="545,724,553,732" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fdel" title="epydoc.apidoc.PropertyDoc.fdel" alt="" coords="573,697,595,711" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fdel" title="fdel" alt="" coords="567,676,575,684" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#fdel" title="fdel" alt="" coords="559,724,567,732" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html" title="A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument." alt="" coords="671,629,783,667" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html" title="API documentation information about a single module." alt="" coords="812,629,916,667" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="epydoc.apidoc.ValueDoc.canonical_name" alt="" coords="601,585,698,599" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="572,564,580,572" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="701,631,709,639" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="epydoc.apidoc.ValueDoc.proxy_for" alt="" coords="707,585,763,599" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="676,555,684,563" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="719,631,727,639" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="epydoc.apidoc.ValueDoc.defining_module" alt="" coords="789,585,888,599" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="676,524,684,532" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="840,631,848,639" />
</map>
<img src="uml_class_diagram_for_epydoc_a_8.gif" alt='' usemap="#uml_class_diagram_for_epydoc_a_8" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>API documentation information about a single property.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
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.PropertyDoc-class.html#apidoc_links" class="summary-sig-name">apidoc_links</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**filters</span>)</span><br />
Return a list of all <code>APIDoc</code>s that are directly linked
from this <code>APIDoc</code> (i.e., are contained or pointed to by
one or more of this <code>APIDoc</code>'s attributes.)</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#PropertyDoc.apidoc_links">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apidoc_links_5-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_apidoc_links_5-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_apidoc_links_5" name="call_graph_for_apidoc_links_5">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="536,34,707,66" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links" title="apidoc_links()" alt="" coords="359,34,487,66" />
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="71,6,244,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="7,62,308,94" />
</map>
<img src="call_graph_for_apidoc_links_5.gif" alt='' usemap="#call_graph_for_apidoc_links_5" 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"><code>bool</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.apidoc.PropertyDoc-class.html#is_detailed" class="summary-sig-name">is_detailed</a>(<span class="summary-sig-arg">self</span>)</span><br />
Does this object deserve a box with extra details?</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#PropertyDoc.is_detailed">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed_4-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_is_detailed_4-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_is_detailed_4" name="call_graph_for_is_detailed_4">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="APIDoc.is_detailed()" alt="" coords="435,6,616,38" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,6,385,38" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,6,221,38" />
</map>
<img src="call_graph_for_is_detailed_4.gif" alt='' usemap="#call_graph_for_is_detailed_4" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#__getstate__">__getstate__</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#__repr__">__repr__</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#__setstate__">__setstate__</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#__cmp__">__cmp__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__hash__">__hash__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__init__">__init__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__setattr__">__setattr__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__str__">__str__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite">merge_and_overwrite</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#pp">pp</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#specialize_to">specialize_to</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b> (private):
<code><a href="epydoc.apidoc.APIDoc-class.html#_debug_setattr" onclick="show_private();">_debug_setattr</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Value Representation</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval_repr">pyval_repr</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr">summary_pyval_repr</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Value Representation</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN">REPR_LINELEN</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES">REPR_MAXLINES</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE">REPR_MIN_SCORE</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN">SUMMARY_REPR_LINELEN</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></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">Instance Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#canonical_name">canonical_name</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#toktree">toktree</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Property Access Functions</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.apidoc.RoutineDoc-class.html"
class="link">RoutineDoc</a></span>
</td><td class="summary">
<a name="fget"></a><span class="summary-name">fget</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
API documentation for the property's get function.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.apidoc.RoutineDoc-class.html"
class="link">RoutineDoc</a></span>
</td><td class="summary">
<a name="fset"></a><span class="summary-name">fset</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
API documentation for the property's set function.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.apidoc.RoutineDoc-class.html"
class="link">RoutineDoc</a></span>
</td><td class="summary">
<a name="fdel"></a><span class="summary-name">fdel</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
API documentation for the property's delete function.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Information Extracted from Docstrings</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.markup.ParsedDocstring-class.html"
class="link">ParsedDocstring</a></span>
</td><td class="summary">
<a name="type_descr"></a><span class="summary-name">type_descr</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A description of the property's expected type, extracted from its
docstring.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#descr">descr</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields">extra_docstring_fields</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#metadata">metadata</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#other_docs">other_docs</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#summary">summary</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Value Representation</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#parse_repr">parse_repr</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval">pyval</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Context</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#defining_module">defining_module</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Information about Imported Variables</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#proxy_for">proxy_for</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Docstrings</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring">docstring</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring_lineno">docstring_lineno</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Source Information</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by">docs_extracted_by</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></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">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="apidoc_links"></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">apidoc_links</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**filters</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#PropertyDoc.apidoc_links">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apidoc_links_5-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_apidoc_links_5-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_apidoc_links_5" name="call_graph_for_apidoc_links_5">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="536,34,707,66" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links" title="apidoc_links()" alt="" coords="359,34,487,66" />
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="71,6,244,38" />
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="7,62,308,94" />
</map>
<img src="call_graph_for_apidoc_links_5.gif" alt='' usemap="#call_graph_for_apidoc_links_5" 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>APIDoc</code>s that are directly linked
from this <code>APIDoc</code> (i.e., are contained or pointed to by one
or more of this <code>APIDoc</code>'s attributes.)</p>
<p>Keyword argument <code>filters</code> can be used to selectively
exclude certain categories of attribute value. For example, using
<code>includes=False</code> will exclude variables that were imported
from other modules; and <code>subclasses=False</code> will exclude
subclasses. The filter categories currently supported by epydoc are:</p>
<ul>
<li>
<code>imports</code>: Imported variables.
</li>
<li>
<code>packages</code>: Containing packages for modules.
</li>
<li>
<code>submodules</code>: Contained submodules for packages.
</li>
<li>
<code>bases</code>: Bases for classes.
</li>
<li>
<code>subclasses</code>: Subclasses for classes.
</li>
<li>
<code>variables</code>: All variables.
</li>
<li>
<code>private</code>: Private variables.
</li>
<li>
<code>overrides</code>: Points from class variables to the variables
they override. This filter is False by default.
</li>
</ul>
<dl class="fields">
<dt>Overrides:
<a href="epydoc.apidoc.APIDoc-class.html#apidoc_links">APIDoc.apidoc_links</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="is_detailed"></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">is_detailed</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#PropertyDoc.is_detailed">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed_4-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_is_detailed_4-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_is_detailed_4" name="call_graph_for_is_detailed_4">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="APIDoc.is_detailed()" alt="" coords="435,6,616,38" />
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,6,385,38" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,6,221,38" />
</map>
<img src="call_graph_for_is_detailed_4.gif" alt='' usemap="#call_graph_for_is_detailed_4" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Does this object deserve a box with extra details?</p>
<dl class="fields">
<dt>Returns: <code>bool</code></dt>
<dd>True if the object needs extra details, else False.</dd>
<dt>Overrides:
<a href="epydoc.apidoc.APIDoc-class.html#is_detailed">APIDoc.is_detailed</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</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:07:25 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>
|
