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
|
<?xml version="1.0" encoding="ascii" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ascii" />
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
<title>Regression Testing for epydoc.docintrospecter</title>
<link rel="stylesheet" href="../custom.css" type="text/css" />
</head>
<body>
<div class="document" id="regression-testing-for-epydoc-docintrospecter">
<h1 class="title">Regression Testing for epydoc.docintrospecter</h1>
<p>The <cite>epydoc.docintrospecter</cite> module is used to extract API documentation
by introspecting Python objects directy. Its primary interface is
<cite>docintrospecter.introspect_docs()</cite>, which takes a Python object, and returns a
<cite>ValueDoc</cite> describing that value.</p>
<div class="section" id="test-function">
<h1>Test Function</h1>
<p>This test function takes a string containing the contents of a module.
It writes the string contents to a file, imports the file as a module,
and uses <cite>docintrospecter.introspect_docs</cite> to introspect it, and pretty prints the resulting
<cite>ModuleDoc</cite> object. The <tt class="docutils literal"><span class="pre">attribs</span></tt> argument specifies which attributes
of the <cite>APIDoc`s should be displayed. The ``introspect`</cite> argument gives the
name of a variable in the module whose value should be introspected,
instead of introspecting the whole module.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> epydoc.test.util <span class="py-keyword">import</span> runintrospecter</pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> epydoc.test.util <span class="py-keyword">import</span> print_warnings
<span class="py-prompt">>>> </span>print_warnings()</pre>
</blockquote>
</div>
<div class="section" id="module-variables">
<h1>Module Variables</h1>
<p>Each variable defined by a module is encoded as a <cite>VariableDoc</cite>, whose
value contains information about the variable's value. This includes
any classes, functions, imported variables, and anything else that has
an entry in a module's dictionary.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> x = 12</span>
<span class="py-more">... </span><span class="py-string"> def f(x): pass</span>
<span class="py-more">... </span><span class="py-string"> class A: pass</span>
<span class="py-more">... </span><span class="py-string"> from os import listdir, mkdir</span>
<span class="py-more">... </span><span class="py-string"> exec("y = 22")</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- A => VariableDoc for epydoc_test.A [1]</span>
<span class="py-output"> +- f => VariableDoc for epydoc_test.f [2]</span>
<span class="py-output"> +- listdir => VariableDoc for epydoc_test.listdir [3]</span>
<span class="py-output"> +- mkdir => VariableDoc for epydoc_test.mkdir [4]</span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.x [5]</span>
<span class="py-output"> +- y => VariableDoc for epydoc_test.y [6]</span></pre>
</blockquote>
<p>If two variables share the same value, then their <cite>VariableDoc</cite>s will
share a <cite>ValueDoc</cite>:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> def f(x): pass</span>
<span class="py-more">... </span><span class="py-string"> alias = f</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables value"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- alias => VariableDoc for epydoc_test.alias [1]</span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- RoutineDoc for epydoc_test.f [2]</span>
<span class="py-output"> +- f => VariableDoc for epydoc_test.f [3]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- RoutineDoc for epydoc_test.f [2] (defined above)</span></pre>
</blockquote>
<p>Importing a dotted name creates a variable for the top-level component
of the dotted name:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> import os.path</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- os => VariableDoc for epydoc_test.os [1]</span></pre>
</blockquote>
<p>Since variables are extracted by introspection, only those variables that
exist when the module finishes running will be seen. (This is
potentially different from <cite>epydoc.docparser</cite>, which has to guess
about which code paths are taken).</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> x = 22</span>
<span class="py-more">... </span><span class="py-string"> if x<13: y = 32</span>
<span class="py-more">... </span><span class="py-string"> else: z = 14</span>
<span class="py-more">... </span><span class="py-string"> del x</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- z => VariableDoc for epydoc_test.z [1]</span></pre>
</blockquote>
<p>Unlike the parser, arbitrary computed values can be extracted:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> def f(x):</span>
<span class="py-more">... </span><span class="py-string"> if x>100: return x</span>
<span class="py-more">... </span><span class="py-string"> else: return f((x+2)*8/7)</span>
<span class="py-more">... </span><span class="py-string"> x = f(12)</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables value pyval"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- pyval = <module 'epydoc_test' from ...</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- f => VariableDoc for epydoc_test.f [1]</span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- RoutineDoc for epydoc_test.f [2]</span>
<span class="py-output"> | +- pyval = <function f at ...></span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.x [3]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- GenericValueDoc [4]</span>
<span class="py-output"> +- pyval = 112</span></pre>
</blockquote>
<p>The introspecter is unable to determine when variables are aliases for
other variables, so it always sets <cite>is_alias</cite> to <cite>UNKNOWN</cite>:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> x = 22</span>
<span class="py-more">... </span><span class="py-string"> y = x</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables is_alias"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.x [1]</span>
<span class="py-output"> | +- is_alias = <UNKNOWN></span>
<span class="py-output"> +- y => VariableDoc for epydoc_test.y [2]</span>
<span class="py-output"> +- is_alias = <UNKNOWN></span></pre>
</blockquote>
<p>Similarly, the introspecter can't always tell if a variable was imported
or not, so it sets <cite>is_imported</cite> to <cite>UNKNOWN</cite> when it can't decide:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> from pickle import dump # definitely imported</span>
<span class="py-more">... </span><span class="py-string"> from pickle import Pickler # definitely imported</span>
<span class="py-more">... </span><span class="py-string"> from pickle import HIGHEST_PROTOCOL # might be imported</span>
<span class="py-more">... </span><span class="py-string"> class A: pass # definitely not imported</span>
<span class="py-more">... </span><span class="py-string"> def f(x): pass # definitely not imported</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">"variables is_imported"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- A => VariableDoc for epydoc_test.A [1]</span>
<span class="py-output"> | +- is_imported = False</span>
<span class="py-output"> +- HIGHEST_PROTOCOL => VariableDoc for epydoc_test.HIGHEST_PROTOCOL [2]</span>
<span class="py-output"> | +- is_imported = <UNKNOWN></span>
<span class="py-output"> +- Pickler => VariableDoc for epydoc_test.Pickler [3]</span>
<span class="py-output"> | +- is_imported = True</span>
<span class="py-output"> +- dump => VariableDoc for epydoc_test.dump [4]</span>
<span class="py-output"> | +- is_imported = True</span>
<span class="py-output"> +- f => VariableDoc for epydoc_test.f [5]</span>
<span class="py-output"> +- is_imported = False</span></pre>
</blockquote>
</div>
<div class="section" id="variable-docstrings">
<h1>Variable Docstrings</h1>
<p>The <cite>docintrospecter</cite> is unable extract docstrings for variables. These
docstrings can only be detected if the <cite>docparser</cite> is used.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> x = 12</span>
<span class="py-more">... </span><span class="py-string"> '''docstring for x.</span>
<span class="py-more">... </span><span class="py-string"> (can be multiline)'''"""</span>,
<span class="py-more">... </span> attribs=<span class="py-string">"variables name docstring"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- docstring = None</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.x [1]</span>
<span class="py-output"> +- docstring = <UNKNOWN></span>
<span class="py-output"> +- name = 'x'</span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> x = 12 #: comment docstring for x"""</span>,
<span class="py-more">... </span> attribs=<span class="py-string">"variables name docstring"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- docstring = None</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.x [1]</span>
<span class="py-output"> +- docstring = <UNKNOWN></span>
<span class="py-output"> +- name = 'x'</span></pre>
</blockquote>
</div>
<div class="section" id="functions">
<h1>Functions</h1>
<p>Introspected functions are represented by <cite>RoutineDoc</cite> objects:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> def f(x):</span>
<span class="py-more">... </span><span class="py-string"> 'docstring for f'</span>
<span class="py-more">... </span><span class="py-string"> print 'inside f'</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"f"</span>, exclude=<span class="py-string">'defining_module'</span>)
<span class="py-output">RoutineDoc for epydoc_test.f [0]</span>
<span class="py-output"> +- canonical_name = DottedName('epydoc_test', 'f')</span>
<span class="py-output"> +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> +- docstring = u'docstring for f'</span>
<span class="py-output"> +- kwarg = None</span>
<span class="py-output"> +- lineno = 2</span>
<span class="py-output"> +- posarg_defaults = [None]</span>
<span class="py-output"> +- posargs = ['x']</span>
<span class="py-output"> +- pyval = <function f at ...></span>
<span class="py-output"> +- vararg = None</span></pre>
</blockquote>
<p>The function's arguments are described by the properties <tt class="docutils literal"><span class="pre">posargs</span></tt>,
<tt class="docutils literal"><span class="pre">posarg_defaults</span></tt>, <tt class="docutils literal"><span class="pre">kwarg</span></tt>, and <tt class="docutils literal"><span class="pre">vararg</span></tt>. <tt class="docutils literal"><span class="pre">posargs</span></tt> is a list of
argument names (or nested tuples of names, for tuple-unpacking args).
<tt class="docutils literal"><span class="pre">posarg_defaults</span></tt> is a list of <cite>ValueDoc</cite>s for default values,
corresponding 1:1 with <tt class="docutils literal"><span class="pre">posargs</span></tt>. <tt class="docutils literal"><span class="pre">posarg_defaults</span></tt> is None for
arguments with no default value. <tt class="docutils literal"><span class="pre">vararg</span></tt> and <tt class="docutils literal"><span class="pre">kwarg</span></tt> are the names
of the variable argument and keyword argument, respectively:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> def f(x, y=22, z=(1,), *v, **kw):</span>
<span class="py-more">... </span><span class="py-string"> 'docstring for f'</span>
<span class="py-more">... </span><span class="py-string"> print 'inside f'</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"f"</span>, exclude=<span class="py-string">'defining_module'</span>)
<span class="py-output">RoutineDoc for epydoc_test.f [0]</span>
<span class="py-output"> +- canonical_name = DottedName('epydoc_test', 'f')</span>
<span class="py-output"> +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> +- docstring = u'docstring for f'</span>
<span class="py-output"> +- kwarg = 'kw'</span>
<span class="py-output"> +- lineno = 2</span>
<span class="py-output"> +- posarg_defaults = [None, <GenericValueDoc 22>, <Generic...</span>
<span class="py-output"> +- posargs = ['x', 'y', 'z']</span>
<span class="py-output"> +- pyval = <function f at ...></span>
<span class="py-output"> +- vararg = 'v'</span></pre>
</blockquote>
<p>Tuple arguments are encoded as a single ArgDoc with a complex name:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> def f( (x, (y,z)) ): pass"""</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value posargs posarg_defaults vararg kwarg'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- f => VariableDoc for epydoc_test.f [1]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- RoutineDoc for epydoc_test.f [2]</span>
<span class="py-output"> +- kwarg = None</span>
<span class="py-output"> +- posarg_defaults = [None]</span>
<span class="py-output"> +- posargs = [['x', ['y', 'z']]]</span>
<span class="py-output"> +- vararg = None</span></pre>
</blockquote>
</div>
<div class="section" id="methods">
<h1>Methods</h1>
<p>Note that the first argument (self) is not listed in the description
of g(), since it's a bound
instance method:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A:</span>
<span class="py-more">... </span><span class="py-string"> def f(self, x): 'docstring'</span>
<span class="py-more">... </span><span class="py-string"> g=A().f</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"g"</span>, exclude=<span class="py-string">'defining_module'</span>)
<span class="py-output">RoutineDoc [0]</span>
<span class="py-output"> +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> +- docstring = u'docstring'</span>
<span class="py-output"> +- kwarg = None</span>
<span class="py-output"> +- lineno = 3</span>
<span class="py-output"> +- posarg_defaults = [None]</span>
<span class="py-output"> +- posargs = ['x']</span>
<span class="py-output"> +- pyval = <bound method A.f of <epydoc_test.A i...</span>
<span class="py-output"> +- vararg = None</span></pre>
</blockquote>
</div>
<div class="section" id="decorators-wrapper-assignments">
<h1>Decorators & Wrapper Assignments</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter( <span class="py-comment"># doctest: +PYTHON2.4</span>
<span class="py-more">... </span> s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> @classmethod</span>
<span class="py-more">... </span><span class="py-string"> def f(cls, x): 'docstring for f'</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"f"</span>)
<span class="py-output">ClassMethodDoc [0]</span>
<span class="py-output"> +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> +- docstring = u'docstring for f'</span>
<span class="py-output"> +- kwarg = None</span>
<span class="py-output"> +- lineno = 2</span>
<span class="py-output"> +- posarg_defaults = [None, None]</span>
<span class="py-output"> +- posargs = ['cls', 'x']</span>
<span class="py-output"> +- pyval = <classmethod object at ...></span>
<span class="py-output"> +- vararg = None</span></pre>
</blockquote>
</div>
<div class="section" id="classes">
<h1>Classes</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A:</span>
<span class="py-more">... </span><span class="py-string"> "no bases"</span>
<span class="py-more">... </span><span class="py-string"> class Nested: "nested class"</span>
<span class="py-more">... </span><span class="py-string"> class B(A): "single base"</span>
<span class="py-more">... </span><span class="py-string"> class C(A,B): "multiple bases"</span>
<span class="py-more">... </span><span class="py-string"> class D( ((A)) ): "extra parens around base"</span>
<span class="py-more">... </span><span class="py-string"> class E(A.Nested): "dotted name"</span>
<span class="py-more">... </span><span class="py-string"> class F(((A).Nested)): "parens with dotted name"</span>
<span class="py-more">... </span><span class="py-string"> class Z(B.__bases__[0]): "calculated base" # not handled!</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value bases docstring'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- docstring = None</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- A => VariableDoc for epydoc_test.A [1]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.A [2]</span>
<span class="py-output"> | +- bases = []</span>
<span class="py-output"> | +- docstring = u'no bases'</span>
<span class="py-output"> | +- variables</span>
<span class="py-output"> | +- Nested => VariableDoc for epydoc_test.A.Nested [3]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc [4]</span>
<span class="py-output"> | +- bases = []</span>
<span class="py-output"> | +- docstring = u'nested class'</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- B => VariableDoc for epydoc_test.B [5]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.B [6]</span>
<span class="py-output"> | +- bases</span>
<span class="py-output"> | | +- ClassDoc for epydoc_test.A [2] (defined above)</span>
<span class="py-output"> | +- docstring = u'single base'</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- C => VariableDoc for epydoc_test.C [7]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.C [8]</span>
<span class="py-output"> | +- bases</span>
<span class="py-output"> | | +- ClassDoc for epydoc_test.A [2] (defined above)</span>
<span class="py-output"> | | +- ClassDoc for epydoc_test.B [6] (defined above)</span>
<span class="py-output"> | +- docstring = u'multiple bases'</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- D => VariableDoc for epydoc_test.D [9]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.D [10]</span>
<span class="py-output"> | +- bases</span>
<span class="py-output"> | | +- ClassDoc for epydoc_test.A [2] (defined above)</span>
<span class="py-output"> | +- docstring = u'extra parens around base'</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- E => VariableDoc for epydoc_test.E [11]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.E [12]</span>
<span class="py-output"> | +- bases</span>
<span class="py-output"> | | +- ClassDoc [4] (defined above)</span>
<span class="py-output"> | +- docstring = u'dotted name'</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- F => VariableDoc for epydoc_test.F [13]</span>
<span class="py-output"> | +- docstring = <UNKNOWN></span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.F [14]</span>
<span class="py-output"> | +- bases</span>
<span class="py-output"> | | +- ClassDoc [4] (defined above)</span>
<span class="py-output"> | +- docstring = u'parens with dotted name'</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- Z => VariableDoc for epydoc_test.Z [15]</span>
<span class="py-output"> +- docstring = <UNKNOWN></span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ClassDoc for epydoc_test.Z [16]</span>
<span class="py-output"> +- bases</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.A [2] (defined above)</span>
<span class="py-output"> +- docstring = u'calculated base'</span>
<span class="py-output"> +- variables = {}</span></pre>
</blockquote>
<p>Some class variable have a special meaning. The <tt class="docutils literal"><span class="pre">__slots__</span></tt> variable isn't
very useful and should be discarded.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class Foo:</span>
<span class="py-more">... </span><span class="py-string"> __slots__ = ['bar']</span>
<span class="py-more">... </span><span class="py-string"> def __init__(self):</span>
<span class="py-more">... </span><span class="py-string"> self.bar = 0</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">"variables name value"</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- Foo => VariableDoc for epydoc_test.Foo [1]</span>
<span class="py-output"> +- name = 'Foo'</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ClassDoc for epydoc_test.Foo [2]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- __init__ => VariableDoc for epydoc_test.Foo.__init__ [3]</span>
<span class="py-output"> +- name = '__init__'</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- RoutineDoc [4]</span></pre>
</blockquote>
</div>
<div class="section" id="delete-statements">
<h1>Delete Statements</h1>
<p>Deleting variables:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> x = y = 12</span>
<span class="py-more">... </span><span class="py-string"> del y</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value repr is_alias'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.x [1]</span>
<span class="py-output"> +- is_alias = <UNKNOWN></span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- GenericValueDoc [2]</span></pre>
</blockquote>
<p>The right-hand side of a <tt class="docutils literal"><span class="pre">del</span></tt> statement may contain a nested
combination of lists, tuples, and parenthases. All variables found
anywhere in this nested structure should be deleted:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> a=b=c=d=e=f=g=1</span>
<span class="py-more">... </span><span class="py-string"> del a</span>
<span class="py-more">... </span><span class="py-string"> del (b)</span>
<span class="py-more">... </span><span class="py-string"> del [c]</span>
<span class="py-more">... </span><span class="py-string"> del (d,)</span>
<span class="py-more">... </span><span class="py-string"> del (((e,)),)</span>
<span class="py-more">... </span><span class="py-string"> del [[[[f]]]]</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- g => VariableDoc for epydoc_test.g [1]</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> a=b=c=d=e=f=g=1</span>
<span class="py-more">... </span><span class="py-string"> del a,b</span>
<span class="py-more">... </span><span class="py-string"> del (c,d)</span>
<span class="py-more">... </span><span class="py-string"> del [e,f]</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- g => VariableDoc for epydoc_test.g [1]</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> a=b=c=d=e=f=g=1</span>
<span class="py-more">... </span><span class="py-string"> del ((a, (((((b, c)), d), [e]))), f)</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- g => VariableDoc for epydoc_test.g [1]</span></pre>
</blockquote>
<p>The right-hand side of a <tt class="docutils literal"><span class="pre">del</span></tt> statement may contain a dotted name, in
which case the named variable should be deleted from its containing
namespace.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A: a = b = 1</span>
<span class="py-more">... </span><span class="py-string"> del A.a</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value local_variables'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- A => VariableDoc for epydoc_test.A [1]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ClassDoc for epydoc_test.A [2]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- b => VariableDoc for epydoc_test.A.b [3]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- GenericValueDoc [4]</span></pre>
</blockquote>
<p>Slice deletes:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> a = b = [1,2,3,4]</span>
<span class="py-more">... </span><span class="py-string"> del a[2]</span>
<span class="py-more">... </span><span class="py-string"> del a[2:]</span>
<span class="py-more">... </span><span class="py-string"> del ([b], a[1])</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- a => VariableDoc for epydoc_test.a [1]</span></pre>
</blockquote>
</div>
<div class="section" id="single-line-blocks">
<h1>Single-Line Blocks</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A: 'docstring for A'</span>
<span class="py-more">...</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value docstring'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- docstring = None</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- A => VariableDoc for epydoc_test.A [1]</span>
<span class="py-output"> +- docstring = <UNKNOWN></span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ClassDoc for epydoc_test.A [2]</span>
<span class="py-output"> +- docstring = u'docstring for A'</span>
<span class="py-output"> +- variables = {}</span></pre>
</blockquote>
</div>
<div class="section" id="imports">
<h1>Imports</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> import pickle</span>
<span class="py-more">... </span><span class="py-string"> from pickle import dump</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value is_imported'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- dump => VariableDoc for epydoc_test.dump [1]</span>
<span class="py-output"> | +- is_imported = True</span>
<span class="py-output"> | +- value</span>
<span class="py-output"> | +- ValueDoc for pickle.dump [2]</span>
<span class="py-output"> +- pickle => VariableDoc for epydoc_test.pickle [3]</span>
<span class="py-output"> +- is_imported = True</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ModuleDoc for pickle [4]</span>
<span class="py-output"> +- variables = {}</span></pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> from __future__ import division</span>
<span class="py-more">... </span><span class="py-string"> from pickle import dump</span>
<span class="py-more">... </span><span class="py-string"> """</span>,
<span class="py-more">... </span> attribs=<span class="py-string">'variables value'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- dump => VariableDoc for epydoc_test.dump [1]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ValueDoc for pickle.dump [2]</span></pre>
</blockquote>
</div>
<div class="section" id="unicode">
<h1>Unicode</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> def f(x):</span>
<span class="py-more">... </span><span class="py-string"> u"unicode in docstring: \u1000"</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"f"</span>, attribs=<span class="py-string">"docstring"</span>)
<span class="py-output">RoutineDoc for epydoc_test.f [0]</span>
<span class="py-output"> +- docstring = u'unicode in docstring: \u1000'</span></pre>
</blockquote>
</div>
<div class="section" id="instance-variables">
<h1>Instance Variables</h1>
<p>DocIntrospecter is unable to discover instance variables:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A:</span>
<span class="py-more">... </span><span class="py-string"> def __init__(self, x, y):</span>
<span class="py-more">... </span><span class="py-string"> self.x = 10</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> self.y = 20 #: docstring for y</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> self.z = 30</span>
<span class="py-more">... </span><span class="py-string"> '''docstring for z'''</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"A"</span>, attribs=<span class="py-string">"variables"</span>)
<span class="py-output">ClassDoc for epydoc_test.A [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- __init__ => VariableDoc for epydoc_test.A.__init__ [1]</span></pre>
</blockquote>
</div>
<div class="section" id="assignments-into-namespaces">
<h1>Assignments Into Namespaces</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A: pass</span>
<span class="py-more">... </span><span class="py-string"> A.x = 22</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"A"</span>, attribs=<span class="py-string">'variables value local_variables'</span>)
<span class="py-output">ClassDoc for epydoc_test.A [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- x => VariableDoc for epydoc_test.A.x [1]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- GenericValueDoc [2]</span></pre>
</blockquote>
</div>
<div class="section" id="recursive-objects">
<h1>Recursive objects</h1>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>x = runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> class A:</span>
<span class="py-more">... </span><span class="py-string"> "A base referring to a child"</span>
<span class="py-more">... </span><span class="py-string"> b = None</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> class B(A):</span>
<span class="py-more">... </span><span class="py-string"> "Its child."</span>
<span class="py-more">... </span><span class="py-string"> pass</span>
<span class="py-more">...</span>
<span class="py-more">... </span><span class="py-string"> A.b = B</span>
<span class="py-more">... </span><span class="py-string"> """</span>, introspect=<span class="py-string">"A"</span>, exclude=<span class="py-string">'defining_module'</span>)
<span class="py-more">... </span> <span class="py-comment"># doctest: +ELLIPSIS</span>
<span class="py-output">ClassDoc for epydoc_test.A [0]</span>
<span class="py-output"> +- bases = []</span>
<span class="py-output"> +- canonical_name = DottedName('epydoc_test', 'A')</span>
<span class="py-output"> +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> +- docstring = u'A base referring to a child'</span>
<span class="py-output"> +- pyval = <class epydoc_test.A at ...></span>
<span class="py-output"> +- subclasses</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.B [1]</span>
<span class="py-output"> | +- bases</span>
<span class="py-output"> | | +- ClassDoc for epydoc_test.A [0] (defined above)</span>
<span class="py-output"> | +- canonical_name = DottedName('epydoc_test', 'B')</span>
<span class="py-output"> | +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> | +- docstring = u'Its child.'</span>
<span class="py-output"> | +- pyval = <class epydoc_test.B at ...></span>
<span class="py-output"> | +- subclasses = []</span>
<span class="py-output"> | +- variables = {}</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- b => VariableDoc for epydoc_test.A.b [2]</span>
<span class="py-output"> +- container</span>
<span class="py-output"> | +- ClassDoc for epydoc_test.A [0] (defined above)</span>
<span class="py-output"> +- docs_extracted_by = 'introspecter'</span>
<span class="py-output"> +- is_public = True</span>
<span class="py-output"> +- name = 'b'</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- ClassDoc for epydoc_test.B [1] (defined above)</span></pre>
</blockquote>
</div>
<div class="section" id="closed-bugs">
<h1>Closed Bugs</h1>
<div class="section" id="sf-bug-1657050-builtins-not-resolved-in-os">
<h2>SF Bug [ 1657050 ] Builtins not resolved in "os"</h2>
<p>If a variable is listed in <tt class="docutils literal"><span class="pre">__all__</span></tt>, then we need to introspect it,
even if we know for certain that it's imported. Before this bug
was fixed, the following test generated a generic <cite>ValueDoc</cite> value
instead of a <cite>RoutineDoc</cite> value, because it didn't introspect the
value of getcwd.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>x = runintrospecter(s=<span class="py-string">"""</span>
<span class="py-more">... </span><span class="py-string"> __all__ = ['getcwd']</span>
<span class="py-more">... </span><span class="py-string"> from os import getcwd</span>
<span class="py-more">... </span><span class="py-string"> """</span>, attribs=<span class="py-string">'variables value'</span>)
<span class="py-output">ModuleDoc for epydoc_test [0]</span>
<span class="py-output"> +- variables</span>
<span class="py-output"> +- getcwd => VariableDoc for epydoc_test.getcwd [1]</span>
<span class="py-output"> +- value</span>
<span class="py-output"> +- RoutineDoc [2]</span></pre>
</blockquote>
</div>
</div>
</div>
<table width="100%" class="navbox" cellpadding="1" cellspacing="0">
<tr>
<a class="nav" href="../index.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../index.html">
Home</a></td></a>
<a class="nav" href="../installing.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../installing.html">
Installing Epydoc</a></td></a>
<a class="nav" href="../using.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../using.html">
Using Epydoc</a></td></a>
<a class="nav" href="../epytext.html">
<td align="center" width="20%" class="nav">
<a class="nav" href="../epytext.html">
Epytext</a></td></a>
<td align="center" width="20%" class="nav">
<A href="http://sourceforge.net/projects/epydoc">
<IMG src="../sflogo.png"
width="88" height="26" border="0" alt="SourceForge"
align="top"/></A></td>
</tr>
</table>
</body>
</html>
|
