1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
|
<?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-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.apidoc-module.html">Module epydoc.apidoc</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># epydoc -- API Documentation Classes</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Copyright (C) 2005 Edward Loper</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Author: Edward Loper <edloper@loper.org></tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># URL: <http://epydoc.sf.net></tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># $Id: apidoc.py 1675 2008-01-29 17:12:56Z edloper $</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">Classes for encoding API documentation about Python programs.</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">These classes are used as a common representation for combining</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">information derived from introspection and from parsing.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">The API documentation for a Python program is encoded using a graph of</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">L{APIDoc} objects, each of which encodes information about a single</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">Python variable or value. C{APIDoc} has two direct subclasses:</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">L{VariableDoc}, for documenting variables; and L{ValueDoc}, for</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">documenting values. The C{ValueDoc} class is subclassed further, to</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">define the different pieces of information that should be recorded</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">about each value type:</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring">G{classtree: APIDoc}</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">The distinction between variables and values is intentionally made</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring">explicit. This allows us to distinguish information about a variable</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring">itself (such as whether it should be considered 'public' in its</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring">containing namespace) from information about the value it contains</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring">(such as what type the value has). This distinction is also important</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring">because several variables can contain the same value: each variable</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring">should be described by a separate C{VariableDoc}; but we only need one</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring">C{ValueDoc}, since they share a single value.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring">@todo: Add a cache to canonical name lookup?</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Imports</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">types</tt><tt class="py-op">,</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.path=epydoc.apidoc.ModuleDoc-class.html#path"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-0', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">pickle</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-1', 'epydoc', 'link-1');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Method epydoc.cli.ConsoleLogger.log()=epydoc.cli.ConsoleLogger-class.html#log,Method epydoc.cli.HTMLLogger.log()=epydoc.cli.HTMLLogger-class.html#log,Method epydoc.gui.GUILogger.log()=epydoc.gui.GUILogger-class.html#log,Module epydoc.log=epydoc.log-module.html,Method epydoc.log.Logger.log()=epydoc.log.Logger-class.html#log,Method epydoc.log.SimpleLogger.log()=epydoc.log.SimpleLogger-class.html#log"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-2', 'log', 'link-2');">log</a></tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-3" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-3', 'epydoc', 'link-1');">epydoc</a></tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">__builtin__</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-4" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-4', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Module epydoc.compat=epydoc.compat-module.html"><a title="epydoc.compat" class="py-name" href="#" onclick="return doclink('link-5', 'compat', 'link-5');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> <tt class="py-comment"># Backwards compatibility</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-6" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-6', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Module epydoc.test.util=epydoc.test.util-module.html,Module epydoc.util=epydoc.util-module.html"><a title="epydoc.test.util
epydoc.util" class="py-name" href="#" onclick="return doclink('link-7', 'util', 'link-7');">util</a></tt> <tt class="py-keyword">import</tt> <tt id="link-8" class="py-name" targets="Function epydoc.util.decode_with_backslashreplace()=epydoc.util-module.html#decode_with_backslashreplace"><a title="epydoc.util.decode_with_backslashreplace" class="py-name" href="#" onclick="return doclink('link-8', 'decode_with_backslashreplace', 'link-8');">decode_with_backslashreplace</a></tt><tt class="py-op">,</tt> <tt id="link-9" class="py-name" targets="Function epydoc.util.py_src_filename()=epydoc.util-module.html#py_src_filename"><a title="epydoc.util.py_src_filename" class="py-name" href="#" onclick="return doclink('link-9', 'py_src_filename', 'link-9');">py_src_filename</a></tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-10" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-10', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Package epydoc.markup=epydoc.markup-module.html,Method epydoc.markup.doctest.DoctestColorizer.markup()=epydoc.markup.doctest.DoctestColorizer-class.html#markup,Method epydoc.markup.doctest.HTMLDoctestColorizer.markup()=epydoc.markup.doctest.HTMLDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.LaTeXDoctestColorizer.markup()=epydoc.markup.doctest.LaTeXDoctestColorizer-class.html#markup,Method epydoc.markup.doctest.XMLDoctestColorizer.markup()=epydoc.markup.doctest.XMLDoctestColorizer-class.html#markup"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-11', 'markup', 'link-11');">markup</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method epydoc.apidoc.ValueDoc.pyval_repr()=epydoc.apidoc.ValueDoc-class.html#pyval_repr,Module epydoc.markup.pyval_repr=epydoc.markup.pyval_repr-module.html"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-12', 'pyval_repr', 'link-12');">pyval_repr</a></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Dotted Names</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DottedName"></a><div id="DottedName-def"><a name="L53"></a><tt class="py-lineno"> 53</tt> <a class="py-toggle" href="#" id="DottedName-toggle" onclick="return toggle('DottedName');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html">DottedName</a><tt class="py-op">:</tt> </tt>
</div><div id="DottedName-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="DottedName-expanded"><a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> A sequence of identifiers, separated by periods, used to name a</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> Python variable, value, or argument. The identifiers that make up</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> a dotted name can be accessed using the indexing operator:</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> >>> name = DottedName('epydoc', 'api_doc', 'DottedName')</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> >>> print name</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> epydoc.apidoc.DottedName</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> >>> name[1]</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> 'api_doc'</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt id="link-13" class="py-name" targets="Variable epydoc.apidoc.DottedName.UNREACHABLE=epydoc.apidoc.DottedName-class.html#UNREACHABLE"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-13', 'UNREACHABLE', 'link-13');">UNREACHABLE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"??"</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt id="link-14" class="py-name" targets="Variable epydoc.apidoc.DottedName._IDENTIFIER_RE=epydoc.apidoc.DottedName-class.html#_IDENTIFIER_RE"><a title="epydoc.apidoc.DottedName._IDENTIFIER_RE" class="py-name" href="#" onclick="return doclink('link-14', '_IDENTIFIER_RE', 'link-14');">_IDENTIFIER_RE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">"""(?x)</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-string"> (%s | # UNREACHABLE marker, or..</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-string"> (script-)? # Prefix: script (not a module)</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-string"> \w+ # Identifier (yes, identifiers starting with a</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-string"> # digit are allowed. See SF bug #1649347)</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-string"> '?) # Suffix: submodule that is shadowed by a var</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-string"> (-\d+)? # Suffix: unreachable vals with the same name</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-string"> $"""</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-op">%</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">escape</tt><tt class="py-op">(</tt><tt id="link-15" class="py-name"><a title="epydoc.apidoc.DottedName.UNREACHABLE" class="py-name" href="#" onclick="return doclink('link-15', 'UNREACHABLE', 'link-13');">UNREACHABLE</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> </tt>
<a name="DottedName.InvalidDottedName"></a><div id="DottedName.InvalidDottedName-def"><a name="L76"></a><tt class="py-lineno"> 76</tt> <a class="py-toggle" href="#" id="DottedName.InvalidDottedName-toggle" onclick="return toggle('DottedName.InvalidDottedName');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName.InvalidDottedName-class.html">InvalidDottedName</a><tt class="py-op">(</tt><tt class="py-base-class">ValueError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.InvalidDottedName-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.InvalidDottedName-expanded"><a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> An exception raised by the DottedName constructor when one of</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> its arguments is not a valid dotted name.</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt id="link-16" class="py-name" targets="Variable epydoc.apidoc.DottedName._ok_identifiers=epydoc.apidoc.DottedName-class.html#_ok_identifiers"><a title="epydoc.apidoc.DottedName._ok_identifiers" class="py-name" href="#" onclick="return doclink('link-16', '_ok_identifiers', 'link-16');">_ok_identifiers</a></tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-string">"""A cache of identifier strings that have been checked against</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-string"> _IDENTIFIER_RE and found to be acceptable."""</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> </tt>
<a name="DottedName.__init__"></a><div id="DottedName.__init__-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="DottedName.__init__-toggle" onclick="return toggle('DottedName.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">pieces</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">options</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__init__-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> Construct a new dotted name from the given sequence of pieces,</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> each of which can be either a C{string} or a C{DottedName}.</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> Each piece is divided into a sequence of identifiers, and</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> these sequences are combined together (in order) to form the</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> identifier sequence for the new C{DottedName}. If a piece</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> contains a string, then it is divided into substrings by</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> splitting on periods, and each substring is checked to see if</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> it is a valid identifier.</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> As an optimization, C{pieces} may also contain a single tuple</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> of values. In that case, that tuple will be used as the</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> C{DottedName}'s identifiers; it will I{not} be checked to</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"><tt class="py-docstring"> see if it's valid.</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt class="py-docstring"> @kwparam strict: if true, then raise an L{InvalidDottedName}</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"><tt class="py-docstring"> if the given name is invalid.</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">pieces</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">pieces</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">tuple</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt> <tt class="py-op">=</tt> <tt class="py-name">pieces</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-comment"># Optimization</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">pieces</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-17" class="py-name" targets="Class epydoc.apidoc.DottedName=epydoc.apidoc.DottedName-class.html"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-17', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Class epydoc.apidoc.DottedName.InvalidDottedName=epydoc.apidoc.DottedName.InvalidDottedName-class.html"><a title="epydoc.apidoc.DottedName.InvalidDottedName" class="py-name" href="#" onclick="return doclink('link-18', 'InvalidDottedName', 'link-18');">InvalidDottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'Empty DottedName'</tt><tt class="py-op">)</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">piece</tt> <tt class="py-keyword">in</tt> <tt class="py-name">pieces</tt><tt class="py-op">:</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">piece</tt><tt class="py-op">,</tt> <tt id="link-19" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-19', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt> <tt class="py-op">+=</tt> <tt class="py-name">piece</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">piece</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">subpiece</tt> <tt class="py-keyword">in</tt> <tt class="py-name">piece</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">piece</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="epydoc.apidoc.DottedName._ok_identifiers" class="py-name" href="#" onclick="return doclink('link-20', '_ok_identifiers', 'link-16');">_ok_identifiers</a></tt><tt class="py-op">:</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="epydoc.apidoc.DottedName._IDENTIFIER_RE" class="py-name" href="#" onclick="return doclink('link-21', '_IDENTIFIER_RE', 'link-14');">_IDENTIFIER_RE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">subpiece</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">options</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'strict'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-22" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-22', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="epydoc.apidoc.DottedName.InvalidDottedName" class="py-name" href="#" onclick="return doclink('link-23', 'InvalidDottedName', 'link-18');">InvalidDottedName</a></tt><tt class="py-op">(</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"> <tt class="py-string">'Bad identifier %r'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">piece</tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> <tt id="link-24" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-24', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-25', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Identifier %r looks suspicious; "</tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"> <tt class="py-string">"using it anyway."</tt> <tt class="py-op">%</tt> <tt class="py-name">piece</tt><tt class="py-op">)</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="epydoc.apidoc.DottedName._ok_identifiers" class="py-name" href="#" onclick="return doclink('link-26', '_ok_identifiers', 'link-16');">_ok_identifiers</a></tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">piece</tt><tt class="py-op">)</tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">subpiece</tt><tt class="py-op">)</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad identifier %r: expected '</tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"> <tt class="py-string">'DottedName or str'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">piece</tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt> <tt class="py-op">=</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
</div><a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"> </tt>
<a name="DottedName.__repr__"></a><div id="DottedName.__repr__-def"><a name="L131"></a><tt class="py-lineno"> 131</tt> <a class="py-toggle" href="#" id="DottedName.__repr__-toggle" onclick="return toggle('DottedName.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__repr__-expanded"><a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"> <tt class="py-name">idents</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">`</tt><tt class="py-name">ident</tt><tt class="py-op">`</tt> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">]</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'DottedName('</tt> <tt class="py-op">+</tt> <tt class="py-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">idents</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">')'</tt> </tt>
</div><a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"> </tt>
<a name="DottedName.__str__"></a><div id="DottedName.__str__-def"><a name="L135"></a><tt class="py-lineno"> 135</tt> <a class="py-toggle" href="#" id="DottedName.__str__-toggle" onclick="return toggle('DottedName.__str__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__str__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__str__-expanded"><a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-docstring"> Return the dotted name as a string formed by joining its</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"><tt class="py-docstring"> identifiers with periods:</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"><tt class="py-docstring"> >>> print DottedName('epydoc', 'api_doc', DottedName')</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"><tt class="py-docstring"> epydoc.apidoc.DottedName</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'.'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
</div><a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"> </tt>
<a name="DottedName.__add__"></a><div id="DottedName.__add__-def"><a name="L145"></a><tt class="py-lineno"> 145</tt> <a class="py-toggle" href="#" id="DottedName.__add__-toggle" onclick="return toggle('DottedName.__add__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__add__">__add__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__add__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__add__-expanded"><a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"><tt class="py-docstring"> Return a new C{DottedName} whose identifier sequence is formed</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt class="py-docstring"> by adding C{other}'s identifier sequence to C{self}'s.</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">basestring</tt><tt class="py-op">,</tt> <tt id="link-27" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-27', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-28" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-28', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">other</tt><tt class="py-op">)</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-29" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-29', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">other</tt><tt class="py-op">)</tt> </tt>
</div><a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"> </tt>
<a name="DottedName.__radd__"></a><div id="DottedName.__radd__-def"><a name="L155"></a><tt class="py-lineno"> 155</tt> <a class="py-toggle" href="#" id="DottedName.__radd__-toggle" onclick="return toggle('DottedName.__radd__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__radd__">__radd__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__radd__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__radd__-expanded"><a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-docstring"> Return a new C{DottedName} whose identifier sequence is formed</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"><tt class="py-docstring"> by adding C{self}'s identifier sequence to C{other}'s.</tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">basestring</tt><tt class="py-op">,</tt> <tt id="link-30" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-30', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-31" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-31', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-32" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-32', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"> </tt>
<a name="DottedName.__getitem__"></a><div id="DottedName.__getitem__-def"><a name="L165"></a><tt class="py-lineno"> 165</tt> <a class="py-toggle" href="#" id="DottedName.__getitem__-toggle" onclick="return toggle('DottedName.__getitem__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__getitem__">__getitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">i</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__getitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__getitem__-expanded"><a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-docstring"> Return the C{i}th identifier in this C{DottedName}. If C{i} is</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-docstring"> a non-empty slice, then return a C{DottedName} built from the</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-docstring"> identifiers selected by the slice. If C{i} is an empty slice,</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-docstring"> return an empty list (since empty C{DottedName}s are not valid).</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">SliceType</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">start</tt><tt class="py-op">:</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">stop</tt><tt class="py-op">]</tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pieces</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-33" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-33', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">pieces</tt><tt class="py-op">)</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
</div><a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"> </tt>
<a name="DottedName.__hash__"></a><div id="DottedName.__hash__-def"><a name="L179"></a><tt class="py-lineno"> 179</tt> <a class="py-toggle" href="#" id="DottedName.__hash__-toggle" onclick="return toggle('DottedName.__hash__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__hash__">__hash__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__hash__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__hash__-expanded"><a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">hash</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
</div><a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"> </tt>
<a name="DottedName.__cmp__"></a><div id="DottedName.__cmp__-def"><a name="L182"></a><tt class="py-lineno"> 182</tt> <a class="py-toggle" href="#" id="DottedName.__cmp__-toggle" onclick="return toggle('DottedName.__cmp__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__cmp__">__cmp__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__cmp__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__cmp__-expanded"><a name="L183"></a><tt class="py-lineno"> 183</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt> <tt class="py-line"><tt class="py-docstring"> Compare this dotted name to C{other}. Two dotted names are</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> considered equal if their identifier subsequences are equal.</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> Ordering between dotted names is lexicographic, in order of</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> identifier from left to right.</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt id="link-34" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-34', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cmp</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">,</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
</div><a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"> </tt>
<a name="DottedName.__len__"></a><div id="DottedName.__len__-def"><a name="L193"></a><tt class="py-lineno"> 193</tt> <a class="py-toggle" href="#" id="DottedName.__len__-toggle" onclick="return toggle('DottedName.__len__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#__len__">__len__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.__len__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.__len__-expanded"><a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> Return the number of identifiers in this dotted name.</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
</div><a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"> </tt>
<a name="DottedName.container"></a><div id="DottedName.container-def"><a name="L199"></a><tt class="py-lineno"> 199</tt> <a class="py-toggle" href="#" id="DottedName.container-toggle" onclick="return toggle('DottedName.container');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#container">container</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.container-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.container-expanded"><a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-docstring"> Return the DottedName formed by removing the last identifier</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-docstring"> from this dotted name's identifier sequence. If this dotted</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-docstring"> name only has one name in its identifier sequence, return</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt class="py-docstring"> C{None} instead.</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-35" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-35', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> </tt>
<a name="DottedName.dominates"></a><div id="DottedName.dominates-def"><a name="L211"></a><tt class="py-lineno"> 211</tt> <a class="py-toggle" href="#" id="DottedName.dominates-toggle" onclick="return toggle('DottedName.dominates');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#dominates">dominates</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">strict</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.dominates-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.dominates-expanded"><a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"><tt class="py-docstring"> Return true if this dotted name is equal to a prefix of</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-docstring"> C{name}. If C{strict} is true, then also require that</tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"><tt class="py-docstring"> C{self!=name}.</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"><tt class="py-docstring"> >>> DottedName('a.b').dominates(DottedName('a.b.c.d'))</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"><tt class="py-docstring"> True</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-name">len_self</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
<a name="L221"></a><tt class="py-lineno"> 221</tt> <tt class="py-line"> <tt class="py-name">len_name</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-36" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.name=epydoc.apidoc.VariableDoc-class.html#name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-36', 'name', 'link-36');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">)</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len_self</tt> <tt class="py-op">></tt> <tt class="py-name">len_name</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-op">(</tt><tt class="py-name">strict</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len_self</tt> <tt class="py-op">==</tt> <tt class="py-name">len_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"> <tt class="py-comment"># The following is redundant (the first clause is implied by</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the second), but is done as an optimization.</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt id="link-37" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-37', 'name', 'link-36');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt> <tt class="py-op">==</tt> <tt id="link-38" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-38', 'name', 'link-36');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">len_self</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> </tt>
<a name="DottedName.contextualize"></a><div id="DottedName.contextualize-def"><a name="L230"></a><tt class="py-lineno"> 230</tt> <a class="py-toggle" href="#" id="DottedName.contextualize-toggle" onclick="return toggle('DottedName.contextualize');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DottedName-class.html#contextualize">contextualize</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DottedName.contextualize-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DottedName.contextualize-expanded"><a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"><tt class="py-docstring"> If C{self} and C{context} share a common ancestor, then return</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-docstring"> a name for C{self}, relative to that ancestor. If they do not</tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"><tt class="py-docstring"> share a common ancestor (or if C{context} is C{UNKNOWN}), then</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"><tt class="py-docstring"> simply return C{self}.</tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"><tt class="py-docstring"> This is used to generate shorter versions of dotted names in</tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"><tt class="py-docstring"> cases where users can infer the intended target from the</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-docstring"> context.</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-docstring"> @type context: L{DottedName}</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{DottedName}</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt id="link-39" class="py-name" targets="Variable epydoc.apidoc.UNKNOWN=epydoc.apidoc-module.html#UNKNOWN"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-39', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">context</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> <tt class="py-op"><=</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">context</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method epydoc.apidoc.DottedName.contextualize()=epydoc.apidoc.DottedName-class.html#contextualize"><a title="epydoc.apidoc.DottedName.contextualize" class="py-name" href="#" onclick="return doclink('link-40', 'contextualize', 'link-40');">contextualize</a></tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> <tt class="py-comment"># Find the first index where self & context differ.</tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt class="py-name">_identifiers</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt> <tt class="py-line"> <tt class="py-name">first_difference</tt> <tt class="py-op">=</tt> <tt class="py-name">i</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt> <tt class="py-line"> <tt class="py-name">first_difference</tt> <tt class="py-op">=</tt> <tt class="py-name">i</tt><tt class="py-op">+</tt><tt class="py-number">1</tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt> <tt class="py-line"> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt> <tt class="py-line"> <tt class="py-comment"># Strip off anything before that index.</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">first_difference</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">first_difference</tt> <tt class="py-op">==</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">first_difference</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
</div></div><a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># UNKNOWN Value</tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="_Sentinel"></a><div id="_Sentinel-def"><a name="L271"></a><tt class="py-lineno"> 271</tt> <a class="py-toggle" href="#" id="_Sentinel-toggle" onclick="return toggle('_Sentinel');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc._Sentinel-class.html">_Sentinel</a><tt class="py-op">:</tt> </tt>
</div><div id="_Sentinel-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_Sentinel-expanded"><a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"><tt class="py-docstring"> A unique value that won't compare equal to any other value. This</tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"><tt class="py-docstring"> class is used to create L{UNKNOWN}.</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="_Sentinel.__init__"></a><div id="_Sentinel.__init__-def"><a name="L276"></a><tt class="py-lineno"> 276</tt> <a class="py-toggle" href="#" id="_Sentinel.__init__-toggle" onclick="return toggle('_Sentinel.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc._Sentinel-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_Sentinel.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_Sentinel.__init__-expanded"><a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-41', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-42" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-42', 'name', 'link-36');">name</a></tt> </tt>
</div><a name="_Sentinel.__repr__"></a><div id="_Sentinel.__repr__-def"><a name="L278"></a><tt class="py-lineno"> 278</tt> <a class="py-toggle" href="#" id="_Sentinel.__repr__-toggle" onclick="return toggle('_Sentinel.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc._Sentinel-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_Sentinel.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_Sentinel.__repr__-expanded"><a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-43', 'name', 'link-36');">name</a></tt> </tt>
</div><a name="_Sentinel.__nonzero__"></a><div id="_Sentinel.__nonzero__-def"><a name="L280"></a><tt class="py-lineno"> 280</tt> <a class="py-toggle" href="#" id="_Sentinel.__nonzero__-toggle" onclick="return toggle('_Sentinel.__nonzero__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc._Sentinel-class.html#__nonzero__">__nonzero__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_Sentinel.__nonzero__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="_Sentinel.__nonzero__-expanded"><a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Sentinel value <%s> can not be used as a boolean'</tt> <tt class="py-op">%</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-44', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"><tt id="link-45" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-45', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-op">=</tt> <tt id="link-46" class="py-name" targets="Class epydoc.apidoc._Sentinel=epydoc.apidoc._Sentinel-class.html"><a title="epydoc.apidoc._Sentinel" class="py-name" href="#" onclick="return doclink('link-46', '_Sentinel', 'link-46');">_Sentinel</a></tt><tt class="py-op">(</tt><tt class="py-string">'UNKNOWN'</tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"><tt class="py-string">"""A special value used to indicate that a given piece of</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"><tt class="py-string">information about an object is unknown. This is used as the</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"><tt class="py-string">default value for all instance variables."""</tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># API Documentation Objects: Abstract Base Classes</tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="APIDoc"></a><div id="APIDoc-def"><a name="L293"></a><tt class="py-lineno"> 293</tt> <a class="py-toggle" href="#" id="APIDoc-toggle" onclick="return toggle('APIDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html">APIDoc</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="APIDoc-expanded"><a name="L294"></a><tt class="py-lineno"> 294</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information for a single element of a Python</tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"><tt class="py-docstring"> program. C{APIDoc} itself is an abstract base class; subclasses</tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt> <tt class="py-line"><tt class="py-docstring"> are used to specify what information should be recorded about each</tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"><tt class="py-docstring"> type of program element. In particular, C{APIDoc} has two direct</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> subclasses, C{VariableDoc} for documenting variables and</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"> C{ValueDoc} for documenting values; and the C{ValueDoc} class is</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> subclassed further for different value types.</tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt> <tt class="py-line"><tt class="py-docstring"> Each C{APIDoc} subclass specifies the set of attributes that</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"><tt class="py-docstring"> should be used to record information about the corresponding</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"><tt class="py-docstring"> program element type. The default value for each attribute is</tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"><tt class="py-docstring"> stored in the class; these default values can then be overridden</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"><tt class="py-docstring"> with instance variables. Most attributes use the special value</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"><tt class="py-docstring"> L{UNKNOWN} as their default value, to indicate that the correct</tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"><tt class="py-docstring"> value for that attribute has not yet been determined. This makes</tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"><tt class="py-docstring"> it easier to merge two C{APIDoc} objects that are documenting the</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-docstring"> same element (in particular, to merge information about an element</tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt> <tt class="py-line"><tt class="py-docstring"> that was derived from parsing with information that was derived</tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"><tt class="py-docstring"> from introspection).</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"><tt class="py-docstring"> For all attributes with boolean values, use only the constants</tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"><tt class="py-docstring"> C{True} and C{False} to designate true and false. In particular,</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt> <tt class="py-line"><tt class="py-docstring"> do I{not} use other values that evaluate as true or false, such as</tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"><tt class="py-docstring"> C{2} or C{()}. This restriction makes it easier to handle</tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"><tt class="py-docstring"> C{UNKNOWN} values. For example, to test if a boolean attribute is</tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"><tt class="py-docstring"> C{True} or C{UNKNOWN}, use 'C{attrib in (True, UNKNOWN)}' or</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"><tt class="py-docstring"> 'C{attrib is not False}'.</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"><tt class="py-docstring"> Two C{APIDoc} objects describing the same object can be X{merged},</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"><tt class="py-docstring"> using the method L{merge_and_overwrite(other)}. After two</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"><tt class="py-docstring"> C{APIDoc}s are merged, any changes to one will be reflected in the</tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"><tt class="py-docstring"> other. This is accomplished by setting the two C{APIDoc} objects</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"><tt class="py-docstring"> to use a shared instance dictionary. See the documentation for</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt> <tt class="py-line"><tt class="py-docstring"> L{merge_and_overwrite} for more information, and some important</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"><tt class="py-docstring"> caveats about hashing.</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-comment">#{ Docstrings</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-47" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring=epydoc.apidoc.APIDoc-class.html#docstring"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-47', 'docstring', 'link-47');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-48" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-48', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The documented item's docstring.</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-string"> @type: C{string} or C{None}"""</tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt> <tt class="py-line"> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt id="link-49" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring_lineno=epydoc.apidoc.APIDoc-class.html#docstring_lineno"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-49', 'docstring_lineno', 'link-49');">docstring_lineno</a></tt> <tt class="py-op">=</tt> <tt id="link-50" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-50', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The line number on which the documented item's docstring</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"><tt class="py-string"> begins.</tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"><tt class="py-string"> @type: C{int}"""</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"> <tt class="py-comment">#} end of "docstrings" group</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-comment">#{ Information Extracted from Docstrings</tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-51" class="py-name" targets="Variable epydoc.apidoc.APIDoc.descr=epydoc.apidoc.APIDoc-class.html#descr,Variable epydoc.cli.descr=epydoc.cli-module.html#descr,Method epydoc.docwriter.html.HTMLWriter.descr()=epydoc.docwriter.html.HTMLWriter-class.html#descr,Method epydoc.markup.ParseError.descr()=epydoc.markup.ParseError-class.html#descr,Method epydoc.markup.epytext.ColorizingError.descr()=epydoc.markup.epytext.ColorizingError-class.html#descr"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-51', 'descr', 'link-51');">descr</a></tt> <tt class="py-op">=</tt> <tt id="link-52" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-52', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A description of the documented item, extracted from its</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"><tt class="py-string"> docstring.</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"><tt class="py-string"> @type: L{ParsedDocstring<epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> <tt id="link-53" class="py-name" targets="Variable epydoc.apidoc.APIDoc.summary=epydoc.apidoc.APIDoc-class.html#summary,Method epydoc.docwriter.html.HTMLWriter.summary()=epydoc.docwriter.html.HTMLWriter-class.html#summary,Method epydoc.markup.ConcatenatedDocstring.summary()=epydoc.markup.ConcatenatedDocstring-class.html#summary,Method epydoc.markup.ParsedDocstring.summary()=epydoc.markup.ParsedDocstring-class.html#summary,Method epydoc.markup.epytext.ParsedEpytextDocstring.summary()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#summary,Method epydoc.markup.javadoc.ParsedJavadocDocstring.summary()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#summary,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.summary()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#summary,Method epydoc.markup.restructuredtext.ParsedRstDocstring.summary()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#summary"><a title="epydoc.apidoc.APIDoc.summary
epydoc.docwriter.html.HTMLWriter.summary
epydoc.markup.ConcatenatedDocstring.summary
epydoc.markup.ParsedDocstring.summary
epydoc.markup.epytext.ParsedEpytextDocstring.summary
epydoc.markup.javadoc.ParsedJavadocDocstring.summary
epydoc.markup.plaintext.ParsedPlaintextDocstring.summary
epydoc.markup.restructuredtext.ParsedRstDocstring.summary" class="py-name" href="#" onclick="return doclink('link-53', 'summary', 'link-53');">summary</a></tt> <tt class="py-op">=</tt> <tt id="link-54" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-54', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A summary description of the documented item, extracted from</tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"><tt class="py-string"> its docstring.</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt> <tt class="py-line"><tt class="py-string"> @type: L{ParsedDocstring<epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt id="link-55" class="py-name" targets="Variable epydoc.apidoc.APIDoc.other_docs=epydoc.apidoc.APIDoc-class.html#other_docs"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-55', 'other_docs', 'link-55');">other_docs</a></tt> <tt class="py-op">=</tt> <tt id="link-56" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-56', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A flag indicating if the entire L{docstring} body (except tags</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"><tt class="py-string"> if any) is entirely included in the L{summary}.</tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"><tt class="py-string"> @type: C{bool}"""</tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"> <tt id="link-57" class="py-name" targets="Variable epydoc.apidoc.APIDoc.metadata=epydoc.apidoc.APIDoc-class.html#metadata"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-57', 'metadata', 'link-57');">metadata</a></tt> <tt class="py-op">=</tt> <tt id="link-58" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-58', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Metadata about the documented item, extracted from fields in</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"><tt class="py-string"> its docstring. I{Currently} this is encoded as a list of tuples</tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt> <tt class="py-line"><tt class="py-string"> C{(field, arg, descr)}. But that may change.</tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"><tt class="py-string"> @type: C{(str, str, L{ParsedDocstring<markup.ParsedDocstring>})}"""</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"> <tt id="link-59" class="py-name" targets="Variable epydoc.apidoc.APIDoc.extra_docstring_fields=epydoc.apidoc.APIDoc-class.html#extra_docstring_fields"><a title="epydoc.apidoc.APIDoc.extra_docstring_fields" class="py-name" href="#" onclick="return doclink('link-59', 'extra_docstring_fields', 'link-59');">extra_docstring_fields</a></tt> <tt class="py-op">=</tt> <tt id="link-60" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-60', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A list of new docstring fields tags that are defined by the</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"><tt class="py-string"> documented item's docstring. These new field tags can be used by</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"><tt class="py-string"> this item or by any item it contains.</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-string"> @type: L{DocstringField <epydoc.docstringparser.DocstringField>}"""</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information extracted from docstrings" group</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt class="py-comment">#{ Source Information</tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-61" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docs_extracted_by=epydoc.apidoc.APIDoc-class.html#docs_extracted_by"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-61', 'docs_extracted_by', 'link-61');">docs_extracted_by</a></tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-62', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-comment"># 'parser' or 'introspecter' or 'both'</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Information about where the information contained by this</tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"><tt class="py-string"> C{APIDoc} came from. Can be one of C{'parser'},</tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"><tt class="py-string"> C{'introspector'}, or C{'both'}.</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-string"> @type: C{str}"""</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"> <tt class="py-comment">#} end of "source information" group</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="APIDoc.__init__"></a><div id="APIDoc.__init__-def"><a name="L379"></a><tt class="py-lineno"> 379</tt> <a class="py-toggle" href="#" id="APIDoc.__init__-toggle" onclick="return toggle('APIDoc.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.__init__-expanded"><a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-docstring"> Construct a new C{APIDoc} object. Keyword arguments may be</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt> <tt class="py-line"><tt class="py-docstring"> used to initialize the new C{APIDoc}'s attributes.</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"><tt class="py-docstring"> @raise TypeError: If a keyword argument is specified that does</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-docstring"> not correspond to a valid attribute for this (sub)class of</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-docstring"> C{APIDoc}.</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-63" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-63', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-64" class="py-name" targets="Variable epydoc.DEBUG=epydoc-module.html#DEBUG,Variable epydoc.gui.DEBUG=epydoc.gui-module.html#DEBUG,Variable epydoc.log.DEBUG=epydoc.log-module.html#DEBUG"><a title="epydoc.DEBUG
epydoc.gui.DEBUG
epydoc.log.DEBUG" class="py-name" href="#" onclick="return doclink('link-64', 'DEBUG', 'link-64');">DEBUG</a></tt><tt class="py-op">:</tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-65" class="py-name" targets="Variable epydoc.cli.key=epydoc.cli-module.html#key"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-65', 'key', 'link-65');">key</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-66" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-66', 'key', 'link-65');">key</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">'_'</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">,</tt> <tt id="link-67" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-67', 'key', 'link-65');">key</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'%s got unexpected arg %r'</tt> <tt class="py-op">%</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt id="link-68" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-68', 'key', 'link-65');">key</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> </tt>
<a name="APIDoc._debug_setattr"></a><div id="APIDoc._debug_setattr-def"><a name="L395"></a><tt class="py-lineno"> 395</tt> <a class="py-toggle" href="#" id="APIDoc._debug_setattr-toggle" onclick="return toggle('APIDoc._debug_setattr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#_debug_setattr">_debug_setattr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">attr</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc._debug_setattr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc._debug_setattr-expanded"><a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"><tt class="py-docstring"> Modify an C{APIDoc}'s attribute. This is used when</tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"><tt class="py-docstring"> L{epydoc.DEBUG} is true, to make sure we don't accidentally</tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt> <tt class="py-line"><tt class="py-docstring"> set any inappropriate attributes on C{APIDoc} objects.</tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt> <tt class="py-line"><tt class="py-docstring"> @raise AttributeError: If C{attr} is not a valid attribute for</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"><tt class="py-docstring"> this (sub)class of C{APIDoc}. (C{attr} is considered a</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"><tt class="py-docstring"> valid attribute iff C{self.__class__} defines an attribute</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"><tt class="py-docstring"> with that name.)</tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt> <tt class="py-line"> <tt class="py-comment"># Don't intercept special assignments like __class__, or</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># assignments to private variables.</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">attr</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">object</tt><tt class="py-op">.</tt><tt class="py-name">__setattr__</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">attr</tt><tt class="py-op">,</tt> <tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">attr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">(</tt><tt class="py-string">'%s does not define attribute %r'</tt> <tt class="py-op">%</tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">attr</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">attr</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">val</tt> </tt>
</div><a name="L414"></a><tt class="py-lineno"> 414</tt> <tt class="py-line"> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-69" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-69', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="epydoc.DEBUG
epydoc.gui.DEBUG
epydoc.log.DEBUG" class="py-name" href="#" onclick="return doclink('link-70', 'DEBUG', 'link-64');">DEBUG</a></tt><tt class="py-op">:</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt> <tt class="py-line"> <tt class="py-name">__setattr__</tt> <tt class="py-op">=</tt> <tt id="link-71" class="py-name" targets="Method epydoc.apidoc.APIDoc._debug_setattr()=epydoc.apidoc.APIDoc-class.html#_debug_setattr"><a title="epydoc.apidoc.APIDoc._debug_setattr" class="py-name" href="#" onclick="return doclink('link-71', '_debug_setattr', 'link-71');">_debug_setattr</a></tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt> <tt class="py-line"> </tt>
<a name="APIDoc.__repr__"></a><div id="APIDoc.__repr__-def"><a name="L418"></a><tt class="py-lineno"> 418</tt> <a class="py-toggle" href="#" id="APIDoc.__repr__-toggle" onclick="return toggle('APIDoc.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.__repr__-expanded"><a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
</div><a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> </tt>
<a name="APIDoc.pp"></a><div id="APIDoc.pp-def"><a name="L421"></a><tt class="py-lineno"> 421</tt> <a class="py-toggle" href="#" id="APIDoc.pp-toggle" onclick="return toggle('APIDoc.pp');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#pp">pp</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doublespace</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">=</tt><tt class="py-number">5</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.pp-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.pp-expanded"><a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt> <tt class="py-line"><tt class="py-docstring"> Return a pretty-printed string representation for the</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"><tt class="py-docstring"> information contained in this C{APIDoc}.</tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-72" class="py-name" targets="Function epydoc.apidoc.pp_apidoc()=epydoc.apidoc-module.html#pp_apidoc"><a title="epydoc.apidoc.pp_apidoc" class="py-name" href="#" onclick="return doclink('link-72', 'pp_apidoc', 'link-72');">pp_apidoc</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">)</tt> </tt>
</div><a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"> <tt id="link-73" class="py-name" targets="Method epydoc.apidoc.DottedName.__str__()=epydoc.apidoc.DottedName-class.html#__str__,Method epydoc.markup.ParseError.__str__()=epydoc.markup.ParseError-class.html#__str__,Method epydoc.markup.epytext.Element.__str__()=epydoc.markup.epytext.Element-class.html#__str__,Method epydoc.markup.epytext.ParsedEpytextDocstring.__str__()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__str__"><a title="epydoc.apidoc.DottedName.__str__
epydoc.markup.ParseError.__str__
epydoc.markup.epytext.Element.__str__
epydoc.markup.epytext.ParsedEpytextDocstring.__str__" class="py-name" href="#" onclick="return doclink('link-73', '__str__', 'link-73');">__str__</a></tt> <tt class="py-op">=</tt> <tt id="link-74" class="py-name" targets="Method epydoc.apidoc.APIDoc.pp()=epydoc.apidoc.APIDoc-class.html#pp"><a title="epydoc.apidoc.APIDoc.pp" class="py-name" href="#" onclick="return doclink('link-74', 'pp', 'link-74');">pp</a></tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"> </tt>
<a name="APIDoc.specialize_to"></a><div id="APIDoc.specialize_to-def"><a name="L429"></a><tt class="py-lineno"> 429</tt> <a class="py-toggle" href="#" id="APIDoc.specialize_to-toggle" onclick="return toggle('APIDoc.specialize_to');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#specialize_to">specialize_to</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">cls</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.specialize_to-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.specialize_to-expanded"><a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"><tt class="py-docstring"> Change C{self}'s class to C{cls}. C{cls} must be a subclass</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"><tt class="py-docstring"> of C{self}'s current class. For example, if a generic</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"><tt class="py-docstring"> C{ValueDoc} was created for a value, and it is determined that</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"><tt class="py-docstring"> the value is a routine, you can update its class with:</tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"><tt class="py-docstring"> >>> valdoc.specialize_to(RoutineDoc)</tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Can not specialize to %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">cls</tt><tt class="py-op">)</tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-comment"># Update the class.</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> <tt class="py-comment"># Update the class of any other apidoc's in the mergeset.</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-75" class="py-name" targets="Variable epydoc.apidoc.APIDoc.__mergeset=epydoc.apidoc.APIDoc-class.html#__mergeset"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-75', '__mergeset', 'link-75');">__mergeset</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-76" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-76', 'apidoc', 'link-76');">apidoc</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-77', '__mergeset', 'link-75');">__mergeset</a></tt><tt class="py-op">:</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt id="link-78" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-78', 'apidoc', 'link-76');">apidoc</a></tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> <tt class="py-comment"># Re-initialize self, in case the subclass constructor does</tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># any special processing on its arguments.</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name" targets="Method epydoc.apidoc.APIDoc.__init__()=epydoc.apidoc.APIDoc-class.html#__init__,Method epydoc.apidoc.DocIndex.__init__()=epydoc.apidoc.DocIndex-class.html#__init__,Method epydoc.apidoc.DottedName.__init__()=epydoc.apidoc.DottedName-class.html#__init__,Method epydoc.apidoc.NamespaceDoc.__init__()=epydoc.apidoc.NamespaceDoc-class.html#__init__,Method epydoc.apidoc.VariableDoc.__init__()=epydoc.apidoc.VariableDoc-class.html#__init__,Method epydoc.apidoc._Sentinel.__init__()=epydoc.apidoc._Sentinel-class.html#__init__,Method epydoc.checker.DocChecker.__init__()=epydoc.checker.DocChecker-class.html#__init__,Method epydoc.cli.ConsoleLogger.__init__()=epydoc.cli.ConsoleLogger-class.html#__init__,Method epydoc.cli.HTMLLogger.__init__()=epydoc.cli.HTMLLogger-class.html#__init__,Method epydoc.cli.TerminalController.__init__()=epydoc.cli.TerminalController-class.html#__init__,Method epydoc.cli.UnifiedProgressConsoleLogger.__init__()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#__init__,Method epydoc.docbuilder.BuildOptions.__init__()=epydoc.docbuilder.BuildOptions-class.html#__init__,Method epydoc.docbuilder._ProgressEstimator.__init__()=epydoc.docbuilder._ProgressEstimator-class.html#__init__,Method epydoc.docintrospecter._DevNull.__init__()=epydoc.docintrospecter._DevNull-class.html#__init__,Method epydoc.docstringparser.DocstringField.__init__()=epydoc.docstringparser.DocstringField-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraph.__init__()=epydoc.docwriter.dotgraph.DotGraph-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphEdge.__init__()=epydoc.docwriter.dotgraph.DotGraphEdge-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphNode.__init__()=epydoc.docwriter.dotgraph.DotGraphNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#__init__,Method epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__()=epydoc.docwriter.dotgraph.DotGraphUmlModuleNode-class.html#__init__,Method epydoc.docwriter.html.HTMLWriter.__init__()=epydoc.docwriter.html.HTMLWriter-class.html#__init__,Method epydoc.docwriter.html._HTMLDocstringLinker.__init__()=epydoc.docwriter.html._HTMLDocstringLinker-class.html#__init__,Method epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__()=epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#__init__,Method epydoc.docwriter.latex.LatexWriter.__init__()=epydoc.docwriter.latex.LatexWriter-class.html#__init__,Method epydoc.docwriter.xlink.ApiLinkReader.__init__()=epydoc.docwriter.xlink.ApiLinkReader-class.html#__init__,Method epydoc.docwriter.xlink.DocUrlGenerator.__init__()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#__init__,Method epydoc.gui.EpydocGUI.__init__()=epydoc.gui.EpydocGUI-class.html#__init__,Method epydoc.gui.GUILogger.__init__()=epydoc.gui.GUILogger-class.html#__init__,Method epydoc.log.SimpleLogger.__init__()=epydoc.log.SimpleLogger-class.html#__init__,Method epydoc.markup.ConcatenatedDocstring.__init__()=epydoc.markup.ConcatenatedDocstring-class.html#__init__,Method epydoc.markup.Field.__init__()=epydoc.markup.Field-class.html#__init__,Method epydoc.markup.ParseError.__init__()=epydoc.markup.ParseError-class.html#__init__,Method epydoc.markup.epytext.ColorizingError.__init__()=epydoc.markup.epytext.ColorizingError-class.html#__init__,Method epydoc.markup.epytext.Element.__init__()=epydoc.markup.epytext.Element-class.html#__init__,Method epydoc.markup.epytext.ParsedEpytextDocstring.__init__()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#__init__,Method epydoc.markup.epytext.Token.__init__()=epydoc.markup.epytext.Token-class.html#__init__,Method epydoc.markup.javadoc.ParsedJavadocDocstring.__init__()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#__init__,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#__init__,Method epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__()=epydoc.markup.pyval_repr.ColorizedPyvalRepr-class.html#__init__,Method epydoc.markup.pyval_repr.PyvalColorizer.__init__()=epydoc.markup.pyval_repr.PyvalColorizer-class.html#__init__,Method epydoc.markup.pyval_repr._ColorizerState.__init__()=epydoc.markup.pyval_repr._ColorizerState-class.html#__init__,Method epydoc.markup.restructuredtext.ParsedRstDocstring.__init__()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#__init__,Method epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__()=epydoc.markup.restructuredtext._DocumentPseudoWriter-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__()=epydoc.markup.restructuredtext._EpydocHTMLTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__()=epydoc.markup.restructuredtext._EpydocLaTeXTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._EpydocReader.__init__()=epydoc.markup.restructuredtext._EpydocReader-class.html#__init__,Method epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__()=epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#__init__,Method epydoc.markup.restructuredtext._SummaryExtractor.__init__()=epydoc.markup.restructuredtext._SummaryExtractor-class.html#__init__,Method epydoc.markup.restructuredtext._TermsExtractor.__init__()=epydoc.markup.restructuredtext._TermsExtractor-class.html#__init__,Method epydoc.markup.restructuredtext.dotgraph.__init__()=epydoc.markup.restructuredtext.dotgraph-class.html#__init__,Method epydoc.util.RunSubprocessError.__init__()=epydoc.util.RunSubprocessError-class.html#__init__"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-79', '__init__', 'link-79');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
</div><a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt id="link-80" class="py-name" targets="Variable epydoc.apidoc.APIDoc.__has_been_hashed=epydoc.apidoc.APIDoc-class.html#__has_been_hashed"><a title="epydoc.apidoc.APIDoc.__has_been_hashed" class="py-name" href="#" onclick="return doclink('link-80', '__has_been_hashed', 'link-80');">__has_been_hashed</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"> <tt class="py-string">"""True iff L{self.__hash__()} has ever been called."""</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> </tt>
<a name="APIDoc.__hash__"></a><div id="APIDoc.__hash__-def"><a name="L453"></a><tt class="py-lineno"> 453</tt> <a class="py-toggle" href="#" id="APIDoc.__hash__-toggle" onclick="return toggle('APIDoc.__hash__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#__hash__">__hash__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.__hash__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.__hash__-expanded"><a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="epydoc.apidoc.APIDoc.__has_been_hashed" class="py-name" href="#" onclick="return doclink('link-81', '__has_been_hashed', 'link-80');">__has_been_hashed</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
</div><a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> </tt>
<a name="APIDoc.__cmp__"></a><div id="APIDoc.__cmp__-def"><a name="L457"></a><tt class="py-lineno"> 457</tt> <a class="py-toggle" href="#" id="APIDoc.__cmp__-toggle" onclick="return toggle('APIDoc.__cmp__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#__cmp__">__cmp__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.__cmp__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.__cmp__-expanded"><a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt id="link-82" class="py-name" targets="Class epydoc.apidoc.APIDoc=epydoc.apidoc.APIDoc-class.html"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-82', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> <tt class="py-keyword">is</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">0</tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"> <tt class="py-name">name_cmp</tt> <tt class="py-op">=</tt> <tt class="py-name">cmp</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name" targets="Variable epydoc.apidoc.GenericValueDoc.canonical_name=epydoc.apidoc.GenericValueDoc-class.html#canonical_name,Variable epydoc.apidoc.ValueDoc.canonical_name=epydoc.apidoc.ValueDoc-class.html#canonical_name,Variable epydoc.apidoc.VariableDoc.canonical_name=epydoc.apidoc.VariableDoc-class.html#canonical_name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-83', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-84', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name_cmp</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">name_cmp</tt> </tt>
</div><a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> </tt>
<a name="APIDoc.is_detailed"></a><div id="APIDoc.is_detailed-def"><a name="L464"></a><tt class="py-lineno"> 464</tt> <a class="py-toggle" href="#" id="APIDoc.is_detailed-toggle" onclick="return toggle('APIDoc.is_detailed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#is_detailed">is_detailed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.is_detailed-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.is_detailed-expanded"><a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"><tt class="py-docstring"> Does this object deserve a box with extra details?</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"><tt class="py-docstring"> @return: True if the object needs extra details, else False.</tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{bool}</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="epydoc.apidoc.APIDoc.other_docs" class="py-name" href="#" onclick="return doclink('link-85', 'other_docs', 'link-55');">other_docs</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt> <tt class="py-line"> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-86', 'metadata', 'link-57');">metadata</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-87" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-87', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-88', 'metadata', 'link-57');">metadata</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"> <tt id="link-89" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-89', '__mergeset', 'link-75');">__mergeset</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"> <tt class="py-string">"""The set of all C{APIDoc} objects that have been merged with</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"><tt class="py-string"> this C{APIDoc} (using L{merge_and_overwrite()}). Each C{APIDoc}</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"><tt class="py-string"> in this set shares a common instance dictionary (C{__dict__})."""</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"> </tt>
<a name="APIDoc.merge_and_overwrite"></a><div id="APIDoc.merge_and_overwrite-def"><a name="L482"></a><tt class="py-lineno"> 482</tt> <a class="py-toggle" href="#" id="APIDoc.merge_and_overwrite-toggle" onclick="return toggle('APIDoc.merge_and_overwrite');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite">merge_and_overwrite</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">,</tt> <tt class="py-param">ignore_hash_conflict</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.merge_and_overwrite-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.merge_and_overwrite-expanded"><a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"><tt class="py-docstring"> Combine C{self} and C{other} into a X{merged object}, such</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"><tt class="py-docstring"> that any changes made to one will affect the other. Any</tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"><tt class="py-docstring"> attributes that C{other} had before merging will be discarded.</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"><tt class="py-docstring"> This is accomplished by copying C{self.__dict__} over</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"><tt class="py-docstring"> C{other.__dict__} and C{self.__class__} over C{other.__class__}.</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"><tt class="py-docstring"> Care must be taken with this method, since it modifies the</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"><tt class="py-docstring"> hash value of C{other}. To help avoid the problems that this</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"><tt class="py-docstring"> can cause, C{merge_and_overwrite} will raise an exception if</tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"><tt class="py-docstring"> C{other} has ever been hashed, unless C{ignore_hash_conflict}</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"><tt class="py-docstring"> is True. Note that adding C{other} to a dictionary, set, or</tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-docstring"> similar data structure will implicitly cause it to be hashed.</tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-docstring"> If you do set C{ignore_hash_conflict} to True, then any</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-docstring"> existing data structures that rely on C{other}'s hash staying</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"><tt class="py-docstring"> constant may become corrupted.</tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{self}</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-docstring"> @raise ValueError: If C{other} has ever been hashed.</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> <tt class="py-comment"># If we're already merged, then there's nothing to do.</tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> <tt class="py-keyword">is</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-keyword">is</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="epydoc.apidoc.APIDoc.__has_been_hashed" class="py-name" href="#" onclick="return doclink('link-90', '__has_been_hashed', 'link-80');">__has_been_hashed</a></tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">ignore_hash_conflict</tt><tt class="py-op">:</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"%r has already been hashed! Merging it "</tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-string">"would cause its has value to change."</tt> <tt class="py-op">%</tt> <tt class="py-name">other</tt><tt class="py-op">)</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"> <tt class="py-comment"># If other was itself already merged with anything,</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># then we need to merge those too.</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">a</tt><tt class="py-op">,</tt><tt class="py-name">b</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-91', '__mergeset', 'link-75');">__mergeset</a></tt><tt class="py-op">,</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-92', '__mergeset', 'link-75');">__mergeset</a></tt><tt class="py-op">)</tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt class="py-name">mergeset</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-93', '__mergeset', 'link-75');">__mergeset</a></tt> <tt class="py-keyword">or</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-94', '__mergeset', 'link-75');">__mergeset</a></tt> <tt class="py-keyword">or</tt> <tt class="py-op">[</tt><tt class="py-name">other</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name" targets="Method epydoc.docwriter.xlink.DocUrlGenerator.clear()=epydoc.docwriter.xlink.DocUrlGenerator-class.html#clear,Method epydoc.gui.GUILogger.clear()=epydoc.gui.GUILogger-class.html#clear"><a title="epydoc.docwriter.xlink.DocUrlGenerator.clear
epydoc.gui.GUILogger.clear" class="py-name" href="#" onclick="return doclink('link-95', 'clear', 'link-95');">clear</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-96" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-96', 'apidoc', 'link-76');">apidoc</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">mergeset</tt><tt class="py-op">:</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"> <tt class="py-comment">#if apidoc is self: pass</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-97" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-97', 'apidoc', 'link-76');">apidoc</a></tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"> <tt id="link-98" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-98', 'apidoc', 'link-76');">apidoc</a></tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-99" class="py-name"><a title="epydoc.apidoc.APIDoc.__mergeset" class="py-name" href="#" onclick="return doclink('link-99', '__mergeset', 'link-75');">__mergeset</a></tt> <tt class="py-op">=</tt> <tt class="py-name">mergeset</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"> <tt class="py-comment"># Sanity chacks.</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt> <tt class="py-keyword">in</tt> <tt class="py-name">mergeset</tt> <tt class="py-keyword">and</tt> <tt class="py-name">other</tt> <tt class="py-keyword">in</tt> <tt class="py-name">mergeset</tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-100" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-100', 'apidoc', 'link-76');">apidoc</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">mergeset</tt><tt class="py-op">:</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt id="link-101" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-101', 'apidoc', 'link-76');">apidoc</a></tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> <tt class="py-keyword">is</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> <tt class="py-comment"># Return self.</tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt> </tt>
</div><a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"> </tt>
<a name="APIDoc.apidoc_links"></a><div id="APIDoc.apidoc_links-def"><a name="L528"></a><tt class="py-lineno"> 528</tt> <a class="py-toggle" href="#" id="APIDoc.apidoc_links-toggle" onclick="return toggle('APIDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.APIDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="APIDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="APIDoc.apidoc_links-expanded"><a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of all C{APIDoc}s that are directly linked from</tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"><tt class="py-docstring"> this C{APIDoc} (i.e., are contained or pointed to by one or</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"><tt class="py-docstring"> more of this C{APIDoc}'s attributes.)</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"><tt class="py-docstring"> Keyword argument C{filters} can be used to selectively exclude</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"><tt class="py-docstring"> certain categories of attribute value. For example, using</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"><tt class="py-docstring"> C{includes=False} will exclude variables that were imported</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"><tt class="py-docstring"> from other modules; and C{subclasses=False} will exclude</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt> <tt class="py-line"><tt class="py-docstring"> subclasses. The filter categories currently supported by</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"><tt class="py-docstring"> epydoc are:</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"><tt class="py-docstring"> - C{imports}: Imported variables.</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"><tt class="py-docstring"> - C{packages}: Containing packages for modules.</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"><tt class="py-docstring"> - C{submodules}: Contained submodules for packages.</tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"><tt class="py-docstring"> - C{bases}: Bases for classes.</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-docstring"> - C{subclasses}: Subclasses for classes.</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"><tt class="py-docstring"> - C{variables}: All variables.</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"><tt class="py-docstring"> - C{private}: Private variables.</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"><tt class="py-docstring"> - C{overrides}: Points from class variables to the variables</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"><tt class="py-docstring"> they override. This filter is False by default.</tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div></div><a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"> </tt>
<a name="reachable_valdocs"></a><div id="reachable_valdocs-def"><a name="L552"></a><tt class="py-lineno"> 552</tt> <a class="py-toggle" href="#" id="reachable_valdocs-toggle" onclick="return toggle('reachable_valdocs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#reachable_valdocs">reachable_valdocs</a><tt class="py-op">(</tt><tt class="py-param">root</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="reachable_valdocs-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="reachable_valdocs-expanded"><a name="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of all C{ValueDoc}s that can be reached, directly or</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"><tt class="py-docstring"> indirectly from the given root list of C{ValueDoc}s.</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"><tt class="py-docstring"> @param filters: A set of filters that can be used to prevent</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"><tt class="py-docstring"> C{reachable_valdocs} from following specific link types when</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"><tt class="py-docstring"> looking for C{ValueDoc}s that can be reached from the root</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"><tt class="py-docstring"> set. See C{APIDoc.apidoc_links} for a more complete</tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"><tt class="py-docstring"> description.</tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-name">apidoc_queue</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">root</tt><tt class="py-op">)</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"> <tt class="py-name">val_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"> <tt class="py-name">var_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">apidoc_queue</tt><tt class="py-op">:</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">apidoc_queue</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-102" class="py-name" targets="Class epydoc.apidoc.ValueDoc=epydoc.apidoc.ValueDoc-class.html"><a title="epydoc.apidoc.ValueDoc" class="py-name" href="#" onclick="return doclink('link-102', 'ValueDoc', 'link-102');">ValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"> <tt class="py-name">val_set</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"> <tt class="py-name">var_set</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"> <tt class="py-name">apidoc_queue</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-103" class="py-name" targets="Variable epydoc.markup.restructuredtext._EpydocReader.v=epydoc.markup.restructuredtext._EpydocReader-class.html#v"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-103', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-104" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-104', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name" targets="Method epydoc.apidoc.APIDoc.apidoc_links()=epydoc.apidoc.APIDoc-class.html#apidoc_links,Method epydoc.apidoc.ClassDoc.apidoc_links()=epydoc.apidoc.ClassDoc-class.html#apidoc_links,Method epydoc.apidoc.ModuleDoc.apidoc_links()=epydoc.apidoc.ModuleDoc-class.html#apidoc_links,Method epydoc.apidoc.NamespaceDoc.apidoc_links()=epydoc.apidoc.NamespaceDoc-class.html#apidoc_links,Method epydoc.apidoc.PropertyDoc.apidoc_links()=epydoc.apidoc.PropertyDoc-class.html#apidoc_links,Method epydoc.apidoc.ValueDoc.apidoc_links()=epydoc.apidoc.ValueDoc-class.html#apidoc_links,Method epydoc.apidoc.VariableDoc.apidoc_links()=epydoc.apidoc.VariableDoc-class.html#apidoc_links"><a title="epydoc.apidoc.APIDoc.apidoc_links
epydoc.apidoc.ClassDoc.apidoc_links
epydoc.apidoc.ModuleDoc.apidoc_links
epydoc.apidoc.NamespaceDoc.apidoc_links
epydoc.apidoc.PropertyDoc.apidoc_links
epydoc.apidoc.ValueDoc.apidoc_links
epydoc.apidoc.VariableDoc.apidoc_links" class="py-name" href="#" onclick="return doclink('link-105', 'apidoc_links', 'link-105');">apidoc_links</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">filters</tt><tt class="py-op">)</tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-106" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-106', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_set</tt> <tt class="py-keyword">and</tt> <tt id="link-107" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-107', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_set</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_set</tt> </tt>
</div><a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Variable Documentation Objects</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="VariableDoc"></a><div id="VariableDoc-def"><a name="L580"></a><tt class="py-lineno"> 580</tt> <a class="py-toggle" href="#" id="VariableDoc-toggle" onclick="return toggle('VariableDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.VariableDoc-class.html">VariableDoc</a><tt class="py-op">(</tt><tt class="py-base-class">APIDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VariableDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="VariableDoc-expanded"><a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a single Python variable.</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"><tt class="py-docstring"> @note: The only time a C{VariableDoc} will have its own docstring</tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"><tt class="py-docstring"> is if that variable was created using an assignment statement, and</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"><tt class="py-docstring"> that assignment statement had a docstring-comment or was followed</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"><tt class="py-docstring"> by a pseudo-docstring.</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <tt class="py-comment">#{ Basic Variable Information</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-108" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-108', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-109" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-109', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The name of this variable in its containing namespace.</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"><tt class="py-string"> @type: C{str}"""</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt id="link-110" class="py-name" targets="Method epydoc.apidoc.DocIndex.container()=epydoc.apidoc.DocIndex-class.html#container,Method epydoc.apidoc.DottedName.container()=epydoc.apidoc.DottedName-class.html#container,Variable epydoc.apidoc.VariableDoc.container=epydoc.apidoc.VariableDoc-class.html#container"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-110', 'container', 'link-110');">container</a></tt> <tt class="py-op">=</tt> <tt id="link-111" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-111', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the namespace that contains this</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"><tt class="py-string"> variable.</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"><tt class="py-string"> @type: L{ValueDoc}"""</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"> <tt id="link-112" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-112', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-113" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-113', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A dotted name that serves as a unique identifier for</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-string"> this C{VariableDoc}. It should be formed by concatenating</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-string"> the C{VariableDoc}'s C{container} with its C{name}.</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-string"> @type: L{DottedName}"""</tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"> <tt id="link-114" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.value=epydoc.apidoc.VariableDoc-class.html#value"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-114', 'value', 'link-114');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-115" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-115', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The API documentation for this variable's value.</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"><tt class="py-string"> @type: L{ValueDoc}"""</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-comment">#}</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> <tt class="py-comment">#{ Information Extracted from Docstrings</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-116" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.type_descr=epydoc.apidoc.PropertyDoc-class.html#type_descr,Variable epydoc.apidoc.VariableDoc.type_descr=epydoc.apidoc.VariableDoc-class.html#type_descr,Method epydoc.docwriter.html.HTMLWriter.type_descr()=epydoc.docwriter.html.HTMLWriter-class.html#type_descr"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-116', 'type_descr', 'link-116');">type_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-117" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-117', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A description of the variable's expected type, extracted from</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"><tt class="py-string"> its docstring.</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"><tt class="py-string"> @type: L{ParsedDocstring<epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information extracted from docstrings" group</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Imported Variables</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-118" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.imported_from=epydoc.apidoc.VariableDoc-class.html#imported_from"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-118', 'imported_from', 'link-118');">imported_from</a></tt> <tt class="py-op">=</tt> <tt id="link-119" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-119', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The fully qualified dotted name of the variable that this</tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"><tt class="py-string"> variable's value was imported from. This attribute should only</tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"><tt class="py-string"> be defined if C{is_instvar} is true.</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt class="py-string"> @type: L{DottedName}"""</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt id="link-120" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_imported=epydoc.apidoc.VariableDoc-class.html#is_imported"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-120', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-op">=</tt> <tt id="link-121" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-121', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Was this variable's value imported from another module?</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"><tt class="py-string"> (Exception: variables that are explicitly included in __all__ have</tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"><tt class="py-string"> C{is_imported} set to C{False}, even if they are in fact</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"><tt class="py-string"> imported.)</tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"><tt class="py-string"> @type: C{bool}"""</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information about imported variables" group</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Variables in Classes</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-122" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_instvar=epydoc.apidoc.VariableDoc-class.html#is_instvar"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-122', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-op">=</tt> <tt id="link-123" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-123', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: If true, then this variable is an instance variable; if false,</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"><tt class="py-string"> then this variable is a class variable. This attribute should</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"><tt class="py-string"> only be defined if the containing namespace is a class </tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"><tt class="py-string"> @type: C{bool}"""</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt id="link-124" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.overrides=epydoc.apidoc.VariableDoc-class.html#overrides"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-124', 'overrides', 'link-124');">overrides</a></tt> <tt class="py-op">=</tt> <tt id="link-125" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-125', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-comment"># [XXX] rename -- don't use a verb.</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The API documentation for the variable that is overridden by</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"><tt class="py-string"> this variable. This attribute should only be defined if the</tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"><tt class="py-string"> containing namespace is a class.</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-string"> @type: L{VariableDoc}"""</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information about variables in classes" group</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"> <tt class="py-comment">#{ Flags</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-126" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_alias=epydoc.apidoc.VariableDoc-class.html#is_alias"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-126', 'is_alias', 'link-126');">is_alias</a></tt> <tt class="py-op">=</tt> <tt id="link-127" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-127', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Is this variable an alias for another variable with the same</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"><tt class="py-string"> value? If so, then this variable will be dispreferred when</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"><tt class="py-string"> assigning canonical names.</tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"><tt class="py-string"> @type: C{bool}"""</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"> <tt id="link-128" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.is_public=epydoc.apidoc.VariableDoc-class.html#is_public"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-128', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-op">=</tt> <tt id="link-129" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-129', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Is this variable part of its container's public API?</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"><tt class="py-string"> @type: C{bool}"""</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-comment">#} end of "flags" group</tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="VariableDoc.__init__"></a><div id="VariableDoc.__init__-def"><a name="L658"></a><tt class="py-lineno"> 658</tt> <a class="py-toggle" href="#" id="VariableDoc.__init__-toggle" onclick="return toggle('VariableDoc.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.VariableDoc-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VariableDoc.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="VariableDoc.__init__-expanded"><a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> <tt id="link-130" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-130', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-131', '__init__', 'link-79');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-132', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-keyword">is</tt> <tt id="link-133" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-133', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-134', 'name', 'link-36');">name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-135" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-135', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-136', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-137', 'name', 'link-36');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-138', 'name', 'link-36');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">endswith</tt><tt class="py-op">(</tt><tt class="py-string">'_'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> </tt>
<a name="VariableDoc.__repr__"></a><div id="VariableDoc.__repr__-def"><a name="L664"></a><tt class="py-lineno"> 664</tt> <a class="py-toggle" href="#" id="VariableDoc.__repr__-toggle" onclick="return toggle('VariableDoc.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.VariableDoc-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VariableDoc.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="VariableDoc.__repr__-expanded"><a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-139', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-140" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-140', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s %s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-141', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-142" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-142', 'name', 'link-36');">name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-143" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-143', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s %s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-144', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s>'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
</div><a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> </tt>
<a name="VariableDoc._get_defining_module"></a><div id="VariableDoc._get_defining_module-def"><a name="L672"></a><tt class="py-lineno"> 672</tt> <a class="py-toggle" href="#" id="VariableDoc._get_defining_module-toggle" onclick="return toggle('VariableDoc._get_defining_module');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.VariableDoc-class.html#_get_defining_module">_get_defining_module</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VariableDoc._get_defining_module-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="VariableDoc._get_defining_module-expanded"><a name="L673"></a><tt class="py-lineno"> 673</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-145" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-145', 'container', 'link-110');">container</a></tt> <tt class="py-keyword">is</tt> <tt id="link-146" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-146', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-147" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-147', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-148', 'container', 'link-110');">container</a></tt><tt class="py-op">.</tt><tt id="link-149" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.defining_module=epydoc.apidoc.ValueDoc-class.html#defining_module,Variable epydoc.apidoc.VariableDoc.defining_module=epydoc.apidoc.VariableDoc-class.html#defining_module"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-149', 'defining_module', 'link-149');">defining_module</a></tt> </tt>
</div><a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> <tt id="link-150" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-150', 'defining_module', 'link-149');">defining_module</a></tt> <tt class="py-op">=</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt id="link-151" class="py-name" targets="Method epydoc.apidoc.VariableDoc._get_defining_module()=epydoc.apidoc.VariableDoc-class.html#_get_defining_module"><a title="epydoc.apidoc.VariableDoc._get_defining_module" class="py-name" href="#" onclick="return doclink('link-151', '_get_defining_module', 'link-151');">_get_defining_module</a></tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">=</tt><tt class="py-string">"""</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"><tt class="py-string"> A read-only property that can be used to get the variable's</tt> </tt>
<a name="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"><tt class="py-string"> defining module. This is defined as the defining module</tt> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"><tt class="py-string"> of the variable's container."""</tt><tt class="py-op">)</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> </tt>
<a name="VariableDoc.apidoc_links"></a><div id="VariableDoc.apidoc_links-def"><a name="L681"></a><tt class="py-lineno"> 681</tt> <a class="py-toggle" href="#" id="VariableDoc.apidoc_links-toggle" onclick="return toggle('VariableDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.VariableDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VariableDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="VariableDoc.apidoc_links-expanded"><a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> <tt class="py-comment"># nb: overrides filter is *False* by default.</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'overrides'</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-152" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-152', 'overrides', 'link-124');">overrides</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-153" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-153', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> <tt id="link-154" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-154', 'overrides', 'link-124');">overrides</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-155', 'overrides', 'link-124');">overrides</a></tt><tt class="py-op">]</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt id="link-156" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-156', 'overrides', 'link-124');">overrides</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-157', 'value', 'link-114');">value</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-158" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-158', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt id="link-159" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-159', 'overrides', 'link-124');">overrides</a></tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-160', 'value', 'link-114');">value</a></tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt id="link-161" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-161', 'overrides', 'link-124');">overrides</a></tt> </tt>
</div><a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> </tt>
<a name="VariableDoc.is_detailed"></a><div id="VariableDoc.is_detailed-def"><a name="L693"></a><tt class="py-lineno"> 693</tt> <a class="py-toggle" href="#" id="VariableDoc.is_detailed-toggle" onclick="return toggle('VariableDoc.is_detailed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.VariableDoc-class.html#is_detailed">is_detailed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="VariableDoc.is_detailed-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="VariableDoc.is_detailed-expanded"><a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> <tt class="py-name">pval</tt> <tt class="py-op">=</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-162" class="py-name" targets="Class epydoc.apidoc.VariableDoc=epydoc.apidoc.VariableDoc-class.html"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-162', 'VariableDoc', 'link-162');">VariableDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-163" class="py-name" targets="Method epydoc.apidoc.APIDoc.is_detailed()=epydoc.apidoc.APIDoc-class.html#is_detailed,Method epydoc.apidoc.GenericValueDoc.is_detailed()=epydoc.apidoc.GenericValueDoc-class.html#is_detailed,Method epydoc.apidoc.NamespaceDoc.is_detailed()=epydoc.apidoc.NamespaceDoc-class.html#is_detailed,Method epydoc.apidoc.PropertyDoc.is_detailed()=epydoc.apidoc.PropertyDoc-class.html#is_detailed,Method epydoc.apidoc.RoutineDoc.is_detailed()=epydoc.apidoc.RoutineDoc-class.html#is_detailed,Method epydoc.apidoc.VariableDoc.is_detailed()=epydoc.apidoc.VariableDoc-class.html#is_detailed"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-163', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pval</tt> <tt class="py-keyword">or</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-164', 'value', 'link-114');">value</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-165" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-165', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">pval</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-166" class="py-name"><a title="epydoc.apidoc.VariableDoc.overrides" class="py-name" href="#" onclick="return doclink('link-166', 'overrides', 'link-124');">overrides</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-167" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-167', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-168" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-168', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-169" class="py-name" targets="Class epydoc.apidoc.RoutineDoc=epydoc.apidoc.RoutineDoc-class.html"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-169', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-170', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-171" class="py-name" targets="Class epydoc.apidoc.GenericValueDoc=epydoc.apidoc.GenericValueDoc-class.html"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-171', 'GenericValueDoc', 'link-171');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"> <tt class="py-comment"># [XX] This is a little hackish -- we assume that the</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># summary lines will have SUMMARY_REPR_LINELEN chars,</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># that len(name) of those will be taken up by the name,</tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and that 3 of those will be taken up by " = " between</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the name & val. Note that if any docwriter uses a</tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># different formula for maxlen for this, then it will</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># not get the right value for is_detailed().</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">maxlen</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-172', 'value', 'link-114');">value</a></tt><tt class="py-op">.</tt><tt id="link-173" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN=epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-173', 'SUMMARY_REPR_LINELEN', 'link-173');">SUMMARY_REPR_LINELEN</a></tt><tt class="py-op">-</tt><tt class="py-number">3</tt><tt class="py-op">-</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-174', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-175', 'value', 'link-114');">value</a></tt><tt class="py-op">.</tt><tt id="link-176" class="py-name" targets="Method epydoc.apidoc.ValueDoc.summary_pyval_repr()=epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-176', 'summary_pyval_repr', 'link-176');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-name">maxlen</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">is_complete</tt><tt class="py-op">)</tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-177" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-177', 'value', 'link-114');">value</a></tt><tt class="py-op">.</tt><tt id="link-178" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-178', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Value Documentation Objects</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ValueDoc"></a><div id="ValueDoc-def"><a name="L719"></a><tt class="py-lineno"> 719</tt> <a class="py-toggle" href="#" id="ValueDoc-toggle" onclick="return toggle('ValueDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a><tt class="py-op">(</tt><tt class="py-base-class">APIDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ValueDoc-expanded"><a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a single Python value.</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> <tt id="link-179" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-179', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-180" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-180', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A dotted name that serves as a unique identifier for</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"><tt class="py-string"> this C{ValueDoc}'s value. If the value can be reached using a</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"><tt class="py-string"> single sequence of identifiers (given the appropriate imports),</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"><tt class="py-string"> then that sequence of identifiers is used as its canonical name.</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt> <tt class="py-line"><tt class="py-string"> If the value can be reached by multiple sequences of identifiers</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"><tt class="py-string"> (i.e., if it has multiple aliases), then one of those sequences of</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"><tt class="py-string"> identifiers is used. If the value cannot be reached by any</tt> </tt>
<a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"><tt class="py-string"> sequence of identifiers (e.g., if it was used as a base class but</tt> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"><tt class="py-string"> then its variable was deleted), then its canonical name will start</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-string"> with C{'??'}. If necessary, a dash followed by a number will be</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt class="py-string"> appended to the end of a non-reachable identifier to make its</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"><tt class="py-string"> canonical name unique.</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"><tt class="py-string"></tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt> <tt class="py-line"><tt class="py-string"> When possible, canonical names are chosen when new C{ValueDoc}s</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"><tt class="py-string"> are created. However, this is sometimes not possible. If a</tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"><tt class="py-string"> canonical name can not be chosen when the C{ValueDoc} is created,</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-string"> then one will be assigned by L{assign_canonical_names()</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"><tt class="py-string"> <docbuilder.assign_canonical_names>}.</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"><tt class="py-string"> @type: L{DottedName}"""</tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt> <tt class="py-line"> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt> <tt class="py-line"> <tt class="py-comment">#{ Value Representation</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-181" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.pyval=epydoc.apidoc.ValueDoc-class.html#pyval"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-181', 'pyval', 'link-181');">pyval</a></tt> <tt class="py-op">=</tt> <tt id="link-182" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-182', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A pointer to the actual Python object described by this</tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"><tt class="py-string"> C{ValueDoc}. This is used to display the value (e.g., when</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"><tt class="py-string"> describing a variable.) Use L{pyval_repr()} to generate a</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"><tt class="py-string"> plaintext string representation of this value.</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"><tt class="py-string"> @type: Python object"""</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt id="link-183" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.parse_repr=epydoc.apidoc.ValueDoc-class.html#parse_repr"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-183', 'parse_repr', 'link-183');">parse_repr</a></tt> <tt class="py-op">=</tt> <tt id="link-184" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-184', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A text representation of this value, extracted from </tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"><tt class="py-string"> parsing its source code. This representation may not accurately</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"><tt class="py-string"> reflect the actual value (e.g., if the value was modified after</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"><tt class="py-string"> the initial assignment).</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"><tt class="py-string"> @type: C{unicode}"""</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt id="link-185" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_MAXLINES=epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-185', 'REPR_MAXLINES', 'link-185');">REPR_MAXLINES</a></tt> <tt class="py-op">=</tt> <tt class="py-number">5</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-string">"""@cvar: The maximum number of lines of text that should be</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"><tt class="py-string"> generated by L{pyval_repr()}. If the string representation does</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"><tt class="py-string"> not fit in this number of lines, an ellpsis marker (...) will</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"><tt class="py-string"> be placed at the end of the formatted representation."""</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt id="link-186" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_LINELEN=epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-186', 'REPR_LINELEN', 'link-186');">REPR_LINELEN</a></tt> <tt class="py-op">=</tt> <tt class="py-number">75</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-string">"""@cvar: The maximum number of characters for lines of text that</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"><tt class="py-string"> should be generated by L{pyval_repr()}. Any lines that exceed</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"><tt class="py-string"> this number of characters will be line-wrappped; The S{crarr}</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"><tt class="py-string"> symbol will be used to indicate that the line was wrapped."""</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt id="link-187" class="py-name"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-187', 'SUMMARY_REPR_LINELEN', 'link-173');">SUMMARY_REPR_LINELEN</a></tt> <tt class="py-op">=</tt> <tt class="py-number">75</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"> <tt class="py-string">"""@cvar: The maximum number of characters for the single-line</tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-string"> text representation generated by L{summary_pyval_repr()}. If</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"><tt class="py-string"> the value's representation does not fit in this number of</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"><tt class="py-string"> characters, an ellipsis marker (...) will be placed at the end</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"><tt class="py-string"> of the formatted representation."""</tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt id="link-188" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.REPR_MIN_SCORE=epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE"><a title="epydoc.apidoc.ValueDoc.REPR_MIN_SCORE" class="py-name" href="#" onclick="return doclink('link-188', 'REPR_MIN_SCORE', 'link-188');">REPR_MIN_SCORE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-string">"""@cvar: The minimum score that a value representation based on</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"><tt class="py-string"> L{pyval} should have in order to be used instead of L{parse_repr}</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"><tt class="py-string"> as the canonical representation for this C{ValueDoc}'s value.</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"><tt class="py-string"> @see: L{epydoc.markup.pyval_repr}"""</tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt> <tt class="py-line"> <tt class="py-comment">#} end of "value representation" group</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-comment">#{ Context</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-189" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-189', 'defining_module', 'link-149');">defining_module</a></tt> <tt class="py-op">=</tt> <tt id="link-190" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-190', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The documentation for the module that defines this</tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-string"> value. This is used, e.g., to lookup the appropriate markup</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"><tt class="py-string"> language for docstrings. For a C{ModuleDoc},</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"><tt class="py-string"> C{defining_module} should be C{self}.</tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"><tt class="py-string"> @type: L{ModuleDoc}"""</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-comment">#} end of "context group"</tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Imported Variables</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-191" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.proxy_for=epydoc.apidoc.ValueDoc-class.html#proxy_for"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-191', 'proxy_for', 'link-191');">proxy_for</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> <tt class="py-comment"># [xx] in progress.</tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: If C{proxy_for} is not None, then this value was</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"><tt class="py-string"> imported from another file. C{proxy_for} is the dotted name of</tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"><tt class="py-string"> the variable that this value was imported from. If that</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"><tt class="py-string"> variable is documented, then its C{value} may contain more</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"><tt class="py-string"> complete API documentation about this value. The C{proxy_for}</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"><tt class="py-string"> attribute is used by the source code parser to link imported</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"><tt class="py-string"> values to their source values (in particular, for base</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"><tt class="py-string"> classes). When possible, these proxy C{ValueDoc}s are replaced</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"><tt class="py-string"> by the imported value's C{ValueDoc} by</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"><tt class="py-string"> L{link_imports()<docbuilder.link_imports>}.</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"><tt class="py-string"> @type: L{DottedName}"""</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information about imported variables" group</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt class="py-comment">#: @ivar:</tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: This is currently used to extract values from __all__, etc, in</tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: the docparser module; maybe I should specialize</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: process_assignment and extract it there? Although, for __all__,</tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: it's not clear where I'd put the value, since I just use it to</tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: set private/public/imported attribs on other vars (that might not</tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#: exist yet at the time.)</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-192" class="py-name" targets="Variable epydoc.apidoc.ValueDoc.toktree=epydoc.apidoc.ValueDoc-class.html#toktree"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-192', 'toktree', 'link-192');">toktree</a></tt> <tt class="py-op">=</tt> <tt id="link-193" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-193', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"> </tt>
<a name="ValueDoc.__repr__"></a><div id="ValueDoc.__repr__-def"><a name="L819"></a><tt class="py-lineno"> 819</tt> <a class="py-toggle" href="#" id="ValueDoc.__repr__-toggle" onclick="return toggle('ValueDoc.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ValueDoc.__repr__-expanded"><a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-194" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-194', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-195" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-195', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s %s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-196" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-196', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'<%s %s>'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> </tt>
<a name="L824"></a><tt class="py-lineno"> 824</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-197', 'summary_pyval_repr', 'link-176');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-198" class="py-name" targets="Method epydoc.markup.ConcatenatedDocstring.to_plaintext()=epydoc.markup.ConcatenatedDocstring-class.html#to_plaintext,Method epydoc.markup.ParsedDocstring.to_plaintext()=epydoc.markup.ParsedDocstring-class.html#to_plaintext,Method epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext()=epydoc.markup.epytext.ParsedEpytextDocstring-class.html#to_plaintext,Function epydoc.markup.epytext.to_plaintext()=epydoc.markup.epytext-module.html#to_plaintext,Method epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext()=epydoc.markup.javadoc.ParsedJavadocDocstring-class.html#to_plaintext,Method epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext()=epydoc.markup.plaintext.ParsedPlaintextDocstring-class.html#to_plaintext,Method epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext()=epydoc.markup.restructuredtext.ParsedRstDocstring-class.html#to_plaintext"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-198', 'to_plaintext', 'link-198');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> </tt>
<a name="ValueDoc.__setstate__"></a><div id="ValueDoc.__setstate__-def"><a name="L826"></a><tt class="py-lineno"> 826</tt> <a class="py-toggle" href="#" id="ValueDoc.__setstate__-toggle" onclick="return toggle('ValueDoc.__setstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html#__setstate__">__setstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">state</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc.__setstate__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ValueDoc.__setstate__-expanded"><a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> <tt class="py-op">=</tt> <tt class="py-name">state</tt> </tt>
</div><a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> </tt>
<a name="ValueDoc.__getstate__"></a><div id="ValueDoc.__getstate__-def"><a name="L829"></a><tt class="py-lineno"> 829</tt> <a class="py-toggle" href="#" id="ValueDoc.__getstate__-toggle" onclick="return toggle('ValueDoc.__getstate__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html#__getstate__">__getstate__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc.__getstate__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ValueDoc.__getstate__-expanded"><a name="L830"></a><tt class="py-lineno"> 830</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"><tt class="py-docstring"> State serializer for the pickle module. This is necessary</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"><tt class="py-docstring"> because sometimes the C{pyval} attribute contains an</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"><tt class="py-docstring"> un-pickleable value.</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-comment"># Construct our pickled dictionary. Maintain this dictionary</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># as a private attribute, so we can reuse it later, since</tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># merged objects need to share a single dictionary.</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'_ValueDoc__pickle_state'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> <tt class="py-comment"># Make sure __pyval_repr & __summary_pyval_repr are cached:</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-199', 'pyval_repr', 'link-12');">pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-200" class="py-name"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-200', 'summary_pyval_repr', 'link-176');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> <tt class="py-comment"># Construct the dictionary; leave out 'pyval'.</tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__pickle_state</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__pickle_state</tt><tt class="py-op">[</tt><tt class="py-string">'pyval'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-201" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-201', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt> <tt class="py-line"> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt id="link-202" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-202', 'GenericValueDoc', 'link-171');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__pickle_state</tt> <tt class="py-op">!=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt> <tt class="py-line"> <tt class="py-comment"># Return the pickle state.</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__pickle_state</tt> </tt>
</div><a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> <tt class="py-comment">#{ Value Representation</tt> </tt>
<a name="ValueDoc.pyval_repr"></a><div id="ValueDoc.pyval_repr-def"><a name="L851"></a><tt class="py-lineno"> 851</tt> <a class="py-toggle" href="#" id="ValueDoc.pyval_repr-toggle" onclick="return toggle('ValueDoc.pyval_repr');">-</a><tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html#pyval_repr">pyval_repr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc.pyval_repr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ValueDoc.pyval_repr-expanded"><a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</tt> <tt class="py-line"><tt class="py-docstring"> Return a formatted representation of the Python object</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"><tt class="py-docstring"> described by this C{ValueDoc}. This representation may</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"><tt class="py-docstring"> include data from introspection or parsing, and is authorative</tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"><tt class="py-docstring"> as 'the best way to represent a Python value.' Any lines that</tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"><tt class="py-docstring"> go beyond L{REPR_LINELEN} characters will be wrapped; and if</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-docstring"> the representation as a whole takes more than L{REPR_MAXLINES}</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"><tt class="py-docstring"> lines, then it will be truncated (with an ellipsis marker).</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"><tt class="py-docstring"> This function will never return L{UNKNOWN} or C{None}.</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{ColorizedPyvalRepr}</tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt class="py-comment"># Use self.__pyval_repr to cache the result.</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'_ValueDoc__pyval_repr'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__pyval_repr</tt> <tt class="py-op">=</tt> <tt id="link-203" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-203', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-204', 'markup', 'link-11');">markup</a></tt><tt class="py-op">.</tt><tt id="link-205" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-205', 'pyval_repr', 'link-12');">pyval_repr</a></tt><tt class="py-op">.</tt><tt id="link-206" class="py-name" targets="Function epydoc.markup.pyval_repr.colorize_pyval()=epydoc.markup.pyval_repr-module.html#colorize_pyval"><a title="epydoc.markup.pyval_repr.colorize_pyval" class="py-name" href="#" onclick="return doclink('link-206', 'colorize_pyval', 'link-206');">colorize_pyval</a></tt><tt class="py-op">(</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-207" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-207', 'pyval', 'link-181');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-208" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-208', 'parse_repr', 'link-183');">parse_repr</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-209" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MIN_SCORE" class="py-name" href="#" onclick="return doclink('link-209', 'REPR_MIN_SCORE', 'link-188');">REPR_MIN_SCORE</a></tt><tt class="py-op">,</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-210', 'REPR_LINELEN', 'link-186');">REPR_LINELEN</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MAXLINES" class="py-name" href="#" onclick="return doclink('link-211', 'REPR_MAXLINES', 'link-185');">REPR_MAXLINES</a></tt><tt class="py-op">,</tt> <tt class="py-name">linebreakok</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__pyval_repr</tt> </tt>
</div><a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> </tt>
<a name="ValueDoc.summary_pyval_repr"></a><div id="ValueDoc.summary_pyval_repr-def"><a name="L871"></a><tt class="py-lineno"> 871</tt> <a class="py-toggle" href="#" id="ValueDoc.summary_pyval_repr-toggle" onclick="return toggle('ValueDoc.summary_pyval_repr');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr">summary_pyval_repr</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">max_len</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc.summary_pyval_repr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ValueDoc.summary_pyval_repr-expanded"><a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"><tt class="py-docstring"> Return a single-line formatted representation of the Python</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt> <tt class="py-line"><tt class="py-docstring"> object described by this C{ValueDoc}. This representation may</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"><tt class="py-docstring"> include data from introspection or parsing, and is authorative</tt> </tt>
<a name="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"><tt class="py-docstring"> as 'the best way to summarize a Python value.' If the</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"><tt class="py-docstring"> representation takes more then L{SUMMARY_REPR_LINELEN}</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"><tt class="py-docstring"> characters, then it will be truncated (with an ellipsis</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"><tt class="py-docstring"> marker). This function will never return L{UNKNOWN} or</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-docstring"> C{None}.</tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{ColorizedPyvalRepr}</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-comment"># If max_len is specified, then do *not* cache the result.</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">max_len</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-212" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-212', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-213" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-213', 'markup', 'link-11');">markup</a></tt><tt class="py-op">.</tt><tt id="link-214" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-214', 'pyval_repr', 'link-12');">pyval_repr</a></tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="epydoc.markup.pyval_repr.colorize_pyval" class="py-name" href="#" onclick="return doclink('link-215', 'colorize_pyval', 'link-206');">colorize_pyval</a></tt><tt class="py-op">(</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-216" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-216', 'pyval', 'link-181');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-217', 'parse_repr', 'link-183');">parse_repr</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-218" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MIN_SCORE" class="py-name" href="#" onclick="return doclink('link-218', 'REPR_MIN_SCORE', 'link-188');">REPR_MIN_SCORE</a></tt><tt class="py-op">,</tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> <tt class="py-name">max_len</tt><tt class="py-op">,</tt> <tt class="py-name">maxlines</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">linebreakok</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt> <tt class="py-line"> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-comment"># Use self.__summary_pyval_repr to cache the result.</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-string">'_ValueDoc__summary_pyval_repr'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__summary_pyval_repr</tt> <tt class="py-op">=</tt> <tt id="link-219" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-219', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-220', 'markup', 'link-11');">markup</a></tt><tt class="py-op">.</tt><tt id="link-221" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval_repr
epydoc.markup.pyval_repr" class="py-name" href="#" onclick="return doclink('link-221', 'pyval_repr', 'link-12');">pyval_repr</a></tt><tt class="py-op">.</tt><tt id="link-222" class="py-name"><a title="epydoc.markup.pyval_repr.colorize_pyval" class="py-name" href="#" onclick="return doclink('link-222', 'colorize_pyval', 'link-206');">colorize_pyval</a></tt><tt class="py-op">(</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-223" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-223', 'pyval', 'link-181');">pyval</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-224" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-224', 'parse_repr', 'link-183');">parse_repr</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-225" class="py-name"><a title="epydoc.apidoc.ValueDoc.REPR_MIN_SCORE" class="py-name" href="#" onclick="return doclink('link-225', 'REPR_MIN_SCORE', 'link-188');">REPR_MIN_SCORE</a></tt><tt class="py-op">,</tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-226" class="py-name"><a title="epydoc.apidoc.ValueDoc.SUMMARY_REPR_LINELEN" class="py-name" href="#" onclick="return doclink('link-226', 'SUMMARY_REPR_LINELEN', 'link-173');">SUMMARY_REPR_LINELEN</a></tt><tt class="py-op">,</tt> <tt class="py-name">maxlines</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">linebreakok</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__summary_pyval_repr</tt> </tt>
</div><a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"> <tt class="py-comment">#} end of "value representation" group</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ValueDoc.apidoc_links"></a><div id="ValueDoc.apidoc_links-def"><a name="L898"></a><tt class="py-lineno"> 898</tt> <a class="py-toggle" href="#" id="ValueDoc.apidoc_links-toggle" onclick="return toggle('ValueDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ValueDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ValueDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ValueDoc.apidoc_links-expanded"><a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div></div><a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"> </tt>
<a name="GenericValueDoc"></a><div id="GenericValueDoc-def"><a name="L901"></a><tt class="py-lineno"> 901</tt> <a class="py-toggle" href="#" id="GenericValueDoc-toggle" onclick="return toggle('GenericValueDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.GenericValueDoc-class.html">GenericValueDoc</a><tt class="py-op">(</tt><tt class="py-base-class">ValueDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GenericValueDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="GenericValueDoc-expanded"><a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"><tt class="py-docstring"> API documentation about a 'generic' value, i.e., one that does not</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"><tt class="py-docstring"> have its own docstring or any information other than its value and</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"><tt class="py-docstring"> parse representation. C{GenericValueDoc}s do not get assigned</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</tt> <tt class="py-line"><tt class="py-docstring"> cannonical names.</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt id="link-227" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-227', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"> </tt>
<a name="GenericValueDoc.is_detailed"></a><div id="GenericValueDoc.is_detailed-def"><a name="L910"></a><tt class="py-lineno"> 910</tt> <a class="py-toggle" href="#" id="GenericValueDoc.is_detailed-toggle" onclick="return toggle('GenericValueDoc.is_detailed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.GenericValueDoc-class.html#is_detailed">is_detailed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="GenericValueDoc.is_detailed-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="GenericValueDoc.is_detailed-expanded"><a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-228" class="py-name"><a title="epydoc.apidoc.ValueDoc.summary_pyval_repr" class="py-name" href="#" onclick="return doclink('link-228', 'summary_pyval_repr', 'link-176');">summary_pyval_repr</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">is_complete</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc"></a><div id="NamespaceDoc-def"><a name="L913"></a><tt class="py-lineno"> 913</tt> <a class="py-toggle" href="#" id="NamespaceDoc-toggle" onclick="return toggle('NamespaceDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html">NamespaceDoc</a><tt class="py-op">(</tt><tt class="py-base-class">ValueDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="NamespaceDoc-expanded"><a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a singe Python namespace</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"><tt class="py-docstring"> value. (I.e., a module or a class).</tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Variables</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-229" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.variables=epydoc.apidoc.NamespaceDoc-class.html#variables"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-229', 'variables', 'link-229');">variables</a></tt> <tt class="py-op">=</tt> <tt id="link-230" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-230', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The contents of the namespace, encoded as a</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt> <tt class="py-line"><tt class="py-string"> dictionary mapping from identifiers to C{VariableDoc}s. This</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"><tt class="py-string"> dictionary contains all names defined by the namespace,</tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"><tt class="py-string"> including imported variables, aliased variables, and variables</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"><tt class="py-string"> inherited from base classes (once L{inherit_docs()</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-string"> <epydoc.docbuilder.inherit_docs>} has added them).</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt> <tt class="py-line"><tt class="py-string"> @type: C{dict} from C{string} to L{VariableDoc}"""</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt id="link-231" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.sorted_variables=epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-231', 'sorted_variables', 'link-231');">sorted_variables</a></tt> <tt class="py-op">=</tt> <tt id="link-232" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-232', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A list of all variables defined by this</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"><tt class="py-string"> namespace, in sorted order. The elements of this list should</tt> </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"><tt class="py-string"> exactly match the values of L{variables}. The sort order for</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"><tt class="py-string"> this list is defined as follows:</tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"><tt class="py-string"> - Any variables listed in a C{@sort} docstring field are</tt> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"><tt class="py-string"> listed in the order given by that field.</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"><tt class="py-string"> - These are followed by any variables that were found while</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"><tt class="py-string"> parsing the source code, in the order in which they were</tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"><tt class="py-string"> defined in the source file.</tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"><tt class="py-string"> - Finally, any remaining variables are listed in</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"><tt class="py-string"> alphabetical order.</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{VariableDoc}"""</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt id="link-233" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.sort_spec=epydoc.apidoc.NamespaceDoc-class.html#sort_spec"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-233', 'sort_spec', 'link-233');">sort_spec</a></tt> <tt class="py-op">=</tt> <tt id="link-234" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-234', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The order in which variables should be listed,</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"><tt class="py-string"> encoded as a list of names. Any variables whose names are not</tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"><tt class="py-string"> included in this list should be listed alphabetically,</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"><tt class="py-string"> following the variables that are included.</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of C{str}"""</tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt> <tt class="py-line"> <tt id="link-235" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.group_specs=epydoc.apidoc.NamespaceDoc-class.html#group_specs"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-235', 'group_specs', 'link-235');">group_specs</a></tt> <tt class="py-op">=</tt> <tt id="link-236" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-236', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The groups that are defined by this namespace's</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-string"> docstrings. C{group_specs} is encoded as an ordered list of</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-string"> tuples C{(group_name, elt_names)}, where C{group_name} is the</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-string"> name of a group and C{elt_names} is a list of element names in</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"><tt class="py-string"> that group. (An element can be a variable or a submodule.) A</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"><tt class="py-string"> '*' in an element name will match any string of characters.</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of C{(str,list)}"""</tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"> <tt id="link-237" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.variable_groups=epydoc.apidoc.NamespaceDoc-class.html#variable_groups"><a title="epydoc.apidoc.NamespaceDoc.variable_groups" class="py-name" href="#" onclick="return doclink('link-237', 'variable_groups', 'link-237');">variable_groups</a></tt> <tt class="py-op">=</tt> <tt id="link-238" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-238', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A dictionary specifying what group each</tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"><tt class="py-string"> variable belongs to. The keys of the dictionary are group</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"><tt class="py-string"> names, and the values are lists of C{VariableDoc}s. The order</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"><tt class="py-string"> that groups should be listed in should be taken from</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"><tt class="py-string"> L{group_specs}.</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt> <tt class="py-line"><tt class="py-string"> @type: C{dict} from C{str} to C{list} of L{VariableDoc}"""</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> <tt class="py-comment">#} end of group "information about variables"</tt> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="NamespaceDoc.__init__"></a><div id="NamespaceDoc.__init__-def"><a name="L964"></a><tt class="py-lineno"> 964</tt> <a class="py-toggle" href="#" id="NamespaceDoc.__init__-toggle" onclick="return toggle('NamespaceDoc.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.__init__-expanded"><a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-string">'variables'</tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt> <tt class="py-line"> <tt id="link-239" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-239', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">.</tt><tt id="link-240" class="py-name"><a title="epydoc.apidoc.APIDoc.__init__
epydoc.apidoc.DocIndex.__init__
epydoc.apidoc.DottedName.__init__
epydoc.apidoc.NamespaceDoc.__init__
epydoc.apidoc.VariableDoc.__init__
epydoc.apidoc._Sentinel.__init__
epydoc.checker.DocChecker.__init__
epydoc.cli.ConsoleLogger.__init__
epydoc.cli.HTMLLogger.__init__
epydoc.cli.TerminalController.__init__
epydoc.cli.UnifiedProgressConsoleLogger.__init__
epydoc.docbuilder.BuildOptions.__init__
epydoc.docbuilder._ProgressEstimator.__init__
epydoc.docintrospecter._DevNull.__init__
epydoc.docstringparser.DocstringField.__init__
epydoc.docwriter.dotgraph.DotGraph.__init__
epydoc.docwriter.dotgraph.DotGraphEdge.__init__
epydoc.docwriter.dotgraph.DotGraphNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlClassNode.__init__
epydoc.docwriter.dotgraph.DotGraphUmlModuleNode.__init__
epydoc.docwriter.html.HTMLWriter.__init__
epydoc.docwriter.html._HTMLDocstringLinker.__init__
epydoc.docwriter.html_colorize.PythonSourceColorizer.__init__
epydoc.docwriter.latex.LatexWriter.__init__
epydoc.docwriter.xlink.ApiLinkReader.__init__
epydoc.docwriter.xlink.DocUrlGenerator.__init__
epydoc.gui.EpydocGUI.__init__
epydoc.gui.GUILogger.__init__
epydoc.log.SimpleLogger.__init__
epydoc.markup.ConcatenatedDocstring.__init__
epydoc.markup.Field.__init__
epydoc.markup.ParseError.__init__
epydoc.markup.epytext.ColorizingError.__init__
epydoc.markup.epytext.Element.__init__
epydoc.markup.epytext.ParsedEpytextDocstring.__init__
epydoc.markup.epytext.Token.__init__
epydoc.markup.javadoc.ParsedJavadocDocstring.__init__
epydoc.markup.plaintext.ParsedPlaintextDocstring.__init__
epydoc.markup.pyval_repr.ColorizedPyvalRepr.__init__
epydoc.markup.pyval_repr.PyvalColorizer.__init__
epydoc.markup.pyval_repr._ColorizerState.__init__
epydoc.markup.restructuredtext.ParsedRstDocstring.__init__
epydoc.markup.restructuredtext._DocumentPseudoWriter.__init__
epydoc.markup.restructuredtext._EpydocHTMLTranslator.__init__
epydoc.markup.restructuredtext._EpydocLaTeXTranslator.__init__
epydoc.markup.restructuredtext._EpydocReader.__init__
epydoc.markup.restructuredtext._SplitFieldsTranslator.__init__
epydoc.markup.restructuredtext._SummaryExtractor.__init__
epydoc.markup.restructuredtext._TermsExtractor.__init__
epydoc.markup.restructuredtext.dotgraph.__init__
epydoc.util.RunSubprocessError.__init__" class="py-name" href="#" onclick="return doclink('link-240', '__init__', 'link-79');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-241" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-241', 'variables', 'link-229');">variables</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-242" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-242', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
</div><a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc.is_detailed"></a><div id="NamespaceDoc.is_detailed-def"><a name="L969"></a><tt class="py-lineno"> 969</tt> <a class="py-toggle" href="#" id="NamespaceDoc.is_detailed-toggle" onclick="return toggle('NamespaceDoc.is_detailed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#is_detailed">is_detailed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.is_detailed-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.is_detailed-expanded"><a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc.apidoc_links"></a><div id="NamespaceDoc.apidoc_links-def"><a name="L972"></a><tt class="py-lineno"> 972</tt> <a class="py-toggle" href="#" id="NamespaceDoc.apidoc_links-toggle" onclick="return toggle('NamespaceDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.apidoc_links-expanded"><a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt id="link-243" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-243', 'variables', 'link-229');">variables</a></tt> <tt class="py-op">=</tt> <tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'variables'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> <tt id="link-244" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.imports=epydoc.apidoc.ModuleDoc-class.html#imports"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-244', 'imports', 'link-244');">imports</a></tt> <tt class="py-op">=</tt> <tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'imports'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"> <tt class="py-name">private</tt> <tt class="py-op">=</tt> <tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'private'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-245" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-245', 'variables', 'link-229');">variables</a></tt> <tt class="py-keyword">and</tt> <tt id="link-246" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-246', 'imports', 'link-244');">imports</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">private</tt><tt class="py-op">:</tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-247" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-247', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-comment"># list the common case first.</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt id="link-248" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-248', 'variables', 'link-229');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt id="link-249" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-249', 'imports', 'link-244');">imports</a></tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">private</tt><tt class="py-op">:</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt id="link-250" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-250', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-251" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-251', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-252" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-252', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt id="link-253" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-253', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-254" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-254', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">True</tt> <tt class="py-keyword">and</tt> <tt id="link-255" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-255', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-256" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-256', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">False</tt><tt class="py-op">]</tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt class="py-name">private</tt><tt class="py-op">:</tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt id="link-257" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-257', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-258" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-258', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-259" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-259', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> <tt id="link-260" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-260', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-261" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-261', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">False</tt><tt class="py-op">]</tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt id="link-262" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-262', 'imports', 'link-244');">imports</a></tt><tt class="py-op">:</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt id="link-263" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-263', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-264" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-264', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-265" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-265', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"> <tt id="link-266" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-266', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-267" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-267', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-string">'this line should be unreachable'</tt> </tt>
</div><a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc.init_sorted_variables"></a><div id="NamespaceDoc.init_sorted_variables-def"><a name="L991"></a><tt class="py-lineno"> 991</tt> <a class="py-toggle" href="#" id="NamespaceDoc.init_sorted_variables-toggle" onclick="return toggle('NamespaceDoc.init_sorted_variables');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables">init_sorted_variables</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.init_sorted_variables-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.init_sorted_variables-expanded"><a name="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"><tt class="py-docstring"> Initialize the L{sorted_variables} attribute, based on the</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"><tt class="py-docstring"> L{variables} and L{sort_spec} attributes. This should usually</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"><tt class="py-docstring"> be called after all variables have been added to C{variables}</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"><tt class="py-docstring"> (including any inherited variables for classes). </tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt class="py-name">unsorted</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-268" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-268', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">copy</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-269" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-269', 'sorted_variables', 'link-231');">sorted_variables</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> <tt class="py-comment"># Add any variables that are listed in sort_spec</tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-270" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-270', 'sort_spec', 'link-233');">sort_spec</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-271" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-271', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"> <tt class="py-name">unused_idents</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-272" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-272', 'sort_spec', 'link-233');">sort_spec</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-273" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-273', 'sort_spec', 'link-233');">sort_spec</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">unsorted</tt><tt class="py-op">:</tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-274" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-274', 'sorted_variables', 'link-231');">sorted_variables</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">unsorted</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"> <tt class="py-name">unused_idents</tt><tt class="py-op">.</tt><tt class="py-name">discard</tt><tt class="py-op">(</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-string">'*'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ident</tt><tt class="py-op">:</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"> <tt class="py-name">regexp</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">'^%s$'</tt> <tt class="py-op">%</tt> <tt class="py-name">ident</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'*'</tt><tt class="py-op">,</tt> <tt class="py-string">'(.*)'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"> <tt class="py-comment"># sort within matching group?</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-275" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-275', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">unsorted</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">regexp</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt id="link-276" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-276', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-277" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-277', 'sorted_variables', 'link-231');">sorted_variables</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">unsorted</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt id="link-278" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-278', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"> <tt class="py-name">unused_idents</tt><tt class="py-op">.</tt><tt class="py-name">discard</tt><tt class="py-op">(</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">unused_idents</tt><tt class="py-op">:</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-string">'__all__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__docformat__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__path__'</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt id="link-279" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-279', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-280" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-280', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"@sort: %s.%s not found"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-281" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-281', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">ident</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt> <tt class="py-line"> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt> <tt class="py-line"> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"> <tt class="py-comment"># Add any remaining variables in alphabetical order.</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_docs</tt> <tt class="py-op">=</tt> <tt class="py-name">unsorted</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-name">var_docs</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-282" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-282', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_docs</tt><tt class="py-op">:</tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-283" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-283', 'sorted_variables', 'link-231');">sorted_variables</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc.init_variable_groups"></a><div id="NamespaceDoc.init_variable_groups-def"><a name="L1027"></a><tt class="py-lineno">1027</tt> <a class="py-toggle" href="#" id="NamespaceDoc.init_variable_groups-toggle" onclick="return toggle('NamespaceDoc.init_variable_groups');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups">init_variable_groups</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.init_variable_groups-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.init_variable_groups-expanded"><a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"><tt class="py-docstring"> Initialize the L{variable_groups} attribute, based on the</tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt> <tt class="py-line"><tt class="py-docstring"> L{sorted_variables} and L{group_specs} attributes.</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-284" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-284', 'sorted_variables', 'link-231');">sorted_variables</a></tt> <tt class="py-keyword">is</tt> <tt id="link-285" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-285', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-286" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc.init_sorted_variables()=epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables"><a title="epydoc.apidoc.NamespaceDoc.init_sorted_variables" class="py-name" href="#" onclick="return doclink('link-286', 'init_sorted_variables', 'link-286');">init_sorted_variables</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-287" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-287', 'sorted_variables', 'link-231');">sorted_variables</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-288" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-288', 'variables', 'link-229');">variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> <tt class="py-name">elts</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt id="link-289" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-289', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-290" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-290', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt id="link-291" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-291', 'v', 'link-103');">v</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt id="link-292" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-292', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-293" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-293', 'sorted_variables', 'link-231');">sorted_variables</a></tt><tt class="py-op">]</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unused_groups</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">,</tt><tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">,</tt><tt class="py-name">i</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-294" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-294', 'group_specs', 'link-235');">group_specs</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-295" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variable_groups" class="py-name" href="#" onclick="return doclink('link-295', 'variable_groups', 'link-237');">variable_groups</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-296" class="py-name" targets="Method epydoc.apidoc.NamespaceDoc._init_grouping()=epydoc.apidoc.NamespaceDoc-class.html#_init_grouping"><a title="epydoc.apidoc.NamespaceDoc._init_grouping" class="py-name" href="#" onclick="return doclink('link-296', '_init_grouping', 'link-296');">_init_grouping</a></tt><tt class="py-op">(</tt><tt class="py-name">elts</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc.group_names"></a><div id="NamespaceDoc.group_names-def"><a name="L1040"></a><tt class="py-lineno">1040</tt> <a class="py-toggle" href="#" id="NamespaceDoc.group_names-toggle" onclick="return toggle('NamespaceDoc.group_names');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#group_names">group_names</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.group_names-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.group_names-expanded"><a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of the group names defined by this namespace, in</tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt> <tt class="py-line"><tt class="py-docstring"> the order in which they should be listed, with no duplicates.</tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt> <tt class="py-line"> <tt id="link-297" class="py-name" targets="Function epydoc.docwriter.dotgraph.name_list()=epydoc.docwriter.dotgraph-module.html#name_list"><a title="epydoc.docwriter.dotgraph.name_list" class="py-name" href="#" onclick="return doclink('link-297', 'name_list', 'link-297');">name_list</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">''</tt><tt class="py-op">]</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"> <tt class="py-name">name_set</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-298" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-298', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">spec</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-299" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-299', 'group_specs', 'link-235');">group_specs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-300" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-300', 'name', 'link-36');">name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">name_set</tt><tt class="py-op">:</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"> <tt class="py-name">name_set</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt id="link-301" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-301', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> <tt id="link-302" class="py-name"><a title="epydoc.docwriter.dotgraph.name_list" class="py-name" href="#" onclick="return doclink('link-302', 'name_list', 'link-297');">name_list</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-303" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-303', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-304" class="py-name"><a title="epydoc.docwriter.dotgraph.name_list" class="py-name" href="#" onclick="return doclink('link-304', 'name_list', 'link-297');">name_list</a></tt> </tt>
</div><a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc._init_grouping"></a><div id="NamespaceDoc._init_grouping-def"><a name="L1053"></a><tt class="py-lineno">1053</tt> <a class="py-toggle" href="#" id="NamespaceDoc._init_grouping-toggle" onclick="return toggle('NamespaceDoc._init_grouping');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping">_init_grouping</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">elts</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc._init_grouping-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc._init_grouping-expanded"><a name="L1054"></a><tt class="py-lineno">1054</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt> <tt class="py-line"><tt class="py-docstring"> Divide a given a list of APIDoc objects into groups, as</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"><tt class="py-docstring"> specified by L{self.group_specs}.</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"><tt class="py-docstring"> @param elts: A list of tuples C{(name, apidoc)}.</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"><tt class="py-docstring"> @return: A list of tuples C{(groupname, elts)}, where</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"><tt class="py-docstring"> C{groupname} is the name of a group and C{elts} is a list of</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"><tt class="py-docstring"> C{APIDoc}s in that group. The first tuple has name C{''}, and</tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"><tt class="py-docstring"> is used for ungrouped elements. The remaining tuples are</tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"><tt class="py-docstring"> listed in the order that they appear in C{self.group_specs}.</tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"><tt class="py-docstring"> Within each tuple, the elements are listed in the order that</tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"><tt class="py-docstring"> they appear in C{api_docs}.</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"> <tt class="py-comment"># Make the common case fast.</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-305" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-305', 'group_specs', 'link-235');">group_specs</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">{</tt><tt class="py-string">''</tt><tt class="py-op">:</tt> <tt class="py-op">[</tt><tt class="py-name">elt</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">elts</tt><tt class="py-op">]</tt><tt class="py-op">}</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"> <tt class="py-name">ungrouped</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">elt_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">elt_name</tt><tt class="py-op">,</tt> <tt class="py-name">elt_doc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">elts</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"> <tt class="py-name">ungrouped</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">elts</tt><tt class="py-op">)</tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elt_name</tt><tt class="py-op">,</tt> <tt class="py-name">elt_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">elts</tt><tt class="py-op">:</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">group_name</tt><tt class="py-op">,</tt> <tt class="py-name">idents</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-306" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-306', 'group_specs', 'link-235');">group_specs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> <tt class="py-name">group</tt> <tt class="py-op">=</tt> <tt class="py-name">groups</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">group_name</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-name">unused_groups</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unused_groups</tt><tt class="py-op">[</tt><tt class="py-name">group_name</tt><tt class="py-op">]</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">idents</tt><tt class="py-op">:</tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">'^%s$'</tt> <tt class="py-op">%</tt> <tt class="py-name">ident</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'*'</tt><tt class="py-op">,</tt> <tt class="py-string">'(.*)'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">elt_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> <tt class="py-name">unused_groups</tt><tt class="py-op">.</tt><tt class="py-name">discard</tt><tt class="py-op">(</tt><tt class="py-name">ident</tt><tt class="py-op">)</tt> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">elt_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ungrouped</tt><tt class="py-op">:</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"> <tt class="py-name">group</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">ungrouped</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-name">elt_name</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"> <tt id="link-307" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-307', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-308" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-308', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s.%s in multiple groups"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-309" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-309', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">elt_name</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-comment"># Convert ungrouped from an unordered set to an ordered list.</tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt><tt class="py-op">[</tt><tt class="py-string">''</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">elt_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">elt_name</tt><tt class="py-op">,</tt> <tt class="py-name">elt_doc</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">elts</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">elt_name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ungrouped</tt><tt class="py-op">]</tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">groups</tt> </tt>
</div><a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> </tt>
<a name="NamespaceDoc.report_unused_groups"></a><div id="NamespaceDoc.report_unused_groups-def"><a name="L1094"></a><tt class="py-lineno">1094</tt> <a class="py-toggle" href="#" id="NamespaceDoc.report_unused_groups-toggle" onclick="return toggle('NamespaceDoc.report_unused_groups');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.NamespaceDoc-class.html#report_unused_groups">report_unused_groups</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NamespaceDoc.report_unused_groups-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="NamespaceDoc.report_unused_groups-expanded"><a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"><tt class="py-docstring"> Issue a warning for any @group items that were not used by</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-docstring"> L{_init_grouping()}.</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">,</tt> <tt class="py-name">unused_idents</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_unused_groups</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">ident</tt> <tt class="py-keyword">in</tt> <tt class="py-name">unused_idents</tt><tt class="py-op">:</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt> <tt class="py-line"> <tt id="link-310" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-310', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-311" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-311', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"@group %s: %s.%s not found"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-312" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-312', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">ident</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> </tt>
<a name="ModuleDoc"></a><div id="ModuleDoc-def"><a name="L1104"></a><tt class="py-lineno">1104</tt> <a class="py-toggle" href="#" id="ModuleDoc-toggle" onclick="return toggle('ModuleDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.ModuleDoc-class.html">ModuleDoc</a><tt class="py-op">(</tt><tt class="py-base-class">NamespaceDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModuleDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ModuleDoc-expanded"><a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a single module.</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about the Module</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-313" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.filename=epydoc.apidoc.ModuleDoc-class.html#filename"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-313', 'filename', 'link-313');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-314" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-314', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The name of the file that defines the module.</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"><tt class="py-string"> @type: C{string}"""</tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"> <tt id="link-315" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.docformat=epydoc.apidoc.ModuleDoc-class.html#docformat"><a title="epydoc.apidoc.ModuleDoc.docformat" class="py-name" href="#" onclick="return doclink('link-315', 'docformat', 'link-315');">docformat</a></tt> <tt class="py-op">=</tt> <tt id="link-316" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-316', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The markup language used by docstrings in this module.</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"><tt class="py-string"> @type: C{string}"""</tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Submodules</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-317" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodules=epydoc.apidoc.ModuleDoc-class.html#submodules"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-317', 'submodules', 'link-317');">submodules</a></tt> <tt class="py-op">=</tt> <tt id="link-318" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-318', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Modules contained by this module (if this module</tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"><tt class="py-string"> is a package). (Note: on rare occasions, a module may have a</tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"><tt class="py-string"> submodule that is shadowed by a variable with the same name.)</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{ModuleDoc}"""</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"> <tt id="link-319" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodule_groups=epydoc.apidoc.ModuleDoc-class.html#submodule_groups"><a title="epydoc.apidoc.ModuleDoc.submodule_groups" class="py-name" href="#" onclick="return doclink('link-319', 'submodule_groups', 'link-319');">submodule_groups</a></tt> <tt class="py-op">=</tt> <tt id="link-320" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-320', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A dictionary specifying what group each</tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"><tt class="py-string"> submodule belongs to. The keys of the dictionary are group</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"><tt class="py-string"> names, and the values are lists of C{ModuleDoc}s. The order</tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"><tt class="py-string"> that groups should be listed in should be taken from</tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"><tt class="py-string"> L{group_specs}.</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"><tt class="py-string"> @type: C{dict} from C{str} to C{list} of L{ModuleDoc}"""</tt> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Packages</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-321" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.package=epydoc.apidoc.ModuleDoc-class.html#package"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-321', 'package', 'link-321');">package</a></tt> <tt class="py-op">=</tt> <tt id="link-322" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-322', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the module's containing package.</tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"><tt class="py-string"> @type: L{ModuleDoc}"""</tt> </tt>
<a name="L1132"></a><tt class="py-lineno">1132</tt> <tt class="py-line"> <tt id="link-323" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.is_package=epydoc.apidoc.ModuleDoc-class.html#is_package"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-323', 'is_package', 'link-323');">is_package</a></tt> <tt class="py-op">=</tt> <tt id="link-324" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-324', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: True if this C{ModuleDoc} describes a package.</tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"><tt class="py-string"> @type: C{bool}"""</tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt id="link-325" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-325', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt id="link-326" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-326', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: If this C{ModuleDoc} describes a package, then C{path}</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-string"> contains a list of directories that constitute its path (i.e.,</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"><tt class="py-string"> the value of its C{__path__} variable).</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of C{str}"""</tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Imported Variables</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-327" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-327', 'imports', 'link-244');">imports</a></tt> <tt class="py-op">=</tt> <tt id="link-328" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-328', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A list of the source names of variables imported into</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"><tt class="py-string"> this module. This is used to construct import graphs.</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{DottedName}"""</tt> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"> <tt class="py-comment">#}</tt> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ModuleDoc.apidoc_links"></a><div id="ModuleDoc.apidoc_links-def"><a name="L1147"></a><tt class="py-lineno">1147</tt> <a class="py-toggle" href="#" id="ModuleDoc.apidoc_links-toggle" onclick="return toggle('ModuleDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ModuleDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModuleDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ModuleDoc.apidoc_links-expanded"><a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt> <tt class="py-op">=</tt> <tt id="link-329" class="py-name" targets="Class epydoc.apidoc.NamespaceDoc=epydoc.apidoc.NamespaceDoc-class.html"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-329', 'NamespaceDoc', 'link-329');">NamespaceDoc</a></tt><tt class="py-op">.</tt><tt id="link-330" class="py-name"><a title="epydoc.apidoc.APIDoc.apidoc_links
epydoc.apidoc.ClassDoc.apidoc_links
epydoc.apidoc.ModuleDoc.apidoc_links
epydoc.apidoc.NamespaceDoc.apidoc_links
epydoc.apidoc.PropertyDoc.apidoc_links
epydoc.apidoc.ValueDoc.apidoc_links
epydoc.apidoc.VariableDoc.apidoc_links" class="py-name" href="#" onclick="return doclink('link-330', 'apidoc_links', 'link-105');">apidoc_links</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">filters</tt><tt class="py-op">)</tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'packages'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-331" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-331', 'package', 'link-321');">package</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-332" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-332', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-333" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-333', 'package', 'link-321');">package</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'submodules'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-334" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-334', 'submodules', 'link-317');">submodules</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-335" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-335', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-336" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-336', 'submodules', 'link-317');">submodules</a></tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_docs</tt> </tt>
</div><a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"> </tt>
<a name="ModuleDoc.init_submodule_groups"></a><div id="ModuleDoc.init_submodule_groups-def"><a name="L1157"></a><tt class="py-lineno">1157</tt> <a class="py-toggle" href="#" id="ModuleDoc.init_submodule_groups-toggle" onclick="return toggle('ModuleDoc.init_submodule_groups');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ModuleDoc-class.html#init_submodule_groups">init_submodule_groups</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModuleDoc.init_submodule_groups-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ModuleDoc.init_submodule_groups-expanded"><a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"><tt class="py-docstring"> Initialize the L{submodule_groups} attribute, based on the</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"><tt class="py-docstring"> L{submodules} and L{group_specs} attributes.</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-337" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-337', 'submodules', 'link-317');">submodules</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-338" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-338', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-339" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-339', 'submodules', 'link-317');">submodules</a></tt> <tt class="py-op">=</tt> <tt id="link-340" class="py-name" targets="Function epydoc.compat.sorted()=epydoc.compat-module.html#sorted"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-340', 'sorted', 'link-340');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-341" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-341', 'submodules', 'link-317');">submodules</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt> <tt class="py-line"> <tt id="link-342" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-342', 'key', 'link-65');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-343" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-343', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt class="py-name">elts</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt id="link-344" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-344', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">m</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">m</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-345" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-345', 'submodules', 'link-317');">submodules</a></tt><tt class="py-op">]</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-346" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodule_groups" class="py-name" href="#" onclick="return doclink('link-346', 'submodule_groups', 'link-319');">submodule_groups</a></tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-347" class="py-name"><a title="epydoc.apidoc.NamespaceDoc._init_grouping" class="py-name" href="#" onclick="return doclink('link-347', '_init_grouping', 'link-296');">_init_grouping</a></tt><tt class="py-op">(</tt><tt class="py-name">elts</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> </tt>
<a name="ModuleDoc.select_variables"></a><div id="ModuleDoc.select_variables-def"><a name="L1169"></a><tt class="py-lineno">1169</tt> <a class="py-toggle" href="#" id="ModuleDoc.select_variables-toggle" onclick="return toggle('ModuleDoc.select_variables');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ModuleDoc-class.html#select_variables">select_variables</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">group</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">value_type</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">public</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"> <tt class="py-param">imported</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">detailed</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ModuleDoc.select_variables-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ModuleDoc.select_variables-expanded"><a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"><tt class="py-docstring"> Return a specified subset of this module's L{sorted_variables}</tt> </tt>
<a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"><tt class="py-docstring"> list. If C{value_type} is given, then only return variables</tt> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt> <tt class="py-line"><tt class="py-docstring"> whose values have the specified type. If C{group} is given,</tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt> <tt class="py-line"><tt class="py-docstring"> then only return variables that belong to the specified group.</tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"><tt class="py-docstring"> @require: The L{sorted_variables}, L{variable_groups}, and</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"><tt class="py-docstring"> L{submodule_groups} attributes must be initialized before</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"><tt class="py-docstring"> this method can be used. See L{init_sorted_variables()},</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-docstring"> L{init_variable_groups()}, and L{init_submodule_groups()}.</tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"><tt class="py-docstring"> @param value_type: A string specifying the value type for</tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"><tt class="py-docstring"> which variables should be returned. Valid values are:</tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"><tt class="py-docstring"> - 'class' - variables whose values are classes or types.</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"><tt class="py-docstring"> - 'function' - variables whose values are functions.</tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"><tt class="py-docstring"> - 'other' - variables whose values are not classes,</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"><tt class="py-docstring"> exceptions, types, or functions.</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"><tt class="py-docstring"> @type value_type: C{string}</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</tt> <tt class="py-line"><tt class="py-docstring"> @param group: The name of the group for which variables should</tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</tt> <tt class="py-line"><tt class="py-docstring"> be returned. A complete list of the groups defined by</tt> </tt>
<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"><tt class="py-docstring"> this C{ModuleDoc} is available in the L{group_names}</tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"><tt class="py-docstring"> instance variable. The first element of this list is</tt> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"><tt class="py-docstring"> always the special group name C{''}, which is used for</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"><tt class="py-docstring"> variables that do not belong to any group.</tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"><tt class="py-docstring"> @type group: C{string}</tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"><tt class="py-docstring"> @param detailed: If True (False), return only the variables</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"><tt class="py-docstring"> deserving (not deserving) a detailed informative box.</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"><tt class="py-docstring"> If C{None}, don't care.</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"><tt class="py-docstring"> @type detailed: C{bool}</tt> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-348" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-348', 'sorted_variables', 'link-231');">sorted_variables</a></tt> <tt class="py-keyword">is</tt> <tt id="link-349" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-349', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-350" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variable_groups" class="py-name" href="#" onclick="return doclink('link-350', 'variable_groups', 'link-237');">variable_groups</a></tt> <tt class="py-keyword">is</tt> <tt id="link-351" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-351', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'sorted_variables and variable_groups '</tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> <tt class="py-string">'must be initialized first.'</tt><tt class="py-op">)</tt> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">group</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-352" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-352', 'sorted_variables', 'link-231');">sorted_variables</a></tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1210"></a><tt class="py-lineno">1210</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-353" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variable_groups" class="py-name" href="#" onclick="return doclink('link-353', 'variable_groups', 'link-237');">variable_groups</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">group</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-354" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-354', 'sorted_variables', 'link-231');">sorted_variables</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt> <tt class="py-line"> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"> <tt class="py-comment"># Public/private filter (Count UNKNOWN as public)</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">public</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-355" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-355', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-356" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-356', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-357" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-357', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-358" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-358', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">False</tt><tt class="py-op">]</tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">public</tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-359" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-359', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-360" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-360', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-361" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-361', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-362" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-362', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">]</tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"> <tt class="py-comment"># Imported filter (Count UNKNOWN as non-imported)</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">imported</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-363" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-363', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-364" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-364', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-365" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-365', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-366" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-366', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">imported</tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-367" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-367', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-368" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-368', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-369" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-369', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-370" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-370', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> <tt class="py-comment"># Detailed filter</tt> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">detailed</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-371" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-371', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-372" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-372', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-373" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-373', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-374" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-374', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">detailed</tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-375" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-375', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-376" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-376', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-377" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-377', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-378" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-378', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"> <tt class="py-comment"># [xx] Modules are not currently included in any of these</tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># value types.</tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">value_type</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'class'</tt><tt class="py-op">:</tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-379" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-379', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-380" class="py-name" targets="Class epydoc.apidoc.ClassDoc=epydoc.apidoc.ClassDoc-class.html"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-380', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'function'</tt><tt class="py-op">:</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-381" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-381', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-382" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-382', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'other'</tt><tt class="py-op">:</tt> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-383" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-383', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-384" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-384', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt id="link-385" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-385', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt id="link-386" class="py-name" targets="Class epydoc.apidoc.ModuleDoc=epydoc.apidoc.ModuleDoc-class.html"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-386', 'ModuleDoc', 'link-386');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad value type %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">value_type</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"> </tt>
<a name="ClassDoc"></a><div id="ClassDoc-def"><a name="L1247"></a><tt class="py-lineno">1247</tt> <a class="py-toggle" href="#" id="ClassDoc-toggle" onclick="return toggle('ClassDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html">ClassDoc</a><tt class="py-op">(</tt><tt class="py-base-class">NamespaceDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ClassDoc-expanded"><a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a single class.</tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Base Classes</tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-387" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.bases=epydoc.apidoc.ClassDoc-class.html#bases"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-387', 'bases', 'link-387');">bases</a></tt> <tt class="py-op">=</tt> <tt id="link-388" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-388', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the class's base classes.</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{ClassDoc}"""</tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"> <tt class="py-comment">#{ Information about Subclasses</tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-389" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.subclasses=epydoc.apidoc.ClassDoc-class.html#subclasses"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-389', 'subclasses', 'link-389');">subclasses</a></tt> <tt class="py-op">=</tt> <tt id="link-390" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-390', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the class's known subclasses.</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{ClassDoc}"""</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"> <tt class="py-comment">#}</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ClassDoc.apidoc_links"></a><div id="ClassDoc.apidoc_links-def"><a name="L1261"></a><tt class="py-lineno">1261</tt> <a class="py-toggle" href="#" id="ClassDoc.apidoc_links-toggle" onclick="return toggle('ClassDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc.apidoc_links-expanded"><a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt> <tt class="py-op">=</tt> <tt id="link-391" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-391', 'NamespaceDoc', 'link-329');">NamespaceDoc</a></tt><tt class="py-op">.</tt><tt id="link-392" class="py-name"><a title="epydoc.apidoc.APIDoc.apidoc_links
epydoc.apidoc.ClassDoc.apidoc_links
epydoc.apidoc.ModuleDoc.apidoc_links
epydoc.apidoc.NamespaceDoc.apidoc_links
epydoc.apidoc.PropertyDoc.apidoc_links
epydoc.apidoc.ValueDoc.apidoc_links
epydoc.apidoc.VariableDoc.apidoc_links" class="py-name" href="#" onclick="return doclink('link-392', 'apidoc_links', 'link-105');">apidoc_links</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">filters</tt><tt class="py-op">)</tt> </tt>
<a name="L1263"></a><tt class="py-lineno">1263</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'bases'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-393" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-393', 'bases', 'link-387');">bases</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-394" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-394', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-395" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-395', 'bases', 'link-387');">bases</a></tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">filters</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-string">'subclasses'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-396" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-396', 'subclasses', 'link-389');">subclasses</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-397" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-397', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-398" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-398', 'subclasses', 'link-389');">subclasses</a></tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_docs</tt> </tt>
</div><a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> </tt>
<a name="ClassDoc.is_type"></a><div id="ClassDoc.is_type-def"><a name="L1271"></a><tt class="py-lineno">1271</tt> <a class="py-toggle" href="#" id="ClassDoc.is_type-toggle" onclick="return toggle('ClassDoc.is_type');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#is_type">is_type</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc.is_type-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc.is_type-expanded"><a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-399" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-399', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-op">==</tt> <tt id="link-400" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-400', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'type'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-401" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-401', 'bases', 'link-387');">bases</a></tt> <tt class="py-keyword">is</tt> <tt id="link-402" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-402', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-403" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-403', 'bases', 'link-387');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-404" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-404', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-405" class="py-name" targets="Method epydoc.apidoc.ClassDoc.is_type()=epydoc.apidoc.ClassDoc-class.html#is_type"><a title="epydoc.apidoc.ClassDoc.is_type" class="py-name" href="#" onclick="return doclink('link-405', 'is_type', 'link-405');">is_type</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"> </tt>
<a name="ClassDoc.is_exception"></a><div id="ClassDoc.is_exception-def"><a name="L1279"></a><tt class="py-lineno">1279</tt> <a class="py-toggle" href="#" id="ClassDoc.is_exception-toggle" onclick="return toggle('ClassDoc.is_exception');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#is_exception">is_exception</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc.is_exception-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc.is_exception-expanded"><a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-406" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-406', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-op">==</tt> <tt id="link-407" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-407', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'Exception'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-408" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-408', 'bases', 'link-387');">bases</a></tt> <tt class="py-keyword">is</tt> <tt id="link-409" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-409', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1282"></a><tt class="py-lineno">1282</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-410" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-410', 'bases', 'link-387');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-411" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-411', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-412" class="py-name" targets="Method epydoc.apidoc.ClassDoc.is_exception()=epydoc.apidoc.ClassDoc-class.html#is_exception"><a title="epydoc.apidoc.ClassDoc.is_exception" class="py-name" href="#" onclick="return doclink('link-412', 'is_exception', 'link-412');">is_exception</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"> </tt>
<a name="ClassDoc.is_newstyle_class"></a><div id="ClassDoc.is_newstyle_class-def"><a name="L1287"></a><tt class="py-lineno">1287</tt> <a class="py-toggle" href="#" id="ClassDoc.is_newstyle_class-toggle" onclick="return toggle('ClassDoc.is_newstyle_class');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#is_newstyle_class">is_newstyle_class</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc.is_newstyle_class-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc.is_newstyle_class-expanded"><a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-413" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-413', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-op">==</tt> <tt id="link-414" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-414', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'object'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-415" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-415', 'bases', 'link-387');">bases</a></tt> <tt class="py-keyword">is</tt> <tt id="link-416" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-416', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-417" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-417', 'bases', 'link-387');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-418" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-418', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-419" class="py-name" targets="Method epydoc.apidoc.ClassDoc.is_newstyle_class()=epydoc.apidoc.ClassDoc-class.html#is_newstyle_class"><a title="epydoc.apidoc.ClassDoc.is_newstyle_class" class="py-name" href="#" onclick="return doclink('link-419', 'is_newstyle_class', 'link-419');">is_newstyle_class</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> </tt>
<a name="ClassDoc.mro"></a><div id="ClassDoc.mro-def"><a name="L1295"></a><tt class="py-lineno">1295</tt> <a class="py-toggle" href="#" id="ClassDoc.mro-toggle" onclick="return toggle('ClassDoc.mro');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#mro">mro</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">warn_about_bad_bases</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc.mro-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc.mro-expanded"><a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-420" class="py-name"><a title="epydoc.apidoc.ClassDoc.is_newstyle_class" class="py-name" href="#" onclick="return doclink('link-420', 'is_newstyle_class', 'link-419');">is_newstyle_class</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-421" class="py-name" targets="Method epydoc.apidoc.ClassDoc._c3_mro()=epydoc.apidoc.ClassDoc-class.html#_c3_mro"><a title="epydoc.apidoc.ClassDoc._c3_mro" class="py-name" href="#" onclick="return doclink('link-421', '_c3_mro', 'link-421');">_c3_mro</a></tt><tt class="py-op">(</tt><tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">)</tt> </tt>
<a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-422" class="py-name" targets="Method epydoc.apidoc.ClassDoc._dfs_bases()=epydoc.apidoc.ClassDoc-class.html#_dfs_bases"><a title="epydoc.apidoc.ClassDoc._dfs_bases" class="py-name" href="#" onclick="return doclink('link-422', '_dfs_bases', 'link-422');">_dfs_bases</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"> </tt>
<a name="ClassDoc._dfs_bases"></a><div id="ClassDoc._dfs_bases-def"><a name="L1301"></a><tt class="py-lineno">1301</tt> <a class="py-toggle" href="#" id="ClassDoc._dfs_bases-toggle" onclick="return toggle('ClassDoc._dfs_bases');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#_dfs_bases">_dfs_bases</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">mro</tt><tt class="py-op">,</tt> <tt class="py-param">seen</tt><tt class="py-op">,</tt> <tt class="py-param">warn_about_bad_bases</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc._dfs_bases-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc._dfs_bases-expanded"><a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt> <tt class="py-keyword">in</tt> <tt class="py-name">seen</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-423" class="py-name" targets="Method epydoc.apidoc.ClassDoc.mro()=epydoc.apidoc.ClassDoc-class.html#mro"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-423', 'mro', 'link-423');">mro</a></tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"> <tt id="link-424" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-424', 'mro', 'link-423');">mro</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"> <tt class="py-name">seen</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-425" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-425', 'bases', 'link-387');">bases</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-426" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-426', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-427" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-427', 'bases', 'link-387');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-428" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-428', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-429" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-429', 'proxy_for', 'link-191');">proxy_for</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt> <tt class="py-line"> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-430" class="py-name"><a title="epydoc.apidoc.ClassDoc._dfs_bases" class="py-name" href="#" onclick="return doclink('link-430', '_dfs_bases', 'link-422');">_dfs_bases</a></tt><tt class="py-op">(</tt><tt id="link-431" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-431', 'mro', 'link-423');">mro</a></tt><tt class="py-op">,</tt> <tt class="py-name">seen</tt><tt class="py-op">,</tt> <tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">)</tt> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">:</tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-432" class="py-name" targets="Method epydoc.apidoc.ClassDoc._report_bad_base()=epydoc.apidoc.ClassDoc-class.html#_report_bad_base"><a title="epydoc.apidoc.ClassDoc._report_bad_base" class="py-name" href="#" onclick="return doclink('link-432', '_report_bad_base', 'link-432');">_report_bad_base</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt> </tt>
<a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-433" class="py-name"><a title="epydoc.apidoc.ClassDoc.mro" class="py-name" href="#" onclick="return doclink('link-433', 'mro', 'link-423');">mro</a></tt> </tt>
</div><a name="L1312"></a><tt class="py-lineno">1312</tt> <tt class="py-line"> </tt>
<a name="ClassDoc._c3_mro"></a><div id="ClassDoc._c3_mro-def"><a name="L1313"></a><tt class="py-lineno">1313</tt> <a class="py-toggle" href="#" id="ClassDoc._c3_mro-toggle" onclick="return toggle('ClassDoc._c3_mro');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#_c3_mro">_c3_mro</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">warn_about_bad_bases</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc._c3_mro-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc._c3_mro-expanded"><a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"><tt class="py-docstring"> Compute the class precedence list (mro) according to C3.</tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"><tt class="py-docstring"> @seealso: U{http://www.python.org/2.3/mro.html}</tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"> <tt id="link-434" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-434', 'bases', 'link-387');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">base</tt> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-435" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-435', 'bases', 'link-387');">bases</a></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-436" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-436', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-437" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-437', 'bases', 'link-387');">bases</a></tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-438" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-438', 'bases', 'link-387');">bases</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">:</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-439" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-439', 'bases', 'link-387');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-440" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-440', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-441" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-441', 'proxy_for', 'link-191');">proxy_for</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-442" class="py-name"><a title="epydoc.apidoc.ClassDoc._report_bad_base" class="py-name" href="#" onclick="return doclink('link-442', '_report_bad_base', 'link-432');">_report_bad_base</a></tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">)</tt> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</tt> <tt class="py-line"> <tt class="py-name">w</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">warn_about_bad_bases</tt><tt class="py-op">]</tt><tt class="py-op">*</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-443" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-443', 'bases', 'link-387');">bases</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-444" class="py-name" targets="Method epydoc.apidoc.ClassDoc._c3_merge()=epydoc.apidoc.ClassDoc-class.html#_c3_merge"><a title="epydoc.apidoc.ClassDoc._c3_merge" class="py-name" href="#" onclick="return doclink('link-444', '_c3_merge', 'link-444');">_c3_merge</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-op">[</tt><tt class="py-name">self</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt id="link-445" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-445', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">.</tt><tt id="link-446" class="py-name"><a title="epydoc.apidoc.ClassDoc._c3_mro" class="py-name" href="#" onclick="return doclink('link-446', '_c3_mro', 'link-421');">_c3_mro</a></tt><tt class="py-op">,</tt> <tt id="link-447" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-447', 'bases', 'link-387');">bases</a></tt><tt class="py-op">,</tt> <tt class="py-name">w</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"> <tt class="py-op">[</tt><tt class="py-name">list</tt><tt class="py-op">(</tt><tt id="link-448" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-448', 'bases', 'link-387');">bases</a></tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"> </tt>
<a name="ClassDoc._report_bad_base"></a><div id="ClassDoc._report_bad_base-def"><a name="L1328"></a><tt class="py-lineno">1328</tt> <a class="py-toggle" href="#" id="ClassDoc._report_bad_base-toggle" onclick="return toggle('ClassDoc._report_bad_base');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#_report_bad_base">_report_bad_base</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">base</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc._report_bad_base-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc._report_bad_base-expanded"><a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-449" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-449', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">base</tt><tt class="py-op">,</tt> <tt id="link-450" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-450', 'GenericValueDoc', 'link-171');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"> <tt class="py-name">base_name</tt> <tt class="py-op">=</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-451" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-451', 'canonical_name', 'link-83');">canonical_name</a></tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-452" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-452', 'parse_repr', 'link-183');">parse_repr</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-453" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-453', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"> <tt class="py-name">base_name</tt> <tt class="py-op">=</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-454" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-454', 'parse_repr', 'link-183');">parse_repr</a></tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</tt> <tt class="py-line"> <tt class="py-name">base_name</tt> <tt class="py-op">=</tt> <tt class="py-string">'%r'</tt> <tt class="py-op">%</tt> <tt class="py-name">base</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"> <tt id="link-455" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-455', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-456" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-456', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s's base %s is not a class"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-457" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-457', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">base_name</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-458" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-458', 'proxy_for', 'link-191');">proxy_for</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"> <tt id="link-459" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-459', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-460" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-460', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"No information available for %s's base %s"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-461" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-461', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">base</tt><tt class="py-op">.</tt><tt id="link-462" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-462', 'proxy_for', 'link-191');">proxy_for</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"> </tt>
<a name="ClassDoc._c3_merge"></a><div id="ClassDoc._c3_merge-def"><a name="L1342"></a><tt class="py-lineno">1342</tt> <a class="py-toggle" href="#" id="ClassDoc._c3_merge-toggle" onclick="return toggle('ClassDoc._c3_merge');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#_c3_merge">_c3_merge</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">seqs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc._c3_merge-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc._c3_merge-expanded"><a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"><tt class="py-docstring"> Helper function for L{_c3_mro}.</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"> <tt class="py-name">nonemptyseqs</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">seq</tt> <tt class="py-keyword">for</tt> <tt class="py-name">seq</tt> <tt class="py-keyword">in</tt> <tt class="py-name">seqs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">seq</tt><tt class="py-op">]</tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">nonemptyseqs</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">seq</tt> <tt class="py-keyword">in</tt> <tt class="py-name">nonemptyseqs</tt><tt class="py-op">:</tt> <tt class="py-comment"># find merge candidates among seq heads</tt> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"> <tt class="py-name">cand</tt> <tt class="py-op">=</tt> <tt class="py-name">seq</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt> <tt class="py-line"> <tt class="py-name">nothead</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">s</tt> <tt class="py-keyword">for</tt> <tt class="py-name">s</tt> <tt class="py-keyword">in</tt> <tt class="py-name">nonemptyseqs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">cand</tt> <tt class="py-keyword">in</tt> <tt class="py-name">s</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">nothead</tt><tt class="py-op">:</tt> <tt class="py-name">cand</tt><tt class="py-op">=</tt><tt class="py-name">None</tt> <tt class="py-comment">#reject candidate</tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L1355"></a><tt class="py-lineno">1355</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">cand</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-string">"Inconsistent hierarchy"</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">cand</tt><tt class="py-op">)</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">seq</tt> <tt class="py-keyword">in</tt> <tt class="py-name">nonemptyseqs</tt><tt class="py-op">:</tt> <tt class="py-comment"># remove cand</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">seq</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">cand</tt><tt class="py-op">:</tt> <tt class="py-keyword">del</tt> <tt class="py-name">seq</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1359"></a><tt class="py-lineno">1359</tt> <tt class="py-line"> </tt>
<a name="ClassDoc.select_variables"></a><div id="ClassDoc.select_variables-def"><a name="L1360"></a><tt class="py-lineno">1360</tt> <a class="py-toggle" href="#" id="ClassDoc.select_variables-toggle" onclick="return toggle('ClassDoc.select_variables');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.ClassDoc-class.html#select_variables">select_variables</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">group</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">value_type</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">inherited</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt> <tt class="py-line"> <tt class="py-param">public</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">imported</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">detailed</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClassDoc.select_variables-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ClassDoc.select_variables-expanded"><a name="L1362"></a><tt class="py-lineno">1362</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1363"></a><tt class="py-lineno">1363</tt> <tt class="py-line"><tt class="py-docstring"> Return a specified subset of this class's L{sorted_variables}</tt> </tt>
<a name="L1364"></a><tt class="py-lineno">1364</tt> <tt class="py-line"><tt class="py-docstring"> list. If C{value_type} is given, then only return variables</tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt> <tt class="py-line"><tt class="py-docstring"> whose values have the specified type. If C{group} is given,</tt> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt> <tt class="py-line"><tt class="py-docstring"> then only return variables that belong to the specified group.</tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt> <tt class="py-line"><tt class="py-docstring"> If C{inherited} is True, then only return inherited variables;</tt> </tt>
<a name="L1368"></a><tt class="py-lineno">1368</tt> <tt class="py-line"><tt class="py-docstring"> if C{inherited} is False, then only return local variables.</tt> </tt>
<a name="L1369"></a><tt class="py-lineno">1369</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt> <tt class="py-line"><tt class="py-docstring"> @require: The L{sorted_variables} and L{variable_groups}</tt> </tt>
<a name="L1371"></a><tt class="py-lineno">1371</tt> <tt class="py-line"><tt class="py-docstring"> attributes must be initialized before this method can be</tt> </tt>
<a name="L1372"></a><tt class="py-lineno">1372</tt> <tt class="py-line"><tt class="py-docstring"> used. See L{init_sorted_variables()} and</tt> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt> <tt class="py-line"><tt class="py-docstring"> L{init_variable_groups()}.</tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</tt> <tt class="py-line"><tt class="py-docstring"> @param value_type: A string specifying the value type for</tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt> <tt class="py-line"><tt class="py-docstring"> which variables should be returned. Valid values are:</tt> </tt>
<a name="L1377"></a><tt class="py-lineno">1377</tt> <tt class="py-line"><tt class="py-docstring"> - 'instancemethod' - variables whose values are</tt> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</tt> <tt class="py-line"><tt class="py-docstring"> instance methods.</tt> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt> <tt class="py-line"><tt class="py-docstring"> - 'classmethod' - variables whose values are class</tt> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt> <tt class="py-line"><tt class="py-docstring"> methods.</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt> <tt class="py-line"><tt class="py-docstring"> - 'staticmethod' - variables whose values are static</tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt> <tt class="py-line"><tt class="py-docstring"> methods.</tt> </tt>
<a name="L1383"></a><tt class="py-lineno">1383</tt> <tt class="py-line"><tt class="py-docstring"> - 'properties' - variables whose values are properties.</tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt> <tt class="py-line"><tt class="py-docstring"> - 'class' - variables whose values are nested classes</tt> </tt>
<a name="L1385"></a><tt class="py-lineno">1385</tt> <tt class="py-line"><tt class="py-docstring"> (including exceptions and types).</tt> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt> <tt class="py-line"><tt class="py-docstring"> - 'instancevariable' - instance variables. This includes</tt> </tt>
<a name="L1387"></a><tt class="py-lineno">1387</tt> <tt class="py-line"><tt class="py-docstring"> any variables that are explicitly marked as instance</tt> </tt>
<a name="L1388"></a><tt class="py-lineno">1388</tt> <tt class="py-line"><tt class="py-docstring"> variables with docstring fields; and variables with</tt> </tt>
<a name="L1389"></a><tt class="py-lineno">1389</tt> <tt class="py-line"><tt class="py-docstring"> docstrings that are initialized in the constructor.</tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt> <tt class="py-line"><tt class="py-docstring"> - 'classvariable' - class variables. This includes any</tt> </tt>
<a name="L1391"></a><tt class="py-lineno">1391</tt> <tt class="py-line"><tt class="py-docstring"> variables that are not included in any of the above</tt> </tt>
<a name="L1392"></a><tt class="py-lineno">1392</tt> <tt class="py-line"><tt class="py-docstring"> categories.</tt> </tt>
<a name="L1393"></a><tt class="py-lineno">1393</tt> <tt class="py-line"><tt class="py-docstring"> @type value_type: C{string}</tt> </tt>
<a name="L1394"></a><tt class="py-lineno">1394</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1395"></a><tt class="py-lineno">1395</tt> <tt class="py-line"><tt class="py-docstring"> @param group: The name of the group for which variables should</tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt> <tt class="py-line"><tt class="py-docstring"> be returned. A complete list of the groups defined by</tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt> <tt class="py-line"><tt class="py-docstring"> this C{ClassDoc} is available in the L{group_names}</tt> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt> <tt class="py-line"><tt class="py-docstring"> instance variable. The first element of this list is</tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt> <tt class="py-line"><tt class="py-docstring"> always the special group name C{''}, which is used for</tt> </tt>
<a name="L1400"></a><tt class="py-lineno">1400</tt> <tt class="py-line"><tt class="py-docstring"> variables that do not belong to any group.</tt> </tt>
<a name="L1401"></a><tt class="py-lineno">1401</tt> <tt class="py-line"><tt class="py-docstring"> @type group: C{string}</tt> </tt>
<a name="L1402"></a><tt class="py-lineno">1402</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt> <tt class="py-line"><tt class="py-docstring"> @param inherited: If C{None}, then return both inherited and</tt> </tt>
<a name="L1404"></a><tt class="py-lineno">1404</tt> <tt class="py-line"><tt class="py-docstring"> local variables; if C{True}, then return only inherited</tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt> <tt class="py-line"><tt class="py-docstring"> variables; if C{False}, then return only local variables.</tt> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt> <tt class="py-line"><tt class="py-docstring"> @param detailed: If True (False), return only the variables</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt> <tt class="py-line"><tt class="py-docstring"> deserving (not deserving) a detailed informative box.</tt> </tt>
<a name="L1409"></a><tt class="py-lineno">1409</tt> <tt class="py-line"><tt class="py-docstring"> If C{None}, don't care.</tt> </tt>
<a name="L1410"></a><tt class="py-lineno">1410</tt> <tt class="py-line"><tt class="py-docstring"> @type detailed: C{bool}</tt> </tt>
<a name="L1411"></a><tt class="py-lineno">1411</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1412"></a><tt class="py-lineno">1412</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-463" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-463', 'sorted_variables', 'link-231');">sorted_variables</a></tt> <tt class="py-keyword">is</tt> <tt id="link-464" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-464', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1413"></a><tt class="py-lineno">1413</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-465" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variable_groups" class="py-name" href="#" onclick="return doclink('link-465', 'variable_groups', 'link-237');">variable_groups</a></tt> <tt class="py-keyword">is</tt> <tt id="link-466" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-466', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1414"></a><tt class="py-lineno">1414</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'sorted_variables and variable_groups '</tt> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt> <tt class="py-line"> <tt class="py-string">'must be initialized first.'</tt><tt class="py-op">)</tt> </tt>
<a name="L1416"></a><tt class="py-lineno">1416</tt> <tt class="py-line"> </tt>
<a name="L1417"></a><tt class="py-lineno">1417</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">group</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-467" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sorted_variables" class="py-name" href="#" onclick="return doclink('link-467', 'sorted_variables', 'link-231');">sorted_variables</a></tt> </tt>
<a name="L1418"></a><tt class="py-lineno">1418</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-468" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variable_groups" class="py-name" href="#" onclick="return doclink('link-468', 'variable_groups', 'link-237');">variable_groups</a></tt><tt class="py-op">[</tt><tt class="py-name">group</tt><tt class="py-op">]</tt> </tt>
<a name="L1419"></a><tt class="py-lineno">1419</tt> <tt class="py-line"> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt> <tt class="py-line"> <tt class="py-comment"># Public/private filter (Count UNKNOWN as public)</tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">public</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1422"></a><tt class="py-lineno">1422</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-469" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-469', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-470" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-470', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-471" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-471', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-472" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-472', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">False</tt><tt class="py-op">]</tt> </tt>
<a name="L1423"></a><tt class="py-lineno">1423</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">public</tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L1424"></a><tt class="py-lineno">1424</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-473" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-473', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-474" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-474', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-475" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-475', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-476" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-476', 'is_public', 'link-128');">is_public</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">]</tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt> <tt class="py-line"> </tt>
<a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"> <tt class="py-comment"># Inherited filter (Count UNKNOWN as non-inherited)</tt> </tt>
<a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">inherited</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L1428"></a><tt class="py-lineno">1428</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">inherited</tt><tt class="py-op">:</tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-477" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-477', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-478" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-478', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-479" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-479', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-480" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-480', 'container', 'link-110');">container</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">self</tt><tt class="py-op">]</tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-481" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-481', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-482" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-482', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-483" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-483', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-484" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-484', 'container', 'link-110');">container</a></tt> <tt class="py-op">==</tt> <tt class="py-name">self</tt> <tt class="py-op">]</tt> </tt>
<a name="L1432"></a><tt class="py-lineno">1432</tt> <tt class="py-line"> </tt>
<a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"> <tt class="py-comment"># Imported filter (Count UNKNOWN as non-imported)</tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">imported</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-485" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-485', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-486" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-486', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-487" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-487', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-488" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-488', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">imported</tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-489" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-489', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-490" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-490', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-491" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-491', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-492" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-492', 'is_imported', 'link-120');">is_imported</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</tt> <tt class="py-line"> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"> <tt class="py-comment"># Detailed filter</tt> </tt>
<a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">detailed</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-493" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-493', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-494" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-494', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-495" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-495', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-496" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-496', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">detailed</tt> <tt class="py-keyword">is</tt> <tt class="py-name">False</tt><tt class="py-op">:</tt> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-497" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-497', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">for</tt> <tt id="link-498" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-498', 'v', 'link-103');">v</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> <tt class="py-keyword">if</tt> <tt id="link-499" class="py-name"><a title="epydoc.markup.restructuredtext._EpydocReader.v" class="py-name" href="#" onclick="return doclink('link-499', 'v', 'link-103');">v</a></tt><tt class="py-op">.</tt><tt id="link-500" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-500', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"> </tt>
<a name="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value_type</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'method'</tt><tt class="py-op">:</tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-501" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-501', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-502" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-502', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-503" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-503', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-504" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-504', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1451"></a><tt class="py-lineno">1451</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'instancemethod'</tt><tt class="py-op">:</tt> </tt>
<a name="L1452"></a><tt class="py-lineno">1452</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1453"></a><tt class="py-lineno">1453</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-505" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-505', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-506" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-506', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1454"></a><tt class="py-lineno">1454</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-507" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-507', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-508" class="py-name" targets="Class epydoc.apidoc.ClassMethodDoc=epydoc.apidoc.ClassMethodDoc-class.html"><a title="epydoc.apidoc.ClassMethodDoc" class="py-name" href="#" onclick="return doclink('link-508', 'ClassMethodDoc', 'link-508');">ClassMethodDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-509" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-509', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-510" class="py-name" targets="Class epydoc.apidoc.StaticMethodDoc=epydoc.apidoc.StaticMethodDoc-class.html"><a title="epydoc.apidoc.StaticMethodDoc" class="py-name" href="#" onclick="return doclink('link-510', 'StaticMethodDoc', 'link-510');">StaticMethodDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-511" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-511', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-512" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-512', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1457"></a><tt class="py-lineno">1457</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'classmethod'</tt><tt class="py-op">:</tt> </tt>
<a name="L1458"></a><tt class="py-lineno">1458</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-513" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-513', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-514" class="py-name"><a title="epydoc.apidoc.ClassMethodDoc" class="py-name" href="#" onclick="return doclink('link-514', 'ClassMethodDoc', 'link-508');">ClassMethodDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-515" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-515', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-516" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-516', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1461"></a><tt class="py-lineno">1461</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'staticmethod'</tt><tt class="py-op">:</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-517" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-517', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-518" class="py-name"><a title="epydoc.apidoc.StaticMethodDoc" class="py-name" href="#" onclick="return doclink('link-518', 'StaticMethodDoc', 'link-510');">StaticMethodDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-519" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-519', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-520" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-520', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'property'</tt><tt class="py-op">:</tt> </tt>
<a name="L1466"></a><tt class="py-lineno">1466</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-521" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-521', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-522" class="py-name" targets="Class epydoc.apidoc.PropertyDoc=epydoc.apidoc.PropertyDoc-class.html"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-522', 'PropertyDoc', 'link-522');">PropertyDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1468"></a><tt class="py-lineno">1468</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-523" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-523', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-524" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-524', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'class'</tt><tt class="py-op">:</tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-525" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-525', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-526" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-526', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-527" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-527', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-528" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-528', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'instancevariable'</tt><tt class="py-op">:</tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-529" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-529', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">True</tt><tt class="py-op">]</tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">value_type</tt> <tt class="py-op">==</tt> <tt class="py-string">'classvariable'</tt><tt class="py-op">:</tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-name">var_doc</tt> <tt class="py-keyword">for</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">var_list</tt> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-530" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-530', 'is_instvar', 'link-122');">is_instvar</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-531" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-531', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-532" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-532', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-533" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-533', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt id="link-534" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-534', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">,</tt> <tt id="link-535" class="py-name"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-535', 'PropertyDoc', 'link-522');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1481"></a><tt class="py-lineno">1481</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Bad value type %r'</tt> <tt class="py-op">%</tt> <tt class="py-name">value_type</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L1483"></a><tt class="py-lineno">1483</tt> <tt class="py-line"> </tt>
<a name="RoutineDoc"></a><div id="RoutineDoc-def"><a name="L1484"></a><tt class="py-lineno">1484</tt> <a class="py-toggle" href="#" id="RoutineDoc-toggle" onclick="return toggle('RoutineDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.RoutineDoc-class.html">RoutineDoc</a><tt class="py-op">(</tt><tt class="py-base-class">ValueDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RoutineDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="RoutineDoc-expanded"><a name="L1485"></a><tt class="py-lineno">1485</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a single routine.</tt> </tt>
<a name="L1487"></a><tt class="py-lineno">1487</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt> <tt class="py-line"> <tt class="py-comment">#{ Signature</tt> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-536" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posargs=epydoc.apidoc.RoutineDoc-class.html#posargs"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-536', 'posargs', 'link-536');">posargs</a></tt> <tt class="py-op">=</tt> <tt id="link-537" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-537', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The names of the routine's positional arguments.</tt> </tt>
<a name="L1491"></a><tt class="py-lineno">1491</tt> <tt class="py-line"><tt class="py-string"> If an argument list contains \"unpacking\" arguments, then</tt> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt> <tt class="py-line"><tt class="py-string"> their names will be specified using nested lists. E.g., if</tt> </tt>
<a name="L1493"></a><tt class="py-lineno">1493</tt> <tt class="py-line"><tt class="py-string"> a function's argument list is C{((x1,y1), (x2,y2))}, then</tt> </tt>
<a name="L1494"></a><tt class="py-lineno">1494</tt> <tt class="py-line"><tt class="py-string"> posargs will be C{[['x1','y1'], ['x2','y2']]}.</tt> </tt>
<a name="L1495"></a><tt class="py-lineno">1495</tt> <tt class="py-line"><tt class="py-string"> @type: C{list}"""</tt> </tt>
<a name="L1496"></a><tt class="py-lineno">1496</tt> <tt class="py-line"> <tt id="link-538" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posarg_defaults=epydoc.apidoc.RoutineDoc-class.html#posarg_defaults"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-538', 'posarg_defaults', 'link-538');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt id="link-539" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-539', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1497"></a><tt class="py-lineno">1497</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the positional arguments'</tt> </tt>
<a name="L1498"></a><tt class="py-lineno">1498</tt> <tt class="py-line"><tt class="py-string"> default values. This list has the same length as C{posargs}, and</tt> </tt>
<a name="L1499"></a><tt class="py-lineno">1499</tt> <tt class="py-line"><tt class="py-string"> each element of C{posarg_defaults} describes the corresponding</tt> </tt>
<a name="L1500"></a><tt class="py-lineno">1500</tt> <tt class="py-line"><tt class="py-string"> argument in C{posargs}. For positional arguments with no default,</tt> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt> <tt class="py-line"><tt class="py-string"> C{posargs_defaults} will contain None.</tt> </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of C{ValueDoc} or C{None}"""</tt> </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt> <tt class="py-line"> <tt id="link-540" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.vararg=epydoc.apidoc.RoutineDoc-class.html#vararg"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-540', 'vararg', 'link-540');">vararg</a></tt> <tt class="py-op">=</tt> <tt id="link-541" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-541', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1504"></a><tt class="py-lineno">1504</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The name of the routine's vararg argument, or C{None} if</tt> </tt>
<a name="L1505"></a><tt class="py-lineno">1505</tt> <tt class="py-line"><tt class="py-string"> it has no vararg argument.</tt> </tt>
<a name="L1506"></a><tt class="py-lineno">1506</tt> <tt class="py-line"><tt class="py-string"> @type: C{string} or C{None}"""</tt> </tt>
<a name="L1507"></a><tt class="py-lineno">1507</tt> <tt class="py-line"> <tt id="link-542" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.kwarg=epydoc.apidoc.RoutineDoc-class.html#kwarg"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-542', 'kwarg', 'link-542');">kwarg</a></tt> <tt class="py-op">=</tt> <tt id="link-543" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-543', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1508"></a><tt class="py-lineno">1508</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The name of the routine's keyword argument, or C{None} if</tt> </tt>
<a name="L1509"></a><tt class="py-lineno">1509</tt> <tt class="py-line"><tt class="py-string"> it has no keyword argument.</tt> </tt>
<a name="L1510"></a><tt class="py-lineno">1510</tt> <tt class="py-line"><tt class="py-string"> @type: C{string} or C{None}"""</tt> </tt>
<a name="L1511"></a><tt class="py-lineno">1511</tt> <tt class="py-line"> <tt id="link-544" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.lineno=epydoc.apidoc.RoutineDoc-class.html#lineno"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-544', 'lineno', 'link-544');">lineno</a></tt> <tt class="py-op">=</tt> <tt id="link-545" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-545', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-comment"># used to look up profiling info from pstats.</tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: The line number of the first line of the function's</tt> </tt>
<a name="L1513"></a><tt class="py-lineno">1513</tt> <tt class="py-line"><tt class="py-string"> signature. For Python functions, this is equal to</tt> </tt>
<a name="L1514"></a><tt class="py-lineno">1514</tt> <tt class="py-line"><tt class="py-string"> C{func.func_code.co_firstlineno}. The first line of a file</tt> </tt>
<a name="L1515"></a><tt class="py-lineno">1515</tt> <tt class="py-line"><tt class="py-string"> is considered line 1.</tt> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt> <tt class="py-line"><tt class="py-string"> @type: C{int}"""</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt> <tt class="py-line"> <tt class="py-comment">#} end of "signature" group</tt> </tt>
<a name="L1518"></a><tt class="py-lineno">1518</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1519"></a><tt class="py-lineno">1519</tt> <tt class="py-line"> <tt class="py-comment">#{ Decorators</tt> </tt>
<a name="L1520"></a><tt class="py-lineno">1520</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-546" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.decorators=epydoc.apidoc.RoutineDoc-class.html#decorators"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-546', 'decorators', 'link-546');">decorators</a></tt> <tt class="py-op">=</tt> <tt id="link-547" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-547', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A list of names of decorators that were applied to this</tt> </tt>
<a name="L1522"></a><tt class="py-lineno">1522</tt> <tt class="py-line"><tt class="py-string"> routine, in the order that they are listed in the source code.</tt> </tt>
<a name="L1523"></a><tt class="py-lineno">1523</tt> <tt class="py-line"><tt class="py-string"> (I.e., in the reverse of the order that they were applied in.)</tt> </tt>
<a name="L1524"></a><tt class="py-lineno">1524</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of C{string}"""</tt> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt> <tt class="py-line"> <tt class="py-comment">#} end of "decorators" group</tt> </tt>
<a name="L1526"></a><tt class="py-lineno">1526</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1527"></a><tt class="py-lineno">1527</tt> <tt class="py-line"> <tt class="py-comment">#{ Information Extracted from Docstrings</tt> </tt>
<a name="L1528"></a><tt class="py-lineno">1528</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-548" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_descrs=epydoc.apidoc.RoutineDoc-class.html#arg_descrs"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-548', 'arg_descrs', 'link-548');">arg_descrs</a></tt> <tt class="py-op">=</tt> <tt id="link-549" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-549', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1529"></a><tt class="py-lineno">1529</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A list of descriptions of the routine's</tt> </tt>
<a name="L1530"></a><tt class="py-lineno">1530</tt> <tt class="py-line"><tt class="py-string"> arguments. Each element of this list is a tuple C{(args,</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt> <tt class="py-line"><tt class="py-string"> descr)}, where C{args} is a list of argument names; and</tt> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt> <tt class="py-line"><tt class="py-string"> C{descr} is a L{ParsedDocstring</tt> </tt>
<a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"><tt class="py-string"> <epydoc.markup.ParsedDocstring>} describing the argument(s)</tt> </tt>
<a name="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"><tt class="py-string"> specified by C{arg}.</tt> </tt>
<a name="L1535"></a><tt class="py-lineno">1535</tt> <tt class="py-line"><tt class="py-string"> @type: C{list}"""</tt> </tt>
<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"> <tt id="link-550" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_types=epydoc.apidoc.RoutineDoc-class.html#arg_types"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-550', 'arg_types', 'link-550');">arg_types</a></tt> <tt class="py-op">=</tt> <tt id="link-551" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-551', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: Descriptions of the expected types for the</tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt> <tt class="py-line"><tt class="py-string"> routine's arguments, encoded as a dictionary mapping from</tt> </tt>
<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"><tt class="py-string"> argument names to type descriptions.</tt> </tt>
<a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"><tt class="py-string"> @type: C{dict} from C{string} to L{ParsedDocstring</tt> </tt>
<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"><tt class="py-string"> <epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"> <tt id="link-552" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_descr=epydoc.apidoc.RoutineDoc-class.html#return_descr,Method epydoc.docwriter.html.HTMLWriter.return_descr()=epydoc.docwriter.html.HTMLWriter-class.html#return_descr"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-552', 'return_descr', 'link-552');">return_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-553" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-553', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1543"></a><tt class="py-lineno">1543</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A description of the value returned by this routine.</tt> </tt>
<a name="L1544"></a><tt class="py-lineno">1544</tt> <tt class="py-line"><tt class="py-string"> @type: L{ParsedDocstring<epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"> <tt id="link-554" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_type=epydoc.apidoc.RoutineDoc-class.html#return_type,Method epydoc.docwriter.html.HTMLWriter.return_type()=epydoc.docwriter.html.HTMLWriter-class.html#return_type"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-554', 'return_type', 'link-554');">return_type</a></tt> <tt class="py-op">=</tt> <tt id="link-555" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-555', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1546"></a><tt class="py-lineno">1546</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A description of expected type for the value</tt> </tt>
<a name="L1547"></a><tt class="py-lineno">1547</tt> <tt class="py-line"><tt class="py-string"> returned by this routine.</tt> </tt>
<a name="L1548"></a><tt class="py-lineno">1548</tt> <tt class="py-line"><tt class="py-string"> @type: L{ParsedDocstring<epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L1549"></a><tt class="py-lineno">1549</tt> <tt class="py-line"> <tt id="link-556" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.exception_descrs=epydoc.apidoc.RoutineDoc-class.html#exception_descrs"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-556', 'exception_descrs', 'link-556');">exception_descrs</a></tt> <tt class="py-op">=</tt> <tt id="link-557" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-557', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1550"></a><tt class="py-lineno">1550</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A list of descriptions of exceptions</tt> </tt>
<a name="L1551"></a><tt class="py-lineno">1551</tt> <tt class="py-line"><tt class="py-string"> that the routine might raise. Each element of this list is a</tt> </tt>
<a name="L1552"></a><tt class="py-lineno">1552</tt> <tt class="py-line"><tt class="py-string"> tuple C{(exc, descr)}, where C{exc} is a string contianing the</tt> </tt>
<a name="L1553"></a><tt class="py-lineno">1553</tt> <tt class="py-line"><tt class="py-string"> exception name; and C{descr} is a L{ParsedDocstring</tt> </tt>
<a name="L1554"></a><tt class="py-lineno">1554</tt> <tt class="py-line"><tt class="py-string"> <epydoc.markup.ParsedDocstring>} describing the circumstances</tt> </tt>
<a name="L1555"></a><tt class="py-lineno">1555</tt> <tt class="py-line"><tt class="py-string"> under which the exception specified by C{exc} is raised.</tt> </tt>
<a name="L1556"></a><tt class="py-lineno">1556</tt> <tt class="py-line"><tt class="py-string"> @type: C{list}"""</tt> </tt>
<a name="L1557"></a><tt class="py-lineno">1557</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information extracted from docstrings" group</tt> </tt>
<a name="L1558"></a><tt class="py-lineno">1558</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-558" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.callgraph_uid=epydoc.apidoc.RoutineDoc-class.html#callgraph_uid"><a title="epydoc.apidoc.RoutineDoc.callgraph_uid" class="py-name" href="#" onclick="return doclink('link-558', 'callgraph_uid', 'link-558');">callgraph_uid</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1559"></a><tt class="py-lineno">1559</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: L{DotGraph}.uid of the call graph for the function.</tt> </tt>
<a name="L1560"></a><tt class="py-lineno">1560</tt> <tt class="py-line"><tt class="py-string"> @type: C{str}"""</tt> </tt>
<a name="L1561"></a><tt class="py-lineno">1561</tt> <tt class="py-line"> </tt>
<a name="RoutineDoc.is_detailed"></a><div id="RoutineDoc.is_detailed-def"><a name="L1562"></a><tt class="py-lineno">1562</tt> <a class="py-toggle" href="#" id="RoutineDoc.is_detailed-toggle" onclick="return toggle('RoutineDoc.is_detailed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.RoutineDoc-class.html#is_detailed">is_detailed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RoutineDoc.is_detailed-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="RoutineDoc.is_detailed-expanded"><a name="L1563"></a><tt class="py-lineno">1563</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-559" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-559', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-560" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-560', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1564"></a><tt class="py-lineno">1564</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1565"></a><tt class="py-lineno">1565</tt> <tt class="py-line"> </tt>
<a name="L1566"></a><tt class="py-lineno">1566</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-561" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-561', 'arg_descrs', 'link-548');">arg_descrs</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-562" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-562', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-563" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-563', 'arg_descrs', 'link-548');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1567"></a><tt class="py-lineno">1567</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1568"></a><tt class="py-lineno">1568</tt> <tt class="py-line"> </tt>
<a name="L1569"></a><tt class="py-lineno">1569</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-564" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-564', 'arg_types', 'link-550');">arg_types</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-565" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-565', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-566" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-566', 'arg_types', 'link-550');">arg_types</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1570"></a><tt class="py-lineno">1570</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1571"></a><tt class="py-lineno">1571</tt> <tt class="py-line"> </tt>
<a name="L1572"></a><tt class="py-lineno">1572</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-567" class="py-name"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-567', 'return_descr', 'link-552');">return_descr</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-568" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-568', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1573"></a><tt class="py-lineno">1573</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1574"></a><tt class="py-lineno">1574</tt> <tt class="py-line"> </tt>
<a name="L1575"></a><tt class="py-lineno">1575</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-569" class="py-name"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-569', 'exception_descrs', 'link-556');">exception_descrs</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-570" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-570', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-571" class="py-name"><a title="epydoc.apidoc.RoutineDoc.exception_descrs" class="py-name" href="#" onclick="return doclink('link-571', 'exception_descrs', 'link-556');">exception_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1576"></a><tt class="py-lineno">1576</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1577"></a><tt class="py-lineno">1577</tt> <tt class="py-line"> </tt>
<a name="L1578"></a><tt class="py-lineno">1578</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-572" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-572', 'decorators', 'link-546');">decorators</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-573" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-573', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1579"></a><tt class="py-lineno">1579</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-op">[</tt> <tt class="py-name">d</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-574" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-574', 'decorators', 'link-546');">decorators</a></tt> </tt>
<a name="L1580"></a><tt class="py-lineno">1580</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">d</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-string">'classmethod'</tt><tt class="py-op">,</tt> <tt class="py-string">'staticmethod'</tt><tt class="py-op">)</tt> <tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1581"></a><tt class="py-lineno">1581</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1582"></a><tt class="py-lineno">1582</tt> <tt class="py-line"> </tt>
<a name="L1583"></a><tt class="py-lineno">1583</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1584"></a><tt class="py-lineno">1584</tt> <tt class="py-line"> </tt>
<a name="RoutineDoc.all_args"></a><div id="RoutineDoc.all_args-def"><a name="L1585"></a><tt class="py-lineno">1585</tt> <a class="py-toggle" href="#" id="RoutineDoc.all_args-toggle" onclick="return toggle('RoutineDoc.all_args');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.RoutineDoc-class.html#all_args">all_args</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RoutineDoc.all_args-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="RoutineDoc.all_args-expanded"><a name="L1586"></a><tt class="py-lineno">1586</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1587"></a><tt class="py-lineno">1587</tt> <tt class="py-line"><tt class="py-docstring"> @return: A list of the names of all arguments (positional,</tt> </tt>
<a name="L1588"></a><tt class="py-lineno">1588</tt> <tt class="py-line"><tt class="py-docstring"> vararg, and keyword), in order. If a positional argument</tt> </tt>
<a name="L1589"></a><tt class="py-lineno">1589</tt> <tt class="py-line"><tt class="py-docstring"> consists of a tuple of names, then that tuple will be</tt> </tt>
<a name="L1590"></a><tt class="py-lineno">1590</tt> <tt class="py-line"><tt class="py-docstring"> flattened.</tt> </tt>
<a name="L1591"></a><tt class="py-lineno">1591</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1592"></a><tt class="py-lineno">1592</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-575" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-575', 'posargs', 'link-536');">posargs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-576" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-576', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1593"></a><tt class="py-lineno">1593</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-577" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-577', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1594"></a><tt class="py-lineno">1594</tt> <tt class="py-line"> </tt>
<a name="L1595"></a><tt class="py-lineno">1595</tt> <tt class="py-line"> <tt id="link-578" class="py-name" targets="Method epydoc.apidoc.RoutineDoc.all_args()=epydoc.apidoc.RoutineDoc-class.html#all_args"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-578', 'all_args', 'link-578');">all_args</a></tt> <tt class="py-op">=</tt> <tt id="link-579" class="py-name" targets="Function epydoc.apidoc._flatten()=epydoc.apidoc-module.html#_flatten"><a title="epydoc.apidoc._flatten" class="py-name" href="#" onclick="return doclink('link-579', '_flatten', 'link-579');">_flatten</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-580" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-580', 'posargs', 'link-536');">posargs</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1596"></a><tt class="py-lineno">1596</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-581" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-581', 'vararg', 'link-540');">vararg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-582" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-582', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1597"></a><tt class="py-lineno">1597</tt> <tt class="py-line"> <tt id="link-583" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-583', 'all_args', 'link-578');">all_args</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-584" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-584', 'vararg', 'link-540');">vararg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1598"></a><tt class="py-lineno">1598</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-585" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-585', 'kwarg', 'link-542');">kwarg</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-586" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-586', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1599"></a><tt class="py-lineno">1599</tt> <tt class="py-line"> <tt id="link-587" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-587', 'all_args', 'link-578');">all_args</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-588" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-588', 'kwarg', 'link-542');">kwarg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1600"></a><tt class="py-lineno">1600</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-589" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-589', 'all_args', 'link-578');">all_args</a></tt> </tt>
</div></div><a name="L1601"></a><tt class="py-lineno">1601</tt> <tt class="py-line"> </tt>
<a name="_flatten"></a><div id="_flatten-def"><a name="L1602"></a><tt class="py-lineno">1602</tt> <a class="py-toggle" href="#" id="_flatten-toggle" onclick="return toggle('_flatten');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#_flatten">_flatten</a><tt class="py-op">(</tt><tt class="py-param">lst</tt><tt class="py-op">,</tt> <tt class="py-param">out</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_flatten-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_flatten-expanded"><a name="L1603"></a><tt class="py-lineno">1603</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1604"></a><tt class="py-lineno">1604</tt> <tt class="py-line"><tt class="py-docstring"> Return a flattened version of C{lst}.</tt> </tt>
<a name="L1605"></a><tt class="py-lineno">1605</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1606"></a><tt class="py-lineno">1606</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">out</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">out</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1607"></a><tt class="py-lineno">1607</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">elt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lst</tt><tt class="py-op">:</tt> </tt>
<a name="L1608"></a><tt class="py-lineno">1608</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">,</tt><tt class="py-name">tuple</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1609"></a><tt class="py-lineno">1609</tt> <tt class="py-line"> <tt id="link-590" class="py-name"><a title="epydoc.apidoc._flatten" class="py-name" href="#" onclick="return doclink('link-590', '_flatten', 'link-579');">_flatten</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">,</tt> <tt class="py-name">out</tt><tt class="py-op">)</tt> </tt>
<a name="L1610"></a><tt class="py-lineno">1610</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1611"></a><tt class="py-lineno">1611</tt> <tt class="py-line"> <tt class="py-name">out</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt> </tt>
<a name="L1612"></a><tt class="py-lineno">1612</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">out</tt> </tt>
</div><a name="L1613"></a><tt class="py-lineno">1613</tt> <tt class="py-line"> </tt>
<a name="ClassMethodDoc"></a><div id="ClassMethodDoc-def"><a name="L1614"></a><tt class="py-lineno">1614</tt> <a class="py-toggle" href="#" id="ClassMethodDoc-toggle" onclick="return toggle('ClassMethodDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.ClassMethodDoc-class.html">ClassMethodDoc</a><tt class="py-op">(</tt><tt class="py-base-class">RoutineDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="StaticMethodDoc"></a><div id="StaticMethodDoc-def"><a name="L1615"></a><tt class="py-lineno">1615</tt> <a class="py-toggle" href="#" id="StaticMethodDoc-toggle" onclick="return toggle('StaticMethodDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.StaticMethodDoc-class.html">StaticMethodDoc</a><tt class="py-op">(</tt><tt class="py-base-class">RoutineDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L1616"></a><tt class="py-lineno">1616</tt> <tt class="py-line"> </tt>
<a name="PropertyDoc"></a><div id="PropertyDoc-def"><a name="L1617"></a><tt class="py-lineno">1617</tt> <a class="py-toggle" href="#" id="PropertyDoc-toggle" onclick="return toggle('PropertyDoc');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.PropertyDoc-class.html">PropertyDoc</a><tt class="py-op">(</tt><tt class="py-base-class">ValueDoc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PropertyDoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="PropertyDoc-expanded"><a name="L1618"></a><tt class="py-lineno">1618</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1619"></a><tt class="py-lineno">1619</tt> <tt class="py-line"><tt class="py-docstring"> API documentation information about a single property.</tt> </tt>
<a name="L1620"></a><tt class="py-lineno">1620</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1621"></a><tt class="py-lineno">1621</tt> <tt class="py-line"> <tt class="py-comment">#{ Property Access Functions</tt> </tt>
<a name="L1622"></a><tt class="py-lineno">1622</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-591" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fget=epydoc.apidoc.PropertyDoc-class.html#fget"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-591', 'fget', 'link-591');">fget</a></tt> <tt class="py-op">=</tt> <tt id="link-592" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-592', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1623"></a><tt class="py-lineno">1623</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the property's get function.</tt> </tt>
<a name="L1624"></a><tt class="py-lineno">1624</tt> <tt class="py-line"><tt class="py-string"> @type: L{RoutineDoc}"""</tt> </tt>
<a name="L1625"></a><tt class="py-lineno">1625</tt> <tt class="py-line"> <tt id="link-593" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fset=epydoc.apidoc.PropertyDoc-class.html#fset"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-593', 'fset', 'link-593');">fset</a></tt> <tt class="py-op">=</tt> <tt id="link-594" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-594', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1626"></a><tt class="py-lineno">1626</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the property's set function.</tt> </tt>
<a name="L1627"></a><tt class="py-lineno">1627</tt> <tt class="py-line"><tt class="py-string"> @type: L{RoutineDoc}"""</tt> </tt>
<a name="L1628"></a><tt class="py-lineno">1628</tt> <tt class="py-line"> <tt id="link-595" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.fdel=epydoc.apidoc.PropertyDoc-class.html#fdel"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-595', 'fdel', 'link-595');">fdel</a></tt> <tt class="py-op">=</tt> <tt id="link-596" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-596', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1629"></a><tt class="py-lineno">1629</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: API documentation for the property's delete function.</tt> </tt>
<a name="L1630"></a><tt class="py-lineno">1630</tt> <tt class="py-line"><tt class="py-string"> @type: L{RoutineDoc}"""</tt> </tt>
<a name="L1631"></a><tt class="py-lineno">1631</tt> <tt class="py-line"> <tt class="py-comment">#}</tt> </tt>
<a name="L1632"></a><tt class="py-lineno">1632</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#{ Information Extracted from Docstrings</tt> </tt>
<a name="L1633"></a><tt class="py-lineno">1633</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-597" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-597', 'type_descr', 'link-116');">type_descr</a></tt> <tt class="py-op">=</tt> <tt id="link-598" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-598', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L1634"></a><tt class="py-lineno">1634</tt> <tt class="py-line"> <tt class="py-string">"""@ivar: A description of the property's expected type, extracted</tt> </tt>
<a name="L1635"></a><tt class="py-lineno">1635</tt> <tt class="py-line"><tt class="py-string"> from its docstring.</tt> </tt>
<a name="L1636"></a><tt class="py-lineno">1636</tt> <tt class="py-line"><tt class="py-string"> @type: L{ParsedDocstring<epydoc.markup.ParsedDocstring>}"""</tt> </tt>
<a name="L1637"></a><tt class="py-lineno">1637</tt> <tt class="py-line"> <tt class="py-comment">#} end of "information extracted from docstrings" group</tt> </tt>
<a name="L1638"></a><tt class="py-lineno">1638</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="PropertyDoc.apidoc_links"></a><div id="PropertyDoc.apidoc_links-def"><a name="L1639"></a><tt class="py-lineno">1639</tt> <a class="py-toggle" href="#" id="PropertyDoc.apidoc_links-toggle" onclick="return toggle('PropertyDoc.apidoc_links');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links">apidoc_links</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PropertyDoc.apidoc_links-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="PropertyDoc.apidoc_links-expanded"><a name="L1640"></a><tt class="py-lineno">1640</tt> <tt class="py-line"> <tt class="py-name">val_docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1641"></a><tt class="py-lineno">1641</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-599" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-599', 'fget', 'link-591');">fget</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-600" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-600', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">val_docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-601" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-601', 'fget', 'link-591');">fget</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1642"></a><tt class="py-lineno">1642</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-602" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-602', 'fset', 'link-593');">fset</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-603" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-603', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">val_docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-604" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-604', 'fset', 'link-593');">fset</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1643"></a><tt class="py-lineno">1643</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-605" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-605', 'fdel', 'link-595');">fdel</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-606" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-606', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">val_docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-607" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-607', 'fdel', 'link-595');">fdel</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1644"></a><tt class="py-lineno">1644</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_docs</tt> </tt>
</div><a name="L1645"></a><tt class="py-lineno">1645</tt> <tt class="py-line"> </tt>
<a name="PropertyDoc.is_detailed"></a><div id="PropertyDoc.is_detailed-def"><a name="L1646"></a><tt class="py-lineno">1646</tt> <a class="py-toggle" href="#" id="PropertyDoc.is_detailed-toggle" onclick="return toggle('PropertyDoc.is_detailed');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.PropertyDoc-class.html#is_detailed">is_detailed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="PropertyDoc.is_detailed-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="PropertyDoc.is_detailed-expanded"><a name="L1647"></a><tt class="py-lineno">1647</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-608" class="py-name"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-608', 'PropertyDoc', 'link-522');">PropertyDoc</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-609" class="py-name"><a title="epydoc.apidoc.APIDoc.is_detailed
epydoc.apidoc.GenericValueDoc.is_detailed
epydoc.apidoc.NamespaceDoc.is_detailed
epydoc.apidoc.PropertyDoc.is_detailed
epydoc.apidoc.RoutineDoc.is_detailed
epydoc.apidoc.VariableDoc.is_detailed" class="py-name" href="#" onclick="return doclink('link-609', 'is_detailed', 'link-163');">is_detailed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1648"></a><tt class="py-lineno">1648</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1649"></a><tt class="py-lineno">1649</tt> <tt class="py-line"> </tt>
<a name="L1650"></a><tt class="py-lineno">1650</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-610" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-610', 'fget', 'link-591');">fget</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-611" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-611', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-612" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fget" class="py-name" href="#" onclick="return doclink('link-612', 'fget', 'link-591');">fget</a></tt><tt class="py-op">.</tt><tt id="link-613" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-613', 'pyval', 'link-181');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1651"></a><tt class="py-lineno">1651</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1652"></a><tt class="py-lineno">1652</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-614" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-614', 'fset', 'link-593');">fset</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-615" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-615', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-616" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fset" class="py-name" href="#" onclick="return doclink('link-616', 'fset', 'link-593');">fset</a></tt><tt class="py-op">.</tt><tt id="link-617" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-617', 'pyval', 'link-181');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1653"></a><tt class="py-lineno">1653</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1654"></a><tt class="py-lineno">1654</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-618" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-618', 'fdel', 'link-595');">fdel</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-619" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-619', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-620" class="py-name"><a title="epydoc.apidoc.PropertyDoc.fdel" class="py-name" href="#" onclick="return doclink('link-620', 'fdel', 'link-595');">fdel</a></tt><tt class="py-op">.</tt><tt id="link-621" class="py-name"><a title="epydoc.apidoc.ValueDoc.pyval" class="py-name" href="#" onclick="return doclink('link-621', 'pyval', 'link-181');">pyval</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1655"></a><tt class="py-lineno">1655</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1656"></a><tt class="py-lineno">1656</tt> <tt class="py-line"> </tt>
<a name="L1657"></a><tt class="py-lineno">1657</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div></div><a name="L1658"></a><tt class="py-lineno">1658</tt> <tt class="py-line"> </tt>
<a name="L1659"></a><tt class="py-lineno">1659</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1660"></a><tt class="py-lineno">1660</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Index</tt> </tt>
<a name="L1661"></a><tt class="py-lineno">1661</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L1662"></a><tt class="py-lineno">1662</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DocIndex"></a><div id="DocIndex-def"><a name="L1663"></a><tt class="py-lineno">1663</tt> <a class="py-toggle" href="#" id="DocIndex-toggle" onclick="return toggle('DocIndex');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html">DocIndex</a><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="DocIndex-expanded"><a name="L1664"></a><tt class="py-lineno">1664</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1665"></a><tt class="py-lineno">1665</tt> <tt class="py-line"><tt class="py-docstring"> [xx] out of date.</tt> </tt>
<a name="L1666"></a><tt class="py-lineno">1666</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1667"></a><tt class="py-lineno">1667</tt> <tt class="py-line"><tt class="py-docstring"> An index that .. hmm... it *can't* be used to access some things,</tt> </tt>
<a name="L1668"></a><tt class="py-lineno">1668</tt> <tt class="py-line"><tt class="py-docstring"> cuz they're not at the root level. Do I want to add them or what?</tt> </tt>
<a name="L1669"></a><tt class="py-lineno">1669</tt> <tt class="py-line"><tt class="py-docstring"> And if so, then I have a sort of a new top level. hmm.. so</tt> </tt>
<a name="L1670"></a><tt class="py-lineno">1670</tt> <tt class="py-line"><tt class="py-docstring"> basically the question is what to do with a name that's not in the</tt> </tt>
<a name="L1671"></a><tt class="py-lineno">1671</tt> <tt class="py-line"><tt class="py-docstring"> root var's name space. 2 types:</tt> </tt>
<a name="L1672"></a><tt class="py-lineno">1672</tt> <tt class="py-line"><tt class="py-docstring"> - entirely outside (eg os.path)</tt> </tt>
<a name="L1673"></a><tt class="py-lineno">1673</tt> <tt class="py-line"><tt class="py-docstring"> - inside but not known (eg a submodule that we didn't look at?)</tt> </tt>
<a name="L1674"></a><tt class="py-lineno">1674</tt> <tt class="py-line"><tt class="py-docstring"> - container of current thing not examined?</tt> </tt>
<a name="L1675"></a><tt class="py-lineno">1675</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1676"></a><tt class="py-lineno">1676</tt> <tt class="py-line"><tt class="py-docstring"> An index of all the C{APIDoc} objects that can be reached from a</tt> </tt>
<a name="L1677"></a><tt class="py-lineno">1677</tt> <tt class="py-line"><tt class="py-docstring"> root set of C{ValueDoc}s. </tt> </tt>
<a name="L1678"></a><tt class="py-lineno">1678</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1679"></a><tt class="py-lineno">1679</tt> <tt class="py-line"><tt class="py-docstring"> The members of this index can be accessed by dotted name. In</tt> </tt>
<a name="L1680"></a><tt class="py-lineno">1680</tt> <tt class="py-line"><tt class="py-docstring"> particular, C{DocIndex} defines two mappings, accessed via the</tt> </tt>
<a name="L1681"></a><tt class="py-lineno">1681</tt> <tt class="py-line"><tt class="py-docstring"> L{get_vardoc()} and L{get_valdoc()} methods, which can be used to</tt> </tt>
<a name="L1682"></a><tt class="py-lineno">1682</tt> <tt class="py-line"><tt class="py-docstring"> access C{VariableDoc}s or C{ValueDoc}s respectively by name. (Two</tt> </tt>
<a name="L1683"></a><tt class="py-lineno">1683</tt> <tt class="py-line"><tt class="py-docstring"> separate mappings are necessary because a single name can be used</tt> </tt>
<a name="L1684"></a><tt class="py-lineno">1684</tt> <tt class="py-line"><tt class="py-docstring"> to refer to both a variable and to the value contained by that</tt> </tt>
<a name="L1685"></a><tt class="py-lineno">1685</tt> <tt class="py-line"><tt class="py-docstring"> variable.)</tt> </tt>
<a name="L1686"></a><tt class="py-lineno">1686</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1687"></a><tt class="py-lineno">1687</tt> <tt class="py-line"><tt class="py-docstring"> Additionally, the index defines two sets of C{ValueDoc}s:</tt> </tt>
<a name="L1688"></a><tt class="py-lineno">1688</tt> <tt class="py-line"><tt class="py-docstring"> \"reachable C{ValueDoc}s\" and \"contained C{ValueDoc}s\". The</tt> </tt>
<a name="L1689"></a><tt class="py-lineno">1689</tt> <tt class="py-line"><tt class="py-docstring"> X{reachable C{ValueDoc}s} are defined as the set of all</tt> </tt>
<a name="L1690"></a><tt class="py-lineno">1690</tt> <tt class="py-line"><tt class="py-docstring"> C{ValueDoc}s that can be reached from the root set by following</tt> </tt>
<a name="L1691"></a><tt class="py-lineno">1691</tt> <tt class="py-line"><tt class="py-docstring"> I{any} sequence of pointers to C{ValueDoc}s or C{VariableDoc}s.</tt> </tt>
<a name="L1692"></a><tt class="py-lineno">1692</tt> <tt class="py-line"><tt class="py-docstring"> The X{contained C{ValueDoc}s} are defined as the set of all</tt> </tt>
<a name="L1693"></a><tt class="py-lineno">1693</tt> <tt class="py-line"><tt class="py-docstring"> C{ValueDoc}s that can be reached from the root set by following</tt> </tt>
<a name="L1694"></a><tt class="py-lineno">1694</tt> <tt class="py-line"><tt class="py-docstring"> only the C{ValueDoc} pointers defined by non-imported</tt> </tt>
<a name="L1695"></a><tt class="py-lineno">1695</tt> <tt class="py-line"><tt class="py-docstring"> C{VariableDoc}s. For example, if the root set contains a module</tt> </tt>
<a name="L1696"></a><tt class="py-lineno">1696</tt> <tt class="py-line"><tt class="py-docstring"> C{m}, then the contained C{ValueDoc}s includes the C{ValueDoc}s</tt> </tt>
<a name="L1697"></a><tt class="py-lineno">1697</tt> <tt class="py-line"><tt class="py-docstring"> for any functions, variables, or classes defined in that module,</tt> </tt>
<a name="L1698"></a><tt class="py-lineno">1698</tt> <tt class="py-line"><tt class="py-docstring"> as well as methods and variables defined in classes defined in the</tt> </tt>
<a name="L1699"></a><tt class="py-lineno">1699</tt> <tt class="py-line"><tt class="py-docstring"> module. The reachable C{ValueDoc}s includes all of those</tt> </tt>
<a name="L1700"></a><tt class="py-lineno">1700</tt> <tt class="py-line"><tt class="py-docstring"> C{ValueDoc}s, as well as C{ValueDoc}s for any values imported into</tt> </tt>
<a name="L1701"></a><tt class="py-lineno">1701</tt> <tt class="py-line"><tt class="py-docstring"> the module, and base classes for classes defined in the module.</tt> </tt>
<a name="L1702"></a><tt class="py-lineno">1702</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1703"></a><tt class="py-lineno">1703</tt> <tt class="py-line"> </tt>
<a name="DocIndex.__init__"></a><div id="DocIndex.__init__-def"><a name="L1704"></a><tt class="py-lineno">1704</tt> <a class="py-toggle" href="#" id="DocIndex.__init__-toggle" onclick="return toggle('DocIndex.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">root</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.__init__-expanded"><a name="L1705"></a><tt class="py-lineno">1705</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1706"></a><tt class="py-lineno">1706</tt> <tt class="py-line"><tt class="py-docstring"> Create a new documentation index, based on the given root set</tt> </tt>
<a name="L1707"></a><tt class="py-lineno">1707</tt> <tt class="py-line"><tt class="py-docstring"> of C{ValueDoc}s. If any C{APIDoc}s reachable from the root</tt> </tt>
<a name="L1708"></a><tt class="py-lineno">1708</tt> <tt class="py-line"><tt class="py-docstring"> set does not have a canonical name, then it will be assigned</tt> </tt>
<a name="L1709"></a><tt class="py-lineno">1709</tt> <tt class="py-line"><tt class="py-docstring"> one. etc.</tt> </tt>
<a name="L1710"></a><tt class="py-lineno">1710</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1711"></a><tt class="py-lineno">1711</tt> <tt class="py-line"><tt class="py-docstring"> @param root: A list of C{ValueDoc}s.</tt> </tt>
<a name="L1712"></a><tt class="py-lineno">1712</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1713"></a><tt class="py-lineno">1713</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-622" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-622', 'apidoc', 'link-76');">apidoc</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">root</tt><tt class="py-op">:</tt> </tt>
<a name="L1714"></a><tt class="py-lineno">1714</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-623" class="py-name"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-623', 'apidoc', 'link-76');">apidoc</a></tt><tt class="py-op">.</tt><tt id="link-624" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-624', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-625" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-625', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1715"></a><tt class="py-lineno">1715</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"All APIdocs passed to DocIndexer "</tt> </tt>
<a name="L1716"></a><tt class="py-lineno">1716</tt> <tt class="py-line"> <tt class="py-string">"must already have canonical names."</tt><tt class="py-op">)</tt> </tt>
<a name="L1717"></a><tt class="py-lineno">1717</tt> <tt class="py-line"> </tt>
<a name="L1718"></a><tt class="py-lineno">1718</tt> <tt class="py-line"> <tt class="py-comment"># Initialize the root items list. We sort them by length in</tt> </tt>
<a name="L1719"></a><tt class="py-lineno">1719</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># ascending order. (This ensures that variables will shadow</tt> </tt>
<a name="L1720"></a><tt class="py-lineno">1720</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># submodules when appropriate.)</tt> </tt>
<a name="L1721"></a><tt class="py-lineno">1721</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># When the elements name is the same, list in alphabetical order:</tt> </tt>
<a name="L1722"></a><tt class="py-lineno">1722</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># this is needed by the check for duplicates below.</tt> </tt>
<a name="L1723"></a><tt class="py-lineno">1723</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt> <tt class="py-op">=</tt> <tt id="link-626" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-626', 'sorted', 'link-340');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">root</tt><tt class="py-op">,</tt> </tt>
<a name="L1724"></a><tt class="py-lineno">1724</tt> <tt class="py-line"> <tt id="link-627" class="py-name"><a title="epydoc.cli.key" class="py-name" href="#" onclick="return doclink('link-627', 'key', 'link-65');">key</a></tt><tt class="py-op">=</tt><tt class="py-keyword">lambda</tt> <tt class="py-name">d</tt><tt class="py-op">:</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-628" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-628', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-629" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-629', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1725"></a><tt class="py-lineno">1725</tt> <tt class="py-line"> <tt class="py-string">"""The list of C{ValueDoc}s to document.</tt> </tt>
<a name="L1726"></a><tt class="py-lineno">1726</tt> <tt class="py-line"><tt class="py-string"> @type: C{list}"""</tt> </tt>
<a name="L1727"></a><tt class="py-lineno">1727</tt> <tt class="py-line"> </tt>
<a name="L1728"></a><tt class="py-lineno">1728</tt> <tt class="py-line"> <tt class="py-comment"># Drop duplicated modules</tt> </tt>
<a name="L1729"></a><tt class="py-lineno">1729</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># [xx] maybe what causes duplicates should be fixed instead.</tt> </tt>
<a name="L1730"></a><tt class="py-lineno">1730</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># If fixed, adjust the sort here above: sorting by names will not</tt> </tt>
<a name="L1731"></a><tt class="py-lineno">1731</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># be required anymore</tt> </tt>
<a name="L1732"></a><tt class="py-lineno">1732</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">i</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1733"></a><tt class="py-lineno">1733</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">i</tt> <tt class="py-op"><</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1734"></a><tt class="py-lineno">1734</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">is</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1735"></a><tt class="py-lineno">1735</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L1736"></a><tt class="py-lineno">1736</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1737"></a><tt class="py-lineno">1737</tt> <tt class="py-line"> <tt class="py-name">i</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1738"></a><tt class="py-lineno">1738</tt> <tt class="py-line"> </tt>
<a name="L1739"></a><tt class="py-lineno">1739</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mlclasses</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-630" class="py-name" targets="Method epydoc.apidoc.DocIndex._get_module_classes()=epydoc.apidoc.DocIndex-class.html#_get_module_classes"><a title="epydoc.apidoc.DocIndex._get_module_classes" class="py-name" href="#" onclick="return doclink('link-630', '_get_module_classes', 'link-630');">_get_module_classes</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">)</tt> </tt>
<a name="L1740"></a><tt class="py-lineno">1740</tt> <tt class="py-line"> <tt class="py-string">"""A mapping from class names to L{ClassDoc}. Contains</tt> </tt>
<a name="L1741"></a><tt class="py-lineno">1741</tt> <tt class="py-line"><tt class="py-string"> classes defined at module level for modules in L{root}</tt> </tt>
<a name="L1742"></a><tt class="py-lineno">1742</tt> <tt class="py-line"><tt class="py-string"> and which can be used as fallback by L{find()} if looking</tt> </tt>
<a name="L1743"></a><tt class="py-lineno">1743</tt> <tt class="py-line"><tt class="py-string"> in containing namespaces fails.</tt> </tt>
<a name="L1744"></a><tt class="py-lineno">1744</tt> <tt class="py-line"><tt class="py-string"> @type: C{dict} from C{str} to L{ClassDoc} or C{list}"""</tt> </tt>
<a name="L1745"></a><tt class="py-lineno">1745</tt> <tt class="py-line"> </tt>
<a name="L1746"></a><tt class="py-lineno">1746</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callers</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1747"></a><tt class="py-lineno">1747</tt> <tt class="py-line"> <tt class="py-string">"""A dictionary mapping from C{RoutineDoc}s in this index</tt> </tt>
<a name="L1748"></a><tt class="py-lineno">1748</tt> <tt class="py-line"><tt class="py-string"> to lists of C{RoutineDoc}s for the routine's callers.</tt> </tt>
<a name="L1749"></a><tt class="py-lineno">1749</tt> <tt class="py-line"><tt class="py-string"> This dictionary is initialized by calling</tt> </tt>
<a name="L1750"></a><tt class="py-lineno">1750</tt> <tt class="py-line"><tt class="py-string"> L{read_profiling_info()}.</tt> </tt>
<a name="L1751"></a><tt class="py-lineno">1751</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{RoutineDoc}"""</tt> </tt>
<a name="L1752"></a><tt class="py-lineno">1752</tt> <tt class="py-line"> </tt>
<a name="L1753"></a><tt class="py-lineno">1753</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callees</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1754"></a><tt class="py-lineno">1754</tt> <tt class="py-line"> <tt class="py-string">"""A dictionary mapping from C{RoutineDoc}s in this index</tt> </tt>
<a name="L1755"></a><tt class="py-lineno">1755</tt> <tt class="py-line"><tt class="py-string"> to lists of C{RoutineDoc}s for the routine's callees.</tt> </tt>
<a name="L1756"></a><tt class="py-lineno">1756</tt> <tt class="py-line"><tt class="py-string"> This dictionary is initialized by calling</tt> </tt>
<a name="L1757"></a><tt class="py-lineno">1757</tt> <tt class="py-line"><tt class="py-string"> L{read_profiling_info()}.</tt> </tt>
<a name="L1758"></a><tt class="py-lineno">1758</tt> <tt class="py-line"><tt class="py-string"> @type: C{list} of L{RoutineDoc}"""</tt> </tt>
<a name="L1759"></a><tt class="py-lineno">1759</tt> <tt class="py-line"> </tt>
<a name="L1760"></a><tt class="py-lineno">1760</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_funcid_to_doc</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1761"></a><tt class="py-lineno">1761</tt> <tt class="py-line"> <tt class="py-string">"""A mapping from C{profile} function ids to corresponding</tt> </tt>
<a name="L1762"></a><tt class="py-lineno">1762</tt> <tt class="py-line"><tt class="py-string"> C{APIDoc} objects. A function id is a tuple of the form</tt> </tt>
<a name="L1763"></a><tt class="py-lineno">1763</tt> <tt class="py-line"><tt class="py-string"> C{(filename, lineno, funcname)}. This is used to update</tt> </tt>
<a name="L1764"></a><tt class="py-lineno">1764</tt> <tt class="py-line"><tt class="py-string"> the L{callers} and L{callees} variables."""</tt> </tt>
<a name="L1765"></a><tt class="py-lineno">1765</tt> <tt class="py-line"> </tt>
<a name="L1766"></a><tt class="py-lineno">1766</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1767"></a><tt class="py-lineno">1767</tt> <tt class="py-line"> <tt class="py-string">"""A cache for the L{container()} method, to increase speed."""</tt> </tt>
<a name="L1768"></a><tt class="py-lineno">1768</tt> <tt class="py-line"> </tt>
<a name="L1769"></a><tt class="py-lineno">1769</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_get_cache</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1770"></a><tt class="py-lineno">1770</tt> <tt class="py-line"> <tt class="py-string">"""A cache for the L{get_vardoc()} and L{get_valdoc()} methods,</tt> </tt>
<a name="L1771"></a><tt class="py-lineno">1771</tt> <tt class="py-line"><tt class="py-string"> to increase speed."""</tt> </tt>
</div><a name="L1772"></a><tt class="py-lineno">1772</tt> <tt class="py-line"> </tt>
<a name="L1773"></a><tt class="py-lineno">1773</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1774"></a><tt class="py-lineno">1774</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Lookup methods</tt> </tt>
<a name="L1775"></a><tt class="py-lineno">1775</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1776"></a><tt class="py-lineno">1776</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># [xx]</tt> </tt>
<a name="L1777"></a><tt class="py-lineno">1777</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Currently these only work for things reachable from the</tt> </tt>
<a name="L1778"></a><tt class="py-lineno">1778</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># root... :-/ I might want to change this so that imported</tt> </tt>
<a name="L1779"></a><tt class="py-lineno">1779</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># values can be accessed even if they're not contained. </tt> </tt>
<a name="L1780"></a><tt class="py-lineno">1780</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Also, I might want canonical names to not start with ??</tt> </tt>
<a name="L1781"></a><tt class="py-lineno">1781</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># if the thing is a top-level imported module..?</tt> </tt>
<a name="L1782"></a><tt class="py-lineno">1782</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DocIndex.get_vardoc"></a><div id="DocIndex.get_vardoc-def"><a name="L1783"></a><tt class="py-lineno">1783</tt> <a class="py-toggle" href="#" id="DocIndex.get_vardoc-toggle" onclick="return toggle('DocIndex.get_vardoc');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#get_vardoc">get_vardoc</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.get_vardoc-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.get_vardoc-expanded"><a name="L1784"></a><tt class="py-lineno">1784</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1785"></a><tt class="py-lineno">1785</tt> <tt class="py-line"><tt class="py-docstring"> Return the C{VariableDoc} with the given name, or C{None} if this</tt> </tt>
<a name="L1786"></a><tt class="py-lineno">1786</tt> <tt class="py-line"><tt class="py-docstring"> index does not contain a C{VariableDoc} with the given name.</tt> </tt>
<a name="L1787"></a><tt class="py-lineno">1787</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1788"></a><tt class="py-lineno">1788</tt> <tt class="py-line"> <tt class="py-name">var</tt><tt class="py-op">,</tt> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-631" class="py-name" targets="Method epydoc.apidoc.DocIndex._get()=epydoc.apidoc.DocIndex-class.html#_get"><a title="epydoc.apidoc.DocIndex._get" class="py-name" href="#" onclick="return doclink('link-631', '_get', 'link-631');">_get</a></tt><tt class="py-op">(</tt><tt id="link-632" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-632', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1789"></a><tt class="py-lineno">1789</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var</tt> </tt>
</div><a name="L1790"></a><tt class="py-lineno">1790</tt> <tt class="py-line"> </tt>
<a name="DocIndex.get_valdoc"></a><div id="DocIndex.get_valdoc-def"><a name="L1791"></a><tt class="py-lineno">1791</tt> <a class="py-toggle" href="#" id="DocIndex.get_valdoc-toggle" onclick="return toggle('DocIndex.get_valdoc');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#get_valdoc">get_valdoc</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.get_valdoc-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.get_valdoc-expanded"><a name="L1792"></a><tt class="py-lineno">1792</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1793"></a><tt class="py-lineno">1793</tt> <tt class="py-line"><tt class="py-docstring"> Return the C{ValueDoc} with the given name, or C{None} if this</tt> </tt>
<a name="L1794"></a><tt class="py-lineno">1794</tt> <tt class="py-line"><tt class="py-docstring"> index does not contain a C{ValueDoc} with the given name.</tt> </tt>
<a name="L1795"></a><tt class="py-lineno">1795</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1796"></a><tt class="py-lineno">1796</tt> <tt class="py-line"> <tt class="py-name">var</tt><tt class="py-op">,</tt> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-633" class="py-name"><a title="epydoc.apidoc.DocIndex._get" class="py-name" href="#" onclick="return doclink('link-633', '_get', 'link-631');">_get</a></tt><tt class="py-op">(</tt><tt id="link-634" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-634', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1797"></a><tt class="py-lineno">1797</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val</tt> </tt>
</div><a name="L1798"></a><tt class="py-lineno">1798</tt> <tt class="py-line"> </tt>
<a name="DocIndex._get"></a><div id="DocIndex._get-def"><a name="L1799"></a><tt class="py-lineno">1799</tt> <a class="py-toggle" href="#" id="DocIndex._get-toggle" onclick="return toggle('DocIndex._get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#_get">_get</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex._get-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex._get-expanded"><a name="L1800"></a><tt class="py-lineno">1800</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1801"></a><tt class="py-lineno">1801</tt> <tt class="py-line"><tt class="py-docstring"> A helper function that's used to implement L{get_vardoc()}</tt> </tt>
<a name="L1802"></a><tt class="py-lineno">1802</tt> <tt class="py-line"><tt class="py-docstring"> and L{get_valdoc()}.</tt> </tt>
<a name="L1803"></a><tt class="py-lineno">1803</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1804"></a><tt class="py-lineno">1804</tt> <tt class="py-line"> <tt class="py-comment"># Convert name to a DottedName, if necessary.</tt> </tt>
<a name="L1805"></a><tt class="py-lineno">1805</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-635" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-635', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt id="link-636" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-636', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1806"></a><tt class="py-lineno">1806</tt> <tt class="py-line"> <tt id="link-637" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-637', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-638" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-638', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-639" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-639', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1807"></a><tt class="py-lineno">1807</tt> <tt class="py-line"> </tt>
<a name="L1808"></a><tt class="py-lineno">1808</tt> <tt class="py-line"> <tt class="py-comment"># Check if the result is cached.</tt> </tt>
<a name="L1809"></a><tt class="py-lineno">1809</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_get_cache</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt id="link-640" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-640', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1810"></a><tt class="py-lineno">1810</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">val</tt> </tt>
<a name="L1811"></a><tt class="py-lineno">1811</tt> <tt class="py-line"> </tt>
<a name="L1812"></a><tt class="py-lineno">1812</tt> <tt class="py-line"> <tt class="py-comment"># Look for an element in the root set whose name is a prefix</tt> </tt>
<a name="L1813"></a><tt class="py-lineno">1813</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># of `name`. If we can't find one, then return None.</tt> </tt>
<a name="L1814"></a><tt class="py-lineno">1814</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">root_valdoc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">:</tt> </tt>
<a name="L1815"></a><tt class="py-lineno">1815</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">root_valdoc</tt><tt class="py-op">.</tt><tt id="link-641" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-641', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">.</tt><tt id="link-642" class="py-name" targets="Method epydoc.apidoc.DottedName.dominates()=epydoc.apidoc.DottedName-class.html#dominates"><a title="epydoc.apidoc.DottedName.dominates" class="py-name" href="#" onclick="return doclink('link-642', 'dominates', 'link-642');">dominates</a></tt><tt class="py-op">(</tt><tt id="link-643" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-643', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1816"></a><tt class="py-lineno">1816</tt> <tt class="py-line"> <tt class="py-comment"># Starting at the root valdoc, walk down the variable/</tt> </tt>
<a name="L1817"></a><tt class="py-lineno">1817</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># submodule chain until we find the requested item.</tt> </tt>
<a name="L1818"></a><tt class="py-lineno">1818</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1819"></a><tt class="py-lineno">1819</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">root_valdoc</tt> </tt>
<a name="L1820"></a><tt class="py-lineno">1820</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt id="link-644" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-644', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">root_valdoc</tt><tt class="py-op">.</tt><tt id="link-645" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-645', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L1821"></a><tt class="py-lineno">1821</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L1822"></a><tt class="py-lineno">1822</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-646" class="py-name" targets="Method epydoc.apidoc.DocIndex._get_from()=epydoc.apidoc.DocIndex-class.html#_get_from"><a title="epydoc.apidoc.DocIndex._get_from" class="py-name" href="#" onclick="return doclink('link-646', '_get_from', 'link-646');">_get_from</a></tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L1823"></a><tt class="py-lineno">1823</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1824"></a><tt class="py-lineno">1824</tt> <tt class="py-line"> <tt class="py-comment"># If we found it, then return.</tt> </tt>
<a name="L1825"></a><tt class="py-lineno">1825</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1826"></a><tt class="py-lineno">1826</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_get_cache</tt><tt class="py-op">[</tt><tt id="link-647" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-647', 'name', 'link-36');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1827"></a><tt class="py-lineno">1827</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L1828"></a><tt class="py-lineno">1828</tt> <tt class="py-line"> </tt>
<a name="L1829"></a><tt class="py-lineno">1829</tt> <tt class="py-line"> <tt class="py-comment"># We didn't find it.</tt> </tt>
<a name="L1830"></a><tt class="py-lineno">1830</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_get_cache</tt><tt class="py-op">[</tt><tt id="link-648" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-648', 'name', 'link-36');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L1831"></a><tt class="py-lineno">1831</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1832"></a><tt class="py-lineno">1832</tt> <tt class="py-line"> </tt>
<a name="DocIndex._get_from"></a><div id="DocIndex._get_from-def"><a name="L1833"></a><tt class="py-lineno">1833</tt> <a class="py-toggle" href="#" id="DocIndex._get_from-toggle" onclick="return toggle('DocIndex._get_from');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#_get_from">_get_from</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">val_doc</tt><tt class="py-op">,</tt> <tt class="py-param">identifier</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex._get_from-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex._get_from-expanded"><a name="L1834"></a><tt class="py-lineno">1834</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-649" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-649', 'NamespaceDoc', 'link-329');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1835"></a><tt class="py-lineno">1835</tt> <tt class="py-line"> <tt class="py-name">child_var</tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-650" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-650', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">)</tt> </tt>
<a name="L1836"></a><tt class="py-lineno">1836</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child_var</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1837"></a><tt class="py-lineno">1837</tt> <tt class="py-line"> <tt class="py-name">child_val</tt> <tt class="py-op">=</tt> <tt class="py-name">child_var</tt><tt class="py-op">.</tt><tt id="link-651" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-651', 'value', 'link-114');">value</a></tt> </tt>
<a name="L1838"></a><tt class="py-lineno">1838</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">child_val</tt> <tt class="py-keyword">is</tt> <tt id="link-652" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-652', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-name">child_val</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1839"></a><tt class="py-lineno">1839</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">child_var</tt><tt class="py-op">,</tt> <tt class="py-name">child_val</tt> </tt>
<a name="L1840"></a><tt class="py-lineno">1840</tt> <tt class="py-line"> </tt>
<a name="L1841"></a><tt class="py-lineno">1841</tt> <tt class="py-line"> <tt class="py-comment"># If that fails, then see if it's a submodule.</tt> </tt>
<a name="L1842"></a><tt class="py-lineno">1842</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-653" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-653', 'ModuleDoc', 'link-386');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1843"></a><tt class="py-lineno">1843</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-654" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-654', 'submodules', 'link-317');">submodules</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-655" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-655', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1844"></a><tt class="py-lineno">1844</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">submodule</tt> <tt class="py-keyword">in</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-656" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-656', 'submodules', 'link-317');">submodules</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1845"></a><tt class="py-lineno">1845</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">submodule</tt><tt class="py-op">.</tt><tt id="link-657" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-657', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">identifier</tt><tt class="py-op">:</tt> </tt>
<a name="L1846"></a><tt class="py-lineno">1846</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1847"></a><tt class="py-lineno">1847</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">submodule</tt> </tt>
<a name="L1848"></a><tt class="py-lineno">1848</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt id="link-658" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-658', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1849"></a><tt class="py-lineno">1849</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L1850"></a><tt class="py-lineno">1850</tt> <tt class="py-line"> </tt>
<a name="L1851"></a><tt class="py-lineno">1851</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1852"></a><tt class="py-lineno">1852</tt> <tt class="py-line"> </tt>
<a name="DocIndex.find"></a><div id="DocIndex.find-def"><a name="L1853"></a><tt class="py-lineno">1853</tt> <a class="py-toggle" href="#" id="DocIndex.find-toggle" onclick="return toggle('DocIndex.find');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#find">find</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.find-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.find-expanded"><a name="L1854"></a><tt class="py-lineno">1854</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1855"></a><tt class="py-lineno">1855</tt> <tt class="py-line"><tt class="py-docstring"> Look for an C{APIDoc} named C{name}, relative to C{context}.</tt> </tt>
<a name="L1856"></a><tt class="py-lineno">1856</tt> <tt class="py-line"><tt class="py-docstring"> Return the C{APIDoc} if one is found; otherwise, return</tt> </tt>
<a name="L1857"></a><tt class="py-lineno">1857</tt> <tt class="py-line"><tt class="py-docstring"> C{None}. C{find} looks in the following places, in order:</tt> </tt>
<a name="L1858"></a><tt class="py-lineno">1858</tt> <tt class="py-line"><tt class="py-docstring"> - Function parameters (if one matches, return C{None})</tt> </tt>
<a name="L1859"></a><tt class="py-lineno">1859</tt> <tt class="py-line"><tt class="py-docstring"> - All enclosing namespaces, from closest to furthest.</tt> </tt>
<a name="L1860"></a><tt class="py-lineno">1860</tt> <tt class="py-line"><tt class="py-docstring"> - If C{name} starts with C{'self'}, then strip it off and</tt> </tt>
<a name="L1861"></a><tt class="py-lineno">1861</tt> <tt class="py-line"><tt class="py-docstring"> look for the remaining part of the name using C{find}</tt> </tt>
<a name="L1862"></a><tt class="py-lineno">1862</tt> <tt class="py-line"><tt class="py-docstring"> - Builtins</tt> </tt>
<a name="L1863"></a><tt class="py-lineno">1863</tt> <tt class="py-line"><tt class="py-docstring"> - Parameter attributes</tt> </tt>
<a name="L1864"></a><tt class="py-lineno">1864</tt> <tt class="py-line"><tt class="py-docstring"> - Classes at module level (if the name is not ambiguous)</tt> </tt>
<a name="L1865"></a><tt class="py-lineno">1865</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1866"></a><tt class="py-lineno">1866</tt> <tt class="py-line"><tt class="py-docstring"> @type name: C{str} or L{DottedName}</tt> </tt>
<a name="L1867"></a><tt class="py-lineno">1867</tt> <tt class="py-line"><tt class="py-docstring"> @type context: L{APIDoc}</tt> </tt>
<a name="L1868"></a><tt class="py-lineno">1868</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1869"></a><tt class="py-lineno">1869</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-659" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-659', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1870"></a><tt class="py-lineno">1870</tt> <tt class="py-line"> <tt id="link-660" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-660', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">sub</tt><tt class="py-op">(</tt><tt class="py-string">r'\(.*\)$'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt id="link-661" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-661', 'name', 'link-36');">name</a></tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1871"></a><tt class="py-lineno">1871</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-string">'^([a-zA-Z_]\w*)(\.[a-zA-Z_]\w*)*$'</tt><tt class="py-op">,</tt> <tt id="link-662" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-662', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1872"></a><tt class="py-lineno">1872</tt> <tt class="py-line"> <tt id="link-663" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-663', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-664" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-664', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-665" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-665', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1873"></a><tt class="py-lineno">1873</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1874"></a><tt class="py-lineno">1874</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1875"></a><tt class="py-lineno">1875</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-666" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-666', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt id="link-667" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-667', 'DottedName', 'link-17');">DottedName</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1876"></a><tt class="py-lineno">1876</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">"'name' should be a string or DottedName"</tt><tt class="py-op">)</tt> </tt>
<a name="L1877"></a><tt class="py-lineno">1877</tt> <tt class="py-line"> </tt>
<a name="L1878"></a><tt class="py-lineno">1878</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-668" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-668', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1879"></a><tt class="py-lineno">1879</tt> <tt class="py-line"> <tt class="py-name">container_name</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1880"></a><tt class="py-lineno">1880</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1881"></a><tt class="py-lineno">1881</tt> <tt class="py-line"> <tt class="py-name">container_name</tt> <tt class="py-op">=</tt> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-669" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-669', 'canonical_name', 'link-83');">canonical_name</a></tt> </tt>
<a name="L1882"></a><tt class="py-lineno">1882</tt> <tt class="py-line"> </tt>
<a name="L1883"></a><tt class="py-lineno">1883</tt> <tt class="py-line"> <tt class="py-comment"># Check for the name in all containing namespaces, starting</tt> </tt>
<a name="L1884"></a><tt class="py-lineno">1884</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># with the closest one.</tt> </tt>
<a name="L1885"></a><tt class="py-lineno">1885</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">container_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1886"></a><tt class="py-lineno">1886</tt> <tt class="py-line"> <tt class="py-name">relative_name</tt> <tt class="py-op">=</tt> <tt class="py-name">container_name</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt id="link-670" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-670', 'name', 'link-36');">name</a></tt> </tt>
<a name="L1887"></a><tt class="py-lineno">1887</tt> <tt class="py-line"> <tt class="py-comment"># Is `name` the absolute name of a documented value?</tt> </tt>
<a name="L1888"></a><tt class="py-lineno">1888</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (excepting GenericValueDoc values.)</tt> </tt>
<a name="L1889"></a><tt class="py-lineno">1889</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-671" class="py-name" targets="Method epydoc.apidoc.DocIndex.get_valdoc()=epydoc.apidoc.DocIndex-class.html#get_valdoc"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-671', 'get_valdoc', 'link-671');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">relative_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1890"></a><tt class="py-lineno">1890</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">val_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1891"></a><tt class="py-lineno">1891</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-672" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-672', 'GenericValueDoc', 'link-171');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1892"></a><tt class="py-lineno">1892</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L1893"></a><tt class="py-lineno">1893</tt> <tt class="py-line"> <tt class="py-comment"># Is `name` the absolute name of a documented variable?</tt> </tt>
<a name="L1894"></a><tt class="py-lineno">1894</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-673" class="py-name" targets="Method epydoc.apidoc.DocIndex.get_vardoc()=epydoc.apidoc.DocIndex-class.html#get_vardoc"><a title="epydoc.apidoc.DocIndex.get_vardoc" class="py-name" href="#" onclick="return doclink('link-673', 'get_vardoc', 'link-673');">get_vardoc</a></tt><tt class="py-op">(</tt><tt class="py-name">relative_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1895"></a><tt class="py-lineno">1895</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">var_doc</tt> </tt>
<a name="L1896"></a><tt class="py-lineno">1896</tt> <tt class="py-line"> </tt>
<a name="L1897"></a><tt class="py-lineno">1897</tt> <tt class="py-line"> <tt class="py-comment"># If the name begins with 'self', then try stripping that off</tt> </tt>
<a name="L1898"></a><tt class="py-lineno">1898</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and see if we can find the variable.</tt> </tt>
<a name="L1899"></a><tt class="py-lineno">1899</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-674" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-674', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'self'</tt><tt class="py-op">:</tt> </tt>
<a name="L1900"></a><tt class="py-lineno">1900</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-675" class="py-name" targets="Method epydoc.apidoc.DocIndex.find()=epydoc.apidoc.DocIndex-class.html#find"><a title="epydoc.apidoc.DocIndex.find" class="py-name" href="#" onclick="return doclink('link-675', 'find', 'link-675');">find</a></tt><tt class="py-op">(</tt><tt class="py-string">'.'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-676" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-676', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L1901"></a><tt class="py-lineno">1901</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">doc</tt> </tt>
<a name="L1902"></a><tt class="py-lineno">1902</tt> <tt class="py-line"> </tt>
<a name="L1903"></a><tt class="py-lineno">1903</tt> <tt class="py-line"> <tt class="py-comment"># Is it the name of a builtin?</tt> </tt>
<a name="L1904"></a><tt class="py-lineno">1904</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-677" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-677', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-number">1</tt> <tt class="py-keyword">and</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt id="link-678" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-678', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1905"></a><tt class="py-lineno">1905</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1906"></a><tt class="py-lineno">1906</tt> <tt class="py-line"> </tt>
<a name="L1907"></a><tt class="py-lineno">1907</tt> <tt class="py-line"> <tt class="py-comment"># Is it a parameter's name or an attribute of a parameter?</tt> </tt>
<a name="L1908"></a><tt class="py-lineno">1908</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">context</tt><tt class="py-op">,</tt> <tt id="link-679" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-679', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1909"></a><tt class="py-lineno">1909</tt> <tt class="py-line"> <tt id="link-680" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-680', 'all_args', 'link-578');">all_args</a></tt> <tt class="py-op">=</tt> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-681" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-681', 'all_args', 'link-578');">all_args</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1910"></a><tt class="py-lineno">1910</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-682" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-682', 'all_args', 'link-578');">all_args</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-683" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-683', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> <tt id="link-684" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-684', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt id="link-685" class="py-name"><a title="epydoc.apidoc.RoutineDoc.all_args" class="py-name" href="#" onclick="return doclink('link-685', 'all_args', 'link-578');">all_args</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1911"></a><tt class="py-lineno">1911</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1912"></a><tt class="py-lineno">1912</tt> <tt class="py-line"> </tt>
<a name="L1913"></a><tt class="py-lineno">1913</tt> <tt class="py-line"> <tt class="py-comment"># Is this an object directly contained by any module?</tt> </tt>
<a name="L1914"></a><tt class="py-lineno">1914</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mlclasses</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt id="link-686" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-686', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1915"></a><tt class="py-lineno">1915</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-687" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-687', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1916"></a><tt class="py-lineno">1916</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">doc</tt> </tt>
<a name="L1917"></a><tt class="py-lineno">1917</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1918"></a><tt class="py-lineno">1918</tt> <tt class="py-line"> <tt id="link-688" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-688', 'log', 'link-2');">log</a></tt><tt class="py-op">.</tt><tt id="link-689" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-689', 'warning', 'link-25');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s is an ambiguous name: it may be %s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
<a name="L1919"></a><tt class="py-lineno">1919</tt> <tt class="py-line"> <tt id="link-690" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-690', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L1920"></a><tt class="py-lineno">1920</tt> <tt class="py-line"> <tt class="py-string">", "</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt> <tt class="py-string">"'%s'"</tt> <tt class="py-op">%</tt> <tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-691" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-691', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt> <tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1921"></a><tt class="py-lineno">1921</tt> <tt class="py-line"> </tt>
<a name="L1922"></a><tt class="py-lineno">1922</tt> <tt class="py-line"> <tt class="py-comment"># Drop this item so that the warning is reported only once.</tt> </tt>
<a name="L1923"></a><tt class="py-lineno">1923</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># fail() will fail anyway.</tt> </tt>
<a name="L1924"></a><tt class="py-lineno">1924</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">mlclasses</tt><tt class="py-op">[</tt><tt id="link-692" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-692', 'name', 'link-36');">name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1925"></a><tt class="py-lineno">1925</tt> <tt class="py-line"> </tt>
<a name="DocIndex._get_module_classes"></a><div id="DocIndex._get_module_classes-def"><a name="L1926"></a><tt class="py-lineno">1926</tt> <a class="py-toggle" href="#" id="DocIndex._get_module_classes-toggle" onclick="return toggle('DocIndex._get_module_classes');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#_get_module_classes">_get_module_classes</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex._get_module_classes-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex._get_module_classes-expanded"><a name="L1927"></a><tt class="py-lineno">1927</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1928"></a><tt class="py-lineno">1928</tt> <tt class="py-line"><tt class="py-docstring"> Gather all the classes defined in a list of modules.</tt> </tt>
<a name="L1929"></a><tt class="py-lineno">1929</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1930"></a><tt class="py-lineno">1930</tt> <tt class="py-line"><tt class="py-docstring"> Very often people refers to classes only by class name,</tt> </tt>
<a name="L1931"></a><tt class="py-lineno">1931</tt> <tt class="py-line"><tt class="py-docstring"> even if they are not imported in the namespace. Linking</tt> </tt>
<a name="L1932"></a><tt class="py-lineno">1932</tt> <tt class="py-line"><tt class="py-docstring"> to such classes will fail if we look for them only in nested</tt> </tt>
<a name="L1933"></a><tt class="py-lineno">1933</tt> <tt class="py-line"><tt class="py-docstring"> namespaces. Allow them to retrieve only by name.</tt> </tt>
<a name="L1934"></a><tt class="py-lineno">1934</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1935"></a><tt class="py-lineno">1935</tt> <tt class="py-line"><tt class="py-docstring"> @param docs: containers of the objects to collect</tt> </tt>
<a name="L1936"></a><tt class="py-lineno">1936</tt> <tt class="py-line"><tt class="py-docstring"> @type docs: C{list} of C{APIDoc}</tt> </tt>
<a name="L1937"></a><tt class="py-lineno">1937</tt> <tt class="py-line"><tt class="py-docstring"> @return: mapping from objects name to the object(s) with that name</tt> </tt>
<a name="L1938"></a><tt class="py-lineno">1938</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{dict} from C{str} to L{ClassDoc} or C{list}</tt> </tt>
<a name="L1939"></a><tt class="py-lineno">1939</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1940"></a><tt class="py-lineno">1940</tt> <tt class="py-line"> <tt class="py-name">classes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L1941"></a><tt class="py-lineno">1941</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt><tt class="py-op">:</tt> </tt>
<a name="L1942"></a><tt class="py-lineno">1942</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-693" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-693', 'ModuleDoc', 'link-386');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1943"></a><tt class="py-lineno">1943</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1944"></a><tt class="py-lineno">1944</tt> <tt class="py-line"> </tt>
<a name="L1945"></a><tt class="py-lineno">1945</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-694" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-694', 'variables', 'link-229');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1946"></a><tt class="py-lineno">1946</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">var</tt><tt class="py-op">.</tt><tt id="link-695" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-695', 'value', 'link-114');">value</a></tt><tt class="py-op">,</tt> <tt id="link-696" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-696', 'ClassDoc', 'link-380');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1947"></a><tt class="py-lineno">1947</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1948"></a><tt class="py-lineno">1948</tt> <tt class="py-line"> </tt>
<a name="L1949"></a><tt class="py-lineno">1949</tt> <tt class="py-line"> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">var</tt><tt class="py-op">.</tt><tt id="link-697" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-697', 'value', 'link-114');">value</a></tt> </tt>
<a name="L1950"></a><tt class="py-lineno">1950</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-698" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-698', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">val</tt><tt class="py-op">.</tt><tt id="link-699" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-699', 'defining_module', 'link-149');">defining_module</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">doc</tt><tt class="py-op">:</tt> </tt>
<a name="L1951"></a><tt class="py-lineno">1951</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1952"></a><tt class="py-lineno">1952</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val</tt><tt class="py-op">.</tt><tt id="link-700" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-700', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-701" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-701', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1953"></a><tt class="py-lineno">1953</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1954"></a><tt class="py-lineno">1954</tt> <tt class="py-line"> </tt>
<a name="L1955"></a><tt class="py-lineno">1955</tt> <tt class="py-line"> <tt id="link-702" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-702', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">val</tt><tt class="py-op">.</tt><tt id="link-703" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-703', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1956"></a><tt class="py-lineno">1956</tt> <tt class="py-line"> <tt class="py-name">vals</tt> <tt class="py-op">=</tt> <tt class="py-name">classes</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt id="link-704" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-704', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1957"></a><tt class="py-lineno">1957</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">vals</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1958"></a><tt class="py-lineno">1958</tt> <tt class="py-line"> <tt class="py-name">classes</tt><tt class="py-op">[</tt><tt id="link-705" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-705', 'name', 'link-36');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">val</tt> </tt>
<a name="L1959"></a><tt class="py-lineno">1959</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">vals</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1960"></a><tt class="py-lineno">1960</tt> <tt class="py-line"> <tt class="py-name">classes</tt><tt class="py-op">[</tt><tt id="link-706" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-706', 'name', 'link-36');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-name">vals</tt><tt class="py-op">,</tt> <tt class="py-name">val</tt> <tt class="py-op">]</tt> </tt>
<a name="L1961"></a><tt class="py-lineno">1961</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1962"></a><tt class="py-lineno">1962</tt> <tt class="py-line"> <tt class="py-name">vals</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
<a name="L1963"></a><tt class="py-lineno">1963</tt> <tt class="py-line"> </tt>
<a name="L1964"></a><tt class="py-lineno">1964</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">classes</tt> </tt>
</div><a name="L1965"></a><tt class="py-lineno">1965</tt> <tt class="py-line"> </tt>
<a name="L1966"></a><tt class="py-lineno">1966</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1967"></a><tt class="py-lineno">1967</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># etc</tt> </tt>
<a name="L1968"></a><tt class="py-lineno">1968</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1969"></a><tt class="py-lineno">1969</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DocIndex.reachable_valdocs"></a><div id="DocIndex.reachable_valdocs-def"><a name="L1970"></a><tt class="py-lineno">1970</tt> <a class="py-toggle" href="#" id="DocIndex.reachable_valdocs-toggle" onclick="return toggle('DocIndex.reachable_valdocs');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs">reachable_valdocs</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">filters</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.reachable_valdocs-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.reachable_valdocs-expanded"><a name="L1971"></a><tt class="py-lineno">1971</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1972"></a><tt class="py-lineno">1972</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of all C{ValueDoc}s that can be reached,</tt> </tt>
<a name="L1973"></a><tt class="py-lineno">1973</tt> <tt class="py-line"><tt class="py-docstring"> directly or indirectly from this C{DocIndex}'s root set.</tt> </tt>
<a name="L1974"></a><tt class="py-lineno">1974</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1975"></a><tt class="py-lineno">1975</tt> <tt class="py-line"><tt class="py-docstring"> @param filters: A set of filters that can be used to prevent</tt> </tt>
<a name="L1976"></a><tt class="py-lineno">1976</tt> <tt class="py-line"><tt class="py-docstring"> C{reachable_valdocs} from following specific link types</tt> </tt>
<a name="L1977"></a><tt class="py-lineno">1977</tt> <tt class="py-line"><tt class="py-docstring"> when looking for C{ValueDoc}s that can be reached from the</tt> </tt>
<a name="L1978"></a><tt class="py-lineno">1978</tt> <tt class="py-line"><tt class="py-docstring"> root set. See C{APIDoc.apidoc_links} for a more complete</tt> </tt>
<a name="L1979"></a><tt class="py-lineno">1979</tt> <tt class="py-line"><tt class="py-docstring"> description.</tt> </tt>
<a name="L1980"></a><tt class="py-lineno">1980</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1981"></a><tt class="py-lineno">1981</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-707" class="py-name" targets="Method epydoc.apidoc.DocIndex.reachable_valdocs()=epydoc.apidoc.DocIndex-class.html#reachable_valdocs,Function epydoc.apidoc.reachable_valdocs()=epydoc.apidoc-module.html#reachable_valdocs"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-707', 'reachable_valdocs', 'link-707');">reachable_valdocs</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">root</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">filters</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1982"></a><tt class="py-lineno">1982</tt> <tt class="py-line"> </tt>
<a name="DocIndex.container"></a><div id="DocIndex.container-def"><a name="L1983"></a><tt class="py-lineno">1983</tt> <a class="py-toggle" href="#" id="DocIndex.container-toggle" onclick="return toggle('DocIndex.container');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#container">container</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.container-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.container-expanded"><a name="L1984"></a><tt class="py-lineno">1984</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1985"></a><tt class="py-lineno">1985</tt> <tt class="py-line"><tt class="py-docstring"> Return the C{ValueDoc} that contains the given C{APIDoc}, or</tt> </tt>
<a name="L1986"></a><tt class="py-lineno">1986</tt> <tt class="py-line"><tt class="py-docstring"> C{None} if its container is not in the index.</tt> </tt>
<a name="L1987"></a><tt class="py-lineno">1987</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1988"></a><tt class="py-lineno">1988</tt> <tt class="py-line"> <tt class="py-comment"># Check if the result is cached.</tt> </tt>
<a name="L1989"></a><tt class="py-lineno">1989</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1990"></a><tt class="py-lineno">1990</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">val</tt> </tt>
<a name="L1991"></a><tt class="py-lineno">1991</tt> <tt class="py-line"> </tt>
<a name="L1992"></a><tt class="py-lineno">1992</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-708" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-708', 'GenericValueDoc', 'link-171');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1993"></a><tt class="py-lineno">1993</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt><tt class="py-op">[</tt><tt class="py-name">api_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1994"></a><tt class="py-lineno">1994</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> <tt class="py-comment"># [xx] unknown.</tt> </tt>
<a name="L1995"></a><tt class="py-lineno">1995</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-709" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-709', 'VariableDoc', 'link-162');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1996"></a><tt class="py-lineno">1996</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt><tt class="py-op">[</tt><tt class="py-name">api_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-710" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-710', 'container', 'link-110');">container</a></tt> </tt>
<a name="L1997"></a><tt class="py-lineno">1997</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-711" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-711', 'container', 'link-110');">container</a></tt> </tt>
<a name="L1998"></a><tt class="py-lineno">1998</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-712" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-712', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L1999"></a><tt class="py-lineno">1999</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt><tt class="py-op">[</tt><tt class="py-name">api_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L2000"></a><tt class="py-lineno">2000</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L2001"></a><tt class="py-lineno">2001</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt id="link-713" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-713', 'ModuleDoc', 'link-386');">ModuleDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-714" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-714', 'package', 'link-321');">package</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-715" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-715', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L2002"></a><tt class="py-lineno">2002</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt><tt class="py-op">[</tt><tt class="py-name">api_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-716" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-716', 'package', 'link-321');">package</a></tt> </tt>
<a name="L2003"></a><tt class="py-lineno">2003</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-717" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-717', 'package', 'link-321');">package</a></tt> </tt>
<a name="L2004"></a><tt class="py-lineno">2004</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2005"></a><tt class="py-lineno">2005</tt> <tt class="py-line"> <tt class="py-name">parent</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-718" class="py-name"><a title="epydoc.apidoc.DocIndex.get_valdoc" class="py-name" href="#" onclick="return doclink('link-718', 'get_valdoc', 'link-671');">get_valdoc</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-719" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-719', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">.</tt><tt id="link-720" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-720', 'container', 'link-110');">container</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2006"></a><tt class="py-lineno">2006</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_container_cache</tt><tt class="py-op">[</tt><tt class="py-name">api_doc</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">parent</tt> </tt>
<a name="L2007"></a><tt class="py-lineno">2007</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parent</tt> </tt>
</div><a name="L2008"></a><tt class="py-lineno">2008</tt> <tt class="py-line"> </tt>
<a name="L2009"></a><tt class="py-lineno">2009</tt> <tt class="py-line"> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2010"></a><tt class="py-lineno">2010</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Profiling information</tt> </tt>
<a name="L2011"></a><tt class="py-lineno">2011</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2012"></a><tt class="py-lineno">2012</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="DocIndex.read_profiling_info"></a><div id="DocIndex.read_profiling_info-def"><a name="L2013"></a><tt class="py-lineno">2013</tt> <a class="py-toggle" href="#" id="DocIndex.read_profiling_info-toggle" onclick="return toggle('DocIndex.read_profiling_info');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#read_profiling_info">read_profiling_info</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">profile_stats</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex.read_profiling_info-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex.read_profiling_info-expanded"><a name="L2014"></a><tt class="py-lineno">2014</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2015"></a><tt class="py-lineno">2015</tt> <tt class="py-line"><tt class="py-docstring"> Initialize the L{callers} and L{callees} variables, given a</tt> </tt>
<a name="L2016"></a><tt class="py-lineno">2016</tt> <tt class="py-line"><tt class="py-docstring"> C{Stat} object from the C{pstats} module.</tt> </tt>
<a name="L2017"></a><tt class="py-lineno">2017</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L2018"></a><tt class="py-lineno">2018</tt> <tt class="py-line"><tt class="py-docstring"> @warning: This method uses undocumented data structures inside</tt> </tt>
<a name="L2019"></a><tt class="py-lineno">2019</tt> <tt class="py-line"><tt class="py-docstring"> of C{profile_stats}.</tt> </tt>
<a name="L2020"></a><tt class="py-lineno">2020</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2021"></a><tt class="py-lineno">2021</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2022"></a><tt class="py-lineno">2022</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callees</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callees</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2023"></a><tt class="py-lineno">2023</tt> <tt class="py-line"> </tt>
<a name="L2024"></a><tt class="py-lineno">2024</tt> <tt class="py-line"> <tt class="py-comment"># The Stat object encodes functions using `funcid`s, or</tt> </tt>
<a name="L2025"></a><tt class="py-lineno">2025</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># tuples of (filename, lineno, funcname). Create a mapping</tt> </tt>
<a name="L2026"></a><tt class="py-lineno">2026</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># from these `funcid`s to `RoutineDoc`s.</tt> </tt>
<a name="L2027"></a><tt class="py-lineno">2027</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-721" class="py-name" targets="Method epydoc.apidoc.DocIndex._update_funcid_to_doc()=epydoc.apidoc.DocIndex-class.html#_update_funcid_to_doc"><a title="epydoc.apidoc.DocIndex._update_funcid_to_doc" class="py-name" href="#" onclick="return doclink('link-721', '_update_funcid_to_doc', 'link-721');">_update_funcid_to_doc</a></tt><tt class="py-op">(</tt><tt class="py-name">profile_stats</tt><tt class="py-op">)</tt> </tt>
<a name="L2028"></a><tt class="py-lineno">2028</tt> <tt class="py-line"> </tt>
<a name="L2029"></a><tt class="py-lineno">2029</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">callee</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">cc</tt><tt class="py-op">,</tt> <tt class="py-name">nc</tt><tt class="py-op">,</tt> <tt class="py-name">tt</tt><tt class="py-op">,</tt> <tt class="py-name">ct</tt><tt class="py-op">,</tt> <tt class="py-name">callers</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">profile_stats</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2030"></a><tt class="py-lineno">2030</tt> <tt class="py-line"> <tt class="py-name">callee</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_funcid_to_doc</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">callee</tt><tt class="py-op">)</tt> </tt>
<a name="L2031"></a><tt class="py-lineno">2031</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">callee</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2032"></a><tt class="py-lineno">2032</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">caller</tt> <tt class="py-keyword">in</tt> <tt class="py-name">callers</tt><tt class="py-op">:</tt> </tt>
<a name="L2033"></a><tt class="py-lineno">2033</tt> <tt class="py-line"> <tt class="py-name">caller</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_funcid_to_doc</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">caller</tt><tt class="py-op">)</tt> </tt>
<a name="L2034"></a><tt class="py-lineno">2034</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">caller</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2035"></a><tt class="py-lineno">2035</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callers</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">callee</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">caller</tt><tt class="py-op">)</tt> </tt>
<a name="L2036"></a><tt class="py-lineno">2036</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">callees</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">caller</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">callee</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2037"></a><tt class="py-lineno">2037</tt> <tt class="py-line"> </tt>
<a name="DocIndex._update_funcid_to_doc"></a><div id="DocIndex._update_funcid_to_doc-def"><a name="L2038"></a><tt class="py-lineno">2038</tt> <a class="py-toggle" href="#" id="DocIndex._update_funcid_to_doc-toggle" onclick="return toggle('DocIndex._update_funcid_to_doc');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc.DocIndex-class.html#_update_funcid_to_doc">_update_funcid_to_doc</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">profile_stats</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocIndex._update_funcid_to_doc-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="DocIndex._update_funcid_to_doc-expanded"><a name="L2039"></a><tt class="py-lineno">2039</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2040"></a><tt class="py-lineno">2040</tt> <tt class="py-line"><tt class="py-docstring"> Update the dictionary mapping from C{pstat.Stat} funciton ids to</tt> </tt>
<a name="L2041"></a><tt class="py-lineno">2041</tt> <tt class="py-line"><tt class="py-docstring"> C{RoutineDoc}s. C{pstat.Stat} function ids are tuples of</tt> </tt>
<a name="L2042"></a><tt class="py-lineno">2042</tt> <tt class="py-line"><tt class="py-docstring"> C{(filename, lineno, funcname)}.</tt> </tt>
<a name="L2043"></a><tt class="py-lineno">2043</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2044"></a><tt class="py-lineno">2044</tt> <tt class="py-line"> <tt class="py-comment"># Maps (filename, lineno, funcname) -> RoutineDoc</tt> </tt>
<a name="L2045"></a><tt class="py-lineno">2045</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">val_doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-722" class="py-name"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-722', 'reachable_valdocs', 'link-707');">reachable_valdocs</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2046"></a><tt class="py-lineno">2046</tt> <tt class="py-line"> <tt class="py-comment"># We only care about routines.</tt> </tt>
<a name="L2047"></a><tt class="py-lineno">2047</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> <tt id="link-723" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-723', 'RoutineDoc', 'link-169');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2048"></a><tt class="py-lineno">2048</tt> <tt class="py-line"> <tt class="py-comment"># Get the filename from the defining module.</tt> </tt>
<a name="L2049"></a><tt class="py-lineno">2049</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-724" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-724', 'defining_module', 'link-149');">defining_module</a></tt> </tt>
<a name="L2050"></a><tt class="py-lineno">2050</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt> <tt class="py-keyword">is</tt> <tt id="link-725" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-725', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-726" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-726', 'filename', 'link-313');">filename</a></tt> <tt class="py-keyword">is</tt> <tt id="link-727" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-727', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L2051"></a><tt class="py-lineno">2051</tt> <tt class="py-line"> <tt class="py-comment"># Normalize the filename.</tt> </tt>
<a name="L2052"></a><tt class="py-lineno">2052</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-728" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-728', 'filename', 'link-313');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-729" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-729', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">abspath</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt id="link-730" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-730', 'filename', 'link-313');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2053"></a><tt class="py-lineno">2053</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-731" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-731', 'filename', 'link-313');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-732" class="py-name"><a title="epydoc.util.py_src_filename" class="py-name" href="#" onclick="return doclink('link-732', 'py_src_filename', 'link-9');">py_src_filename</a></tt><tt class="py-op">(</tt><tt id="link-733" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-733', 'filename', 'link-313');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2054"></a><tt class="py-lineno">2054</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L2055"></a><tt class="py-lineno">2055</tt> <tt class="py-line"> <tt class="py-comment"># Look up the stat_func_id</tt> </tt>
<a name="L2056"></a><tt class="py-lineno">2056</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">funcid</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-734" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-734', 'filename', 'link-313');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-735" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-735', 'lineno', 'link-544');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-736" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-736', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2057"></a><tt class="py-lineno">2057</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">funcid</tt> <tt class="py-keyword">in</tt> <tt class="py-name">profile_stats</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt><tt class="py-op">:</tt> </tt>
<a name="L2058"></a><tt class="py-lineno">2058</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_funcid_to_doc</tt><tt class="py-op">[</tt><tt class="py-name">funcid</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">val_doc</tt> </tt>
</div></div><a name="L2059"></a><tt class="py-lineno">2059</tt> <tt class="py-line"> </tt>
<a name="L2060"></a><tt class="py-lineno">2060</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L2061"></a><tt class="py-lineno">2061</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Pretty Printing</tt> </tt>
<a name="L2062"></a><tt class="py-lineno">2062</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L2063"></a><tt class="py-lineno">2063</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="pp_apidoc"></a><div id="pp_apidoc-def"><a name="L2064"></a><tt class="py-lineno">2064</tt> <a class="py-toggle" href="#" id="pp_apidoc-toggle" onclick="return toggle('pp_apidoc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#pp_apidoc">pp_apidoc</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">doublespace</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">=</tt><tt class="py-number">5</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">=</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L2065"></a><tt class="py-lineno">2065</tt> <tt class="py-line"> <tt class="py-param">backpointers</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pp_apidoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="pp_apidoc-expanded"><a name="L2066"></a><tt class="py-lineno">2066</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2067"></a><tt class="py-lineno">2067</tt> <tt class="py-line"><tt class="py-docstring"> @return: A multiline pretty-printed string representation for the</tt> </tt>
<a name="L2068"></a><tt class="py-lineno">2068</tt> <tt class="py-line"><tt class="py-docstring"> given C{APIDoc}.</tt> </tt>
<a name="L2069"></a><tt class="py-lineno">2069</tt> <tt class="py-line"><tt class="py-docstring"> @param doublespace: If true, then extra lines will be</tt> </tt>
<a name="L2070"></a><tt class="py-lineno">2070</tt> <tt class="py-line"><tt class="py-docstring"> inserted to make the output more readable.</tt> </tt>
<a name="L2071"></a><tt class="py-lineno">2071</tt> <tt class="py-line"><tt class="py-docstring"> @param depth: The maximum depth that pp_apidoc will descend</tt> </tt>
<a name="L2072"></a><tt class="py-lineno">2072</tt> <tt class="py-line"><tt class="py-docstring"> into descendent VarDocs. To put no limit on</tt> </tt>
<a name="L2073"></a><tt class="py-lineno">2073</tt> <tt class="py-line"><tt class="py-docstring"> depth, use C{depth=-1}.</tt> </tt>
<a name="L2074"></a><tt class="py-lineno">2074</tt> <tt class="py-line"><tt class="py-docstring"> @param exclude: A list of names of attributes whose values should</tt> </tt>
<a name="L2075"></a><tt class="py-lineno">2075</tt> <tt class="py-line"><tt class="py-docstring"> not be shown.</tt> </tt>
<a name="L2076"></a><tt class="py-lineno">2076</tt> <tt class="py-line"><tt class="py-docstring"> @param backpointers: For internal use.</tt> </tt>
<a name="L2077"></a><tt class="py-lineno">2077</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2078"></a><tt class="py-lineno">2078</tt> <tt class="py-line"> <tt class="py-name">pyid</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
<a name="L2079"></a><tt class="py-lineno">2079</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">backpointers</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-name">backpointers</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L2080"></a><tt class="py-lineno">2080</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'canonical_name'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2081"></a><tt class="py-lineno">2081</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-737" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-737', 'canonical_name', 'link-83');">canonical_name</a></tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-738" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-738', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2082"></a><tt class="py-lineno">2082</tt> <tt class="py-line"> <tt id="link-739" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-739', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s for %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> </tt>
<a name="L2083"></a><tt class="py-lineno">2083</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-740" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-740', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2084"></a><tt class="py-lineno">2084</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'name'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-741" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-741', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2085"></a><tt class="py-lineno">2085</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'container'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-742" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-742', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2086"></a><tt class="py-lineno">2086</tt> <tt class="py-line"> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-743" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-743', 'container', 'link-110');">container</a></tt><tt class="py-op">,</tt> <tt class="py-string">'canonical_name'</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L2087"></a><tt class="py-lineno">2087</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt id="link-744" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-744', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2088"></a><tt class="py-lineno">2088</tt> <tt class="py-line"> <tt id="link-745" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-745', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt><tt class="py-string">'%s for %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> </tt>
<a name="L2089"></a><tt class="py-lineno">2089</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-746" class="py-name"><a title="epydoc.apidoc.DocIndex.container
epydoc.apidoc.DottedName.container
epydoc.apidoc.VariableDoc.container" class="py-name" href="#" onclick="return doclink('link-746', 'container', 'link-110');">container</a></tt><tt class="py-op">.</tt><tt id="link-747" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-747', 'canonical_name', 'link-83');">canonical_name</a></tt><tt class="py-op">+</tt> </tt>
<a name="L2090"></a><tt class="py-lineno">2090</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-748" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-748', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2091"></a><tt class="py-lineno">2091</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2092"></a><tt class="py-lineno">2092</tt> <tt class="py-line"> <tt id="link-749" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-749', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'%s for %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-750" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-750', 'name', 'link-36');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2093"></a><tt class="py-lineno">2093</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2094"></a><tt class="py-lineno">2094</tt> <tt class="py-line"> <tt id="link-751" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-751', 'name', 'link-36');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L2095"></a><tt class="py-lineno">2095</tt> <tt class="py-line"> </tt>
<a name="L2096"></a><tt class="py-lineno">2096</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">pyid</tt> <tt class="py-keyword">in</tt> <tt class="py-name">backpointers</tt><tt class="py-op">:</tt> </tt>
<a name="L2097"></a><tt class="py-lineno">2097</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s [%s] (defined above)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-752" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-752', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2098"></a><tt class="py-lineno">2098</tt> <tt class="py-line"> </tt>
<a name="L2099"></a><tt class="py-lineno">2099</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">depth</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L2100"></a><tt class="py-lineno">2100</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'name'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-753" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-753', 'name', 'link-36');">name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L2101"></a><tt class="py-lineno">2101</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s...'</tt> <tt class="py-op">%</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-754" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-754', 'name', 'link-36');">name</a></tt> </tt>
<a name="L2102"></a><tt class="py-lineno">2102</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2103"></a><tt class="py-lineno">2103</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'...'</tt> </tt>
<a name="L2104"></a><tt class="py-lineno">2104</tt> <tt class="py-line"> </tt>
<a name="L2105"></a><tt class="py-lineno">2105</tt> <tt class="py-line"> <tt class="py-name">backpointers</tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">backpointers</tt><tt class="py-op">)</tt> </tt>
<a name="L2106"></a><tt class="py-lineno">2106</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">'%s [%s]'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-755" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-755', 'name', 'link-36');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">[</tt><tt class="py-name">pyid</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L2107"></a><tt class="py-lineno">2107</tt> <tt class="py-line"> </tt>
<a name="L2108"></a><tt class="py-lineno">2108</tt> <tt class="py-line"> <tt class="py-comment"># Only print non-empty fields:</tt> </tt>
<a name="L2109"></a><tt class="py-lineno">2109</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">field</tt> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2110"></a><tt class="py-lineno">2110</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">include</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L2111"></a><tt class="py-lineno">2111</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-756" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-756', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L2112"></a><tt class="py-lineno">2112</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">field</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">exclude</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L2113"></a><tt class="py-lineno">2113</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">include</tt><tt class="py-op">:</tt> </tt>
<a name="L2114"></a><tt class="py-lineno">2114</tt> <tt class="py-line"> <tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">field</tt> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dir</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L2115"></a><tt class="py-lineno">2115</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">include</tt><tt class="py-op">]</tt> </tt>
<a name="L2116"></a><tt class="py-lineno">2116</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2117"></a><tt class="py-lineno">2117</tt> <tt class="py-line"> <tt class="py-name">fields</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">field</tt> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">.</tt><tt class="py-name">keys</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2118"></a><tt class="py-lineno">2118</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-757" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-757', 'UNKNOWN', 'link-39');">UNKNOWN</a></tt> </tt>
<a name="L2119"></a><tt class="py-lineno">2119</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">field</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">exclude</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L2120"></a><tt class="py-lineno">2120</tt> <tt class="py-line"> <tt class="py-name">fields</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2121"></a><tt class="py-lineno">2121</tt> <tt class="py-line"> </tt>
<a name="L2122"></a><tt class="py-lineno">2122</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">field</tt> <tt class="py-keyword">in</tt> <tt class="py-name">fields</tt><tt class="py-op">:</tt> </tt>
<a name="L2123"></a><tt class="py-lineno">2123</tt> <tt class="py-line"> <tt class="py-name">fieldval</tt> <tt class="py-op">=</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">field</tt><tt class="py-op">)</tt> </tt>
<a name="L2124"></a><tt class="py-lineno">2124</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doublespace</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n |'</tt> </tt>
<a name="L2125"></a><tt class="py-lineno">2125</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n +- %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">field</tt> </tt>
<a name="L2126"></a><tt class="py-lineno">2126</tt> <tt class="py-line"> </tt>
<a name="L2127"></a><tt class="py-lineno">2127</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">ListType</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2128"></a><tt class="py-lineno">2128</tt> <tt class="py-line"> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">)</tt><tt class="py-op">></tt><tt class="py-number">0</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2129"></a><tt class="py-lineno">2129</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-758" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-758', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2130"></a><tt class="py-lineno">2130</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt id="link-759" class="py-name" targets="Function epydoc.apidoc._pp_list()=epydoc.apidoc-module.html#_pp_list"><a title="epydoc.apidoc._pp_list" class="py-name" href="#" onclick="return doclink('link-759', '_pp_list', 'link-759');">_pp_list</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">,</tt> </tt>
<a name="L2131"></a><tt class="py-lineno">2131</tt> <tt class="py-line"> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">,</tt> </tt>
<a name="L2132"></a><tt class="py-lineno">2132</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">field</tt> <tt class="py-keyword">is</tt> <tt class="py-name">fields</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2133"></a><tt class="py-lineno">2133</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">DictType</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2134"></a><tt class="py-lineno">2134</tt> <tt class="py-line"> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">)</tt><tt class="py-op">></tt><tt class="py-number">0</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2135"></a><tt class="py-lineno">2135</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-760" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-760', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2136"></a><tt class="py-lineno">2136</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt id="link-761" class="py-name" targets="Function epydoc.apidoc._pp_dict()=epydoc.apidoc-module.html#_pp_dict"><a title="epydoc.apidoc._pp_dict" class="py-name" href="#" onclick="return doclink('link-761', '_pp_dict', 'link-761');">_pp_dict</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> </tt>
<a name="L2137"></a><tt class="py-lineno">2137</tt> <tt class="py-line"> <tt class="py-name">depth</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">,</tt> </tt>
<a name="L2138"></a><tt class="py-lineno">2138</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">field</tt> <tt class="py-keyword">is</tt> <tt class="py-name">fields</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2139"></a><tt class="py-lineno">2139</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt id="link-762" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-762', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2140"></a><tt class="py-lineno">2140</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt id="link-763" class="py-name" targets="Function epydoc.apidoc._pp_apidoc()=epydoc.apidoc-module.html#_pp_apidoc"><a title="epydoc.apidoc._pp_apidoc" class="py-name" href="#" onclick="return doclink('link-763', '_pp_apidoc', 'link-763');">_pp_apidoc</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">,</tt> </tt>
<a name="L2141"></a><tt class="py-lineno">2141</tt> <tt class="py-line"> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">,</tt> </tt>
<a name="L2142"></a><tt class="py-lineno">2142</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">field</tt> <tt class="py-keyword">is</tt> <tt class="py-name">fields</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2143"></a><tt class="py-lineno">2143</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2144"></a><tt class="py-lineno">2144</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">' = '</tt> <tt class="py-op">+</tt> <tt id="link-764" class="py-name" targets="Function epydoc.apidoc._pp_val()=epydoc.apidoc-module.html#_pp_val"><a title="epydoc.apidoc._pp_val" class="py-name" href="#" onclick="return doclink('link-764', '_pp_val', 'link-764');">_pp_val</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">fieldval</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> </tt>
<a name="L2145"></a><tt class="py-lineno">2145</tt> <tt class="py-line"> <tt class="py-name">depth</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">)</tt> </tt>
<a name="L2146"></a><tt class="py-lineno">2146</tt> <tt class="py-line"> </tt>
<a name="L2147"></a><tt class="py-lineno">2147</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L2148"></a><tt class="py-lineno">2148</tt> <tt class="py-line"> </tt>
<a name="_pp_list"></a><div id="_pp_list-def"><a name="L2149"></a><tt class="py-lineno">2149</tt> <a class="py-toggle" href="#" id="_pp_list-toggle" onclick="return toggle('_pp_list');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#_pp_list">_pp_list</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">items</tt><tt class="py-op">,</tt> <tt class="py-param">doublespace</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">,</tt> </tt>
<a name="L2150"></a><tt class="py-lineno">2150</tt> <tt class="py-line"> <tt class="py-param">backpointers</tt><tt class="py-op">,</tt> <tt class="py-param">is_last</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pp_list-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pp_list-expanded"><a name="L2151"></a><tt class="py-lineno">2151</tt> <tt class="py-line"> <tt class="py-name">line1</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">is_last</tt> <tt class="py-keyword">and</tt> <tt class="py-string">' '</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'|'</tt> </tt>
<a name="L2152"></a><tt class="py-lineno">2152</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2153"></a><tt class="py-lineno">2153</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L2154"></a><tt class="py-lineno">2154</tt> <tt class="py-line"> <tt class="py-name">line2</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">item</tt> <tt class="py-keyword">is</tt> <tt class="py-name">items</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-string">' '</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'|'</tt> </tt>
<a name="L2155"></a><tt class="py-lineno">2155</tt> <tt class="py-line"> <tt class="py-name">joiner</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n %s %s '</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">line1</tt><tt class="py-op">,</tt> <tt class="py-name">line2</tt><tt class="py-op">)</tt> </tt>
<a name="L2156"></a><tt class="py-lineno">2156</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doublespace</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n %s |'</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2157"></a><tt class="py-lineno">2157</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n %s +- '</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2158"></a><tt class="py-lineno">2158</tt> <tt class="py-line"> <tt class="py-name">valstr</tt> <tt class="py-op">=</tt> <tt id="link-765" class="py-name"><a title="epydoc.apidoc._pp_val" class="py-name" href="#" onclick="return doclink('link-765', '_pp_val', 'link-764');">_pp_val</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> <tt class="py-name">include</tt><tt class="py-op">,</tt> </tt>
<a name="L2159"></a><tt class="py-lineno">2159</tt> <tt class="py-line"> <tt class="py-name">backpointers</tt><tt class="py-op">)</tt> </tt>
<a name="L2160"></a><tt class="py-lineno">2160</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-name">joiner</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">valstr</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2161"></a><tt class="py-lineno">2161</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L2162"></a><tt class="py-lineno">2162</tt> <tt class="py-line"> </tt>
<a name="_pp_dict"></a><div id="_pp_dict-def"><a name="L2163"></a><tt class="py-lineno">2163</tt> <a class="py-toggle" href="#" id="_pp_dict-toggle" onclick="return toggle('_pp_dict');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#_pp_dict">_pp_dict</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">dict</tt><tt class="py-op">,</tt> <tt class="py-param">doublespace</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">,</tt> </tt>
<a name="L2164"></a><tt class="py-lineno">2164</tt> <tt class="py-line"> <tt class="py-param">backpointers</tt><tt class="py-op">,</tt> <tt class="py-param">is_last</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pp_dict-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pp_dict-expanded"><a name="L2165"></a><tt class="py-lineno">2165</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2166"></a><tt class="py-lineno">2166</tt> <tt class="py-line"> <tt class="py-name">items</tt><tt class="py-op">.</tt><tt class="py-name">sort</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L2167"></a><tt class="py-lineno">2167</tt> <tt class="py-line"> <tt class="py-name">line1</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">is_last</tt> <tt class="py-keyword">and</tt> <tt class="py-string">' '</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'|'</tt> </tt>
<a name="L2168"></a><tt class="py-lineno">2168</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2169"></a><tt class="py-lineno">2169</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">items</tt><tt class="py-op">:</tt> </tt>
<a name="L2170"></a><tt class="py-lineno">2170</tt> <tt class="py-line"> <tt class="py-name">line2</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">item</tt> <tt class="py-keyword">is</tt> <tt class="py-name">items</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-string">' '</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'|'</tt> </tt>
<a name="L2171"></a><tt class="py-lineno">2171</tt> <tt class="py-line"> <tt class="py-name">joiner</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n %s %s '</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">line1</tt><tt class="py-op">,</tt> <tt class="py-name">line2</tt><tt class="py-op">)</tt> </tt>
<a name="L2172"></a><tt class="py-lineno">2172</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doublespace</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n %s |'</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2173"></a><tt class="py-lineno">2173</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n %s +- '</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2174"></a><tt class="py-lineno">2174</tt> <tt class="py-line"> <tt class="py-name">valstr</tt> <tt class="py-op">=</tt> <tt id="link-766" class="py-name"><a title="epydoc.apidoc._pp_val" class="py-name" href="#" onclick="return doclink('link-766', '_pp_val', 'link-764');">_pp_val</a></tt><tt class="py-op">(</tt><tt class="py-name">api_doc</tt><tt class="py-op">,</tt> <tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> </tt>
<a name="L2175"></a><tt class="py-lineno">2175</tt> <tt class="py-line"> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">)</tt> </tt>
<a name="L2176"></a><tt class="py-lineno">2176</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-name">joiner</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-string">'%s => %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">valstr</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2177"></a><tt class="py-lineno">2177</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> </tt>
</div><a name="L2178"></a><tt class="py-lineno">2178</tt> <tt class="py-line"> </tt>
<a name="_pp_apidoc"></a><div id="_pp_apidoc-def"><a name="L2179"></a><tt class="py-lineno">2179</tt> <a class="py-toggle" href="#" id="_pp_apidoc-toggle" onclick="return toggle('_pp_apidoc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#_pp_apidoc">_pp_apidoc</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">,</tt> <tt class="py-param">doublespace</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">,</tt> </tt>
<a name="L2180"></a><tt class="py-lineno">2180</tt> <tt class="py-line"> <tt class="py-param">backpointers</tt><tt class="py-op">,</tt> <tt class="py-param">is_last</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pp_apidoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pp_apidoc-expanded"><a name="L2181"></a><tt class="py-lineno">2181</tt> <tt class="py-line"> <tt class="py-name">line1</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">is_last</tt> <tt class="py-keyword">and</tt> <tt class="py-string">' '</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'|'</tt> </tt>
<a name="L2182"></a><tt class="py-lineno">2182</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L2183"></a><tt class="py-lineno">2183</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doublespace</tt><tt class="py-op">:</tt> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n %s | '</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2184"></a><tt class="py-lineno">2184</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">+=</tt> <tt class="py-string">'\n %s +- '</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2185"></a><tt class="py-lineno">2185</tt> <tt class="py-line"> <tt class="py-name">joiner</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n %s '</tt> <tt class="py-op">%</tt> <tt class="py-name">line1</tt> </tt>
<a name="L2186"></a><tt class="py-lineno">2186</tt> <tt class="py-line"> <tt class="py-name">childstr</tt> <tt class="py-op">=</tt> <tt id="link-767" class="py-name"><a title="epydoc.apidoc.pp_apidoc" class="py-name" href="#" onclick="return doclink('link-767', 'pp_apidoc', 'link-72');">pp_apidoc</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> </tt>
<a name="L2187"></a><tt class="py-lineno">2187</tt> <tt class="py-line"> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">)</tt> </tt>
<a name="L2188"></a><tt class="py-lineno">2188</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">s</tt> <tt class="py-op">+</tt> <tt class="py-name">joiner</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">childstr</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">'\n'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2189"></a><tt class="py-lineno">2189</tt> <tt class="py-line"> </tt>
<a name="_pp_val"></a><div id="_pp_val-def"><a name="L2190"></a><tt class="py-lineno">2190</tt> <a class="py-toggle" href="#" id="_pp_val-toggle" onclick="return toggle('_pp_val');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.apidoc-module.html#_pp_val">_pp_val</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">val</tt><tt class="py-op">,</tt> <tt class="py-param">doublespace</tt><tt class="py-op">,</tt> <tt class="py-param">depth</tt><tt class="py-op">,</tt> <tt class="py-param">exclude</tt><tt class="py-op">,</tt> <tt class="py-param">include</tt><tt class="py-op">,</tt> <tt class="py-param">backpointers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pp_val-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pp_val-expanded"><a name="L2191"></a><tt class="py-lineno">2191</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-768" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-768', 'epydoc', 'link-1');">epydoc</a></tt> <tt class="py-keyword">import</tt> <tt id="link-769" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-769', 'markup', 'link-11');">markup</a></tt> </tt>
<a name="L2192"></a><tt class="py-lineno">2192</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt id="link-770" class="py-name"><a title="epydoc.apidoc.APIDoc" class="py-name" href="#" onclick="return doclink('link-770', 'APIDoc', 'link-82');">APIDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2193"></a><tt class="py-lineno">2193</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-771" class="py-name"><a title="epydoc.apidoc.pp_apidoc" class="py-name" href="#" onclick="return doclink('link-771', 'pp_apidoc', 'link-72');">pp_apidoc</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">doublespace</tt><tt class="py-op">,</tt> <tt class="py-name">depth</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">exclude</tt><tt class="py-op">,</tt> </tt>
<a name="L2194"></a><tt class="py-lineno">2194</tt> <tt class="py-line"> <tt class="py-name">include</tt><tt class="py-op">,</tt> <tt class="py-name">backpointers</tt><tt class="py-op">)</tt> </tt>
<a name="L2195"></a><tt class="py-lineno">2195</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt id="link-772" class="py-name"><a title="epydoc.markup
epydoc.markup.doctest.DoctestColorizer.markup
epydoc.markup.doctest.HTMLDoctestColorizer.markup
epydoc.markup.doctest.LaTeXDoctestColorizer.markup
epydoc.markup.doctest.XMLDoctestColorizer.markup" class="py-name" href="#" onclick="return doclink('link-772', 'markup', 'link-11');">markup</a></tt><tt class="py-op">.</tt><tt id="link-773" class="py-name" targets="Class epydoc.markup.ParsedDocstring=epydoc.markup.ParsedDocstring-class.html"><a title="epydoc.markup.ParsedDocstring" class="py-name" href="#" onclick="return doclink('link-773', 'ParsedDocstring', 'link-773');">ParsedDocstring</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2196"></a><tt class="py-lineno">2196</tt> <tt class="py-line"> <tt class="py-name">valrepr</tt> <tt class="py-op">=</tt> <tt class="py-op">`</tt><tt class="py-name">val</tt><tt class="py-op">.</tt><tt id="link-774" class="py-name"><a title="epydoc.markup.ConcatenatedDocstring.to_plaintext
epydoc.markup.ParsedDocstring.to_plaintext
epydoc.markup.epytext.ParsedEpytextDocstring.to_plaintext
epydoc.markup.epytext.to_plaintext
epydoc.markup.javadoc.ParsedJavadocDocstring.to_plaintext
epydoc.markup.plaintext.ParsedPlaintextDocstring.to_plaintext
epydoc.markup.restructuredtext.ParsedRstDocstring.to_plaintext" class="py-name" href="#" onclick="return doclink('link-774', 'to_plaintext', 'link-198');">to_plaintext</a></tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">`</tt> </tt>
<a name="L2197"></a><tt class="py-lineno">2197</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">valrepr</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-number">40</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">valrepr</tt> </tt>
<a name="L2198"></a><tt class="py-lineno">2198</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">valrepr</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">37</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-string">'...'</tt> </tt>
<a name="L2199"></a><tt class="py-lineno">2199</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2200"></a><tt class="py-lineno">2200</tt> <tt class="py-line"> <tt class="py-name">valrepr</tt> <tt class="py-op">=</tt> <tt class="py-name">repr</tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">)</tt> </tt>
<a name="L2201"></a><tt class="py-lineno">2201</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">valrepr</tt><tt class="py-op">)</tt> <tt class="py-op"><</tt> <tt class="py-number">40</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">valrepr</tt> </tt>
<a name="L2202"></a><tt class="py-lineno">2202</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">valrepr</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-number">37</tt><tt class="py-op">]</tt><tt class="py-op">+</tt><tt class="py-string">'...'</tt> </tt>
</div><a name="L2203"></a><tt class="py-lineno">2203</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<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:09:30 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>
|
