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
|
<?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.docparser</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 docparser
</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.docparser-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.docparser-module.html">Module epydoc.docparser</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 -- Source code parsing</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: docparser.py 1673 2008-01-29 05:42:58Z 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">Extract API documentation about python objects by parsing their source</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">code.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">The function L{parse_docs()}, which provides the main interface</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring">of this module, reads and parses the Python source code for a</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">module, and uses it to create an L{APIDoc} object containing</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">the API documentation for the variables and values defined in</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">that modules.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">Currently, C{parse_docs()} extracts documentation from the following</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">source code constructions:</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"> - module docstring</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring"> - import statements</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring"> - class definition blocks</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"> - function definition blocks</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring"> - assignment statements</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"> - simple assignment statements</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-docstring"> - assignment statements with multiple C{'='}s</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-docstring"> - assignment statements with unpacked left-hand sides</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-docstring"> - assignment statements that wrap a function in classmethod</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> or staticmethod.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"> - assignment to special variables __path__, __all__, and</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> __docformat__.</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> - delete statements</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring">C{parse_docs()} does not yet support the following source code</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring">constructions:</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> - assignment statements that create properties</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring">By default, C{parse_docs()} will expore the contents of top-level</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring">C{try} and C{if} blocks. If desired, C{parse_docs()} can also</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring">be configured to explore the contents of C{while} and C{for} blocks.</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring">(See the configuration constants, below.)</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring">@todo: Make it possible to extend the functionality of C{parse_docs()},</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> by replacing process_line with a dispatch table that can be</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> customized (similarly to C{docintrospector.register_introspector()}).</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</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="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Imports</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-comment"># Python source code parsing:</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">token</tt><tt class="py-op">,</tt> <tt class="py-name">tokenize</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-comment"># Finding modules:</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">imp</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-comment"># File services:</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">os</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">sys</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-comment"># Unicode:</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">codecs</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-comment"># API documentation encoding:</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-comment"></tt><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-op">.</tt><tt id="link-2" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-2', 'apidoc', 'link-2');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-comment"># For looking up the docs of builtins:</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">__builtin__</tt><tt class="py-op">,</tt> <tt class="py-name">exceptions</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</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 class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module epydoc.docintrospecter=epydoc.docintrospecter-module.html"><a title="epydoc.docintrospecter" class="py-name" href="#" onclick="return doclink('link-4', 'docintrospecter', 'link-4');">docintrospecter</a></tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-comment"># Misc utility functions:</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">from</tt> <tt id="link-5" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-5', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-6" 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-6', 'util', 'link-6');">util</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-comment"># Backwards compatibility</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">from</tt> <tt id="link-7" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-7', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Module epydoc.compat=epydoc.compat-module.html"><a title="epydoc.compat" class="py-name" href="#" onclick="return doclink('link-8', 'compat', 'link-8');">compat</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-comment">######################################################################</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Doc Parser</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################################################################</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="ParseError"></a><div id="ParseError-def"><a name="L78"></a><tt class="py-lineno"> 78</tt> <a class="py-toggle" href="#" id="ParseError-toggle" onclick="return toggle('ParseError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.docparser.ParseError-class.html">ParseError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ParseError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ParseError-expanded"><a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> An exception that is used to signify that C{docparser} encountered</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> syntactically invalid Python code while processing a Python source</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> file.</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
</div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt id="link-9" class="py-name" targets="Variable epydoc.docparser._moduledoc_cache=epydoc.docparser-module.html#_moduledoc_cache"><a title="epydoc.docparser._moduledoc_cache" class="py-name" href="#" onclick="return doclink('link-9', '_moduledoc_cache', 'link-9');">_moduledoc_cache</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-string">"""A cache of C{ModuleDoc}s that we've already created.</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-string">C{_moduledoc_cache} is a dictionary mapping from filenames to</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-string">C{ValueDoc} objects.</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-string">@type: C{dict}"""</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Configuration Constants</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-comment">#{ Configuration Constants: Control Flow </tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-10" class="py-name" targets="Variable epydoc.docparser.PARSE_TRY_BLOCKS=epydoc.docparser-module.html#PARSE_TRY_BLOCKS"><a title="epydoc.docparser.PARSE_TRY_BLOCKS" class="py-name" href="#" onclick="return doclink('link-10', 'PARSE_TRY_BLOCKS', 'link-10');">PARSE_TRY_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{try} blocks be examined?"""</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable epydoc.docparser.PARSE_EXCEPT_BLOCKS=epydoc.docparser-module.html#PARSE_EXCEPT_BLOCKS"><a title="epydoc.docparser.PARSE_EXCEPT_BLOCKS" class="py-name" href="#" onclick="return doclink('link-11', 'PARSE_EXCEPT_BLOCKS', 'link-11');">PARSE_EXCEPT_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{except} blocks be examined?"""</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt> <tt class="py-line"><tt id="link-12" class="py-name" targets="Variable epydoc.docparser.PARSE_FINALLY_BLOCKS=epydoc.docparser-module.html#PARSE_FINALLY_BLOCKS"><a title="epydoc.docparser.PARSE_FINALLY_BLOCKS" class="py-name" href="#" onclick="return doclink('link-12', 'PARSE_FINALLY_BLOCKS', 'link-12');">PARSE_FINALLY_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L101"></a><tt class="py-lineno"> 101</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{finally} blocks be examined?"""</tt> </tt>
<a name="L102"></a><tt class="py-lineno"> 102</tt> <tt class="py-line"><tt id="link-13" class="py-name" targets="Variable epydoc.docparser.PARSE_IF_BLOCKS=epydoc.docparser-module.html#PARSE_IF_BLOCKS"><a title="epydoc.docparser.PARSE_IF_BLOCKS" class="py-name" href="#" onclick="return doclink('link-13', 'PARSE_IF_BLOCKS', 'link-13');">PARSE_IF_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L103"></a><tt class="py-lineno"> 103</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{if} blocks be examined?"""</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt> <tt class="py-line"><tt id="link-14" class="py-name" targets="Variable epydoc.docparser.PARSE_ELSE_BLOCKS=epydoc.docparser-module.html#PARSE_ELSE_BLOCKS"><a title="epydoc.docparser.PARSE_ELSE_BLOCKS" class="py-name" href="#" onclick="return doclink('link-14', 'PARSE_ELSE_BLOCKS', 'link-14');">PARSE_ELSE_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{else} and C{elif} blocks be examined?"""</tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt> <tt class="py-line"><tt id="link-15" class="py-name" targets="Variable epydoc.docparser.PARSE_WHILE_BLOCKS=epydoc.docparser-module.html#PARSE_WHILE_BLOCKS"><a title="epydoc.docparser.PARSE_WHILE_BLOCKS" class="py-name" href="#" onclick="return doclink('link-15', 'PARSE_WHILE_BLOCKS', 'link-15');">PARSE_WHILE_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{while} blocks be examined?"""</tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt> <tt class="py-line"><tt id="link-16" class="py-name" targets="Variable epydoc.docparser.PARSE_FOR_BLOCKS=epydoc.docparser-module.html#PARSE_FOR_BLOCKS"><a title="epydoc.docparser.PARSE_FOR_BLOCKS" class="py-name" href="#" onclick="return doclink('link-16', 'PARSE_FOR_BLOCKS', 'link-16');">PARSE_FOR_BLOCKS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt> <tt class="py-line"><tt class="py-string">"""Should the contents of C{for} blocks be examined?"""</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt> <tt class="py-line"> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt> <tt class="py-line"><tt class="py-comment">#{ Configuration Constants: Imports</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-17" class="py-name" targets="Variable epydoc.docparser.IMPORT_HANDLING=epydoc.docparser-module.html#IMPORT_HANDLING"><a title="epydoc.docparser.IMPORT_HANDLING" class="py-name" href="#" onclick="return doclink('link-17', 'IMPORT_HANDLING', 'link-17');">IMPORT_HANDLING</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'link'</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt> <tt class="py-line"><tt class="py-string">"""What should C{docparser} do when it encounters an import</tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt> <tt class="py-line"><tt class="py-string">statement?</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt> <tt class="py-line"><tt class="py-string"> - C{'link'}: Create variabledoc objects with imported_from pointers</tt> </tt>
<a name="L116"></a><tt class="py-lineno"> 116</tt> <tt class="py-line"><tt class="py-string"> to the source object.</tt> </tt>
<a name="L117"></a><tt class="py-lineno"> 117</tt> <tt class="py-line"><tt class="py-string"> - C{'parse'}: Parse the imported file, to find the actual</tt> </tt>
<a name="L118"></a><tt class="py-lineno"> 118</tt> <tt class="py-line"><tt class="py-string"> documentation for the imported object. (This will fall back</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt> <tt class="py-line"><tt class="py-string"> to the 'link' behavior if the imported file can't be parsed,</tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt> <tt class="py-line"><tt class="py-string"> e.g., if it's a builtin.)</tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt> <tt class="py-line"> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt> <tt class="py-line"><tt id="link-18" class="py-name" targets="Variable epydoc.docparser.IMPORT_STAR_HANDLING=epydoc.docparser-module.html#IMPORT_STAR_HANDLING"><a title="epydoc.docparser.IMPORT_STAR_HANDLING" class="py-name" href="#" onclick="return doclink('link-18', 'IMPORT_STAR_HANDLING', 'link-18');">IMPORT_STAR_HANDLING</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'parse'</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt> <tt class="py-line"><tt class="py-string">"""When C{docparser} encounters a C{'from M{m} import *'}</tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt> <tt class="py-line"><tt class="py-string">statement, and is unable to parse C{M{m}} (either because</tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt> <tt class="py-line"><tt class="py-string">L{IMPORT_HANDLING}=C{'link'}, or because parsing failed), how</tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt> <tt class="py-line"><tt class="py-string">should it determine the list of identifiers expored by C{M{m}}?</tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt> <tt class="py-line"><tt class="py-string"> - C{'ignore'}: ignore the import statement, and don't create</tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt> <tt class="py-line"><tt class="py-string"> any new variables.</tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt> <tt class="py-line"><tt class="py-string"> - C{'parse'}: parse it to find a list of the identifiers that it</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt> <tt class="py-line"><tt class="py-string"> exports. (This will fall back to the 'ignore' behavior if the</tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt> <tt class="py-line"><tt class="py-string"> imported file can't be parsed, e.g., if it's a builtin.)</tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt> <tt class="py-line"><tt class="py-string"> - C{'introspect'}: import the module and introspect it (using C{dir})</tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt> <tt class="py-line"><tt class="py-string"> to find a list of the identifiers that it exports. (This will</tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt> <tt class="py-line"><tt class="py-string"> fall back to the 'ignore' behavior if the imported file can't</tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt> <tt class="py-line"><tt class="py-string"> be parsed, e.g., if it's a builtin.)</tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt> <tt class="py-line"> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt> <tt class="py-line"><tt id="link-19" class="py-name" targets="Variable epydoc.docparser.DEFAULT_DECORATOR_BEHAVIOR=epydoc.docparser-module.html#DEFAULT_DECORATOR_BEHAVIOR"><a title="epydoc.docparser.DEFAULT_DECORATOR_BEHAVIOR" class="py-name" href="#" onclick="return doclink('link-19', 'DEFAULT_DECORATOR_BEHAVIOR', 'link-19');">DEFAULT_DECORATOR_BEHAVIOR</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'transparent'</tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt> <tt class="py-line"><tt class="py-string">"""When C{DocParse} encounters an unknown decorator, what should</tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt> <tt class="py-line"><tt class="py-string">it do to the documentation of the decorated function?</tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt> <tt class="py-line"><tt class="py-string"> - C{'transparent'}: leave the function's documentation as-is.</tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt> <tt class="py-line"><tt class="py-string"> - C{'opaque'}: replace the function's documentation with an</tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt> <tt class="py-line"><tt class="py-string"> empty C{ValueDoc} object, reflecting the fact that we have no</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt> <tt class="py-line"><tt class="py-string"> knowledge about what value the decorator returns.</tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt> <tt class="py-line"> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt> <tt class="py-line"><tt id="link-20" class="py-name" targets="Variable epydoc.docparser.BASE_HANDLING=epydoc.docparser-module.html#BASE_HANDLING"><a title="epydoc.docparser.BASE_HANDLING" class="py-name" href="#" onclick="return doclink('link-20', 'BASE_HANDLING', 'link-20');">BASE_HANDLING</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'parse'</tt><tt class="py-comment">#'link'</tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt> <tt class="py-line"><tt class="py-string">"""What should C{docparser} do when it encounters a base class that</tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt> <tt class="py-line"><tt class="py-string">was imported from another module?</tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt> <tt class="py-line"><tt class="py-string"> - C{'link'}: Create a valuedoc with a C{proxy_for} pointer to the</tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt> <tt class="py-line"><tt class="py-string"> base class.</tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt> <tt class="py-line"><tt class="py-string"> - C{'parse'}: Parse the file containing the base class, to find</tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt> <tt class="py-line"><tt class="py-string"> the actual documentation for it. (This will fall back to the</tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt> <tt class="py-line"><tt class="py-string"> 'link' behavior if the imported file can't be parsed, e.g., if</tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt> <tt class="py-line"><tt class="py-string"> it's a builtin.)</tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt> <tt class="py-line"> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt> <tt class="py-line"><tt class="py-comment">#{ Configuration Constants: Comment docstrings</tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-21" class="py-name" targets="Variable epydoc.docparser.COMMENT_DOCSTRING_MARKER=epydoc.docparser-module.html#COMMENT_DOCSTRING_MARKER"><a title="epydoc.docparser.COMMENT_DOCSTRING_MARKER" class="py-name" href="#" onclick="return doclink('link-21', 'COMMENT_DOCSTRING_MARKER', 'link-21');">COMMENT_DOCSTRING_MARKER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'#:'</tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt> <tt class="py-line"><tt class="py-string">"""The prefix used to mark comments that contain attribute</tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt> <tt class="py-line"><tt class="py-string">docstrings for variables."""</tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt> <tt class="py-line"> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt> <tt class="py-line"><tt class="py-comment">#{ Configuration Constants: Grouping</tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-22" class="py-name" targets="Variable epydoc.docparser.START_GROUP_MARKER=epydoc.docparser-module.html#START_GROUP_MARKER"><a title="epydoc.docparser.START_GROUP_MARKER" class="py-name" href="#" onclick="return doclink('link-22', 'START_GROUP_MARKER', 'link-22');">START_GROUP_MARKER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'#{'</tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt> <tt class="py-line"><tt class="py-string">"""The prefix used to mark a comment that starts a group. This marker</tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt> <tt class="py-line"><tt class="py-string">should be followed (on the same line) by the name of the group.</tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt> <tt class="py-line"><tt class="py-string">Following a start-group comment, all variables defined at the same</tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt> <tt class="py-line"><tt class="py-string">indentation level will be assigned to this group name, until the</tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt> <tt class="py-line"><tt class="py-string">parser reaches the end of the file, a matching end-group comment, or</tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt> <tt class="py-line"><tt class="py-string">another start-group comment at the same indentation level.</tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt> <tt class="py-line"> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt> <tt class="py-line"><tt id="link-23" class="py-name" targets="Variable epydoc.docparser.END_GROUP_MARKER=epydoc.docparser-module.html#END_GROUP_MARKER"><a title="epydoc.docparser.END_GROUP_MARKER" class="py-name" href="#" onclick="return doclink('link-23', 'END_GROUP_MARKER', 'link-23');">END_GROUP_MARKER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'#}'</tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt> <tt class="py-line"><tt class="py-string">"""The prefix used to mark a comment that ends a group. See</tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt> <tt class="py-line"><tt class="py-string">L{START_GROUP_MARKER}."""</tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt> <tt class="py-line"> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Module parser</tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="parse_docs"></a><div id="parse_docs-def"><a name="L182"></a><tt class="py-lineno"> 182</tt> <a class="py-toggle" href="#" id="parse_docs-toggle" onclick="return toggle('parse_docs');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_docs">parse_docs</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">context</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">is_script</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="parse_docs-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_docs-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"> Generate the API documentation for a specified object by</tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt> <tt class="py-line"><tt class="py-docstring"> parsing Python source files, and return it as a L{ValueDoc}.</tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt> <tt class="py-line"><tt class="py-docstring"> The object to generate documentation for may be specified</tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt> <tt class="py-line"><tt class="py-docstring"> using the C{filename} parameter I{or} the C{name} parameter.</tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt> <tt class="py-line"><tt class="py-docstring"> (It is an error to specify both a filename and a name; or to</tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt> <tt class="py-line"><tt class="py-docstring"> specify neither a filename nor a name).</tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt> <tt class="py-line"><tt class="py-docstring"> @param filename: The name of the file that contains the python</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt> <tt class="py-line"><tt class="py-docstring"> source code for a package, module, or script. If</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt> <tt class="py-line"><tt class="py-docstring"> C{filename} is specified, then C{parse} will return a</tt> </tt>
<a name="L194"></a><tt class="py-lineno"> 194</tt> <tt class="py-line"><tt class="py-docstring"> C{ModuleDoc} describing its contents.</tt> </tt>
<a name="L195"></a><tt class="py-lineno"> 195</tt> <tt class="py-line"><tt class="py-docstring"> @param name: The fully-qualified python dotted name of any</tt> </tt>
<a name="L196"></a><tt class="py-lineno"> 196</tt> <tt class="py-line"><tt class="py-docstring"> value (including packages, modules, classes, and</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt> <tt class="py-line"><tt class="py-docstring"> functions). C{parse_docs()} will automatically figure out</tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt> <tt class="py-line"><tt class="py-docstring"> which module(s) it needs to parse in order to find the</tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt> <tt class="py-line"><tt class="py-docstring"> documentation for the specified object.</tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt> <tt class="py-line"><tt class="py-docstring"> @param context: The API documentation for the package that</tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt> <tt class="py-line"><tt class="py-docstring"> contains C{filename}. If no context is given, then</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt> <tt class="py-line"><tt class="py-docstring"> C{filename} is assumed to contain a top-level module or</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt> <tt class="py-line"><tt class="py-docstring"> package. It is an error to specify a C{context} if the</tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt> <tt class="py-line"><tt class="py-docstring"> C{name} argument is used.</tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{ValueDoc}</tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt> <tt class="py-line"> <tt class="py-comment"># Always introspect __builtins__ & exceptions (e.g., in case</tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># they're used as base classes.)</tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-24" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-24', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="epydoc.docintrospecter" class="py-name" href="#" onclick="return doclink('link-25', 'docintrospecter', 'link-4');">docintrospecter</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Function epydoc.docintrospecter.introspect_docs()=epydoc.docintrospecter-module.html#introspect_docs"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-26', 'introspect_docs', 'link-26');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">)</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt> <tt class="py-line"> <tt id="link-27" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-27', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="epydoc.docintrospecter" class="py-name" href="#" onclick="return doclink('link-28', 'docintrospecter', 'link-4');">docintrospecter</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-29', 'introspect_docs', 'link-26');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">exceptions</tt><tt class="py-op">)</tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt> <tt class="py-line"> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt> <tt class="py-line"> <tt class="py-comment"># If our input is a python object name, then delegate to</tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># _find().</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-30" 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-30', 'filename', 'link-30');">filename</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt id="link-31" 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-31', 'name', 'link-31');">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="L215"></a><tt class="py-lineno"> 215</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">context</tt><tt class="py-op">:</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</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">"context should only be specified together "</tt> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt> <tt class="py-line"> <tt class="py-string">"with filename, not with name."</tt><tt class="py-op">)</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt> <tt class="py-line"> <tt id="link-32" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-32', 'name', 'link-31');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-33" 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-33', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-34" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-34', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L219"></a><tt class="py-lineno"> 219</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt id="link-35" class="py-name" targets="Function epydoc.docparser._find()=epydoc.docparser-module.html#_find"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-35', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt id="link-36" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-36', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L220"></a><tt class="py-lineno"> 220</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">val_doc</tt><tt class="py-op">.</tt><tt id="link-37" 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-37', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-38" 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-38', 'UNKNOWN', 'link-38');">UNKNOWN</a></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">val_doc</tt><tt class="py-op">.</tt><tt id="link-39" 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-39', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-40" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-40', 'name', 'link-31');">name</a></tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt> <tt class="py-line"> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt> <tt class="py-line"> <tt class="py-comment"># If our input is a filename, then create a ModuleDoc for it,</tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and use process_file() to populate its attributes.</tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt id="link-41" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-41', 'filename', 'link-30');">filename</a></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 id="link-42" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-42', 'name', 'link-31');">name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt> <tt class="py-line"> <tt class="py-comment"># Use a python source version, if possible.</tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</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">is_script</tt><tt class="py-op">:</tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt id="link-43" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-43', 'filename', 'link-30');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-44" 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-44', 'py_src_filename', 'link-44');">py_src_filename</a></tt><tt class="py-op">(</tt><tt id="link-45" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-45', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-string">'%s'</tt> <tt class="py-op">%</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt> <tt class="py-line"> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt> <tt class="py-line"> <tt class="py-comment"># Check the cache, first.</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-46" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-46', 'filename', 'link-30');">filename</a></tt> <tt class="py-keyword">in</tt> <tt id="link-47" class="py-name"><a title="epydoc.docparser._moduledoc_cache" class="py-name" href="#" onclick="return doclink('link-47', '_moduledoc_cache', 'link-9');">_moduledoc_cache</a></tt><tt class="py-op">:</tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-48" class="py-name"><a title="epydoc.docparser._moduledoc_cache" class="py-name" href="#" onclick="return doclink('link-48', '_moduledoc_cache', 'link-9');">_moduledoc_cache</a></tt><tt class="py-op">[</tt><tt id="link-49" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-49', 'filename', 'link-30');">filename</a></tt><tt class="py-op">]</tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt> <tt class="py-line"> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt> <tt class="py-line"> <tt id="link-50" 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-50', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-51" class="py-name" targets="Function epydoc.log.info()=epydoc.log-module.html#info"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-51', 'info', 'link-51');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">"Parsing %s"</tt> <tt class="py-op">%</tt> <tt id="link-52" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-52', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt> <tt class="py-line"> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt> <tt class="py-line"> <tt class="py-comment"># If the context wasn't provided, then check if the file is in</tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># a package directory. If so, then update basedir & name to</tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># contain the topmost package's directory and the fully</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># qualified name for this file. (This update assume the</tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># default value of __path__ for the parent packages; if the</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># parent packages override their __path__s, then this can</tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># cause us not to find the value.)</tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt> <tt class="py-line"><tt class="py-comment"></tt> <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">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">is_script</tt><tt class="py-op">:</tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt> <tt class="py-line"> <tt class="py-name">basedir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-53', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-54" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-54', 'filename', 'link-30');">filename</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="L247"></a><tt class="py-lineno"> 247</tt> <tt class="py-line"> <tt id="link-55" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-55', 'name', 'link-31');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-56', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">splitext</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-57', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-58" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-58', 'filename', 'link-30');">filename</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-op">[</tt><tt class="py-number">0</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">if</tt> <tt id="link-59" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-59', 'name', 'link-31');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">:</tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt> <tt class="py-line"> <tt class="py-name">basedir</tt><tt class="py-op">,</tt> <tt id="link-60" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-60', 'name', 'link-31');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-61', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">basedir</tt><tt class="py-op">)</tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt> <tt class="py-line"> <tt class="py-name">context</tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name" targets="Function epydoc.docparser._parse_package()=epydoc.docparser-module.html#_parse_package"><a title="epydoc.docparser._parse_package" class="py-name" href="#" onclick="return doclink('link-62', '_parse_package', 'link-62');">_parse_package</a></tt><tt class="py-op">(</tt><tt class="py-name">basedir</tt><tt class="py-op">)</tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt> <tt class="py-line"> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt> <tt class="py-line"> <tt class="py-comment"># Figure out the canonical name of the module we're parsing.</tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</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">is_script</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">module_name</tt><tt class="py-op">,</tt> <tt class="py-name">is_pkg</tt> <tt class="py-op">=</tt> <tt id="link-63" class="py-name" targets="Function epydoc.docparser._get_module_name()=epydoc.docparser-module.html#_get_module_name"><a title="epydoc.docparser._get_module_name" class="py-name" href="#" onclick="return doclink('link-63', '_get_module_name', 'link-63');">_get_module_name</a></tt><tt class="py-op">(</tt><tt id="link-64" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-64', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">)</tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt> <tt class="py-line"> <tt class="py-name">module_name</tt> <tt class="py-op">=</tt> <tt id="link-65" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-65', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-66" class="py-name" targets="Function epydoc.util.munge_script_name()=epydoc.util-module.html#munge_script_name"><a title="epydoc.util.munge_script_name" class="py-name" href="#" onclick="return doclink('link-66', 'munge_script_name', 'link-66');">munge_script_name</a></tt><tt class="py-op">(</tt><tt id="link-67" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-67', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</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">is_pkg</tt> <tt class="py-op">=</tt> <tt class="py-name">False</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"># Create a new ModuleDoc for the module, & add it to the cache.</tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">module_doc</tt> <tt class="py-op">=</tt> <tt id="link-68" 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-68', 'ModuleDoc', 'link-68');">ModuleDoc</a></tt><tt class="py-op">(</tt><tt id="link-69" 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-69', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">=</tt><tt class="py-name">module_name</tt><tt class="py-op">,</tt> <tt id="link-70" 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-70', 'variables', 'link-70');">variables</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="L261"></a><tt class="py-lineno"> 261</tt> <tt class="py-line"> <tt id="link-71" 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-71', 'sort_spec', 'link-71');">sort_spec</a></tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-72" 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-72', 'imports', 'link-72');">imports</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="L262"></a><tt class="py-lineno"> 262</tt> <tt class="py-line"> <tt id="link-73" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-73', 'filename', 'link-30');">filename</a></tt><tt class="py-op">=</tt><tt id="link-74" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-74', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt id="link-75" 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-75', 'package', 'link-75');">package</a></tt><tt class="py-op">=</tt><tt class="py-name">context</tt><tt class="py-op">,</tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt> <tt class="py-line"> <tt id="link-76" 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-76', 'is_package', 'link-76');">is_package</a></tt><tt class="py-op">=</tt><tt class="py-name">is_pkg</tt><tt class="py-op">,</tt> <tt id="link-77" 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-77', 'submodules', 'link-77');">submodules</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="L264"></a><tt class="py-lineno"> 264</tt> <tt class="py-line"> <tt id="link-78" 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-78', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-79" 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-79', 'defining_module', 'link-79');">defining_module</a></tt> <tt class="py-op">=</tt> <tt class="py-name">module_doc</tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt> <tt class="py-line"> <tt id="link-80" class="py-name"><a title="epydoc.docparser._moduledoc_cache" class="py-name" href="#" onclick="return doclink('link-80', '_moduledoc_cache', 'link-9');">_moduledoc_cache</a></tt><tt class="py-op">[</tt><tt id="link-81" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-81', 'filename', 'link-30');">filename</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">module_doc</tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt> <tt class="py-line"> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt> <tt class="py-line"> <tt class="py-comment"># Set the module's __path__ to its default 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-keyword">if</tt> <tt class="py-name">is_pkg</tt><tt class="py-op">:</tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-82', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-83', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-84', 'filename', 'link-30');">filename</a></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>
<a name="L271"></a><tt class="py-lineno"> 271</tt> <tt class="py-line"> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt> <tt class="py-line"> <tt class="py-comment"># Add this module to the parent package's list of submodules.</tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">context</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="L274"></a><tt class="py-lineno"> 274</tt> <tt class="py-line"> <tt class="py-name">context</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-85', 'submodules', 'link-77');">submodules</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt> <tt class="py-line"> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt> <tt class="py-line"> <tt class="py-comment"># Tokenize & process the contents of the module's source file.</tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt> <tt class="py-line"> <tt id="link-86" class="py-name" targets="Function epydoc.docparser.process_file()=epydoc.docparser-module.html#process_file"><a title="epydoc.docparser.process_file" class="py-name" href="#" onclick="return doclink('link-86', 'process_file', 'link-86');">process_file</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">tokenize</tt><tt class="py-op">.</tt><tt class="py-name">TokenError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt> <tt class="py-line"> <tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">srow</tt><tt class="py-op">,</tt> <tt class="py-name">scol</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">args</tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-87" class="py-name" targets="Class epydoc.docparser.ParseError=epydoc.docparser.ParseError-class.html,Class epydoc.markup.ParseError=epydoc.markup.ParseError-class.html"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-87', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Error during parsing: %s '</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt> <tt class="py-line"> <tt class="py-string">'(%s, line %d, char %d)'</tt> <tt class="py-op">%</tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-88', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">srow</tt><tt class="py-op">,</tt> <tt class="py-name">scol</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IndentationError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-89" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-89', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Error during parsing: %s (%s)'</tt> <tt class="py-op">%</tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">,</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-90', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt> <tt class="py-line"> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt> <tt class="py-line"> <tt class="py-comment"># Handle any special variables (__path__, __docformat__, etc.)</tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-91" class="py-name" targets="Function epydoc.docparser.handle_special_module_vars()=epydoc.docparser-module.html#handle_special_module_vars"><a title="epydoc.docparser.handle_special_module_vars" class="py-name" href="#" onclick="return doclink('link-91', 'handle_special_module_vars', 'link-91');">handle_special_module_vars</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt> <tt class="py-line"> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt> <tt class="py-line"> <tt class="py-comment"># Return the completed ModuleDoc</tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">module_doc</tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</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">"Expected exactly one of the following "</tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt> <tt class="py-line"> <tt class="py-string">"arguments: name, filename"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L296"></a><tt class="py-lineno"> 296</tt> <tt class="py-line"> </tt>
<a name="_parse_package"></a><div id="_parse_package-def"><a name="L297"></a><tt class="py-lineno"> 297</tt> <a class="py-toggle" href="#" id="_parse_package-toggle" onclick="return toggle('_parse_package');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_parse_package">_parse_package</a><tt class="py-op">(</tt><tt class="py-param">package_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_parse_package-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_parse_package-expanded"><a name="L298"></a><tt class="py-lineno"> 298</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt> <tt class="py-line"><tt class="py-docstring"> If the given directory is a package directory, then parse its</tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt> <tt class="py-line"><tt class="py-docstring"> __init__.py file (and the __init__.py files of all ancestor</tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt> <tt class="py-line"><tt class="py-docstring"> packages); and return its C{ModuleDoc}.</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-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-92" class="py-name" targets="Function epydoc.util.is_package_dir()=epydoc.util-module.html#is_package_dir"><a title="epydoc.util.is_package_dir" class="py-name" href="#" onclick="return doclink('link-92', 'is_package_dir', 'link-92');">is_package_dir</a></tt><tt class="py-op">(</tt><tt class="py-name">package_dir</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt> <tt class="py-line"> <tt class="py-name">parent_dir</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-93', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">package_dir</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="L306"></a><tt class="py-lineno"> 306</tt> <tt class="py-line"> <tt class="py-name">parent_doc</tt> <tt class="py-op">=</tt> <tt id="link-94" class="py-name"><a title="epydoc.docparser._parse_package" class="py-name" href="#" onclick="return doclink('link-94', '_parse_package', 'link-62');">_parse_package</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_dir</tt><tt class="py-op">)</tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt> <tt class="py-line"> <tt class="py-name">package_file</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-95', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">package_dir</tt><tt class="py-op">,</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-96" class="py-name" targets="Function epydoc.docparser.parse_docs()=epydoc.docparser-module.html#parse_docs"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-96', 'parse_docs', 'link-96');">parse_docs</a></tt><tt class="py-op">(</tt><tt id="link-97" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-97', 'filename', 'link-30');">filename</a></tt><tt class="py-op">=</tt><tt class="py-name">package_file</tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">parent_doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L309"></a><tt class="py-lineno"> 309</tt> <tt class="py-line"> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt> <tt class="py-line"><tt class="py-comment"># Special vars:</tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># C{__docformat__}, C{__all__}, and C{__path__}.</tt> </tt>
<a name="handle_special_module_vars"></a><div id="handle_special_module_vars-def"><a name="L312"></a><tt class="py-lineno"> 312</tt> <a class="py-toggle" href="#" id="handle_special_module_vars-toggle" onclick="return toggle('handle_special_module_vars');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#handle_special_module_vars">handle_special_module_vars</a><tt class="py-op">(</tt><tt class="py-param">module_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="handle_special_module_vars-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="handle_special_module_vars-expanded"><a name="L313"></a><tt class="py-lineno"> 313</tt> <tt class="py-line"> <tt class="py-comment"># If __docformat__ is defined, parse its value.</tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-98" 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-98', 'toktree', 'link-98');">toktree</a></tt> <tt class="py-op">=</tt> <tt id="link-99" class="py-name" targets="Function epydoc.docparser._module_var_toktree()=epydoc.docparser-module.html#_module_var_toktree"><a title="epydoc.docparser._module_var_toktree" class="py-name" href="#" onclick="return doclink('link-99', '_module_var_toktree', 'link-99');">_module_var_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'__docformat__'</tt><tt class="py-op">)</tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-100" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-100', 'toktree', 'link-98');">toktree</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="L316"></a><tt class="py-lineno"> 316</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-101" 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-101', 'docformat', 'link-101');">docformat</a></tt> <tt class="py-op">=</tt> <tt id="link-102" class="py-name" targets="Function epydoc.docparser.parse_string()=epydoc.docparser-module.html#parse_string"><a title="epydoc.docparser.parse_string" class="py-name" href="#" onclick="return doclink('link-102', 'parse_string', 'link-102');">parse_string</a></tt><tt class="py-op">(</tt><tt id="link-103" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-103', 'toktree', 'link-98');">toktree</a></tt><tt class="py-op">)</tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</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="L318"></a><tt class="py-lineno"> 318</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-104" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-104', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-string">'__docformat__'</tt><tt class="py-op">]</tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt> <tt class="py-line"> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt> <tt class="py-line"> <tt class="py-comment"># If __all__ is defined, parse its value.</tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-105" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-105', 'toktree', 'link-98');">toktree</a></tt> <tt class="py-op">=</tt> <tt id="link-106" class="py-name"><a title="epydoc.docparser._module_var_toktree" class="py-name" href="#" onclick="return doclink('link-106', '_module_var_toktree', 'link-99');">_module_var_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'__all__'</tt><tt class="py-op">)</tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-107" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-107', 'toktree', 'link-98');">toktree</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="L323"></a><tt class="py-lineno"> 323</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt> <tt class="py-line"> <tt class="py-name">public_names</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt id="link-108" class="py-name" targets="Function epydoc.docparser.parse_string_list()=epydoc.docparser-module.html#parse_string_list"><a title="epydoc.docparser.parse_string_list" class="py-name" href="#" onclick="return doclink('link-108', 'parse_string_list', 'link-108');">parse_string_list</a></tt><tt class="py-op">(</tt><tt id="link-109" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-109', 'toktree', 'link-98');">toktree</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-110" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-110', 'name', 'link-31');">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">module_doc</tt><tt class="py-op">.</tt><tt id="link-111" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-111', 'variables', 'link-70');">variables</a></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="L326"></a><tt class="py-lineno"> 326</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-112" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-112', 'name', 'link-31');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">public_names</tt><tt class="py-op">:</tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-113" 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-113', 'is_public', 'link-113');">is_public</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</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-114" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-114', 'ModuleDoc', 'link-68');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-115" 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-115', 'is_imported', 'link-115');">is_imported</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-116', 'is_public', 'link-113');">is_public</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-117" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-117', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">:</tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt> <tt class="py-line"> <tt class="py-comment"># If we couldn't parse the list, give precedence to introspection.</tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-118" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-118', 'name', 'link-31');">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">module_doc</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-119', 'variables', 'link-70');">variables</a></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="L335"></a><tt class="py-lineno"> 335</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-120" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-120', 'ModuleDoc', 'link-68');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-121', 'is_imported', 'link-115');">is_imported</a></tt> <tt class="py-op">=</tt> <tt id="link-122" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-122', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-123', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-string">'__all__'</tt><tt class="py-op">]</tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt> <tt class="py-line"> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt> <tt class="py-line"> <tt class="py-comment"># If __path__ is defined, then extract its value (pkgs only)</tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-124', 'is_package', 'link-76');">is_package</a></tt><tt class="py-op">:</tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt> <tt class="py-line"> <tt id="link-125" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-125', 'toktree', 'link-98');">toktree</a></tt> <tt class="py-op">=</tt> <tt id="link-126" class="py-name"><a title="epydoc.docparser._module_var_toktree" class="py-name" href="#" onclick="return doclink('link-126', '_module_var_toktree', 'link-99');">_module_var_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> <tt class="py-string">'__path__'</tt><tt class="py-op">)</tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-127" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-127', 'toktree', 'link-98');">toktree</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="L343"></a><tt class="py-lineno"> 343</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-128', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt id="link-129" class="py-name"><a title="epydoc.docparser.parse_string_list" class="py-name" href="#" onclick="return doclink('link-129', 'parse_string_list', 'link-108');">parse_string_list</a></tt><tt class="py-op">(</tt><tt id="link-130" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-130', 'toktree', 'link-98');">toktree</a></tt><tt class="py-op">)</tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-131" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-131', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">:</tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> <tt class="py-comment"># [xx]</tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-132', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-string">'__path__'</tt><tt class="py-op">]</tt> </tt>
</div><a name="L348"></a><tt class="py-lineno"> 348</tt> <tt class="py-line"> </tt>
<a name="_module_var_toktree"></a><div id="_module_var_toktree-def"><a name="L349"></a><tt class="py-lineno"> 349</tt> <a class="py-toggle" href="#" id="_module_var_toktree-toggle" onclick="return toggle('_module_var_toktree');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_module_var_toktree">_module_var_toktree</a><tt class="py-op">(</tt><tt class="py-param">module_doc</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="_module_var_toktree-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_module_var_toktree-expanded"><a name="L350"></a><tt class="py-lineno"> 350</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-133', 'variables', 'link-70');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">get</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-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</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-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-135" 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-135', 'value', 'link-135');">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-136" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-136', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-137', 'value', 'link-135');">value</a></tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-138', 'toktree', 'link-98');">toktree</a></tt> <tt class="py-keyword">is</tt> <tt id="link-139" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-139', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-140', 'value', 'link-135');">value</a></tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-141', 'toktree', 'link-98');">toktree</a></tt> </tt>
</div><a name="L356"></a><tt class="py-lineno"> 356</tt> <tt class="py-line"> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt> <tt class="py-line"><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Module Lookup</tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#////////////////////////////////////////////////////////////</tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="_find"></a><div id="_find-def"><a name="L361"></a><tt class="py-lineno"> 361</tt> <a class="py-toggle" href="#" id="_find-toggle" onclick="return toggle('_find');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_find">_find</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">package_doc</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="_find-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_find-expanded"><a name="L362"></a><tt class="py-lineno"> 362</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt> <tt class="py-line"><tt class="py-docstring"> Return the API documentaiton for the object whose name is</tt> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt> <tt class="py-line"><tt class="py-docstring"> C{name}. C{package_doc}, if specified, is the API</tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt> <tt class="py-line"><tt class="py-docstring"> documentation for the package containing the named object.</tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt> <tt class="py-line"> <tt class="py-comment"># If we're inside a package, then find the package's path.</tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">package_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt> <tt class="py-line"> <tt id="link-142" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-142', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">package_doc</tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-143', 'path', 'link-0');">path</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-144" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-144', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt> <tt class="py-line"> <tt id="link-145" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-145', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">package_doc</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-146', 'path', 'link-0');">path</a></tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt> <tt class="py-line"> <tt id="link-147" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-147', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-148', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">package_doc</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-149', 'filename', 'link-30');">filename</a></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>
<a name="L374"></a><tt class="py-lineno"> 374</tt> <tt class="py-line"> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt> <tt class="py-line"> <tt class="py-comment"># The leftmost identifier in `name` should be a module or</tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># package on the given path; find it and parse it.</tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-150" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-150', 'filename', 'link-30');">filename</a></tt> <tt class="py-op">=</tt> <tt id="link-151" class="py-name" targets="Function epydoc.docparser._get_filename()=epydoc.docparser-module.html#_get_filename"><a title="epydoc.docparser._get_filename" class="py-name" href="#" onclick="return doclink('link-151', '_get_filename', 'link-151');">_get_filename</a></tt><tt class="py-op">(</tt><tt id="link-152" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-152', 'name', 'link-31');">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 id="link-153" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-153', 'path', 'link-0');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt> <tt class="py-line"> <tt class="py-name">module_doc</tt> <tt class="py-op">=</tt> <tt id="link-154" class="py-name"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-154', 'parse_docs', 'link-96');">parse_docs</a></tt><tt class="py-op">(</tt><tt id="link-155" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-155', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">context</tt><tt class="py-op">=</tt><tt class="py-name">package_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt> <tt class="py-line"> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt> <tt class="py-line"> <tt class="py-comment"># If the name just has one identifier, then the module we just</tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># parsed is the object we're looking for; return it.</tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</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-156" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-156', 'name', 'link-31');">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-keyword">return</tt> <tt class="py-name">module_doc</tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt> <tt class="py-line"> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, we're looking for something inside the module.</tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># First, check to see if it's in a variable (but ignore</tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># variables that just contain imported submodules).</tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-157" class="py-name" targets="Function epydoc.docparser._is_submodule_import_var()=epydoc.docparser-module.html#_is_submodule_import_var"><a title="epydoc.docparser._is_submodule_import_var" class="py-name" href="#" onclick="return doclink('link-157', '_is_submodule_import_var', 'link-157');">_is_submodule_import_var</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">,</tt> <tt id="link-158" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-158', 'name', 'link-31');">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>
<a name="L388"></a><tt class="py-lineno"> 388</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt id="link-159" class="py-name" targets="Function epydoc.docparser._find_in_namespace()=epydoc.docparser-module.html#_find_in_namespace"><a title="epydoc.docparser._find_in_namespace" class="py-name" href="#" onclick="return doclink('link-159', '_find_in_namespace', 'link-159');">_find_in_namespace</a></tt><tt class="py-op">(</tt><tt id="link-160" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-160', 'name', 'link-31');">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-name">module_doc</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">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt> <tt class="py-line"> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt> <tt class="py-line"> <tt class="py-comment"># If not, then check to see if it's in a subpackage.</tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-161', 'is_package', 'link-76');">is_package</a></tt><tt class="py-op">:</tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-162" class="py-name"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-162', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt id="link-163" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-163', 'name', 'link-31');">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-name">module_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt> <tt class="py-line"> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt> <tt class="py-line"> <tt class="py-comment"># If it's not in a variable or a subpackage, then we can't</tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># find it.</tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-string">'Could not find value'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L398"></a><tt class="py-lineno"> 398</tt> <tt class="py-line"> </tt>
<a name="_is_submodule_import_var"></a><div id="_is_submodule_import_var-def"><a name="L399"></a><tt class="py-lineno"> 399</tt> <a class="py-toggle" href="#" id="_is_submodule_import_var-toggle" onclick="return toggle('_is_submodule_import_var');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_is_submodule_import_var">_is_submodule_import_var</a><tt class="py-op">(</tt><tt class="py-param">module_doc</tt><tt class="py-op">,</tt> <tt class="py-param">var_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_is_submodule_import_var-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_is_submodule_import_var-expanded"><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"> Return true if C{var_name} is the name of a variable in</tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt> <tt class="py-line"><tt class="py-docstring"> C{module_doc} that just contains an C{imported_from} link to a</tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt> <tt class="py-line"><tt class="py-docstring"> submodule of the same name. (I.e., is a variable created when</tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt> <tt class="py-line"><tt class="py-docstring"> a package imports one of its own submodules.)</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-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-164" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-164', 'variables', 'link-70');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">var_name</tt><tt class="py-op">)</tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt> <tt class="py-line"> <tt class="py-name">full_var_name</tt> <tt class="py-op">=</tt> <tt id="link-165" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-165', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-166" 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-166', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_name</tt><tt class="py-op">)</tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</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">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-167" 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-167', 'imported_from', 'link-167');">imported_from</a></tt> <tt class="py-op">==</tt> <tt class="py-name">full_var_name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L410"></a><tt class="py-lineno"> 410</tt> <tt class="py-line"> </tt>
<a name="_find_in_namespace"></a><div id="_find_in_namespace-def"><a name="L411"></a><tt class="py-lineno"> 411</tt> <a class="py-toggle" href="#" id="_find_in_namespace-toggle" onclick="return toggle('_find_in_namespace');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_find_in_namespace">_find_in_namespace</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">namespace_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_find_in_namespace-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_find_in_namespace-expanded"><a name="L412"></a><tt class="py-lineno"> 412</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-168" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-168', 'name', 'link-31');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">namespace_doc</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-169', 'variables', 'link-70');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-string">'Could not find value'</tt><tt class="py-op">)</tt> </tt>
<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-comment"># Look up the variable in the namespace.</tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</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">namespace_doc</tt><tt class="py-op">.</tt><tt id="link-170" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-170', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt id="link-171" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-171', 'name', 'link-31');">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>
<a name="L417"></a><tt class="py-lineno"> 417</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-172" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-172', 'value', 'link-135');">value</a></tt> <tt class="py-keyword">is</tt> <tt id="link-173" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-173', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-string">'Could not find value'</tt><tt class="py-op">)</tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt> <tt class="py-line"> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-174', 'value', 'link-135');">value</a></tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt> <tt class="py-line"> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt> <tt class="py-line"> <tt class="py-comment"># If the variable's value was imported, then follow its</tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># alias link.</tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</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-op">.</tt><tt id="link-175" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-175', 'imported_from', 'link-167');">imported_from</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-176" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-176', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-177" class="py-name"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-177', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-178" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-178', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">+</tt><tt id="link-179" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-179', 'name', 'link-31');">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>
<a name="L425"></a><tt class="py-lineno"> 425</tt> <tt class="py-line"> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, if the name has one identifier, then this is the</tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># value we're looking for; return it.</tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-180" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-180', 'name', 'link-31');">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="L429"></a><tt class="py-lineno"> 429</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">val_doc</tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt> <tt class="py-line"> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, if this value is a namespace, look inside it.</tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</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-181" 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-181', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-182" class="py-name"><a title="epydoc.docparser._find_in_namespace" class="py-name" href="#" onclick="return doclink('link-182', '_find_in_namespace', 'link-159');">_find_in_namespace</a></tt><tt class="py-op">(</tt><tt id="link-183" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-183', 'name', 'link-31');">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-name">val_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt> <tt class="py-line"> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, we ran into a dead end.</tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">(</tt><tt class="py-string">'Could not find value'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L438"></a><tt class="py-lineno"> 438</tt> <tt class="py-line"> </tt>
<a name="_get_filename"></a><div id="_get_filename-def"><a name="L439"></a><tt class="py-lineno"> 439</tt> <a class="py-toggle" href="#" id="_get_filename-toggle" onclick="return toggle('_get_filename');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_get_filename">_get_filename</a><tt class="py-op">(</tt><tt class="py-param">identifier</tt><tt class="py-op">,</tt> <tt class="py-param">path</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="_get_filename-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_filename-expanded"><a name="L440"></a><tt class="py-lineno"> 440</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-184" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-184', 'path', 'link-0');">path</a></tt> <tt class="py-keyword">is</tt> <tt id="link-185" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-185', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt id="link-186" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-186', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt> <tt class="py-line"> <tt class="py-name">fp</tt><tt class="py-op">,</tt> <tt id="link-187" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-187', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">,</tt><tt class="py-name">m</tt><tt class="py-op">,</tt><tt class="py-name">typ</tt><tt class="py-op">)</tt> <tt class="py-op">=</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">find_module</tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt id="link-188" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-188', 'path', 'link-0');">path</a></tt><tt class="py-op">)</tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">fp</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-name">fp</tt><tt class="py-op">.</tt><tt id="link-189" class="py-name" targets="Method epydoc.cli.HTMLLogger.close()=epydoc.cli.HTMLLogger-class.html#close,Method epydoc.docintrospecter._DevNull.close()=epydoc.docintrospecter._DevNull-class.html#close,Method epydoc.log.Logger.close()=epydoc.log.Logger-class.html#close,Function epydoc.log.close()=epydoc.log-module.html#close"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-189', 'close', 'link-189');">close</a></tt><tt class="py-op">(</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">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-string">'No Python source file found.'</tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt> <tt class="py-line"> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">typ</tt> <tt class="py-op">==</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">PY_SOURCE</tt><tt class="py-op">:</tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-190" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-190', 'filename', 'link-30');">filename</a></tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">typ</tt> <tt class="py-op">==</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">PY_COMPILED</tt><tt class="py-op">:</tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt> <tt class="py-line"> <tt class="py-comment"># See if we can find a corresponding non-compiled version.</tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-191" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-191', 'filename', 'link-30');">filename</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">'.py\w$'</tt><tt class="py-op">,</tt> <tt class="py-string">'.py'</tt><tt class="py-op">,</tt> <tt id="link-192" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-192', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-193" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-193', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt id="link-194" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-194', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-string">'No Python source file found.'</tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-195" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-195', 'filename', 'link-30');">filename</a></tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">typ</tt> <tt class="py-op">==</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">PKG_DIRECTORY</tt><tt class="py-op">:</tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt> <tt class="py-line"> <tt id="link-196" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-196', 'filename', 'link-30');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-197" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-197', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-198" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-198', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__init__.py'</tt><tt class="py-op">)</tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-199" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-199', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt id="link-200" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-200', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt> <tt class="py-line"> <tt id="link-201" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-201', 'filename', 'link-30');">filename</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-202" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-202', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt id="link-203" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-203', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'__init__.pyw'</tt><tt class="py-op">)</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-keyword">not</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-204" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-204', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">exists</tt><tt class="py-op">(</tt><tt id="link-205" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-205', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-string">'No package file found.'</tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-206" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-206', 'filename', 'link-30');">filename</a></tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">typ</tt> <tt class="py-op">==</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">C_BUILTIN</tt><tt class="py-op">:</tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-string">'No Python source file for builtin modules.'</tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">typ</tt> <tt class="py-op">==</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">C_EXTENSION</tt><tt class="py-op">:</tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-string">'No Python source file for c extensions.'</tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ImportError</tt><tt class="py-op">,</tt> <tt class="py-string">'No Python source file found.'</tt> </tt>
</div><a name="L468"></a><tt class="py-lineno"> 468</tt> <tt class="py-line"> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ File tokenization loop</tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_file"></a><div id="process_file-def"><a name="L473"></a><tt class="py-lineno"> 473</tt> <a class="py-toggle" href="#" id="process_file-toggle" onclick="return toggle('process_file');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_file">process_file</a><tt class="py-op">(</tt><tt class="py-param">module_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_file-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_file-expanded"><a name="L474"></a><tt class="py-lineno"> 474</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt> <tt class="py-line"><tt class="py-docstring"> Read the given C{ModuleDoc}'s file, and add variables</tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt> <tt class="py-line"><tt class="py-docstring"> corresponding to any objects defined in that file. In</tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt> <tt class="py-line"><tt class="py-docstring"> particular, read and tokenize C{module_doc.filename}, and</tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt> <tt class="py-line"><tt class="py-docstring"> process each logical line using L{process_line()}.</tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt> <tt class="py-line"> <tt class="py-comment"># Keep track of the current line number:</tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-207" 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-207', 'lineno', 'link-207');">lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt> <tt class="py-line"> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt> <tt class="py-line"> <tt class="py-comment"># Use this list to collect the tokens on a single logical line:</tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line_toks</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt> <tt class="py-line"> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt> <tt class="py-line"> <tt class="py-comment"># This list contains one APIDoc for each indentation level.</tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># The first element is the APIDoc for the module, and each</tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># subsequent element is the APIDoc for the object at that</tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># indentation level. The final element of the list is the</tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># C{APIDoc} for the entity that we're currently processing.</tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_docs</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">module_doc</tt><tt class="py-op">]</tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt> <tt class="py-line"> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt> <tt class="py-line"> <tt class="py-comment"># The APIDoc for the object that was defined by the previous</tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># line, if any; or None otherwise. This is used to update</tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># parent_docs when we encounter an indent; and to decide what</tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># object (if any) is described by a docstring.</tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">prev_line_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">module_doc</tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt> <tt class="py-line"> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt> <tt class="py-line"> <tt class="py-comment"># A list of comments that occur before or on the current</tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># logical line, used to build the comment docstring. Each</tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># element is a tuple (comment_text, comment_lineno).</tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">comments</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt> <tt class="py-line"> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt> <tt class="py-line"> <tt class="py-comment"># A list of decorator lines that occur before the current</tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># logical line. This is used so we can process a function</tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># declaration line and its decorators all at once.</tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-208" 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-208', 'decorators', 'link-208');">decorators</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt> <tt class="py-line"> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt> <tt class="py-line"> <tt class="py-comment"># A list of group names, one for each indentation level. This is</tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># used to keep track groups that are defined by comment markers</tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># START_GROUP_MARKER and END_GROUP_MARKER.</tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">groups</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">None</tt><tt class="py-op">]</tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt> <tt class="py-line"> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt> <tt class="py-line"> <tt class="py-comment"># When we encounter a comment start group marker, set this to the</tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># name of the group; but wait until we're ready to process the</tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># next line before we actually set groups[-1] to this value. This</tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># is necessary because at the top of a block, the tokenizer gives</tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># us comments before the INDENT token; but if we encounter a group</tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># start marker at the top of a block, then we want it to apply</tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># inside that block, not outside it.</tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">start_group</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt> <tt class="py-line"> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt> <tt class="py-line"> <tt class="py-comment"># Check if the source file declares an encoding.</tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">encoding</tt> <tt class="py-op">=</tt> <tt id="link-209" class="py-name" targets="Function epydoc.docparser.get_module_encoding()=epydoc.docparser-module.html#get_module_encoding"><a title="epydoc.docparser.get_module_encoding" class="py-name" href="#" onclick="return doclink('link-209', 'get_module_encoding', 'link-209');">get_module_encoding</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-210" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-210', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt> <tt class="py-line"> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt> <tt class="py-line"> <tt class="py-comment"># The token-eating loop:</tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt> <tt class="py-line"> <tt class="py-name">module_file</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt id="link-211" class="py-name" targets="Method epydoc.gui.EpydocGUI.open()=epydoc.gui.EpydocGUI-class.html#open"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-211', 'open', 'link-211');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-212" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-212', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'rU'</tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">LookupError</tt><tt class="py-op">:</tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt> <tt class="py-line"> <tt id="link-213" 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-213', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-214" 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-214', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Unknown encoding %r for %s; using the default"</tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt> <tt class="py-line"> <tt class="py-string">"encoding instead (iso-8859-1)"</tt> <tt class="py-op">%</tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">encoding</tt><tt class="py-op">,</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-215" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-215', 'filename', 'link-30');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt> <tt class="py-line"> <tt class="py-name">encoding</tt> <tt class="py-op">=</tt> <tt class="py-string">'iso-8859-1'</tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt> <tt class="py-line"> <tt class="py-name">module_file</tt> <tt class="py-op">=</tt> <tt class="py-name">codecs</tt><tt class="py-op">.</tt><tt id="link-216" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-216', 'open', 'link-211');">open</a></tt><tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-217" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-217', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'rU'</tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt> <tt class="py-line"> <tt class="py-name">tok_iter</tt> <tt class="py-op">=</tt> <tt class="py-name">tokenize</tt><tt class="py-op">.</tt><tt class="py-name">generate_tokens</tt><tt class="py-op">(</tt><tt class="py-name">module_file</tt><tt class="py-op">.</tt><tt id="link-218" class="py-name" targets="Method epydoc.docintrospecter._DevNull.readline()=epydoc.docintrospecter._DevNull-class.html#readline"><a title="epydoc.docintrospecter._DevNull.readline" class="py-name" href="#" onclick="return doclink('link-218', 'readline', 'link-218');">readline</a></tt><tt class="py-op">)</tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">toktype</tt><tt class="py-op">,</tt> <tt class="py-name">toktext</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">srow</tt><tt class="py-op">,</tt><tt class="py-name">scol</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">erow</tt><tt class="py-op">,</tt><tt class="py-name">ecol</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">line_str</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tok_iter</tt><tt class="py-op">:</tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt> <tt class="py-line"> <tt class="py-comment"># BOM encoding marker: ignore.</tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</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">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">ERRORTOKEN</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">toktext</tt> <tt class="py-op">==</tt> <tt class="py-string">u'\ufeff'</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt> <tt class="py-line"> <tt class="py-name">toktext</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-name">encoding</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">'\xef\xbb\xbf'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt> <tt class="py-line"> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt> <tt class="py-line"> <tt class="py-comment"># Error token: abort</tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">ERRORTOKEN</tt><tt class="py-op">:</tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-219" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-219', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Error during parsing: invalid syntax '</tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt> <tt class="py-line"> <tt class="py-string">'(%s, line %d, char %d: %r)'</tt> <tt class="py-op">%</tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-220" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-220', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">srow</tt><tt class="py-op">,</tt> <tt class="py-name">scol</tt><tt class="py-op">,</tt> <tt class="py-name">toktext</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt> <tt class="py-line"> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt> <tt class="py-line"> <tt class="py-comment"># Indent token: update the parent_doc stack.</tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">INDENT</tt><tt class="py-op">:</tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">prev_line_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt> <tt class="py-line"> <tt class="py-name">parent_docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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="L553"></a><tt class="py-lineno"> 553</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt> <tt class="py-line"> <tt class="py-name">parent_docs</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">prev_line_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt> <tt class="py-line"> <tt class="py-name">groups</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt> <tt class="py-line"> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt> <tt class="py-line"> <tt class="py-comment"># Dedent token: update the parent_doc stack.</tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">DEDENT</tt><tt class="py-op">:</tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">line_toks</tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt> <tt class="py-line"> <tt class="py-name">parent_docs</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="L561"></a><tt class="py-lineno"> 561</tt> <tt class="py-line"> <tt class="py-name">groups</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="L562"></a><tt class="py-lineno"> 562</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt> <tt class="py-line"> <tt class="py-comment"># This *should* only happen if the file ends on an</tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># indented line, with no final newline.</tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (otherwise, this is the wrong thing to do.)</tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt> <tt class="py-line"> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt> <tt class="py-line"> <tt class="py-comment"># Line-internal newline token: if we're still at the start of</tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the logical line, and we've seen one or more comment lines,</tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># then discard them: blank lines are not allowed between a</tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># comment block and the thing it describes.</tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">tokenize</tt><tt class="py-op">.</tt><tt class="py-name">NL</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 class="py-name">comments</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">line_toks</tt><tt class="py-op">:</tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt> <tt class="py-line"> <tt id="link-221" 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-221', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-222" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-222', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Ignoring docstring comment block followed by '</tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt> <tt class="py-line"> <tt class="py-string">'a blank line in %r on line %r'</tt> <tt class="py-op">%</tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-223" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-223', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">srow</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="L577"></a><tt class="py-lineno"> 577</tt> <tt class="py-line"> <tt class="py-name">comments</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt> <tt class="py-line"> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt> <tt class="py-line"> <tt class="py-comment"># Comment token: add to comments if appropriate.</tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">tokenize</tt><tt class="py-op">.</tt><tt class="py-name">COMMENT</tt><tt class="py-op">:</tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">toktext</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt id="link-224" class="py-name"><a title="epydoc.docparser.COMMENT_DOCSTRING_MARKER" class="py-name" href="#" onclick="return doclink('link-224', 'COMMENT_DOCSTRING_MARKER', 'link-21');">COMMENT_DOCSTRING_MARKER</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt> <tt class="py-line"> <tt class="py-name">comment_line</tt> <tt class="py-op">=</tt> <tt class="py-name">toktext</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-225" class="py-name"><a title="epydoc.docparser.COMMENT_DOCSTRING_MARKER" class="py-name" href="#" onclick="return doclink('link-225', 'COMMENT_DOCSTRING_MARKER', 'link-21');">COMMENT_DOCSTRING_MARKER</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">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">comment_line</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="L584"></a><tt class="py-lineno"> 584</tt> <tt class="py-line"> <tt class="py-name">comment_line</tt> <tt class="py-op">=</tt> <tt class="py-name">comment_line</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="L585"></a><tt class="py-lineno"> 585</tt> <tt class="py-line"> <tt class="py-name">comments</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">[</tt><tt class="py-name">comment_line</tt><tt class="py-op">,</tt> <tt class="py-name">srow</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">toktext</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt id="link-226" class="py-name"><a title="epydoc.docparser.START_GROUP_MARKER" class="py-name" href="#" onclick="return doclink('link-226', 'START_GROUP_MARKER', 'link-22');">START_GROUP_MARKER</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt> <tt class="py-line"> <tt class="py-name">start_group</tt> <tt class="py-op">=</tt> <tt class="py-name">toktext</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-227" class="py-name"><a title="epydoc.docparser.START_GROUP_MARKER" class="py-name" href="#" onclick="return doclink('link-227', 'START_GROUP_MARKER', 'link-22');">START_GROUP_MARKER</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">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L588"></a><tt class="py-lineno"> 588</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">toktext</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt id="link-228" class="py-name"><a title="epydoc.docparser.END_GROUP_MARKER" class="py-name" href="#" onclick="return doclink('link-228', 'END_GROUP_MARKER', 'link-23');">END_GROUP_MARKER</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L589"></a><tt class="py-lineno"> 589</tt> <tt class="py-line"> <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">groups</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 class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L590"></a><tt class="py-lineno"> 590</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">groups</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="L591"></a><tt class="py-lineno"> 591</tt> <tt class="py-line"> <tt class="py-name">groups</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">None</tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt> <tt class="py-line"> <tt id="link-229" 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-229', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-230" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-230', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Got group end marker without a corresponding "</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt> <tt class="py-line"> <tt class="py-string">"start marker in %r on line %r"</tt> <tt class="py-op">%</tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-231" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-231', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">srow</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt> <tt class="py-line"> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt> <tt class="py-line"> <tt class="py-comment"># Normal token: Add it to line_toks. (If it's a non-unicode</tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># string literal, then we need to re-encode using the file's</tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># encoding, to get back to the original 8-bit data; and then</tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># convert that string with 8-bit data to a 7-bit ascii</tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># representation.)</tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">toktype</tt> <tt class="py-op">!=</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NEWLINE</tt> <tt class="py-keyword">and</tt> <tt class="py-name">toktype</tt> <tt class="py-op">!=</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">ENDMARKER</tt><tt class="py-op">:</tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-232" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-232', 'lineno', 'link-207');">lineno</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt id="link-233" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-233', 'lineno', 'link-207');">lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">srow</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">toktype</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">STRING</tt><tt class="py-op">:</tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt> <tt class="py-line"> <tt class="py-name">str_prefixes</tt> <tt class="py-op">=</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">'[^\'"]*'</tt><tt class="py-op">,</tt> <tt class="py-name">toktext</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'u'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">str_prefixes</tt><tt class="py-op">:</tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt> <tt class="py-line"> <tt class="py-name">s</tt> <tt class="py-op">=</tt> <tt class="py-name">toktext</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt> <tt class="py-line"> <tt class="py-name">toktext</tt> <tt class="py-op">=</tt> <tt id="link-234" 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-234', 'decode_with_backslashreplace', 'link-234');">decode_with_backslashreplace</a></tt><tt class="py-op">(</tt><tt class="py-name">s</tt><tt class="py-op">)</tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt> <tt class="py-line"> <tt class="py-name">line_toks</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt> <tt class="py-op">(</tt><tt class="py-name">toktype</tt><tt class="py-op">,</tt> <tt class="py-name">toktext</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt> <tt class="py-line"> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt> <tt class="py-line"> <tt class="py-comment"># Decorator line: add it to the decorators list.</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">line_toks</tt> <tt class="py-keyword">and</tt> <tt class="py-name">line_toks</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'@'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L614"></a><tt class="py-lineno"> 614</tt> <tt class="py-line"> <tt id="link-235" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-235', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-236" class="py-name" targets="Function epydoc.docparser.shallow_parse()=epydoc.docparser-module.html#shallow_parse"><a title="epydoc.docparser.shallow_parse" class="py-name" href="#" onclick="return doclink('link-236', 'shallow_parse', 'link-236');">shallow_parse</a></tt><tt class="py-op">(</tt><tt class="py-name">line_toks</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L615"></a><tt class="py-lineno"> 615</tt> <tt class="py-line"> <tt class="py-name">line_toks</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L616"></a><tt class="py-lineno"> 616</tt> <tt class="py-line"> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt> <tt class="py-line"> <tt class="py-comment"># End of line token, but nothing to do.</tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">line_toks</tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt> <tt class="py-line"> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt> <tt class="py-line"> <tt class="py-comment"># End of line token: parse the logical line & process it.</tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">start_group</tt><tt class="py-op">:</tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt> <tt class="py-line"> <tt class="py-name">groups</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">start_group</tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt> <tt class="py-line"> <tt class="py-name">start_group</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt> <tt class="py-line"> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parent_docs</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-string">'skip_block'</tt><tt class="py-op">:</tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt> <tt class="py-op">=</tt> <tt id="link-237" class="py-name" targets="Function epydoc.docparser.process_line()=epydoc.docparser-module.html#process_line"><a title="epydoc.docparser.process_line" class="py-name" href="#" onclick="return doclink('link-237', 'process_line', 'link-237');">process_line</a></tt><tt class="py-op">(</tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt> <tt class="py-line"> <tt id="link-238" class="py-name"><a title="epydoc.docparser.shallow_parse" class="py-name" href="#" onclick="return doclink('link-238', 'shallow_parse', 'link-236');">shallow_parse</a></tt><tt class="py-op">(</tt><tt class="py-name">line_toks</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt> <tt class="py-line"> <tt id="link-239" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-239', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">comments</tt><tt class="py-op">,</tt> <tt id="link-240" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-240', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-241" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-241', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-242" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-242', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Error during parsing: invalid '</tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt> <tt class="py-line"> <tt class="py-string">'syntax (%s, line %d) -- %s'</tt> <tt class="py-op">%</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-243" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-243', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt id="link-244" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-244', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">KeyboardInterrupt</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt> <tt class="py-line"> <tt id="link-245" 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-245', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-246" class="py-name" targets="Function epydoc.log.error()=epydoc.log-module.html#error"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-246', 'error', 'link-246');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">'Internal error during parsing (%s, line '</tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt> <tt class="py-line"> <tt class="py-string">'%s):\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-247" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-247', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt id="link-248" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-248', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt> <tt class="py-line"> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt> <tt class="py-line"> <tt class="py-comment"># grouping...</tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">groups</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-keyword">and</tt> <tt class="py-name">prev_line_doc</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 class="py-string">'skip_block'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</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">prev_line_doc</tt><tt class="py-op">,</tt> <tt id="link-249" 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-249', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt> <tt class="py-line"> <tt class="py-comment"># prev_line_doc's container will only be</tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># UNKNOWN if it's an instance variable that</tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># didn't have a doc-comment, but might still</tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># be followed by a docstring. Since we</tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># tokenize in order, we can't do lookahead to</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># see if the variable will have a comment; but</tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># it should only be added to the container if</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># it does. So we defer the grouping of that</tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># to be handled by process_docstring instead.</tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-250" 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-250', 'container', 'link-250');">container</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-251" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-251', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt> <tt class="py-line"> <tt id="link-252" class="py-name" targets="Function epydoc.docparser.add_to_group()=epydoc.docparser-module.html#add_to_group"><a title="epydoc.docparser.add_to_group" class="py-name" href="#" onclick="return doclink('link-252', 'add_to_group', 'link-252');">add_to_group</a></tt><tt class="py-op">(</tt><tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-253" 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-253', 'container', 'link-250');">container</a></tt><tt class="py-op">,</tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-name">groups</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="L657"></a><tt class="py-lineno"> 657</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">parent_docs</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 id="link-254" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-254', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt> <tt class="py-line"> <tt id="link-255" class="py-name"><a title="epydoc.docparser.add_to_group" class="py-name" href="#" onclick="return doclink('link-255', 'add_to_group', 'link-252');">add_to_group</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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">prev_line_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt> <tt class="py-line"> <tt class="py-name">groups</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="L660"></a><tt class="py-lineno"> 660</tt> <tt class="py-line"> <tt class="py-keyword">else</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">prev_line_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt> <tt class="py-line"> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt> <tt class="py-line"> <tt class="py-comment"># Reset line contents.</tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">line_toks</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt> <tt class="py-line"> <tt id="link-256" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-256', 'lineno', 'link-207');">lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt> <tt class="py-line"> <tt class="py-name">comments</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt> <tt class="py-line"> <tt id="link-257" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-257', 'decorators', 'link-208');">decorators</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L668"></a><tt class="py-lineno"> 668</tt> <tt class="py-line"> </tt>
<a name="add_to_group"></a><div id="add_to_group-def"><a name="L669"></a><tt class="py-lineno"> 669</tt> <a class="py-toggle" href="#" id="add_to_group-toggle" onclick="return toggle('add_to_group');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#add_to_group">add_to_group</a><tt class="py-op">(</tt><tt class="py-param">container</tt><tt class="py-op">,</tt> <tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">group_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="add_to_group-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="add_to_group-expanded"><a name="L670"></a><tt class="py-lineno"> 670</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-258" 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-258', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-259" 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-259', 'group_specs', 'link-259');">group_specs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-260" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-260', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt> <tt class="py-line"> <tt id="link-261" 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-261', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-262" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-262', 'group_specs', 'link-259');">group_specs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt> <tt class="py-line"> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</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-263" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-263', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt> <tt class="py-line"> <tt class="py-name">var_name</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-264" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-264', 'name', 'link-31');">name</a></tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-265" 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-265', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt id="link-266" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-266', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt id="link-267" 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-267', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-268" class="py-name" targets="Function epydoc.log.debug()=epydoc.log-module.html#debug,Method epydoc.markup.restructuredtext.OptimizedReporter.debug()=epydoc.markup.restructuredtext.OptimizedReporter-class.html#debug"><a title="epydoc.log.debug
epydoc.markup.restructuredtext.OptimizedReporter.debug" class="py-name" href="#" onclick="return doclink('link-268', 'debug', 'link-268');">debug</a></tt><tt class="py-op">(</tt><tt class="py-string">'ouch'</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-op">)</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt> <tt class="py-line"> <tt class="py-name">var_name</tt> <tt class="py-op">=</tt> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-269" 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-269', 'canonical_name', 'link-37');">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="L678"></a><tt class="py-lineno"> 678</tt> <tt class="py-line"> </tt>
<a name="L679"></a><tt class="py-lineno"> 679</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-270" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-270', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">group_vars</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt id="link-271" 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-271', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-272" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-272', 'group_specs', 'link-259');">group_specs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L680"></a><tt class="py-lineno"> 680</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-273" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-273', 'name', 'link-31');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-name">group_name</tt><tt class="py-op">:</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt> <tt class="py-line"> <tt class="py-name">group_vars</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">var_name</tt><tt class="py-op">)</tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt> <tt class="py-line"> <tt id="link-274" 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-274', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-275" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.group_specs" class="py-name" href="#" onclick="return doclink('link-275', 'group_specs', 'link-259');">group_specs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</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-name">var_name</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">)</tt> </tt>
</div><a name="L685"></a><tt class="py-lineno"> 685</tt> <tt class="py-line"> </tt>
<a name="script_guard"></a><div id="script_guard-def"><a name="L686"></a><tt class="py-lineno"> 686</tt> <a class="py-toggle" href="#" id="script_guard-toggle" onclick="return toggle('script_guard');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#script_guard">script_guard</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="script_guard-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="script_guard-expanded"><a name="L687"></a><tt class="py-lineno"> 687</tt> <tt class="py-line"> <tt class="py-docstring">"""Detect the idiomatic trick C{if __name__ == "__main__":}"""</tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">5</tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">line</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 class="py-string">'__name__'</tt> <tt class="py-comment"># this is the most selective</tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">line</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-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'if'</tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">2</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-string">'=='</tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">4</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-string">':'</tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">3</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 class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'__main__'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L694"></a><tt class="py-lineno"> 694</tt> <tt class="py-line"> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Shallow parser</tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="shallow_parse"></a><div id="shallow_parse-def"><a name="L699"></a><tt class="py-lineno"> 699</tt> <a class="py-toggle" href="#" id="shallow_parse-toggle" onclick="return toggle('shallow_parse');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#shallow_parse">shallow_parse</a><tt class="py-op">(</tt><tt class="py-param">line_toks</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="shallow_parse-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="shallow_parse-expanded"><a name="L700"></a><tt class="py-lineno"> 700</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L701"></a><tt class="py-lineno"> 701</tt> <tt class="py-line"><tt class="py-docstring"> Given a flat list of tokens, return a nested tree structure</tt> </tt>
<a name="L702"></a><tt class="py-lineno"> 702</tt> <tt class="py-line"><tt class="py-docstring"> (called a X{token tree}), whose leaves are identical to the</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt> <tt class="py-line"><tt class="py-docstring"> original list, but whose structure reflects the structure</tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt> <tt class="py-line"><tt class="py-docstring"> implied by the grouping tokens (i.e., parenthases, braces, and</tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt> <tt class="py-line"><tt class="py-docstring"> brackets). If the parenthases, braces, and brackets do not</tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt> <tt class="py-line"><tt class="py-docstring"> match, or are not balanced, then raise a ParseError.</tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt> <tt class="py-line"><tt class="py-docstring"> Assign some structure to a sequence of structure (group parens).</tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt> <tt class="py-line"> <tt class="py-name">stack</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>
<a name="L711"></a><tt class="py-lineno"> 711</tt> <tt class="py-line"> <tt class="py-name">parens</tt> <tt class="py-op">=</tt> <tt class="py-op">[</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">for</tt> <tt class="py-name">tok</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line_toks</tt><tt class="py-op">:</tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt> <tt class="py-line"> <tt class="py-name">toktype</tt><tt class="py-op">,</tt> <tt class="py-name">toktext</tt> <tt class="py-op">=</tt> <tt class="py-name">tok</tt> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">toktext</tt> <tt class="py-keyword">in</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-string">'{'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt> <tt class="py-line"> <tt class="py-name">parens</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">tok</tt><tt class="py-op">)</tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">tok</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">toktext</tt> <tt class="py-keyword">in</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-string">')'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">parens</tt><tt class="py-op">:</tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-276" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-276', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unbalanced parens'</tt><tt class="py-op">)</tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt> <tt class="py-line"> <tt class="py-name">left_paren</tt> <tt class="py-op">=</tt> <tt class="py-name">parens</tt><tt class="py-op">.</tt><tt class="py-name">pop</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>
<a name="L721"></a><tt class="py-lineno"> 721</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">left_paren</tt><tt class="py-op">+</tt><tt class="py-name">toktext</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</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-string">'{}'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-277" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-277', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Mismatched parens'</tt><tt class="py-op">)</tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt> <tt class="py-line"> <tt class="py-name">lst</tt> <tt class="py-op">=</tt> <tt class="py-name">stack</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="L724"></a><tt class="py-lineno"> 724</tt> <tt class="py-line"> <tt class="py-name">lst</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">tok</tt><tt class="py-op">)</tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt> <tt class="py-line"> <tt class="py-name">stack</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">append</tt><tt class="py-op">(</tt><tt class="py-name">lst</tt><tt class="py-op">)</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt> <tt class="py-line"> <tt class="py-name">stack</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">append</tt><tt class="py-op">(</tt><tt class="py-name">tok</tt><tt class="py-op">)</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</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">stack</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">parens</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="L729"></a><tt class="py-lineno"> 729</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-278" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-278', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unbalanced parens'</tt><tt class="py-op">)</tt> </tt>
<a name="L730"></a><tt class="py-lineno"> 730</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">stack</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
</div><a name="L731"></a><tt class="py-lineno"> 731</tt> <tt class="py-line"> </tt>
<a name="L732"></a><tt class="py-lineno"> 732</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Line processing</tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># The methods process_*() are used to handle lines.</tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_line"></a><div id="process_line-def"><a name="L737"></a><tt class="py-lineno"> 737</tt> <a class="py-toggle" href="#" id="process_line-toggle" onclick="return toggle('process_line');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_line">process_line</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_line-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_line-expanded"><a name="L739"></a><tt class="py-lineno"> 739</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{new-doc}, C{decorator}..?</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt> <tt class="py-line"> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">,</tt> <tt id="link-279" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-279', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt> <tt class="py-line"> <tt class="py-name">comments</tt><tt class="py-op">,</tt> <tt id="link-280" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-280', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</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-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">line</tt><tt class="py-op">:</tt> <tt class="py-comment"># blank line.</tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">':'</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line</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>
<a name="L748"></a><tt class="py-lineno"> 748</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-281" class="py-name" targets="Function epydoc.docparser.process_one_line_block()=epydoc.docparser-module.html#process_one_line_block"><a title="epydoc.docparser.process_one_line_block" class="py-name" href="#" onclick="return doclink('link-281', 'process_one_line_block', 'link-281');">process_one_line_block</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">';'</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line</tt><tt class="py-op">:</tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-282" class="py-name" targets="Function epydoc.docparser.process_multi_stmt()=epydoc.docparser-module.html#process_multi_stmt"><a title="epydoc.docparser.process_multi_stmt" class="py-name" href="#" onclick="return doclink('link-282', 'process_multi_stmt', 'link-282');">process_multi_stmt</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'def'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-283" class="py-name" targets="Function epydoc.docparser.process_funcdef()=epydoc.docparser-module.html#process_funcdef"><a title="epydoc.docparser.process_funcdef" class="py-name" href="#" onclick="return doclink('link-283', 'process_funcdef', 'link-283');">process_funcdef</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'@'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-284" class="py-name"><a title="epydoc.docparser.process_funcdef" class="py-name" href="#" onclick="return doclink('link-284', 'process_funcdef', 'link-283');">process_funcdef</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'class'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L756"></a><tt class="py-lineno"> 756</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-285" class="py-name" targets="Function epydoc.docparser.process_classdef()=epydoc.docparser-module.html#process_classdef"><a title="epydoc.docparser.process_classdef" class="py-name" href="#" onclick="return doclink('link-285', 'process_classdef', 'link-285');">process_classdef</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'import'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-286" class="py-name" targets="Function epydoc.docparser.process_import()=epydoc.docparser-module.html#process_import"><a title="epydoc.docparser.process_import" class="py-name" href="#" onclick="return doclink('link-286', 'process_import', 'link-286');">process_import</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L759"></a><tt class="py-lineno"> 759</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'from'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L760"></a><tt class="py-lineno"> 760</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-287" class="py-name" targets="Function epydoc.docparser.process_from_import()=epydoc.docparser-module.html#process_from_import"><a title="epydoc.docparser.process_from_import" class="py-name" href="#" onclick="return doclink('link-287', 'process_from_import', 'link-287');">process_from_import</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'del'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-288" class="py-name" targets="Function epydoc.docparser.process_del()=epydoc.docparser-module.html#process_del"><a title="epydoc.docparser.process_del" class="py-name" href="#" onclick="return doclink('link-288', 'process_del', 'link-288');">process_del</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</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">line</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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">STRING</tt><tt class="py-op">:</tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-289" class="py-name" targets="Function epydoc.docparser.process_docstring()=epydoc.docparser-module.html#process_docstring"><a title="epydoc.docparser.process_docstring" class="py-name" href="#" onclick="return doclink('link-289', 'process_docstring', 'link-289');">process_docstring</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">line</tt><tt class="py-op">:</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-290" class="py-name" targets="Function epydoc.docparser.process_assignment()=epydoc.docparser-module.html#process_assignment"><a title="epydoc.docparser.process_assignment" class="py-name" href="#" onclick="return doclink('link-290', 'process_assignment', 'link-290');">process_assignment</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">line</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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt> <tt class="py-line"> <tt class="py-name">line</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-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt id="link-291" class="py-name" targets="Variable epydoc.docparser.CONTROL_FLOW_KEYWORDS=epydoc.docparser-module.html#CONTROL_FLOW_KEYWORDS"><a title="epydoc.docparser.CONTROL_FLOW_KEYWORDS" class="py-name" href="#" onclick="return doclink('link-291', 'CONTROL_FLOW_KEYWORDS', 'link-291');">CONTROL_FLOW_KEYWORDS</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-292" class="py-name" targets="Function epydoc.docparser.process_control_flow_line()=epydoc.docparser-module.html#process_control_flow_line"><a title="epydoc.docparser.process_control_flow_line" class="py-name" href="#" onclick="return doclink('link-292', 'process_control_flow_line', 'link-292');">process_control_flow_line</a></tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L772"></a><tt class="py-lineno"> 772</tt> <tt class="py-line"> <tt class="py-comment"># [xx] do something with control structures like for/if?</tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: control flow</tt> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L778"></a><tt class="py-lineno"> 778</tt> <tt class="py-line"><tt id="link-293" class="py-name"><a title="epydoc.docparser.CONTROL_FLOW_KEYWORDS" class="py-name" href="#" onclick="return doclink('link-293', 'CONTROL_FLOW_KEYWORDS', 'link-291');">CONTROL_FLOW_KEYWORDS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> </tt>
<a name="L779"></a><tt class="py-lineno"> 779</tt> <tt class="py-line"> <tt class="py-comment">#: A list of the control flow keywords. If a line begins with</tt> </tt>
<a name="L780"></a><tt class="py-lineno"> 780</tt> <tt class="py-line"> <tt class="py-comment">#: one of these keywords, then it should be handled by</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt> <tt class="py-line"> <tt class="py-comment">#: C{process_control_flow_line}.</tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt> <tt class="py-line"> <tt class="py-string">'if'</tt><tt class="py-op">,</tt> <tt class="py-string">'elif'</tt><tt class="py-op">,</tt> <tt class="py-string">'else'</tt><tt class="py-op">,</tt> <tt class="py-string">'while'</tt><tt class="py-op">,</tt> <tt class="py-string">'for'</tt><tt class="py-op">,</tt> <tt class="py-string">'try'</tt><tt class="py-op">,</tt> <tt class="py-string">'except'</tt><tt class="py-op">,</tt> <tt class="py-string">'finally'</tt><tt class="py-op">]</tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt> <tt class="py-line"> </tt>
<a name="process_control_flow_line"></a><div id="process_control_flow_line-def"><a name="L784"></a><tt class="py-lineno"> 784</tt> <a class="py-toggle" href="#" id="process_control_flow_line-toggle" onclick="return toggle('process_control_flow_line');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_control_flow_line">process_control_flow_line</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt> <tt class="py-line"> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_control_flow_line-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_control_flow_line-expanded"><a name="L786"></a><tt class="py-lineno"> 786</tt> <tt class="py-line"> <tt class="py-name">keyword</tt> <tt class="py-op">=</tt> <tt class="py-name">line</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-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt> <tt class="py-line"> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt> <tt class="py-line"> <tt class="py-comment"># If it's a 'for' block: create the loop variable.</tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'for'</tt> <tt class="py-keyword">and</tt> <tt id="link-294" class="py-name"><a title="epydoc.docparser.PARSE_FOR_BLOCKS" class="py-name" href="#" onclick="return doclink('link-294', 'PARSE_FOR_BLOCKS', 'link-16');">PARSE_FOR_BLOCKS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt> <tt class="py-line"> <tt class="py-name">loopvar_name</tt> <tt class="py-op">=</tt> <tt id="link-295" class="py-name" targets="Function epydoc.docparser.parse_dotted_name()=epydoc.docparser-module.html#parse_dotted_name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-295', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt> <tt class="py-line"> <tt id="link-296" class="py-name" targets="Function epydoc.docparser.split_on()=epydoc.docparser-module.html#split_on"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-296', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'in'</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>
<a name="L792"></a><tt class="py-lineno"> 792</tt> <tt class="py-line"> <tt class="py-name">parent</tt> <tt class="py-op">=</tt> <tt id="link-297" class="py-name" targets="Function epydoc.docparser.get_lhs_parent()=epydoc.docparser-module.html#get_lhs_parent"><a title="epydoc.docparser.get_lhs_parent" class="py-name" href="#" onclick="return doclink('link-297', 'get_lhs_parent', 'link-297');">get_lhs_parent</a></tt><tt class="py-op">(</tt><tt class="py-name">loopvar_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parent</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="L794"></a><tt class="py-lineno"> 794</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-298" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-298', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-299" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-299', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">loopvar_name</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 id="link-300" 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-300', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt> <tt class="py-line"> <tt id="link-301" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-301', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-302" 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-302', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt> <tt class="py-line"> <tt id="link-303" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-303', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt> <tt class="py-line"> <tt id="link-304" class="py-name" targets="Function epydoc.docparser.set_variable()=epydoc.docparser-module.html#set_variable"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-304', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">parent</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt> <tt class="py-line"> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'if'</tt> <tt class="py-keyword">and</tt> <tt id="link-305" class="py-name"><a title="epydoc.docparser.PARSE_IF_BLOCKS" class="py-name" href="#" onclick="return doclink('link-305', 'PARSE_IF_BLOCKS', 'link-13');">PARSE_IF_BLOCKS</a></tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-306" class="py-name" targets="Function epydoc.docparser.script_guard()=epydoc.docparser-module.html#script_guard"><a title="epydoc.docparser.script_guard" class="py-name" href="#" onclick="return doclink('link-306', 'script_guard', 'link-306');">script_guard</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'elif'</tt> <tt class="py-keyword">and</tt> <tt id="link-307" class="py-name"><a title="epydoc.docparser.PARSE_ELSE_BLOCKS" class="py-name" href="#" onclick="return doclink('link-307', 'PARSE_ELSE_BLOCKS', 'link-14');">PARSE_ELSE_BLOCKS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'else'</tt> <tt class="py-keyword">and</tt> <tt id="link-308" class="py-name"><a title="epydoc.docparser.PARSE_ELSE_BLOCKS" class="py-name" href="#" onclick="return doclink('link-308', 'PARSE_ELSE_BLOCKS', 'link-14');">PARSE_ELSE_BLOCKS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'while'</tt> <tt class="py-keyword">and</tt> <tt id="link-309" class="py-name"><a title="epydoc.docparser.PARSE_WHILE_BLOCKS" class="py-name" href="#" onclick="return doclink('link-309', 'PARSE_WHILE_BLOCKS', 'link-15');">PARSE_WHILE_BLOCKS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'for'</tt> <tt class="py-keyword">and</tt> <tt id="link-310" class="py-name"><a title="epydoc.docparser.PARSE_FOR_BLOCKS" class="py-name" href="#" onclick="return doclink('link-310', 'PARSE_FOR_BLOCKS', 'link-16');">PARSE_FOR_BLOCKS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'try'</tt> <tt class="py-keyword">and</tt> <tt id="link-311" class="py-name"><a title="epydoc.docparser.PARSE_TRY_BLOCKS" class="py-name" href="#" onclick="return doclink('link-311', 'PARSE_TRY_BLOCKS', 'link-10');">PARSE_TRY_BLOCKS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'except'</tt> <tt class="py-keyword">and</tt> <tt id="link-312" class="py-name"><a title="epydoc.docparser.PARSE_EXCEPT_BLOCKS" class="py-name" href="#" onclick="return doclink('link-312', 'PARSE_EXCEPT_BLOCKS', 'link-11');">PARSE_EXCEPT_BLOCKS</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">keyword</tt> <tt class="py-op">==</tt> <tt class="py-string">'finally'</tt> <tt class="py-keyword">and</tt> <tt id="link-313" class="py-name"><a title="epydoc.docparser.PARSE_FINALLY_BLOCKS" class="py-name" href="#" onclick="return doclink('link-313', 'PARSE_FINALLY_BLOCKS', 'link-12');">PARSE_FINALLY_BLOCKS</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt> <tt class="py-line"> <tt class="py-comment"># Return "None" to indicate that we should process the</tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># block using the same context that we were already in.</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt> <tt class="py-line"> <tt class="py-comment"># Return 'skip_block' to indicate that we should ignore</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 contents of this block.</tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-string">'skip_block'</tt> </tt>
</div><a name="L814"></a><tt class="py-lineno"> 814</tt> <tt class="py-line"> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</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"># Line handler: imports</tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># [xx] I could optionally add ValueDoc's for the imported</tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># variables with proxy_for set to the imported source; but</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># I don't think I gain much of anything by doing so.</tt> </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_import"></a><div id="process_import-def"><a name="L822"></a><tt class="py-lineno"> 822</tt> <a class="py-toggle" href="#" id="process_import-toggle" onclick="return toggle('process_import');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_import">process_import</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_import-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_import-expanded"><a name="L824"></a><tt class="py-lineno"> 824</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">parent_docs</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 id="link-314" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-314', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L825"></a><tt class="py-lineno"> 825</tt> <tt class="py-line"> </tt>
<a name="L826"></a><tt class="py-lineno"> 826</tt> <tt class="py-line"> <tt class="py-name">names</tt> <tt class="py-op">=</tt> <tt id="link-315" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-315', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt> <tt class="py-line"> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-316" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-316', 'name', 'link-31');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">names</tt><tt class="py-op">:</tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt> <tt class="py-line"> <tt class="py-name">name_pieces</tt> <tt class="py-op">=</tt> <tt id="link-317" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-317', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt id="link-318" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-318', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'as'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</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">name_pieces</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="L831"></a><tt class="py-lineno"> 831</tt> <tt class="py-line"> <tt class="py-name">src_name</tt> <tt class="py-op">=</tt> <tt id="link-319" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-319', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">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>
<a name="L832"></a><tt class="py-lineno"> 832</tt> <tt class="py-line"> <tt id="link-320" class="py-name" targets="Function epydoc.docparser._import_var()=epydoc.docparser-module.html#_import_var"><a title="epydoc.docparser._import_var" class="py-name" href="#" onclick="return doclink('link-320', '_import_var', 'link-320');">_import_var</a></tt><tt class="py-op">(</tt><tt class="py-name">src_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">name_pieces</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</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">name_pieces</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-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-321" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-321', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Expected identifier after "as"'</tt><tt class="py-op">)</tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt> <tt class="py-line"> <tt class="py-name">src_name</tt> <tt class="py-op">=</tt> <tt id="link-322" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-322', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">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>
<a name="L837"></a><tt class="py-lineno"> 837</tt> <tt class="py-line"> <tt class="py-name">var_name</tt> <tt class="py-op">=</tt> <tt id="link-323" class="py-name" targets="Function epydoc.docparser.parse_name()=epydoc.docparser-module.html#parse_name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-323', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">name_pieces</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">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt> <tt class="py-line"> <tt id="link-324" class="py-name" targets="Function epydoc.docparser._import_var_as()=epydoc.docparser-module.html#_import_var_as"><a title="epydoc.docparser._import_var_as" class="py-name" href="#" onclick="return doclink('link-324', '_import_var_as', 'link-324');">_import_var_as</a></tt><tt class="py-op">(</tt><tt class="py-name">src_name</tt><tt class="py-op">,</tt> <tt class="py-name">var_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-325" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-325', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">'Multiple "as" tokens in import'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L841"></a><tt class="py-lineno"> 841</tt> <tt class="py-line"> </tt>
<a name="process_from_import"></a><div id="process_from_import-def"><a name="L842"></a><tt class="py-lineno"> 842</tt> <a class="py-toggle" href="#" id="process_from_import-toggle" onclick="return toggle('process_from_import');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_from_import">process_from_import</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_from_import-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_from_import-expanded"><a name="L844"></a><tt class="py-lineno"> 844</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">parent_docs</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 id="link-326" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-326', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt> <tt class="py-line"> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt> <tt class="py-line"> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt id="link-327" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-327', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'import'</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-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">2</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</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-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">pieces</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="L848"></a><tt class="py-lineno"> 848</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-328" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-328', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad from-import"</tt><tt class="py-op">)</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt> <tt class="py-line"> <tt class="py-name">lhs</tt><tt class="py-op">,</tt> <tt class="py-name">rhs</tt> <tt class="py-op">=</tt> <tt class="py-name">pieces</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt> <tt class="py-line"> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt> <tt class="py-line"> <tt class="py-comment"># The RHS might be parenthasized, as specified by PEP 328:</tt> </tt>
<a name="L852"></a><tt class="py-lineno"> 852</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># http://www.python.org/peps/pep-0328.html</tt> </tt>
<a name="L853"></a><tt class="py-lineno"> 853</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">len</tt><tt class="py-op">(</tt><tt class="py-name">rhs</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">rhs</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">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L854"></a><tt class="py-lineno"> 854</tt> <tt class="py-line"> <tt class="py-name">rhs</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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'('</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">rhs</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 class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L855"></a><tt class="py-lineno"> 855</tt> <tt class="py-line"> <tt class="py-name">rhs</tt> <tt class="py-op">=</tt> <tt class="py-name">rhs</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-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>
<a name="L856"></a><tt class="py-lineno"> 856</tt> <tt class="py-line"> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt> <tt class="py-line"> <tt class="py-comment"># >>> from __future__ import nested_scopes</tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">lhs</tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'__future__'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt> <tt class="py-line"> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt> <tt class="py-line"> <tt class="py-comment"># >>> from sys import *</tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">rhs</tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L863"></a><tt class="py-lineno"> 863</tt> <tt class="py-line"> <tt class="py-name">src_name</tt> <tt class="py-op">=</tt> <tt id="link-329" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-329', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs</tt><tt class="py-op">)</tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt> <tt class="py-line"> <tt id="link-330" class="py-name" targets="Function epydoc.docparser._process_fromstar_import()=epydoc.docparser-module.html#_process_fromstar_import"><a title="epydoc.docparser._process_fromstar_import" class="py-name" href="#" onclick="return doclink('link-330', '_process_fromstar_import', 'link-330');">_process_fromstar_import</a></tt><tt class="py-op">(</tt><tt class="py-name">src_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt> <tt class="py-line"> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt> <tt class="py-line"> <tt class="py-comment"># >>> from os.path import join, split</tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt> <tt class="py-line"> <tt class="py-comment"># Allow relative imports in this case, as per PEP 328</tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">src_name</tt> <tt class="py-op">=</tt> <tt id="link-331" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-331', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs</tt><tt class="py-op">,</tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt> <tt class="py-line"> <tt class="py-name">parent_name</tt><tt class="py-op">=</tt><tt class="py-name">parent_docs</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 id="link-332" 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-332', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt> <tt class="py-line"> <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt id="link-333" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-333', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parts</tt><tt class="py-op">:</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt> <tt class="py-line"> <tt class="py-comment"># from m import x</tt> </tt>
<a name="L874"></a><tt class="py-lineno"> 874</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">part</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="L875"></a><tt class="py-lineno"> 875</tt> <tt class="py-line"> <tt class="py-name">var_name</tt> <tt class="py-op">=</tt> <tt id="link-334" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-334', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">part</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="L876"></a><tt class="py-lineno"> 876</tt> <tt class="py-line"> <tt id="link-335" class="py-name"><a title="epydoc.docparser._import_var_as" class="py-name" href="#" onclick="return doclink('link-335', '_import_var_as', 'link-324');">_import_var_as</a></tt><tt class="py-op">(</tt><tt id="link-336" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-336', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">src_name</tt><tt class="py-op">,</tt> <tt class="py-name">var_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L877"></a><tt class="py-lineno"> 877</tt> <tt class="py-line"> <tt class="py-name">var_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L878"></a><tt class="py-lineno"> 878</tt> <tt class="py-line"> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt> <tt class="py-line"> <tt class="py-comment"># from m import x as y</tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">3</tt> <tt class="py-keyword">and</tt> <tt class="py-name">part</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-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'as'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt> <tt class="py-line"> <tt class="py-name">orig_name</tt> <tt class="py-op">=</tt> <tt id="link-337" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-337', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">part</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="L882"></a><tt class="py-lineno"> 882</tt> <tt class="py-line"> <tt class="py-name">var_name</tt> <tt class="py-op">=</tt> <tt id="link-338" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-338', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt> <tt class="py-line"> <tt id="link-339" class="py-name"><a title="epydoc.docparser._import_var_as" class="py-name" href="#" onclick="return doclink('link-339', '_import_var_as', 'link-324');">_import_var_as</a></tt><tt class="py-op">(</tt><tt id="link-340" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-340', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">src_name</tt><tt class="py-op">,</tt> <tt class="py-name">orig_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt> <tt class="py-line"> <tt class="py-name">var_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt> <tt class="py-line"> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt> <tt class="py-line"> <tt id="link-341" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-341', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad from-import"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L888"></a><tt class="py-lineno"> 888</tt> <tt class="py-line"> </tt>
<a name="_process_fromstar_import"></a><div id="_process_fromstar_import-def"><a name="L889"></a><tt class="py-lineno"> 889</tt> <a class="py-toggle" href="#" id="_process_fromstar_import-toggle" onclick="return toggle('_process_fromstar_import');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_process_fromstar_import">_process_fromstar_import</a><tt class="py-op">(</tt><tt class="py-param">src</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_process_fromstar_import-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_process_fromstar_import-expanded"><a name="L890"></a><tt class="py-lineno"> 890</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt> <tt class="py-line"><tt class="py-docstring"> Handle a statement of the form:</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt> <tt class="py-line"><tt class="py-docstring"> >>> from <src> import *</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt> <tt class="py-line"><tt class="py-docstring"> If L{IMPORT_HANDLING} is C{'parse'}, then first try to parse</tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt> <tt class="py-line"><tt class="py-docstring"> the module C{M{<src>}}, and copy all of its exported variables</tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt> <tt class="py-line"><tt class="py-docstring"> to C{parent_docs[-1]}.</tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt> <tt class="py-line"><tt class="py-docstring"> Otherwise, try to determine the names of the variables exported by</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt> <tt class="py-line"><tt class="py-docstring"> C{M{<src>}}, and create a new variable for each export. If</tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt> <tt class="py-line"><tt class="py-docstring"> L{IMPORT_STAR_HANDLING} is C{'parse'}, then the list of exports if</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt> <tt class="py-line"><tt class="py-docstring"> found by parsing C{M{<src>}}; if it is C{'introspect'}, then the</tt> </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt> <tt class="py-line"><tt class="py-docstring"> list of exports is found by importing and introspecting</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt> <tt class="py-line"><tt class="py-docstring"> C{M{<src>}}.</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L905"></a><tt class="py-lineno"> 905</tt> <tt class="py-line"> <tt class="py-comment"># This is redundant: already checked by caller.</tt> </tt>
<a name="L906"></a><tt class="py-lineno"> 906</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">parent_docs</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 id="link-342" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-342', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L907"></a><tt class="py-lineno"> 907</tt> <tt class="py-line"> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt> <tt class="py-line"> <tt class="py-comment"># If src is package-local, then convert it to a global name.</tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">src</tt> <tt class="py-op">=</tt> <tt id="link-343" class="py-name" targets="Function epydoc.docparser._global_name()=epydoc.docparser-module.html#_global_name"><a title="epydoc.docparser._global_name" class="py-name" href="#" onclick="return doclink('link-343', '_global_name', 'link-343');">_global_name</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt> <tt class="py-line"> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt> <tt class="py-line"> <tt class="py-comment"># Record the import</tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_docs</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-344" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-344', 'imports', 'link-72');">imports</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt> <tt class="py-comment"># mark that it's .*??</tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt> <tt class="py-line"> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt> <tt class="py-line"> <tt class="py-comment"># [xx] add check for if we already have the source docs in our</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># cache??</tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt id="link-345" class="py-name"><a title="epydoc.docparser.IMPORT_HANDLING" class="py-name" href="#" onclick="return doclink('link-345', 'IMPORT_HANDLING', 'link-17');">IMPORT_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt> <tt class="py-line"> <tt id="link-346" class="py-name"><a title="epydoc.docparser.IMPORT_STAR_HANDLING" class="py-name" href="#" onclick="return doclink('link-346', 'IMPORT_STAR_HANDLING', 'link-18');">IMPORT_STAR_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-comment"># [xx] is this ok?</tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">module_doc</tt> <tt class="py-op">=</tt> <tt id="link-347" class="py-name"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-347', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> <tt class="py-name">module_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</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">module_doc</tt><tt class="py-op">,</tt> <tt id="link-348" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-348', 'ModuleDoc', 'link-68');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-349" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-349', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">imp_var</tt> <tt class="py-keyword">in</tt> <tt class="py-name">module_doc</tt><tt class="py-op">.</tt><tt id="link-350" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-350', 'variables', 'link-70');">variables</a></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="L923"></a><tt class="py-lineno"> 923</tt> <tt class="py-line"> <tt class="py-comment"># [xx] this is not exactly correct, but close. It</tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># does the wrong thing if a __var__ is explicitly</tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># listed in __all__.</tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</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">imp_var</tt><tt class="py-op">.</tt><tt id="link-351" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_public" class="py-name" href="#" onclick="return doclink('link-351', 'is_public', 'link-113');">is_public</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt id="link-352" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-352', 'name', 'link-31');">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">and</tt> <tt id="link-353" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-353', 'name', 'link-31');">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 class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-354" class="py-name" targets="Function epydoc.docparser._add_import_var()=epydoc.docparser-module.html#_add_import_var"><a title="epydoc.docparser._add_import_var" class="py-name" href="#" onclick="return doclink('link-354', '_add_import_var', 'link-354');">_add_import_var</a></tt><tt class="py-op">(</tt><tt id="link-355" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-355', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt id="link-356" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-356', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-357" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-357', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt> <tt class="py-line"> <tt class="py-name">parent_docs</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="L930"></a><tt class="py-lineno"> 930</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-358" class="py-name"><a title="epydoc.docparser.IMPORT_HANDLING" class="py-name" href="#" onclick="return doclink('link-358', 'IMPORT_HANDLING', 'link-17');">IMPORT_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt><tt class="py-op">:</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-359" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-359', 'value', 'link-135');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-name">imp_var</tt><tt class="py-op">.</tt><tt id="link-360" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-360', 'value', 'link-135');">value</a></tt> </tt>
<a name="L932"></a><tt class="py-lineno"> 932</tt> <tt class="py-line"> </tt>
<a name="L933"></a><tt class="py-lineno"> 933</tt> <tt class="py-line"> <tt class="py-comment"># If we got here, then either IMPORT_HANDLING='link' or we</tt> </tt>
<a name="L934"></a><tt class="py-lineno"> 934</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># failed to parse the `src` module.</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt id="link-361" class="py-name"><a title="epydoc.docparser.IMPORT_STAR_HANDLING" class="py-name" href="#" onclick="return doclink('link-361', 'IMPORT_STAR_HANDLING', 'link-18');">IMPORT_STAR_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'introspect'</tt><tt class="py-op">:</tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">module</tt> <tt class="py-op">=</tt> <tt class="py-name">__import__</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">src</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-op">{</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>
<a name="L937"></a><tt class="py-lineno"> 937</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-comment"># We couldn't import it.</tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">module</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-comment"># We couldn't import it.</tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</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">module</tt><tt class="py-op">,</tt> <tt class="py-string">'__all__'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt> <tt class="py-line"> <tt class="py-name">names</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">.</tt><tt class="py-name">__all__</tt><tt class="py-op">)</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt> <tt class="py-line"> <tt class="py-name">names</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">n</tt> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">dir</tt><tt class="py-op">(</tt><tt class="py-name">module</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">n</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="L943"></a><tt class="py-lineno"> 943</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-362" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-362', 'name', 'link-31');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">names</tt><tt class="py-op">:</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt> <tt class="py-line"> <tt id="link-363" class="py-name"><a title="epydoc.docparser._add_import_var" class="py-name" href="#" onclick="return doclink('link-363', '_add_import_var', 'link-354');">_add_import_var</a></tt><tt class="py-op">(</tt><tt id="link-364" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-364', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt id="link-365" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-365', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-366" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-366', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</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="L945"></a><tt class="py-lineno"> 945</tt> <tt class="py-line"> </tt>
<a name="_import_var"></a><div id="_import_var-def"><a name="L946"></a><tt class="py-lineno"> 946</tt> <a class="py-toggle" href="#" id="_import_var-toggle" onclick="return toggle('_import_var');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_import_var">_import_var</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_import_var-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_import_var-expanded"><a name="L947"></a><tt class="py-lineno"> 947</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt> <tt class="py-line"><tt class="py-docstring"> Handle a statement of the form:</tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt> <tt class="py-line"><tt class="py-docstring"> >>> import <name></tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt> <tt class="py-line"><tt class="py-docstring"> If L{IMPORT_HANDLING} is C{'parse'}, then first try to find</tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt> <tt class="py-line"><tt class="py-docstring"> the value by parsing; and create an appropriate variable in</tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt> <tt class="py-line"><tt class="py-docstring"> parentdoc.</tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt> <tt class="py-line"><tt class="py-docstring"> Otherwise, add a variable for the imported variable. (More than</tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt> <tt class="py-line"><tt class="py-docstring"> one variable may be created for cases like C{'import a.b'}, where</tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt> <tt class="py-line"><tt class="py-docstring"> we need to create a variable C{'a'} in parentdoc containing a</tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt> <tt class="py-line"><tt class="py-docstring"> proxy module; and a variable C{'b'} in the proxy module.</tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt> <tt class="py-line"> <tt class="py-comment"># This is redundant: already checked by caller.</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</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">parent_docs</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 id="link-367" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-367', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L962"></a><tt class="py-lineno"> 962</tt> <tt class="py-line"> </tt>
<a name="L963"></a><tt class="py-lineno"> 963</tt> <tt class="py-line"> <tt class="py-comment"># If name is package-local, then convert it to a global name.</tt> </tt>
<a name="L964"></a><tt class="py-lineno"> 964</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">src</tt> <tt class="py-op">=</tt> <tt id="link-368" class="py-name"><a title="epydoc.docparser._global_name" class="py-name" href="#" onclick="return doclink('link-368', '_global_name', 'link-343');">_global_name</a></tt><tt class="py-op">(</tt><tt id="link-369" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-369', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt> <tt class="py-line"> <tt class="py-name">src_prefix</tt> <tt class="py-op">=</tt> <tt class="py-name">src</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">src</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-370" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-370', 'name', 'link-31');">name</a></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>
<a name="L967"></a><tt class="py-lineno"> 967</tt> <tt class="py-line"> <tt class="py-comment"># Record the import</tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_docs</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-371" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-371', 'imports', 'link-72');">imports</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-372" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-372', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt> <tt class="py-line"> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt> <tt class="py-line"> <tt class="py-comment"># [xx] add check for if we already have the source docs in our</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># cache??</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-373" class="py-name"><a title="epydoc.docparser.IMPORT_HANDLING" class="py-name" href="#" onclick="return doclink('link-373', 'IMPORT_HANDLING', 'link-17');">IMPORT_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt><tt class="py-op">:</tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt> <tt class="py-line"> <tt class="py-comment"># Check to make sure that we can actually find the value.</tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt id="link-374" class="py-name"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-374', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt class="py-name">src</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">except</tt> <tt class="py-name">ImportError</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="L977"></a><tt class="py-lineno"> 977</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-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt> <tt class="py-line"> <tt class="py-comment"># We found it; but it's not the value itself we want to</tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># import, but the module containing it; so import that</tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># module (=top_mod) and create a variable for it.</tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">top_mod</tt> <tt class="py-op">=</tt> <tt class="py-name">src_prefix</tt><tt class="py-op">+</tt><tt id="link-375" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-375', 'name', 'link-31');">name</a></tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-376" class="py-name"><a title="epydoc.docparser._add_import_var" class="py-name" href="#" onclick="return doclink('link-376', '_add_import_var', 'link-354');">_add_import_var</a></tt><tt class="py-op">(</tt><tt class="py-name">top_mod</tt><tt class="py-op">,</tt> <tt id="link-377" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-377', 'name', 'link-31');">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-name">parent_docs</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="L983"></a><tt class="py-lineno"> 983</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-378" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-378', 'value', 'link-135');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-379" class="py-name"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-379', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt id="link-380" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-380', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-381" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-381', 'name', 'link-31');">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="L984"></a><tt class="py-lineno"> 984</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt> <tt class="py-line"> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt> <tt class="py-line"> <tt class="py-comment"># If we got here, then either IMPORT_HANDLING='link', or we</tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># did not successfully find the value's docs by parsing; use</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># a variable with an UNKNOWN value.</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L990"></a><tt class="py-lineno"> 990</tt> <tt class="py-line"> <tt class="py-comment"># Create any necessary intermediate proxy module values.</tt> </tt>
<a name="L991"></a><tt class="py-lineno"> 991</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-382" 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-382', 'container', 'link-250');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</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="L992"></a><tt class="py-lineno"> 992</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt id="link-383" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-383', 'name', 'link-31');">name</a></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-op">:</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">identifier</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-384" 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-384', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-385" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-385', 'variables', 'link-70');">variables</a></tt> <tt class="py-keyword">or</tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-386" 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-386', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-387" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-387', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">identifier</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-388" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-388', 'ModuleDoc', 'link-68');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-389" class="py-name"><a title="epydoc.docparser._add_import_var" class="py-name" href="#" onclick="return doclink('link-389', '_add_import_var', 'link-354');">_add_import_var</a></tt><tt class="py-op">(</tt><tt id="link-390" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-390', 'name', 'link-31');">name</a></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-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 id="link-391" 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-391', 'container', 'link-250');">container</a></tt><tt class="py-op">)</tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-392" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-392', 'value', 'link-135');">value</a></tt> <tt class="py-op">=</tt> <tt id="link-393" class="py-name"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-393', 'ModuleDoc', 'link-68');">ModuleDoc</a></tt><tt class="py-op">(</tt><tt id="link-394" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-394', 'variables', 'link-70');">variables</a></tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt id="link-395" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-395', 'sort_spec', 'link-71');">sort_spec</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="L997"></a><tt class="py-lineno"> 997</tt> <tt class="py-line"> <tt id="link-396" 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-396', 'proxy_for', 'link-396');">proxy_for</a></tt><tt class="py-op">=</tt><tt class="py-name">src_prefix</tt><tt class="py-op">+</tt><tt id="link-397" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-397', 'name', 'link-31');">name</a></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-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt> <tt class="py-line"> <tt id="link-398" class="py-name"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-398', 'submodules', 'link-77');">submodules</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="L999"></a><tt class="py-lineno"> 999</tt> <tt class="py-line"> <tt id="link-399" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-399', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt> <tt class="py-line"> <tt id="link-400" 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-400', 'container', 'link-250');">container</a></tt> <tt class="py-op">=</tt> <tt id="link-401" 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-401', 'container', 'link-250');">container</a></tt><tt class="py-op">.</tt><tt id="link-402" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-402', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">identifier</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-403" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-403', 'value', 'link-135');">value</a></tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt> <tt class="py-line"> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt> <tt class="py-line"> <tt class="py-comment"># Add the variable to the container.</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-404" class="py-name"><a title="epydoc.docparser._add_import_var" class="py-name" href="#" onclick="return doclink('link-404', '_add_import_var', 'link-354');">_add_import_var</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt id="link-405" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-405', 'name', 'link-31');">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 id="link-406" 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-406', 'container', 'link-250');">container</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L1004"></a><tt class="py-lineno">1004</tt> <tt class="py-line"> </tt>
<a name="_import_var_as"></a><div id="_import_var_as-def"><a name="L1005"></a><tt class="py-lineno">1005</tt> <a class="py-toggle" href="#" id="_import_var_as-toggle" onclick="return toggle('_import_var_as');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_import_var_as">_import_var_as</a><tt class="py-op">(</tt><tt class="py-param">src</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_import_var_as-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_import_var_as-expanded"><a name="L1006"></a><tt class="py-lineno">1006</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt> <tt class="py-line"><tt class="py-docstring"> Handle a statement of the form:</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt> <tt class="py-line"><tt class="py-docstring"> >>> import src as name</tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt> <tt class="py-line"><tt class="py-docstring"> If L{IMPORT_HANDLING} is C{'parse'}, then first try to find</tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt> <tt class="py-line"><tt class="py-docstring"> the value by parsing; and create an appropriate variable in</tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt> <tt class="py-line"><tt class="py-docstring"> parentdoc.</tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt> <tt class="py-line"><tt class="py-docstring"> Otherwise, create a variables with its C{imported_from} attribute</tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt> <tt class="py-line"><tt class="py-docstring"> pointing to the imported object.</tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt> <tt class="py-line"> <tt class="py-comment"># This is redundant: already checked by caller.</tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</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">parent_docs</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 id="link-407" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-407', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</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 class="py-comment"># If src is package-local, then convert it to a global name.</tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">src</tt> <tt class="py-op">=</tt> <tt id="link-408" class="py-name"><a title="epydoc.docparser._global_name" class="py-name" href="#" onclick="return doclink('link-408', '_global_name', 'link-343');">_global_name</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt> <tt class="py-line"> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt> <tt class="py-line"> <tt class="py-comment"># Record the import</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_docs</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-409" class="py-name"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-409', 'imports', 'link-72');">imports</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt> <tt class="py-line"> </tt>
<a name="L1026"></a><tt class="py-lineno">1026</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-410" class="py-name"><a title="epydoc.docparser.IMPORT_HANDLING" class="py-name" href="#" onclick="return doclink('link-410', 'IMPORT_HANDLING', 'link-17');">IMPORT_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt><tt class="py-op">:</tt> </tt>
<a name="L1027"></a><tt class="py-lineno">1027</tt> <tt class="py-line"> <tt class="py-comment"># Parse the value and create a variable for it.</tt> </tt>
<a name="L1028"></a><tt class="py-lineno">1028</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">val_doc</tt> <tt class="py-op">=</tt> <tt id="link-411" class="py-name"><a title="epydoc.docparser._find" class="py-name" href="#" onclick="return doclink('link-411', '_find', 'link-35');">_find</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">)</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</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="L1030"></a><tt class="py-lineno">1030</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-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-412" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-412', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-413" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-413', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt id="link-414" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-414', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt id="link-415" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-415', 'value', 'link-135');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">val_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt> <tt class="py-line"> <tt id="link-416" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-416', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt id="link-417" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-417', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt> <tt class="py-line"> <tt id="link-418" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-418', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">=</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt> <tt class="py-line"> <tt id="link-419" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-419', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt> <tt class="py-line"> <tt id="link-420" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-420', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt> <tt class="py-line"> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt> <tt class="py-line"> <tt class="py-comment"># If we got here, then either IMPORT_HANDLING='link', or we</tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># did not successfully find the value's docs by parsing; use a</tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># variable with a proxy value.</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-421" class="py-name"><a title="epydoc.docparser._add_import_var" class="py-name" href="#" onclick="return doclink('link-421', '_add_import_var', 'link-354');">_add_import_var</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt id="link-422" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-422', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</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="L1042"></a><tt class="py-lineno">1042</tt> <tt class="py-line"> </tt>
<a name="_add_import_var"></a><div id="_add_import_var-def"><a name="L1043"></a><tt class="py-lineno">1043</tt> <a class="py-toggle" href="#" id="_add_import_var-toggle" onclick="return toggle('_add_import_var');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_add_import_var">_add_import_var</a><tt class="py-op">(</tt><tt class="py-param">src</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">container</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_add_import_var-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_add_import_var-expanded"><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 class="py-docstring"> Add a new imported variable named C{name} to C{container}, with</tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt> <tt class="py-line"><tt class="py-docstring"> C{imported_from=src}.</tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-423" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-423', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-424" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-424', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt id="link-425" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-425', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt id="link-426" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-426', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt id="link-427" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-427', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt> <tt class="py-line"> <tt id="link-428" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-428', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">=</tt><tt class="py-name">src</tt><tt class="py-op">,</tt> <tt id="link-429" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-429', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt> <tt class="py-line"> <tt id="link-430" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-430', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt id="link-431" 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-431', 'container', 'link-250');">container</a></tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</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 class="py-name">var_doc</tt> </tt>
</div><a name="L1052"></a><tt class="py-lineno">1052</tt> <tt class="py-line"> </tt>
<a name="_global_name"></a><div id="_global_name-def"><a name="L1053"></a><tt class="py-lineno">1053</tt> <a class="py-toggle" href="#" id="_global_name-toggle" onclick="return toggle('_global_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_global_name">_global_name</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_global_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_global_name-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"> If the given name is package-local (relative to the current</tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt> <tt class="py-line"><tt class="py-docstring"> context, as determined by C{parent_docs}), then convert it</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt> <tt class="py-line"><tt class="py-docstring"> to a global name.</tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1059"></a><tt class="py-lineno">1059</tt> <tt class="py-line"> <tt class="py-comment"># Get the containing package from parent_docs.</tt> </tt>
<a name="L1060"></a><tt class="py-lineno">1060</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">parent_docs</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-432" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-432', 'is_package', 'link-76');">is_package</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1061"></a><tt class="py-lineno">1061</tt> <tt class="py-line"> <tt id="link-433" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-433', 'package', 'link-75');">package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt> <tt class="py-line"> <tt id="link-434" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-434', 'package', 'link-75');">package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</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-435" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-435', 'package', 'link-75');">package</a></tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt> <tt class="py-line"> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt> <tt class="py-line"> <tt class="py-comment"># Check each package (from closest to furthest) to see if it</tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># contains a module named name[0]; if so, then treat `name` as</tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># relative to that package.</tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt id="link-436" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-436', 'package', 'link-75');">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-437" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-437', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt> <tt class="py-line"> <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt class="py-name">imp</tt><tt class="py-op">.</tt><tt class="py-name">find_module</tt><tt class="py-op">(</tt><tt id="link-438" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-438', 'name', 'link-31');">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 id="link-439" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-439', 'package', 'link-75');">package</a></tt><tt class="py-op">.</tt><tt id="link-440" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-440', 'path', 'link-0');">path</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="L1071"></a><tt class="py-lineno">1071</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">fp</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-name">fp</tt><tt class="py-op">.</tt><tt id="link-441" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-441', 'close', 'link-189');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt> <tt class="py-line"> <tt class="py-comment"># No submodule found here; try the next package up.</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-442" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-442', 'package', 'link-75');">package</a></tt> <tt class="py-op">=</tt> <tt id="link-443" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-443', 'package', 'link-75');">package</a></tt><tt class="py-op">.</tt><tt id="link-444" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-444', 'package', 'link-75');">package</a></tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt> <tt class="py-line"> <tt class="py-comment"># A submodule was found; return its name.</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-445" class="py-name"><a title="epydoc.apidoc.ModuleDoc.package" class="py-name" href="#" onclick="return doclink('link-445', 'package', 'link-75');">package</a></tt><tt class="py-op">.</tt><tt id="link-446" 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-446', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">+</tt> <tt id="link-447" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-447', 'name', 'link-31');">name</a></tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt> <tt class="py-line"> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt> <tt class="py-line"> <tt class="py-comment"># We didn't find any package containing `name`; so just return</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># `name` as-is.</tt> </tt>
<a name="L1081"></a><tt class="py-lineno">1081</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-448" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-448', 'name', 'link-31');">name</a></tt> </tt>
</div><a name="L1082"></a><tt class="py-lineno">1082</tt> <tt class="py-line"> </tt>
<a name="L1083"></a><tt class="py-lineno">1083</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: assignment</tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_assignment"></a><div id="process_assignment-def"><a name="L1087"></a><tt class="py-lineno">1087</tt> <a class="py-toggle" href="#" id="process_assignment-toggle" onclick="return toggle('process_assignment');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_assignment">process_assignment</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_assignment-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_assignment-expanded"><a name="L1089"></a><tt class="py-lineno">1089</tt> <tt class="py-line"> <tt class="py-comment"># Divide the assignment statement into its pieces.</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">pieces</tt> <tt class="py-op">=</tt> <tt id="link-449" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-449', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt> <tt class="py-line"> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt> <tt class="py-line"> <tt class="py-name">lhs_pieces</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-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt> <tt class="py-line"> <tt class="py-name">rhs</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-op">]</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt> <tt class="py-line"> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt> <tt class="py-line"> <tt class="py-comment"># Decide whether the variable is an instance variable or not.</tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># If it's an instance var, then discard the value.</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-450" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-450', 'is_instvar', 'link-302');">is_instvar</a></tt> <tt class="py-op">=</tt> <tt id="link-451" class="py-name" targets="Function epydoc.docparser.lhs_is_instvar()=epydoc.docparser-module.html#lhs_is_instvar"><a title="epydoc.docparser.lhs_is_instvar" class="py-name" href="#" onclick="return doclink('link-451', 'lhs_is_instvar', 'link-451');">lhs_is_instvar</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_pieces</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt> <tt class="py-line"> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt> <tt class="py-line"> <tt class="py-comment"># if it's not an instance var, and we're not in a namespace,</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># then it's just a local var -- so ignore it.</tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</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-op">(</tt><tt id="link-452" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-452', 'is_instvar', 'link-302');">is_instvar</a></tt> <tt class="py-keyword">or</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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 id="link-453" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-453', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt> <tt class="py-line"> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt> <tt class="py-line"> <tt class="py-comment"># Evaluate the right hand side.</tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-454" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-454', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt> <tt class="py-line"> <tt class="py-name">rhs_val</tt><tt class="py-op">,</tt> <tt id="link-455" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-455', 'is_alias', 'link-300');">is_alias</a></tt> <tt class="py-op">=</tt> <tt id="link-456" class="py-name" targets="Function epydoc.docparser.rhs_to_valuedoc()=epydoc.docparser-module.html#rhs_to_valuedoc"><a title="epydoc.docparser.rhs_to_valuedoc" class="py-name" href="#" onclick="return doclink('link-456', 'rhs_to_valuedoc', 'link-456');">rhs_to_valuedoc</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt> <tt class="py-line"> <tt class="py-name">rhs_val</tt><tt class="py-op">,</tt> <tt id="link-457" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-457', 'is_alias', 'link-300');">is_alias</a></tt> <tt class="py-op">=</tt> <tt id="link-458" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-458', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">,</tt> <tt class="py-name">False</tt> </tt>
<a name="L1109"></a><tt class="py-lineno">1109</tt> <tt class="py-line"> </tt>
<a name="L1110"></a><tt class="py-lineno">1110</tt> <tt class="py-line"> <tt class="py-comment"># Assign the right hand side value to each left hand side.</tt> </tt>
<a name="L1111"></a><tt class="py-lineno">1111</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (Do the rightmost assignment first)</tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">lhs_pieces</tt><tt class="py-op">.</tt><tt class="py-name">reverse</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">lhs</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lhs_pieces</tt><tt class="py-op">:</tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt> <tt class="py-line"> <tt class="py-comment"># Try treating the LHS as a simple dotted name.</tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> <tt class="py-name">lhs_name</tt> <tt class="py-op">=</tt> <tt id="link-459" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-459', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs</tt><tt class="py-op">)</tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-name">lhs_name</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">lhs_name</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="L1118"></a><tt class="py-lineno">1118</tt> <tt class="py-line"> <tt class="py-name">lhs_parent</tt> <tt class="py-op">=</tt> <tt id="link-460" class="py-name"><a title="epydoc.docparser.get_lhs_parent" class="py-name" href="#" onclick="return doclink('link-460', 'get_lhs_parent', 'link-297');">get_lhs_parent</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">lhs_parent</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="L1120"></a><tt class="py-lineno">1120</tt> <tt class="py-line"> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt> <tt class="py-line"> <tt class="py-comment"># Skip a special class variable.</tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">lhs_name</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-string">'__slots__'</tt><tt class="py-op">:</tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt> <tt class="py-line"> <tt class="py-keyword">continue</tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt> <tt class="py-line"> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt> <tt class="py-line"> <tt class="py-comment"># Create the VariableDoc.</tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-461" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-461', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-462" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-462', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">lhs_name</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 id="link-463" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-463', 'value', 'link-135');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">rhs_val</tt><tt class="py-op">,</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt> <tt class="py-line"> <tt id="link-464" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-464', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-465" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-465', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt id="link-466" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-466', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt> <tt class="py-line"> <tt id="link-467" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-467', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">=</tt><tt id="link-468" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-468', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt> <tt class="py-line"> <tt id="link-469" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-469', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1130"></a><tt class="py-lineno">1130</tt> <tt class="py-line"> <tt class="py-comment"># Extract a docstring from the comments, when present,</tt> </tt>
<a name="L1131"></a><tt class="py-lineno">1131</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># but only if there's a single LHS.</tt> </tt>
<a name="L1132"></a><tt class="py-lineno">1132</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">lhs_pieces</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="L1133"></a><tt class="py-lineno">1133</tt> <tt class="py-line"> <tt id="link-470" class="py-name" targets="Function epydoc.docparser.add_docstring_from_comments()=epydoc.docparser-module.html#add_docstring_from_comments"><a title="epydoc.docparser.add_docstring_from_comments" class="py-name" href="#" onclick="return doclink('link-470', 'add_docstring_from_comments', 'link-470');">add_docstring_from_comments</a></tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">comments</tt><tt class="py-op">)</tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt> <tt class="py-line"> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt> <tt class="py-line"> <tt class="py-comment"># Assign the variable to the containing namespace,</tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># *unless* the variable is an instance variable</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># without a comment docstring. In that case, we'll</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># only want to add it if we later discover that it's</tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># followed by a variable docstring. If it is, then</tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># process_docstring will take care of adding it to the</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># containing clas. (This is a little hackish, but</tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># unfortunately is necessary because we won't know if</tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># this assignment line is followed by a docstring</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># until later.)</tt> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt id="link-471" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-471', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">comments</tt><tt class="py-op">:</tt> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt> <tt class="py-line"> <tt id="link-472" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-472', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_parent</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1147"></a><tt class="py-lineno">1147</tt> <tt class="py-line"> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt> <tt class="py-line"> <tt class="py-comment"># If it's the only var, then return the VarDoc for use</tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># as the new `prev_line_doc`.</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</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">len</tt><tt class="py-op">(</tt><tt class="py-name">lhs_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>
<a name="L1151"></a><tt class="py-lineno">1151</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lhs_name</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt> <tt class="py-keyword">or</tt> <tt id="link-473" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-473', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">)</tt><tt class="py-op">)</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">return</tt> <tt class="py-name">var_doc</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt> <tt class="py-line"> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, the LHS must be a complex expression; use</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># dotted_names_in() to decide what variables it contains,</tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># and create VariableDoc's for all of them (with UNKNOWN</tt> </tt>
<a name="L1157"></a><tt class="py-lineno">1157</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># value).</tt> </tt>
<a name="L1158"></a><tt class="py-lineno">1158</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1159"></a><tt class="py-lineno">1159</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">lhs_name</tt> <tt class="py-keyword">in</tt> <tt id="link-474" class="py-name" targets="Function epydoc.docparser.dotted_names_in()=epydoc.docparser-module.html#dotted_names_in"><a title="epydoc.docparser.dotted_names_in" class="py-name" href="#" onclick="return doclink('link-474', 'dotted_names_in', 'link-474');">dotted_names_in</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_pieces</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt> <tt class="py-line"> <tt class="py-name">lhs_parent</tt> <tt class="py-op">=</tt> <tt id="link-475" class="py-name"><a title="epydoc.docparser.get_lhs_parent" class="py-name" href="#" onclick="return doclink('link-475', 'get_lhs_parent', 'link-297');">get_lhs_parent</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">lhs_parent</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="L1162"></a><tt class="py-lineno">1162</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-476" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-476', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-477" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-477', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">lhs_name</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="L1163"></a><tt class="py-lineno">1163</tt> <tt class="py-line"> <tt id="link-478" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-478', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt> <tt class="py-line"> <tt id="link-479" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-479', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt id="link-480" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-480', 'is_alias', 'link-300');">is_alias</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-481" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-481', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">=</tt><tt id="link-482" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-482', 'is_instvar', 'link-302');">is_instvar</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt> <tt class="py-line"> <tt id="link-483" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-483', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt> <tt class="py-line"> <tt id="link-484" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-484', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_parent</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt> <tt class="py-line"> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt> <tt class="py-line"> <tt class="py-comment"># If we have multiple left-hand-sides, then all but the</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># rightmost one are considered aliases.</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-485" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-485', 'is_alias', 'link-300');">is_alias</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L1172"></a><tt class="py-lineno">1172</tt> <tt class="py-line"> </tt>
<a name="L1173"></a><tt class="py-lineno">1173</tt> <tt class="py-line"> </tt>
<a name="lhs_is_instvar"></a><div id="lhs_is_instvar-def"><a name="L1174"></a><tt class="py-lineno">1174</tt> <a class="py-toggle" href="#" id="lhs_is_instvar-toggle" onclick="return toggle('lhs_is_instvar');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#lhs_is_instvar">lhs_is_instvar</a><tt class="py-op">(</tt><tt class="py-param">lhs_pieces</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="lhs_is_instvar-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="lhs_is_instvar-expanded"><a name="L1175"></a><tt class="py-lineno">1175</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">parent_docs</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 id="link-486" 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-486', 'RoutineDoc', 'link-486');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt> <tt class="py-line"> <tt class="py-comment"># make sure that lhs_pieces is <self>.<name>, where <self> is</tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the name of the first arg to the containing routinedoc, and</tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># <name> is a simple name.</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-487" 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-487', 'posargs', 'link-487');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</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 id="link-488" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-488', 'posargs', 'link-487');">posargs</a></tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-489" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-489', 'posargs', 'link-487');">posargs</a></tt> <tt class="py-keyword">is</tt> <tt id="link-490" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-490', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lhs_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">len</tt><tt class="py-op">(</tt><tt id="link-491" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-491', 'posargs', 'link-487');">posargs</a></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="L1183"></a><tt class="py-lineno">1183</tt> <tt class="py-line"> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">lhs_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-op">==</tt> <tt class="py-number">3</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt> <tt class="py-line"> <tt class="py-name">lhs_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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt id="link-492" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-492', 'posargs', 'link-487');">posargs</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-keyword">and</tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt> <tt class="py-line"> <tt class="py-name">lhs_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-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'.'</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt> <tt class="py-line"> <tt class="py-name">lhs_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-number">2</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt> <tt class="py-line"> <tt class="py-comment"># Make sure we're in an instance method, and not a</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># module-level function.</tt> </tt>
<a name="L1190"></a><tt class="py-lineno">1190</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">parent_docs</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 class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1191"></a><tt class="py-lineno">1191</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">parent_docs</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-493" 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-493', 'ClassDoc', 'link-493');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1192"></a><tt class="py-lineno">1192</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">parent_docs</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">parent_docs</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="L1194"></a><tt class="py-lineno">1194</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1196"></a><tt class="py-lineno">1196</tt> <tt class="py-line"> </tt>
<a name="rhs_to_valuedoc"></a><div id="rhs_to_valuedoc-def"><a name="L1197"></a><tt class="py-lineno">1197</tt> <a class="py-toggle" href="#" id="rhs_to_valuedoc-toggle" onclick="return toggle('rhs_to_valuedoc');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#rhs_to_valuedoc">rhs_to_valuedoc</a><tt class="py-op">(</tt><tt class="py-param">rhs</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="rhs_to_valuedoc-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="rhs_to_valuedoc-expanded"><a name="L1198"></a><tt class="py-lineno">1198</tt> <tt class="py-line"> <tt class="py-comment"># Dotted variable:</tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt> <tt class="py-line"> <tt class="py-name">rhs_name</tt> <tt class="py-op">=</tt> <tt id="link-494" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-494', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</tt><tt class="py-op">)</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt> <tt class="py-line"> <tt class="py-name">rhs_val</tt> <tt class="py-op">=</tt> <tt id="link-495" class="py-name" targets="Function epydoc.docparser.lookup_value()=epydoc.docparser-module.html#lookup_value"><a title="epydoc.docparser.lookup_value" class="py-name" href="#" onclick="return doclink('link-495', 'lookup_value', 'link-495');">lookup_value</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">rhs_val</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 class="py-name">rhs_val</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-496" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-496', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">rhs_val</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-497" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-497', 'ParseError', 'link-87');">ParseError</a></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">pass</tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt> <tt class="py-line"> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt> <tt class="py-line"> <tt class="py-comment"># Decorators:</tt> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</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">len</tt><tt class="py-op">(</tt><tt class="py-name">rhs</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-number">2</tt> <tt class="py-keyword">and</tt> <tt class="py-name">rhs</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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt> <tt class="py-line"> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">rhs</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">list</tt><tt class="py-op">)</tt><tt class="py-op">)</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">arg_val</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt> <tt class="py-op">=</tt> <tt id="link-498" class="py-name"><a title="epydoc.docparser.rhs_to_valuedoc" class="py-name" href="#" onclick="return doclink('link-498', 'rhs_to_valuedoc', 'link-456');">rhs_to_valuedoc</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</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 class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</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">arg_val</tt><tt class="py-op">,</tt> <tt id="link-499" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-499', 'RoutineDoc', 'link-486');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt id="link-500" class="py-name" targets="Function epydoc.docparser.apply_decorator()=epydoc.docparser-module.html#apply_decorator"><a title="epydoc.docparser.apply_decorator" class="py-name" href="#" onclick="return doclink('link-500', 'apply_decorator', 'link-500');">apply_decorator</a></tt><tt class="py-op">(</tt><tt id="link-501" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-501', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</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-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">arg_val</tt><tt class="py-op">)</tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-502" 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-502', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-503" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-503', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-504" 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-504', 'parse_repr', 'link-504');">parse_repr</a></tt> <tt class="py-op">=</tt> <tt id="link-505" class="py-name" targets="Function epydoc.docparser.pp_toktree()=epydoc.docparser-module.html#pp_toktree"><a title="epydoc.docparser.pp_toktree" class="py-name" href="#" onclick="return doclink('link-505', 'pp_toktree', 'link-505');">pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</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">return</tt> <tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt> <tt class="py-line"> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt> <tt class="py-line"> <tt class="py-comment"># Nothing else to do: make a val with the source as its repr.</tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-506" 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-506', 'GenericValueDoc', 'link-506');">GenericValueDoc</a></tt><tt class="py-op">(</tt><tt id="link-507" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-507', 'parse_repr', 'link-504');">parse_repr</a></tt><tt class="py-op">=</tt><tt id="link-508" class="py-name"><a title="epydoc.docparser.pp_toktree" class="py-name" href="#" onclick="return doclink('link-508', 'pp_toktree', 'link-505');">pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">rhs</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-509" class="py-name"><a title="epydoc.apidoc.ValueDoc.toktree" class="py-name" href="#" onclick="return doclink('link-509', 'toktree', 'link-98');">toktree</a></tt><tt class="py-op">=</tt><tt class="py-name">rhs</tt><tt class="py-op">,</tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt> <tt class="py-line"> <tt id="link-510" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-510', 'defining_module', 'link-79');">defining_module</a></tt><tt class="py-op">=</tt><tt class="py-name">parent_docs</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="L1220"></a><tt class="py-lineno">1220</tt> <tt class="py-line"> <tt id="link-511" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-511', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L1221"></a><tt class="py-lineno">1221</tt> <tt class="py-line"> </tt>
<a name="get_lhs_parent"></a><div id="get_lhs_parent-def"><a name="L1222"></a><tt class="py-lineno">1222</tt> <a class="py-toggle" href="#" id="get_lhs_parent-toggle" onclick="return toggle('get_lhs_parent');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#get_lhs_parent">get_lhs_parent</a><tt class="py-op">(</tt><tt class="py-param">lhs_name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_lhs_parent-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_lhs_parent-expanded"><a name="L1223"></a><tt class="py-lineno">1223</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">lhs_name</tt><tt class="py-op">,</tt> <tt id="link-512" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-512', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt> <tt class="py-line"> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt> <tt class="py-line"> <tt class="py-comment"># For instance vars inside an __init__ method:</tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</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">parent_docs</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 id="link-513" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-513', 'RoutineDoc', 'link-486');">RoutineDoc</a></tt><tt class="py-op">)</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">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">parent_docs</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 class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1228"></a><tt class="py-lineno">1228</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">parent_docs</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-514" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-514', 'ClassDoc', 'link-493');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L1230"></a><tt class="py-lineno">1230</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1231"></a><tt class="py-lineno">1231</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 is not a namespace or method"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1232"></a><tt class="py-lineno">1232</tt> <tt class="py-line"> <tt class="py-name">parent_docs</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="L1233"></a><tt class="py-lineno">1233</tt> <tt class="py-line"> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt> <tt class="py-line"> <tt class="py-comment"># For local variables:</tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</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">lhs_name</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="L1236"></a><tt class="py-lineno">1236</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parent_docs</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="L1237"></a><tt class="py-lineno">1237</tt> <tt class="py-line"> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt> <tt class="py-line"> <tt class="py-comment"># For non-local variables:</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-515" class="py-name"><a title="epydoc.docparser.lookup_value" class="py-name" href="#" onclick="return doclink('link-515', 'lookup_value', 'link-495');">lookup_value</a></tt><tt class="py-op">(</tt><tt class="py-name">lhs_name</tt><tt class="py-op">.</tt><tt id="link-516" 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-516', 'container', 'link-250');">container</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1240"></a><tt class="py-lineno">1240</tt> <tt class="py-line"> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: single-line blocks</tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_one_line_block"></a><div id="process_one_line_block-def"><a name="L1245"></a><tt class="py-lineno">1245</tt> <a class="py-toggle" href="#" id="process_one_line_block-toggle" onclick="return toggle('process_one_line_block');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_one_line_block">process_one_line_block</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_one_line_block-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_one_line_block-expanded"><a name="L1247"></a><tt class="py-lineno">1247</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt> <tt class="py-line"><tt class="py-docstring"> The line handler for single-line blocks, such as:</tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt> <tt class="py-line"><tt class="py-docstring"> >>> def f(x): return x*2</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt> <tt class="py-line"><tt class="py-docstring"> This handler calls L{process_line} twice: once for the tokens</tt> </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt> <tt class="py-line"><tt class="py-docstring"> up to and including the colon, and once for the remaining</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt> <tt class="py-line"><tt class="py-docstring"> tokens. The comment docstring is applied to the first line</tt> </tt>
<a name="L1255"></a><tt class="py-lineno">1255</tt> <tt class="py-line"><tt class="py-docstring"> only.</tt> </tt>
<a name="L1256"></a><tt class="py-lineno">1256</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{None}</tt> </tt>
<a name="L1257"></a><tt class="py-lineno">1257</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt> <tt class="py-line"> <tt class="py-name">i</tt> <tt class="py-op">=</tt> <tt class="py-name">line</tt><tt class="py-op">.</tt><tt class="py-name">index</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">':'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt> <tt class="py-line"> <tt class="py-name">doc1</tt> <tt class="py-op">=</tt> <tt id="link-517" class="py-name"><a title="epydoc.docparser.process_line" class="py-name" href="#" onclick="return doclink('link-517', 'process_line', 'link-237');">process_line</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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-number">1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt> <tt class="py-line"> <tt id="link-518" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-518', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">comments</tt><tt class="py-op">,</tt> <tt id="link-519" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-519', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt> <tt class="py-line"> <tt class="py-name">doc2</tt> <tt class="py-op">=</tt> <tt id="link-520" class="py-name"><a title="epydoc.docparser.process_line" class="py-name" href="#" onclick="return doclink('link-520', 'process_line', 'link-237');">process_line</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">+</tt><tt class="py-op">[</tt><tt class="py-name">doc1</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
<a name="L1262"></a><tt class="py-lineno">1262</tt> <tt class="py-line"> <tt class="py-name">doc1</tt><tt class="py-op">,</tt> <tt id="link-521" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-521', 'lineno', 'link-207');">lineno</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 class="py-op">,</tt> <tt class="py-name">encoding</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">return</tt> <tt class="py-name">doc1</tt> </tt>
</div><a name="L1264"></a><tt class="py-lineno">1264</tt> <tt class="py-line"> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: semicolon-separated statements</tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_multi_stmt"></a><div id="process_multi_stmt-def"><a name="L1269"></a><tt class="py-lineno">1269</tt> <a class="py-toggle" href="#" id="process_multi_stmt-toggle" onclick="return toggle('process_multi_stmt');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_multi_stmt">process_multi_stmt</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_multi_stmt-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_multi_stmt-expanded"><a name="L1271"></a><tt class="py-lineno">1271</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1272"></a><tt class="py-lineno">1272</tt> <tt class="py-line"><tt class="py-docstring"> The line handler for semicolon-separated statements, such as:</tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1274"></a><tt class="py-lineno">1274</tt> <tt class="py-line"><tt class="py-docstring"> >>> x=1; y=2; z=3</tt> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt> <tt class="py-line"><tt class="py-docstring"> This handler calls L{process_line} once for each statement.</tt> </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt> <tt class="py-line"><tt class="py-docstring"> The comment docstring is not passed on to any of the</tt> </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt> <tt class="py-line"><tt class="py-docstring"> sub-statements.</tt> </tt>
<a name="L1279"></a><tt class="py-lineno">1279</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{None}</tt> </tt>
<a name="L1280"></a><tt class="py-lineno">1280</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1281"></a><tt class="py-lineno">1281</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">statement</tt> <tt class="py-keyword">in</tt> <tt id="link-522" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-522', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1282"></a><tt class="py-lineno">1282</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">statement</tt><tt class="py-op">:</tt> <tt class="py-keyword">continue</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt> <tt class="py-line"> <tt class="py-name">doc</tt> <tt class="py-op">=</tt> <tt id="link-523" class="py-name"><a title="epydoc.docparser.process_line" class="py-name" href="#" onclick="return doclink('link-523', 'process_line', 'link-237');">process_line</a></tt><tt class="py-op">(</tt><tt class="py-name">statement</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt> <tt class="py-line"> <tt id="link-524" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-524', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-525" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-525', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">,</tt> <tt class="py-name">encoding</tt><tt class="py-op">)</tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt> <tt class="py-line"> <tt id="link-526" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-526', 'decorators', 'link-208');">decorators</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1287"></a><tt class="py-lineno">1287</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1288"></a><tt class="py-lineno">1288</tt> <tt class="py-line"> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: delete statements</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_del"></a><div id="process_del-def"><a name="L1293"></a><tt class="py-lineno">1293</tt> <a class="py-toggle" href="#" id="process_del-toggle" onclick="return toggle('process_del');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_del">process_del</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_del-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_del-expanded"><a name="L1295"></a><tt class="py-lineno">1295</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</tt> <tt class="py-line"><tt class="py-docstring"> The line handler for delete statements, such as:</tt> </tt>
<a name="L1297"></a><tt class="py-lineno">1297</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1298"></a><tt class="py-lineno">1298</tt> <tt class="py-line"><tt class="py-docstring"> >>> del x, y.z</tt> </tt>
<a name="L1299"></a><tt class="py-lineno">1299</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1300"></a><tt class="py-lineno">1300</tt> <tt class="py-line"><tt class="py-docstring"> This handler calls L{del_variable} for each dotted variable in</tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt> <tt class="py-line"><tt class="py-docstring"> the variable list. The variable list may be nested. Complex</tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt> <tt class="py-line"><tt class="py-docstring"> expressions in the variable list (such as C{x[3]}) are ignored.</tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt> <tt class="py-line"><tt class="py-docstring"> @return: C{None}</tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt> <tt class="py-line"> <tt class="py-comment"># If we're not in a namespace, then ignore it.</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</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="L1307"></a><tt class="py-lineno">1307</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">parent_doc</tt><tt class="py-op">,</tt> <tt id="link-527" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-527', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt> <tt class="py-line"> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt> <tt class="py-line"> <tt class="py-name">var_list</tt> <tt class="py-op">=</tt> <tt id="link-528" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-528', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">var_name</tt> <tt class="py-keyword">in</tt> <tt id="link-529" class="py-name"><a title="epydoc.docparser.dotted_names_in" class="py-name" href="#" onclick="return doclink('link-529', 'dotted_names_in', 'link-474');">dotted_names_in</a></tt><tt class="py-op">(</tt><tt class="py-name">var_list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1311"></a><tt class="py-lineno">1311</tt> <tt class="py-line"> <tt id="link-530" class="py-name" targets="Function epydoc.docparser.del_variable()=epydoc.docparser-module.html#del_variable"><a title="epydoc.docparser.del_variable" class="py-name" href="#" onclick="return doclink('link-530', 'del_variable', 'link-530');">del_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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">var_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1312"></a><tt class="py-lineno">1312</tt> <tt class="py-line"> </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1314"></a><tt class="py-lineno">1314</tt> <tt class="py-line"> </tt>
<a name="L1315"></a><tt class="py-lineno">1315</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1316"></a><tt class="py-lineno">1316</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: docstrings</tt> </tt>
<a name="L1317"></a><tt class="py-lineno">1317</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_docstring"></a><div id="process_docstring-def"><a name="L1319"></a><tt class="py-lineno">1319</tt> <a class="py-toggle" href="#" id="process_docstring-toggle" onclick="return toggle('process_docstring');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_docstring">process_docstring</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_docstring-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_docstring-expanded"><a name="L1321"></a><tt class="py-lineno">1321</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt> <tt class="py-line"><tt class="py-docstring"> The line handler for bare string literals. If</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</tt> <tt class="py-line"><tt class="py-docstring"> C{prev_line_doc} is not C{None}, then the string literal is</tt> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</tt> <tt class="py-line"><tt class="py-docstring"> added to that C{APIDoc} as a docstring. If it already has a</tt> </tt>
<a name="L1325"></a><tt class="py-lineno">1325</tt> <tt class="py-line"><tt class="py-docstring"> docstring (from comment docstrings), then the new docstring</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt> <tt class="py-line"><tt class="py-docstring"> will be appended to the old one.</tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">prev_line_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt> <tt class="py-line"> <tt id="link-531" 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-531', 'docstring', 'link-531');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-532" class="py-name"><a title="epydoc.docparser.parse_string" class="py-name" href="#" onclick="return doclink('link-532', 'parse_string', 'link-102');">parse_string</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt> <tt class="py-line"> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt> <tt class="py-line"> <tt class="py-comment"># If the docstring is a str, then convert it to unicode.</tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># According to a strict reading of PEP 263, this might not be the</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># right thing to do; but it will almost always be what the</tt> </tt>
<a name="L1334"></a><tt class="py-lineno">1334</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># module's author intended.</tt> </tt>
<a name="L1335"></a><tt class="py-lineno">1335</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 id="link-533" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-533', 'docstring', 'link-531');">docstring</a></tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1336"></a><tt class="py-lineno">1336</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt> <tt class="py-line"> <tt id="link-534" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-534', 'docstring', 'link-531');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-535" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-535', 'docstring', 'link-531');">docstring</a></tt><tt class="py-op">.</tt><tt class="py-name">decode</tt><tt class="py-op">(</tt><tt class="py-name">encoding</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">except</tt> <tt class="py-name">UnicodeDecodeError</tt><tt class="py-op">:</tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt> <tt class="py-line"> <tt class="py-comment"># If decoding failed, then fall back on using</tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># decode_with_backslashreplace, which will map e.g.</tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># "\xe9" -> u"\\xe9".</tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-536" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-536', 'docstring', 'link-531');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-537" class="py-name"><a title="epydoc.util.decode_with_backslashreplace" class="py-name" href="#" onclick="return doclink('link-537', 'decode_with_backslashreplace', 'link-234');">decode_with_backslashreplace</a></tt><tt class="py-op">(</tt><tt id="link-538" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-538', 'docstring', 'link-531');">docstring</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1343"></a><tt class="py-lineno">1343</tt> <tt class="py-line"> <tt id="link-539" 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-539', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-540" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-540', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"While parsing %s: docstring is not a unicode "</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt> <tt class="py-line"> <tt class="py-string">"string, but it contains non-ascii data."</tt> <tt class="py-op">%</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-541" 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-541', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt> <tt class="py-line"> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt> <tt class="py-line"> <tt class="py-comment"># If the modified APIDoc is an instance variable, and it has</tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># not yet been added to its class's C{variables} list,</tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># then add it now. This is done here, rather than in the</tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># process_assignment() call that created the variable, because</tt> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># we only want to add instance variables if they have an</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># associated docstring. (For more info, see the comment above</tt> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the set_variable() call in process_assignment().)</tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">added_instvar</tt> <tt class="py-op">=</tt> <tt class="py-name">False</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-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">prev_line_doc</tt><tt class="py-op">,</tt> <tt id="link-542" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-542', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-543" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_instvar" class="py-name" href="#" onclick="return doclink('link-543', 'is_instvar', 'link-302');">is_instvar</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-544" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-544', 'docstring', 'link-531');">docstring</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-545" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-545', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt> <tt class="py-line"> <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">parent_docs</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 class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1359"></a><tt class="py-lineno">1359</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">parent_docs</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-546" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-546', 'ClassDoc', 'link-493');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1360"></a><tt class="py-lineno">1360</tt> <tt class="py-line"> <tt id="link-547" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-547', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt> <tt class="py-line"> <tt class="py-name">added_instvar</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L1362"></a><tt class="py-lineno">1362</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
<a name="L1363"></a><tt class="py-lineno">1363</tt> <tt class="py-line"> </tt>
<a name="L1364"></a><tt class="py-lineno">1364</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-548" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-548', 'docstring', 'link-531');">docstring</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-549" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-549', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt> <tt class="py-line"> <tt id="link-550" 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-550', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-551" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-551', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s has both a comment-docstring and a normal "</tt> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt> <tt class="py-line"> <tt class="py-string">"(string) docstring; ignoring the comment-"</tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt> <tt class="py-line"> <tt class="py-string">"docstring."</tt> <tt class="py-op">%</tt> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-552" 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-552', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1368"></a><tt class="py-lineno">1368</tt> <tt class="py-line"> </tt>
<a name="L1369"></a><tt class="py-lineno">1369</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-553" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-553', 'docstring', 'link-531');">docstring</a></tt> <tt class="py-op">=</tt> <tt id="link-554" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-554', 'docstring', 'link-531');">docstring</a></tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt> <tt class="py-line"> <tt class="py-name">prev_line_doc</tt><tt class="py-op">.</tt><tt id="link-555" 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-555', 'docstring_lineno', 'link-555');">docstring_lineno</a></tt> <tt class="py-op">=</tt> <tt id="link-556" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-556', 'lineno', 'link-207');">lineno</a></tt> </tt>
<a name="L1371"></a><tt class="py-lineno">1371</tt> <tt class="py-line"> </tt>
<a name="L1372"></a><tt class="py-lineno">1372</tt> <tt class="py-line"> <tt class="py-comment"># If the modified APIDoc is an instance variable, and we added it</tt> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># to the class's variables list here, then it still needs to be</tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># grouped too; so return it for use as the new "prev_line_doc."</tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">added_instvar</tt><tt class="py-op">:</tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">prev_line_doc</tt> </tt>
</div><a name="L1377"></a><tt class="py-lineno">1377</tt> <tt class="py-line"> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</tt> <tt class="py-line"> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: function declarations</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_funcdef"></a><div id="process_funcdef-def"><a name="L1383"></a><tt class="py-lineno">1383</tt> <a class="py-toggle" href="#" id="process_funcdef-toggle" onclick="return toggle('process_funcdef');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_funcdef">process_funcdef</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_funcdef-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_funcdef-expanded"><a name="L1385"></a><tt class="py-lineno">1385</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt> <tt class="py-line"><tt class="py-docstring"> The line handler for function declaration lines, such as:</tt> </tt>
<a name="L1387"></a><tt class="py-lineno">1387</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1388"></a><tt class="py-lineno">1388</tt> <tt class="py-line"><tt class="py-docstring"> >>> def f(a, b=22, (c,d)):</tt> </tt>
<a name="L1389"></a><tt class="py-lineno">1389</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt> <tt class="py-line"><tt class="py-docstring"> This handler creates and initializes a new C{VariableDoc}</tt> </tt>
<a name="L1391"></a><tt class="py-lineno">1391</tt> <tt class="py-line"><tt class="py-docstring"> containing a C{RoutineDoc}, adds the C{VariableDoc} to the</tt> </tt>
<a name="L1392"></a><tt class="py-lineno">1392</tt> <tt class="py-line"><tt class="py-docstring"> containing namespace, and returns the C{RoutineDoc}.</tt> </tt>
<a name="L1393"></a><tt class="py-lineno">1393</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1394"></a><tt class="py-lineno">1394</tt> <tt class="py-line"> <tt class="py-comment"># Check syntax.</tt> </tt>
<a name="L1395"></a><tt class="py-lineno">1395</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">line</tt><tt class="py-op">)</tt> <tt class="py-op">!=</tt> <tt class="py-number">4</tt> <tt class="py-keyword">or</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">3</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">':'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-557" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-557', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad function definition line"</tt><tt class="py-op">)</tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt> <tt class="py-line"> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt> <tt class="py-line"> <tt class="py-comment"># If we're not in a namespace, then ignore it.</tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</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="L1400"></a><tt class="py-lineno">1400</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">parent_doc</tt><tt class="py-op">,</tt> <tt id="link-558" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-558', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1401"></a><tt class="py-lineno">1401</tt> <tt class="py-line"> </tt>
<a name="L1402"></a><tt class="py-lineno">1402</tt> <tt class="py-line"> <tt class="py-comment"># Get the function's name</tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">func_name</tt> <tt class="py-op">=</tt> <tt id="link-559" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-559', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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="L1404"></a><tt class="py-lineno">1404</tt> <tt class="py-line"> <tt id="link-560" 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-560', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-561" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-561', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_doc</tt><tt class="py-op">.</tt><tt id="link-562" 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-562', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">func_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt> <tt class="py-line"> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt> <tt class="py-line"> <tt class="py-comment"># Create the function's RoutineDoc.</tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">func_doc</tt> <tt class="py-op">=</tt> <tt id="link-563" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-563', 'RoutineDoc', 'link-486');">RoutineDoc</a></tt><tt class="py-op">(</tt><tt id="link-564" 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-564', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">=</tt><tt id="link-565" 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-565', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt> <tt class="py-line"> <tt id="link-566" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-566', 'defining_module', 'link-79');">defining_module</a></tt><tt class="py-op">=</tt><tt class="py-name">parent_docs</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="L1409"></a><tt class="py-lineno">1409</tt> <tt class="py-line"> <tt id="link-567" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-567', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">=</tt><tt id="link-568" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-568', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">,</tt> <tt id="link-569" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-569', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1410"></a><tt class="py-lineno">1410</tt> <tt class="py-line"> </tt>
<a name="L1411"></a><tt class="py-lineno">1411</tt> <tt class="py-line"> <tt class="py-comment"># Process the signature.</tt> </tt>
<a name="L1412"></a><tt class="py-lineno">1412</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-570" class="py-name" targets="Function epydoc.docparser.init_arglist()=epydoc.docparser-module.html#init_arglist"><a title="epydoc.docparser.init_arglist" class="py-name" href="#" onclick="return doclink('link-570', 'init_arglist', 'link-570');">init_arglist</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">,</tt> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1413"></a><tt class="py-lineno">1413</tt> <tt class="py-line"> </tt>
<a name="L1414"></a><tt class="py-lineno">1414</tt> <tt class="py-line"> <tt class="py-comment"># If the preceeding comment includes a docstring, then add it.</tt> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-571" class="py-name"><a title="epydoc.docparser.add_docstring_from_comments" class="py-name" href="#" onclick="return doclink('link-571', 'add_docstring_from_comments', 'link-470');">add_docstring_from_comments</a></tt><tt class="py-op">(</tt><tt class="py-name">func_doc</tt><tt class="py-op">,</tt> <tt class="py-name">comments</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-comment"># Apply any decorators.</tt> </tt>
<a name="L1418"></a><tt class="py-lineno">1418</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">func_doc</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-208');">decorators</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-573" class="py-name"><a title="epydoc.docparser.pp_toktree" class="py-name" href="#" onclick="return doclink('link-573', 'pp_toktree', 'link-505');">pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">deco</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-keyword">for</tt> <tt class="py-name">deco</tt> <tt class="py-keyword">in</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-208');">decorators</a></tt><tt class="py-op">]</tt> </tt>
<a name="L1419"></a><tt class="py-lineno">1419</tt> <tt class="py-line"> <tt id="link-575" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-575', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">.</tt><tt class="py-name">reverse</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">decorator</tt> <tt class="py-keyword">in</tt> <tt id="link-576" class="py-name"><a title="epydoc.apidoc.RoutineDoc.decorators" class="py-name" href="#" onclick="return doclink('link-576', 'decorators', 'link-208');">decorators</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt> <tt class="py-line"> <tt class="py-keyword">try</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">deco_name</tt> <tt class="py-op">=</tt> <tt id="link-577" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-577', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">decorator</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="L1423"></a><tt class="py-lineno">1423</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-578" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-578', 'ParseError', 'link-87');">ParseError</a></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">deco_name</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-579" 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-579', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-580" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-580', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1426"></a><tt class="py-lineno">1426</tt> <tt class="py-line"> <tt class="py-name">deco_repr</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-581" class="py-name"><a title="epydoc.docparser.pp_toktree" class="py-name" href="#" onclick="return doclink('link-581', 'pp_toktree', 'link-505');">pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">decorator</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>
<a name="L1427"></a><tt class="py-lineno">1427</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-582" 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-582', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">)</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">func_doc</tt><tt class="py-op">.</tt><tt id="link-583" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-583', 'parse_repr', 'link-504');">parse_repr</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-584" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-584', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt> <tt class="py-line"> <tt class="py-comment"># [xx] this case should be improved.. when will func_doc</tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># have a known parse_repr??</tt> </tt>
<a name="L1431"></a><tt class="py-lineno">1431</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">deco_repr</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-585" class="py-name"><a title="epydoc.docparser.pp_toktree" class="py-name" href="#" onclick="return doclink('link-585', 'pp_toktree', 'link-505');">pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">decorator</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>
<a name="L1432"></a><tt class="py-lineno">1432</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-586" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-586', 'parse_repr', 'link-504');">parse_repr</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1433"></a><tt class="py-lineno">1433</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt> <tt class="py-line"> <tt class="py-name">deco_repr</tt> <tt class="py-op">=</tt> <tt id="link-587" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-587', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt> <tt class="py-op">=</tt> <tt id="link-588" class="py-name"><a title="epydoc.docparser.apply_decorator" class="py-name" href="#" onclick="return doclink('link-588', 'apply_decorator', 'link-500');">apply_decorator</a></tt><tt class="py-op">(</tt><tt class="py-name">deco_name</tt><tt class="py-op">,</tt> <tt class="py-name">func_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-589" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-589', 'parse_repr', 'link-504');">parse_repr</a></tt> <tt class="py-op">=</tt> <tt class="py-name">deco_repr</tt> </tt>
<a name="L1437"></a><tt class="py-lineno">1437</tt> <tt class="py-line"> <tt class="py-comment"># [XX] Is there a reson the following should be done? It</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># causes the grouping code to break. Presumably the canonical</tt> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># name should remain valid if we're just applying a standard</tt> </tt>
<a name="L1440"></a><tt class="py-lineno">1440</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># decorator.</tt> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#func_doc.canonical_name = UNKNOWN</tt> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt> <tt class="py-line"> <tt class="py-comment"># Add a variable to the containing namespace.</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-590" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-590', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-591" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-591', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">func_name</tt><tt class="py-op">,</tt> <tt id="link-592" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-592', 'value', 'link-135');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">func_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L1445"></a><tt class="py-lineno">1445</tt> <tt class="py-line"> <tt id="link-593" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-593', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-594" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-594', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1446"></a><tt class="py-lineno">1446</tt> <tt class="py-line"> <tt id="link-595" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-595', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt> <tt class="py-line"> <tt id="link-596" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-596', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_doc</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt> <tt class="py-line"> </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt> <tt class="py-line"> <tt class="py-comment"># Return the new ValueDoc.</tt> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">func_doc</tt> </tt>
</div><a name="L1451"></a><tt class="py-lineno">1451</tt> <tt class="py-line"> </tt>
<a name="apply_decorator"></a><div id="apply_decorator-def"><a name="L1452"></a><tt class="py-lineno">1452</tt> <a class="py-toggle" href="#" id="apply_decorator-toggle" onclick="return toggle('apply_decorator');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#apply_decorator">apply_decorator</a><tt class="py-op">(</tt><tt class="py-param">decorator_name</tt><tt class="py-op">,</tt> <tt class="py-param">func_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="apply_decorator-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="apply_decorator-expanded"><a name="L1453"></a><tt class="py-lineno">1453</tt> <tt class="py-line"> <tt class="py-comment"># [xx] what if func_doc is not a RoutineDoc?</tt> </tt>
<a name="L1454"></a><tt class="py-lineno">1454</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">decorator_name</tt> <tt class="py-op">==</tt> <tt id="link-597" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-597', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'staticmethod'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-598" 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-598', 'StaticMethodDoc', 'link-598');">StaticMethodDoc</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">decorator_name</tt> <tt class="py-op">==</tt> <tt id="link-599" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-599', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-string">'classmethod'</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">return</tt> <tt id="link-600" 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-600', 'ClassMethodDoc', 'link-600');">ClassMethodDoc</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</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">elif</tt> <tt id="link-601" class="py-name"><a title="epydoc.docparser.DEFAULT_DECORATOR_BEHAVIOR" class="py-name" href="#" onclick="return doclink('link-601', 'DEFAULT_DECORATOR_BEHAVIOR', 'link-19');">DEFAULT_DECORATOR_BEHAVIOR</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'transparent'</tt><tt class="py-op">:</tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">func_doc</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-name">func_doc</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">)</tt> <tt class="py-comment"># make a copy.</tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-602" class="py-name"><a title="epydoc.docparser.DEFAULT_DECORATOR_BEHAVIOR" class="py-name" href="#" onclick="return doclink('link-602', 'DEFAULT_DECORATOR_BEHAVIOR', 'link-19');">DEFAULT_DECORATOR_BEHAVIOR</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'opaque'</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">return</tt> <tt id="link-603" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-603', 'GenericValueDoc', 'link-506');">GenericValueDoc</a></tt><tt class="py-op">(</tt><tt id="link-604" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-604', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</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">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</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 for DEFAULT_DECORATOR_BEHAVIOR'</tt> </tt>
</div><a name="L1464"></a><tt class="py-lineno">1464</tt> <tt class="py-line"> </tt>
<a name="init_arglist"></a><div id="init_arglist-def"><a name="L1465"></a><tt class="py-lineno">1465</tt> <a class="py-toggle" href="#" id="init_arglist-toggle" onclick="return toggle('init_arglist');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#init_arglist">init_arglist</a><tt class="py-op">(</tt><tt class="py-param">func_doc</tt><tt class="py-op">,</tt> <tt class="py-param">arglist</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="init_arglist-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="init_arglist-expanded"><a name="L1466"></a><tt class="py-lineno">1466</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">arglist</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">arglist</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'('</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-605" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-605', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad argument list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1468"></a><tt class="py-lineno">1468</tt> <tt class="py-line"> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt> <tt class="py-line"> <tt class="py-comment"># Initialize to defaults.</tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-606" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-606', 'posargs', 'link-487');">posargs</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-607" 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-607', 'posarg_defaults', 'link-607');">posarg_defaults</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1472"></a><tt class="py-lineno">1472</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-608" 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-608', 'vararg', 'link-608');">vararg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-609" 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-609', 'kwarg', 'link-609');">kwarg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt> <tt class="py-line"> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt> <tt class="py-line"> <tt class="py-comment"># Divide the arglist into individual args.</tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt id="link-610" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-610', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">arglist</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 class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt> <tt class="py-line"> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt> <tt class="py-line"> <tt class="py-comment"># Keyword argument.</tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt> <tt class="py-keyword">and</tt> <tt class="py-name">args</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">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'**'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</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">args</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 class="py-number">2</tt> <tt class="py-keyword">or</tt> <tt class="py-name">args</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 class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</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">raise</tt> <tt id="link-611" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-611', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected name after ** in argument list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-612" class="py-name"><a title="epydoc.apidoc.RoutineDoc.kwarg" class="py-name" href="#" onclick="return doclink('link-612', 'kwarg', 'link-609');">kwarg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">args</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 class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1483"></a><tt class="py-lineno">1483</tt> <tt class="py-line"> <tt class="py-name">args</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="L1484"></a><tt class="py-lineno">1484</tt> <tt class="py-line"> </tt>
<a name="L1485"></a><tt class="py-lineno">1485</tt> <tt class="py-line"> <tt class="py-comment"># Vararg argument.</tt> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt> <tt class="py-keyword">and</tt> <tt class="py-name">args</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">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'*'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1487"></a><tt class="py-lineno">1487</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">args</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 class="py-number">2</tt> <tt class="py-keyword">or</tt> <tt class="py-name">args</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 class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">:</tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-613" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-613', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected name after * in argument list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-614" class="py-name"><a title="epydoc.apidoc.RoutineDoc.vararg" class="py-name" href="#" onclick="return doclink('link-614', 'vararg', 'link-608');">vararg</a></tt> <tt class="py-op">=</tt> <tt class="py-name">args</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 class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt> <tt class="py-line"> <tt class="py-name">args</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="L1491"></a><tt class="py-lineno">1491</tt> <tt class="py-line"> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt> <tt class="py-line"> <tt class="py-comment"># Positional arguments.</tt> </tt>
<a name="L1493"></a><tt class="py-lineno">1493</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt id="link-615" class="py-name" targets="Method epydoc.markup.Field.arg()=epydoc.markup.Field-class.html#arg"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-615', 'arg', 'link-615');">arg</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L1494"></a><tt class="py-lineno">1494</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-616" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-616', 'posargs', 'link-487');">posargs</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-617" class="py-name" targets="Function epydoc.docparser.parse_funcdef_arg()=epydoc.docparser-module.html#parse_funcdef_arg"><a title="epydoc.docparser.parse_funcdef_arg" class="py-name" href="#" onclick="return doclink('link-617', 'parse_funcdef_arg', 'link-617');">parse_funcdef_arg</a></tt><tt class="py-op">(</tt><tt id="link-618" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-618', 'arg', 'link-615');">arg</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="L1495"></a><tt class="py-lineno">1495</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-619" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-619', 'arg', 'link-615');">arg</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="L1496"></a><tt class="py-lineno">1496</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-620" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-620', 'posarg_defaults', 'link-607');">posarg_defaults</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L1497"></a><tt class="py-lineno">1497</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-621" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-621', 'arg', 'link-615');">arg</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-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'='</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt id="link-622" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-622', 'arg', 'link-615');">arg</a></tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L1498"></a><tt class="py-lineno">1498</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-623" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-623', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad argument list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1499"></a><tt class="py-lineno">1499</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1500"></a><tt class="py-lineno">1500</tt> <tt class="py-line"> <tt class="py-name">default_repr</tt> <tt class="py-op">=</tt> <tt id="link-624" class="py-name"><a title="epydoc.docparser.pp_toktree" class="py-name" href="#" onclick="return doclink('link-624', 'pp_toktree', 'link-505');">pp_toktree</a></tt><tt class="py-op">(</tt><tt id="link-625" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-625', 'arg', 'link-615');">arg</a></tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-string">'tight'</tt><tt class="py-op">)</tt> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt> <tt class="py-line"> <tt class="py-name">default_val</tt> <tt class="py-op">=</tt> <tt id="link-626" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-626', 'GenericValueDoc', 'link-506');">GenericValueDoc</a></tt><tt class="py-op">(</tt><tt id="link-627" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-627', 'parse_repr', 'link-504');">parse_repr</a></tt><tt class="py-op">=</tt><tt class="py-name">default_repr</tt><tt class="py-op">,</tt> </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt> <tt class="py-line"> <tt id="link-628" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-628', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt> <tt class="py-line"> <tt class="py-name">func_doc</tt><tt class="py-op">.</tt><tt id="link-629" class="py-name"><a title="epydoc.apidoc.RoutineDoc.posarg_defaults" class="py-name" href="#" onclick="return doclink('link-629', 'posarg_defaults', 'link-607');">posarg_defaults</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">default_val</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1504"></a><tt class="py-lineno">1504</tt> <tt class="py-line"> </tt>
<a name="L1505"></a><tt class="py-lineno">1505</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1506"></a><tt class="py-lineno">1506</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Line handler: class declarations</tt> </tt>
<a name="L1507"></a><tt class="py-lineno">1507</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1508"></a><tt class="py-lineno">1508</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="process_classdef"></a><div id="process_classdef-def"><a name="L1509"></a><tt class="py-lineno">1509</tt> <a class="py-toggle" href="#" id="process_classdef-toggle" onclick="return toggle('process_classdef');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#process_classdef">process_classdef</a><tt class="py-op">(</tt><tt class="py-param">line</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">,</tt> <tt class="py-param">prev_line_doc</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> </tt>
<a name="L1510"></a><tt class="py-lineno">1510</tt> <tt class="py-line"> <tt class="py-param">comments</tt><tt class="py-op">,</tt> <tt class="py-param">decorators</tt><tt class="py-op">,</tt> <tt class="py-param">encoding</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="process_classdef-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="process_classdef-expanded"><a name="L1511"></a><tt class="py-lineno">1511</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt> <tt class="py-line"><tt class="py-docstring"> The line handler for class declaration lines, such as:</tt> </tt>
<a name="L1513"></a><tt class="py-lineno">1513</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1514"></a><tt class="py-lineno">1514</tt> <tt class="py-line"><tt class="py-docstring"> >>> class Foo(Bar, Baz):</tt> </tt>
<a name="L1515"></a><tt class="py-lineno">1515</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt> <tt class="py-line"><tt class="py-docstring"> This handler creates and initializes a new C{VariableDoc}</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt> <tt class="py-line"><tt class="py-docstring"> containing a C{ClassDoc}, adds the C{VariableDoc} to the</tt> </tt>
<a name="L1518"></a><tt class="py-lineno">1518</tt> <tt class="py-line"><tt class="py-docstring"> containing namespace, and returns the C{ClassDoc}.</tt> </tt>
<a name="L1519"></a><tt class="py-lineno">1519</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1520"></a><tt class="py-lineno">1520</tt> <tt class="py-line"> <tt class="py-comment"># Check syntax</tt> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</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">line</tt><tt class="py-op">)</tt><tt class="py-op"><</tt><tt class="py-number">3</tt> <tt class="py-keyword">or</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">></tt><tt class="py-number">4</tt> <tt class="py-keyword">or</tt> <tt class="py-name">line</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">':'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1522"></a><tt class="py-lineno">1522</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-630" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-630', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad class definition line"</tt><tt class="py-op">)</tt> </tt>
<a name="L1523"></a><tt class="py-lineno">1523</tt> <tt class="py-line"> </tt>
<a name="L1524"></a><tt class="py-lineno">1524</tt> <tt class="py-line"> <tt class="py-comment"># If we're not in a namespace, then ignore it.</tt> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parent_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">parent_docs</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="L1526"></a><tt class="py-lineno">1526</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">parent_doc</tt><tt class="py-op">,</tt> <tt id="link-631" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-631', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1527"></a><tt class="py-lineno">1527</tt> <tt class="py-line"> </tt>
<a name="L1528"></a><tt class="py-lineno">1528</tt> <tt class="py-line"> <tt class="py-comment"># Get the class's name</tt> </tt>
<a name="L1529"></a><tt class="py-lineno">1529</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">class_name</tt> <tt class="py-op">=</tt> <tt id="link-632" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-632', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">line</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="L1530"></a><tt class="py-lineno">1530</tt> <tt class="py-line"> <tt id="link-633" 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-633', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-634" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-634', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_doc</tt><tt class="py-op">.</tt><tt id="link-635" 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-635', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">class_name</tt><tt class="py-op">)</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt> <tt class="py-line"> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt> <tt class="py-line"> <tt class="py-comment"># Create the class's ClassDoc & VariableDoc.</tt> </tt>
<a name="L1533"></a><tt class="py-lineno">1533</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">class_doc</tt> <tt class="py-op">=</tt> <tt id="link-636" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-636', 'ClassDoc', 'link-493');">ClassDoc</a></tt><tt class="py-op">(</tt><tt id="link-637" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-637', 'variables', 'link-70');">variables</a></tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt id="link-638" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-638', 'sort_spec', 'link-71');">sort_spec</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="L1534"></a><tt class="py-lineno">1534</tt> <tt class="py-line"> <tt id="link-639" 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-639', 'bases', 'link-639');">bases</a></tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-640" 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-640', 'subclasses', 'link-640');">subclasses</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="L1535"></a><tt class="py-lineno">1535</tt> <tt class="py-line"> <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-37');">canonical_name</a></tt><tt class="py-op">=</tt><tt id="link-642" 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-642', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> </tt>
<a name="L1536"></a><tt class="py-lineno">1536</tt> <tt class="py-line"> <tt id="link-643" class="py-name"><a title="epydoc.apidoc.ValueDoc.defining_module
epydoc.apidoc.VariableDoc.defining_module" class="py-name" href="#" onclick="return doclink('link-643', 'defining_module', 'link-79');">defining_module</a></tt><tt class="py-op">=</tt><tt class="py-name">parent_docs</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="L1537"></a><tt class="py-lineno">1537</tt> <tt class="py-line"> <tt id="link-644" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-644', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-645" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-645', 'VariableDoc', 'link-249');">VariableDoc</a></tt><tt class="py-op">(</tt><tt id="link-646" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-646', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">class_name</tt><tt class="py-op">,</tt> <tt id="link-647" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-647', 'value', 'link-135');">value</a></tt><tt class="py-op">=</tt><tt class="py-name">class_doc</tt><tt class="py-op">,</tt> </tt>
<a name="L1539"></a><tt class="py-lineno">1539</tt> <tt class="py-line"> <tt id="link-648" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-648', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-649" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-649', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L1540"></a><tt class="py-lineno">1540</tt> <tt class="py-line"> <tt id="link-650" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-650', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1541"></a><tt class="py-lineno">1541</tt> <tt class="py-line"> </tt>
<a name="L1542"></a><tt class="py-lineno">1542</tt> <tt class="py-line"> <tt class="py-comment"># Add the bases.</tt> </tt>
<a name="L1543"></a><tt class="py-lineno">1543</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">line</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">4</tt><tt class="py-op">:</tt> </tt>
<a name="L1544"></a><tt class="py-lineno">1544</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">line</tt><tt class="py-op">[</tt><tt class="py-number">2</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-keyword">or</tt> </tt>
<a name="L1545"></a><tt class="py-lineno">1545</tt> <tt class="py-line"> <tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">2</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 class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1546"></a><tt class="py-lineno">1546</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-651" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-651', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected base list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1547"></a><tt class="py-lineno">1547</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1548"></a><tt class="py-lineno">1548</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">base_name</tt> <tt class="py-keyword">in</tt> <tt id="link-652" class="py-name" targets="Function epydoc.docparser.parse_classdef_bases()=epydoc.docparser-module.html#parse_classdef_bases"><a title="epydoc.docparser.parse_classdef_bases" class="py-name" href="#" onclick="return doclink('link-652', 'parse_classdef_bases', 'link-652');">parse_classdef_bases</a></tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1549"></a><tt class="py-lineno">1549</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-653" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-653', 'bases', 'link-639');">bases</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-654" class="py-name" targets="Function epydoc.docparser.find_base()=epydoc.docparser-module.html#find_base"><a title="epydoc.docparser.find_base" class="py-name" href="#" onclick="return doclink('link-654', 'find_base', 'link-654');">find_base</a></tt><tt class="py-op">(</tt><tt class="py-name">base_name</tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1550"></a><tt class="py-lineno">1550</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-655" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-655', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L1551"></a><tt class="py-lineno">1551</tt> <tt class="py-line"> <tt id="link-656" 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-656', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-657" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-657', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Unable to extract the base list for %s: %s"</tt> <tt class="py-op">%</tt> </tt>
<a name="L1552"></a><tt class="py-lineno">1552</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt id="link-658" 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-658', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1553"></a><tt class="py-lineno">1553</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-659" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-659', 'bases', 'link-639');">bases</a></tt> <tt class="py-op">=</tt> <tt id="link-660" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-660', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L1554"></a><tt class="py-lineno">1554</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1555"></a><tt class="py-lineno">1555</tt> <tt class="py-line"> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-661" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-661', 'bases', 'link-639');">bases</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1556"></a><tt class="py-lineno">1556</tt> <tt class="py-line"> </tt>
<a name="L1557"></a><tt class="py-lineno">1557</tt> <tt class="py-line"> <tt class="py-comment"># Register ourselves as a subclass to our bases.</tt> </tt>
<a name="L1558"></a><tt class="py-lineno">1558</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-662" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-662', 'bases', 'link-639');">bases</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-663" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-663', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1559"></a><tt class="py-lineno">1559</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">basedoc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">class_doc</tt><tt class="py-op">.</tt><tt id="link-664" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-664', 'bases', 'link-639');">bases</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1560"></a><tt class="py-lineno">1560</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">basedoc</tt><tt class="py-op">,</tt> <tt id="link-665" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-665', 'ClassDoc', 'link-493');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1561"></a><tt class="py-lineno">1561</tt> <tt class="py-line"> <tt class="py-comment"># This test avoids that a subclass gets listed twice when</tt> </tt>
<a name="L1562"></a><tt class="py-lineno">1562</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># both introspection and parsing.</tt> </tt>
<a name="L1563"></a><tt class="py-lineno">1563</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># [XXX] This check only works because currently parsing is</tt> </tt>
<a name="L1564"></a><tt class="py-lineno">1564</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># always performed just after introspection of the same</tt> </tt>
<a name="L1565"></a><tt class="py-lineno">1565</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># class. A more complete fix shuld be independent from</tt> </tt>
<a name="L1566"></a><tt class="py-lineno">1566</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># calling order; probably the subclasses list should be</tt> </tt>
<a name="L1567"></a><tt class="py-lineno">1567</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># replaced by a ClassDoc set or a {name: ClassDoc} mapping.</tt> </tt>
<a name="L1568"></a><tt class="py-lineno">1568</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">basedoc</tt><tt class="py-op">.</tt><tt id="link-666" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-666', 'subclasses', 'link-640');">subclasses</a></tt> </tt>
<a name="L1569"></a><tt class="py-lineno">1569</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-name">basedoc</tt><tt class="py-op">.</tt><tt id="link-667" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-667', 'subclasses', 'link-640');">subclasses</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 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-37');">canonical_name</a></tt> </tt>
<a name="L1570"></a><tt class="py-lineno">1570</tt> <tt class="py-line"> <tt class="py-op">!=</tt> <tt class="py-name">class_doc</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-37');">canonical_name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1571"></a><tt class="py-lineno">1571</tt> <tt class="py-line"> <tt class="py-name">basedoc</tt><tt class="py-op">.</tt><tt id="link-670" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-670', 'subclasses', 'link-640');">subclasses</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">class_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1572"></a><tt class="py-lineno">1572</tt> <tt class="py-line"> </tt>
<a name="L1573"></a><tt class="py-lineno">1573</tt> <tt class="py-line"> <tt class="py-comment"># If the preceeding comment includes a docstring, then add it.</tt> </tt>
<a name="L1574"></a><tt class="py-lineno">1574</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-671" class="py-name"><a title="epydoc.docparser.add_docstring_from_comments" class="py-name" href="#" onclick="return doclink('link-671', 'add_docstring_from_comments', 'link-470');">add_docstring_from_comments</a></tt><tt class="py-op">(</tt><tt class="py-name">class_doc</tt><tt class="py-op">,</tt> <tt class="py-name">comments</tt><tt class="py-op">)</tt> </tt>
<a name="L1575"></a><tt class="py-lineno">1575</tt> <tt class="py-line"> </tt>
<a name="L1576"></a><tt class="py-lineno">1576</tt> <tt class="py-line"> <tt class="py-comment"># Add the VariableDoc to our container.</tt> </tt>
<a name="L1577"></a><tt class="py-lineno">1577</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-672" class="py-name"><a title="epydoc.docparser.set_variable" class="py-name" href="#" onclick="return doclink('link-672', 'set_variable', 'link-304');">set_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">parent_doc</tt><tt class="py-op">,</tt> <tt class="py-name">var_doc</tt><tt class="py-op">)</tt> </tt>
<a name="L1578"></a><tt class="py-lineno">1578</tt> <tt class="py-line"> </tt>
<a name="L1579"></a><tt class="py-lineno">1579</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">class_doc</tt> </tt>
</div><a name="L1580"></a><tt class="py-lineno">1580</tt> <tt class="py-line"> </tt>
<a name="_proxy_base"></a><div id="_proxy_base-def"><a name="L1581"></a><tt class="py-lineno">1581</tt> <a class="py-toggle" href="#" id="_proxy_base-toggle" onclick="return toggle('_proxy_base');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_proxy_base">_proxy_base</a><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-param">attribs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_proxy_base-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_proxy_base-expanded"><a name="L1582"></a><tt class="py-lineno">1582</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-673" class="py-name"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-673', 'ClassDoc', 'link-493');">ClassDoc</a></tt><tt class="py-op">(</tt><tt id="link-674" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-674', 'variables', 'link-70');">variables</a></tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">,</tt> <tt id="link-675" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-675', 'sort_spec', 'link-71');">sort_spec</a></tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-676" class="py-name"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-676', 'bases', 'link-639');">bases</a></tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt id="link-677" class="py-name"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-677', 'subclasses', 'link-640');">subclasses</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="L1583"></a><tt class="py-lineno">1583</tt> <tt class="py-line"> <tt id="link-678" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-678', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">attribs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1584"></a><tt class="py-lineno">1584</tt> <tt class="py-line"> </tt>
<a name="find_base"></a><div id="find_base-def"><a name="L1585"></a><tt class="py-lineno">1585</tt> <a class="py-toggle" href="#" id="find_base-toggle" onclick="return toggle('find_base');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#find_base">find_base</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="find_base-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="find_base-expanded"><a name="L1586"></a><tt class="py-lineno">1586</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-679" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-679', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt id="link-680" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-680', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1587"></a><tt class="py-lineno">1587</tt> <tt class="py-line"> </tt>
<a name="L1588"></a><tt class="py-lineno">1588</tt> <tt class="py-line"> <tt class="py-comment"># Find the variable containing the base.</tt> </tt>
<a name="L1589"></a><tt class="py-lineno">1589</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">base_var</tt> <tt class="py-op">=</tt> <tt id="link-681" class="py-name" targets="Function epydoc.docparser.lookup_variable()=epydoc.docparser-module.html#lookup_variable"><a title="epydoc.docparser.lookup_variable" class="py-name" href="#" onclick="return doclink('link-681', 'lookup_variable', 'link-681');">lookup_variable</a></tt><tt class="py-op">(</tt><tt id="link-682" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-682', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt class="py-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1590"></a><tt class="py-lineno">1590</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">base_var</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L1591"></a><tt class="py-lineno">1591</tt> <tt class="py-line"> <tt class="py-comment"># If we didn't find it, then it must have been imported.</tt> </tt>
<a name="L1592"></a><tt class="py-lineno">1592</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># First, check if it looks like it's contained in any</tt> </tt>
<a name="L1593"></a><tt class="py-lineno">1593</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># known imported variable:</tt> </tt>
<a name="L1594"></a><tt class="py-lineno">1594</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-683" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-683', 'name', 'link-31');">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="L1595"></a><tt class="py-lineno">1595</tt> <tt class="py-line"> <tt class="py-name">src</tt> <tt class="py-op">=</tt> <tt id="link-684" class="py-name" targets="Function epydoc.docparser.lookup_name()=epydoc.docparser-module.html#lookup_name"><a title="epydoc.docparser.lookup_name" class="py-name" href="#" onclick="return doclink('link-684', 'lookup_name', 'link-684');">lookup_name</a></tt><tt class="py-op">(</tt><tt id="link-685" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-685', 'name', 'link-31');">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-name">parent_docs</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-op">(</tt><tt class="py-name">src</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="L1597"></a><tt class="py-lineno">1597</tt> <tt class="py-line"> <tt class="py-name">src</tt><tt class="py-op">.</tt><tt id="link-686" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-686', 'imported_from', 'link-167');">imported_from</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-687" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-687', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1598"></a><tt class="py-lineno">1598</tt> <tt class="py-line"> <tt class="py-name">base_src</tt> <tt class="py-op">=</tt> <tt id="link-688" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-688', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">src</tt><tt class="py-op">.</tt><tt id="link-689" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-689', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">,</tt> <tt id="link-690" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-690', 'name', 'link-31');">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>
<a name="L1599"></a><tt class="py-lineno">1599</tt> <tt class="py-line"> <tt class="py-name">base_var</tt> <tt class="py-op">=</tt> <tt id="link-691" class="py-name"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-691', 'VariableDoc', 'link-249');">VariableDoc</a></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-31');">name</a></tt><tt class="py-op">=</tt><tt id="link-693" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-693', 'name', 'link-31');">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 id="link-694" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_imported" class="py-name" href="#" onclick="return doclink('link-694', 'is_imported', 'link-115');">is_imported</a></tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
<a name="L1600"></a><tt class="py-lineno">1600</tt> <tt class="py-line"> <tt id="link-695" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-695', 'is_alias', 'link-300');">is_alias</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-696" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-696', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">=</tt><tt class="py-name">base_src</tt><tt class="py-op">,</tt> </tt>
<a name="L1601"></a><tt class="py-lineno">1601</tt> <tt class="py-line"> <tt id="link-697" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-697', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1602"></a><tt class="py-lineno">1602</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, it must have come from an "import *" statement</tt> </tt>
<a name="L1603"></a><tt class="py-lineno">1603</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># (or from magic, such as direct manipulation of the module's</tt> </tt>
<a name="L1604"></a><tt class="py-lineno">1604</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># dictionary), so we don't know where it came from. So</tt> </tt>
<a name="L1605"></a><tt class="py-lineno">1605</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># there's nothing left but to use an empty proxy.</tt> </tt>
<a name="L1606"></a><tt class="py-lineno">1606</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">base_var</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</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">return</tt> <tt id="link-698" class="py-name" targets="Function epydoc.docparser._proxy_base()=epydoc.docparser-module.html#_proxy_base"><a title="epydoc.docparser._proxy_base" class="py-name" href="#" onclick="return doclink('link-698', '_proxy_base', 'link-698');">_proxy_base</a></tt><tt class="py-op">(</tt><tt id="link-699" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-699', 'parse_repr', 'link-504');">parse_repr</a></tt><tt class="py-op">=</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-700" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-700', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1608"></a><tt class="py-lineno">1608</tt> <tt class="py-line"> <tt class="py-comment">#raise ParseError("Could not find %s" % name)</tt> </tt>
<a name="L1609"></a><tt class="py-lineno">1609</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L1610"></a><tt class="py-lineno">1610</tt> <tt class="py-line"> <tt class="py-comment"># If the variable has a value, return that value.</tt> </tt>
<a name="L1611"></a><tt class="py-lineno">1611</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">base_var</tt><tt class="py-op">.</tt><tt id="link-701" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-701', 'value', 'link-135');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-702" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-702', 'UNKNOWN', 'link-38');">UNKNOWN</a></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">base_var</tt><tt class="py-op">.</tt><tt id="link-703" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-703', 'value', 'link-135');">value</a></tt> </tt>
<a name="L1613"></a><tt class="py-lineno">1613</tt> <tt class="py-line"> </tt>
<a name="L1614"></a><tt class="py-lineno">1614</tt> <tt class="py-line"> <tt class="py-comment"># Otherwise, if BASE_HANDLING is 'parse', try parsing the docs for</tt> </tt>
<a name="L1615"></a><tt class="py-lineno">1615</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># the base class; if that fails, or if BASE_HANDLING is 'link',</tt> </tt>
<a name="L1616"></a><tt class="py-lineno">1616</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># just make a proxy object.</tt> </tt>
<a name="L1617"></a><tt class="py-lineno">1617</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">base_var</tt><tt class="py-op">.</tt><tt id="link-704" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-704', 'imported_from', 'link-167');">imported_from</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-705" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-705', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1618"></a><tt class="py-lineno">1618</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-706" class="py-name"><a title="epydoc.docparser.BASE_HANDLING" class="py-name" href="#" onclick="return doclink('link-706', 'BASE_HANDLING', 'link-20');">BASE_HANDLING</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'parse'</tt><tt class="py-op">:</tt> </tt>
<a name="L1619"></a><tt class="py-lineno">1619</tt> <tt class="py-line"> <tt class="py-name">old_sys_path</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-707" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-707', 'path', 'link-0');">path</a></tt> </tt>
<a name="L1620"></a><tt class="py-lineno">1620</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1621"></a><tt class="py-lineno">1621</tt> <tt class="py-line"> <tt class="py-name">dirname</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-708" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-708', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">parent_docs</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-709" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-709', 'filename', 'link-30');">filename</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="L1622"></a><tt class="py-lineno">1622</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-710" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-710', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">dirname</tt><tt class="py-op">]</tt> <tt class="py-op">+</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-711" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-711', 'path', 'link-0');">path</a></tt> </tt>
<a name="L1623"></a><tt class="py-lineno">1623</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1624"></a><tt class="py-lineno">1624</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-712" class="py-name"><a title="epydoc.docparser.parse_docs" class="py-name" href="#" onclick="return doclink('link-712', 'parse_docs', 'link-96');">parse_docs</a></tt><tt class="py-op">(</tt><tt id="link-713" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-713', 'name', 'link-31');">name</a></tt><tt class="py-op">=</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">base_var</tt><tt class="py-op">.</tt><tt id="link-714" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-714', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1625"></a><tt class="py-lineno">1625</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-715" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-715', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1626"></a><tt class="py-lineno">1626</tt> <tt class="py-line"> <tt id="link-716" 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-716', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-717" class="py-name"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-717', 'info', 'link-51');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unable to parse base'</tt><tt class="py-op">,</tt> <tt class="py-name">base_var</tt><tt class="py-op">.</tt><tt id="link-718" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-718', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1627"></a><tt class="py-lineno">1627</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
<a name="L1628"></a><tt class="py-lineno">1628</tt> <tt class="py-line"> <tt id="link-719" 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-719', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-720" class="py-name"><a title="epydoc.log.info" class="py-name" href="#" onclick="return doclink('link-720', 'info', 'link-51');">info</a></tt><tt class="py-op">(</tt><tt class="py-string">'Unable to find base'</tt><tt class="py-op">,</tt> <tt class="py-name">base_var</tt><tt class="py-op">.</tt><tt id="link-721" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-721', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1629"></a><tt class="py-lineno">1629</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L1630"></a><tt class="py-lineno">1630</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-722" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-722', 'path', 'link-0');">path</a></tt> <tt class="py-op">=</tt> <tt class="py-name">old_sys_path</tt> </tt>
<a name="L1631"></a><tt class="py-lineno">1631</tt> <tt class="py-line"> </tt>
<a name="L1632"></a><tt class="py-lineno">1632</tt> <tt class="py-line"> <tt class="py-comment"># Either BASE_HANDLING='link' or parsing the base class failed;</tt> </tt>
<a name="L1633"></a><tt class="py-lineno">1633</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># return a proxy value for the base class.</tt> </tt>
<a name="L1634"></a><tt class="py-lineno">1634</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-723" class="py-name"><a title="epydoc.docparser._proxy_base" class="py-name" href="#" onclick="return doclink('link-723', '_proxy_base', 'link-698');">_proxy_base</a></tt><tt class="py-op">(</tt><tt id="link-724" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-724', 'proxy_for', 'link-396');">proxy_for</a></tt><tt class="py-op">=</tt><tt class="py-name">base_var</tt><tt class="py-op">.</tt><tt id="link-725" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-725', 'imported_from', 'link-167');">imported_from</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1635"></a><tt class="py-lineno">1635</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1636"></a><tt class="py-lineno">1636</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-726" class="py-name"><a title="epydoc.docparser._proxy_base" class="py-name" href="#" onclick="return doclink('link-726', '_proxy_base', 'link-698');">_proxy_base</a></tt><tt class="py-op">(</tt><tt id="link-727" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-727', 'parse_repr', 'link-504');">parse_repr</a></tt><tt class="py-op">=</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt id="link-728" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-728', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1637"></a><tt class="py-lineno">1637</tt> <tt class="py-line"> </tt>
<a name="L1638"></a><tt class="py-lineno">1638</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1639"></a><tt class="py-lineno">1639</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Parsing</tt> </tt>
<a name="L1640"></a><tt class="py-lineno">1640</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1641"></a><tt class="py-lineno">1641</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="dotted_names_in"></a><div id="dotted_names_in-def"><a name="L1642"></a><tt class="py-lineno">1642</tt> <a class="py-toggle" href="#" id="dotted_names_in-toggle" onclick="return toggle('dotted_names_in');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#dotted_names_in">dotted_names_in</a><tt class="py-op">(</tt><tt class="py-param">elt_list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="dotted_names_in-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="dotted_names_in-expanded"><a name="L1643"></a><tt class="py-lineno">1643</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1644"></a><tt class="py-lineno">1644</tt> <tt class="py-line"><tt class="py-docstring"> Return a list of all simple dotted names in the given</tt> </tt>
<a name="L1645"></a><tt class="py-lineno">1645</tt> <tt class="py-line"><tt class="py-docstring"> expression.</tt> </tt>
<a name="L1646"></a><tt class="py-lineno">1646</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1647"></a><tt class="py-lineno">1647</tt> <tt class="py-line"> <tt class="py-name">names</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">while</tt> <tt class="py-name">elt_list</tt><tt class="py-op">:</tt> </tt>
<a name="L1649"></a><tt class="py-lineno">1649</tt> <tt class="py-line"> <tt class="py-name">elt</tt> <tt class="py-op">=</tt> <tt class="py-name">elt_list</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="L1650"></a><tt class="py-lineno">1650</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">elt</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">elt</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">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1651"></a><tt class="py-lineno">1651</tt> <tt class="py-line"> <tt class="py-comment"># Nested list: process the contents</tt> </tt>
<a name="L1652"></a><tt class="py-lineno">1652</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">elt_list</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt id="link-729" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-729', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</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-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 class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1653"></a><tt class="py-lineno">1653</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1654"></a><tt class="py-lineno">1654</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L1655"></a><tt class="py-lineno">1655</tt> <tt class="py-line"> <tt class="py-name">names</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-730" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-730', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1656"></a><tt class="py-lineno">1656</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-731" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-731', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1657"></a><tt class="py-lineno">1657</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> <tt class="py-comment"># complex expression -- ignore</tt> </tt>
<a name="L1658"></a><tt class="py-lineno">1658</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">names</tt> </tt>
</div><a name="L1659"></a><tt class="py-lineno">1659</tt> <tt class="py-line"> </tt>
<a name="parse_name"></a><div id="parse_name-def"><a name="L1660"></a><tt class="py-lineno">1660</tt> <a class="py-toggle" href="#" id="parse_name-toggle" onclick="return toggle('parse_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_name">parse_name</a><tt class="py-op">(</tt><tt class="py-param">elt</tt><tt class="py-op">,</tt> <tt class="py-param">strip_parens</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="parse_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_name-expanded"><a name="L1661"></a><tt class="py-lineno">1661</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1662"></a><tt class="py-lineno">1662</tt> <tt class="py-line"><tt class="py-docstring"> If the given token tree element is a name token, then return</tt> </tt>
<a name="L1663"></a><tt class="py-lineno">1663</tt> <tt class="py-line"><tt class="py-docstring"> that name as a string. Otherwise, raise ParseError.</tt> </tt>
<a name="L1664"></a><tt class="py-lineno">1664</tt> <tt class="py-line"><tt class="py-docstring"> @param strip_parens: If true, then if elt is a single name</tt> </tt>
<a name="L1665"></a><tt class="py-lineno">1665</tt> <tt class="py-line"><tt class="py-docstring"> enclosed in parenthases, then return that name.</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-keyword">if</tt> <tt class="py-name">strip_parens</tt> <tt class="py-keyword">and</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-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1668"></a><tt class="py-lineno">1668</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-op">(</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-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</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-number">3</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1669"></a><tt class="py-lineno">1669</tt> <tt class="py-line"> <tt class="py-name">elt</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'('</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1670"></a><tt class="py-lineno">1670</tt> <tt class="py-line"> <tt class="py-name">elt</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1671"></a><tt class="py-lineno">1671</tt> <tt class="py-line"> <tt class="py-name">elt</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>
<a name="L1672"></a><tt class="py-lineno">1672</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-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">:</tt> </tt>
<a name="L1673"></a><tt class="py-lineno">1673</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-732" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-732', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad name"</tt><tt class="py-op">)</tt> </tt>
<a name="L1674"></a><tt class="py-lineno">1674</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">elt</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1675"></a><tt class="py-lineno">1675</tt> <tt class="py-line"> </tt>
<a name="parse_dotted_name"></a><div id="parse_dotted_name-def"><a name="L1676"></a><tt class="py-lineno">1676</tt> <a class="py-toggle" href="#" id="parse_dotted_name-toggle" onclick="return toggle('parse_dotted_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_dotted_name">parse_dotted_name</a><tt class="py-op">(</tt><tt class="py-param">elt_list</tt><tt class="py-op">,</tt> <tt class="py-param">strip_parens</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">parent_name</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="parse_dotted_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_dotted_name-expanded"><a name="L1677"></a><tt class="py-lineno">1677</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1678"></a><tt class="py-lineno">1678</tt> <tt class="py-line"><tt class="py-docstring"> @param parent_name: canonical name of referring module, to resolve</tt> </tt>
<a name="L1679"></a><tt class="py-lineno">1679</tt> <tt class="py-line"><tt class="py-docstring"> relative imports.</tt> </tt>
<a name="L1680"></a><tt class="py-lineno">1680</tt> <tt class="py-line"><tt class="py-docstring"> @type parent_name: L{DottedName}</tt> </tt>
<a name="L1681"></a><tt class="py-lineno">1681</tt> <tt class="py-line"><tt class="py-docstring"> @bug: does not handle 'x.(y).z'</tt> </tt>
<a name="L1682"></a><tt class="py-lineno">1682</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1683"></a><tt class="py-lineno">1683</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">elt_list</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-keyword">raise</tt> <tt id="link-733" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-733', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad dotted name"</tt><tt class="py-op">)</tt> </tt>
<a name="L1684"></a><tt class="py-lineno">1684</tt> <tt class="py-line"> </tt>
<a name="L1685"></a><tt class="py-lineno">1685</tt> <tt class="py-line"> <tt class="py-comment"># Handle ((x.y).z). (If the contents of the parens include</tt> </tt>
<a name="L1686"></a><tt class="py-lineno">1686</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># anything other than dotted names, such as (x,y), then we'll</tt> </tt>
<a name="L1687"></a><tt class="py-lineno">1687</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># catch it below and raise a ParseError.</tt> </tt>
<a name="L1688"></a><tt class="py-lineno">1688</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">while</tt> <tt class="py-op">(</tt><tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">elt_list</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">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1689"></a><tt class="py-lineno">1689</tt> <tt class="py-line"> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">elt_list</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 class="py-number">3</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1690"></a><tt class="py-lineno">1690</tt> <tt class="py-line"> <tt class="py-name">elt_list</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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'('</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1691"></a><tt class="py-lineno">1691</tt> <tt class="py-line"> <tt class="py-name">elt_list</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 class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1692"></a><tt class="py-lineno">1692</tt> <tt class="py-line"> <tt class="py-name">elt_list</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">elt_list</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-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>
<a name="L1693"></a><tt class="py-lineno">1693</tt> <tt class="py-line"> </tt>
<a name="L1694"></a><tt class="py-lineno">1694</tt> <tt class="py-line"> <tt class="py-comment"># Convert a relative import into an absolute name.</tt> </tt>
<a name="L1695"></a><tt class="py-lineno">1695</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">prefix_name</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L1696"></a><tt class="py-lineno">1696</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parent_name</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 class="py-name">elt_list</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 class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'.'</tt><tt class="py-op">:</tt> </tt>
<a name="L1697"></a><tt class="py-lineno">1697</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1698"></a><tt class="py-lineno">1698</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">elt_list</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">items</tt> <tt class="py-keyword">and</tt> <tt class="py-name">elt_list</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 class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'.'</tt><tt class="py-op">:</tt> </tt>
<a name="L1699"></a><tt class="py-lineno">1699</tt> <tt class="py-line"> <tt class="py-name">items</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1700"></a><tt class="py-lineno">1700</tt> <tt class="py-line"> </tt>
<a name="L1701"></a><tt class="py-lineno">1701</tt> <tt class="py-line"> <tt class="py-name">elt_list</tt> <tt class="py-op">=</tt> <tt class="py-name">elt_list</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="L1702"></a><tt class="py-lineno">1702</tt> <tt class="py-line"> <tt class="py-name">prefix_name</tt> <tt class="py-op">=</tt> <tt class="py-name">parent_name</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-name">items</tt><tt class="py-op">]</tt> </tt>
<a name="L1703"></a><tt class="py-lineno">1703</tt> <tt class="py-line"> </tt>
<a name="L1704"></a><tt class="py-lineno">1704</tt> <tt class="py-line"> <tt class="py-comment"># >>> from . import foo</tt> </tt>
<a name="L1705"></a><tt class="py-lineno">1705</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">elt_list</tt><tt class="py-op">:</tt> </tt>
<a name="L1706"></a><tt class="py-lineno">1706</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">prefix_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="L1707"></a><tt class="py-lineno">1707</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-734" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-734', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Attempted relative import in non-package, "</tt> </tt>
<a name="L1708"></a><tt class="py-lineno">1708</tt> <tt class="py-line"> <tt class="py-string">"or beyond toplevel package"</tt><tt class="py-op">)</tt> </tt>
<a name="L1709"></a><tt class="py-lineno">1709</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">prefix_name</tt> </tt>
<a name="L1710"></a><tt class="py-lineno">1710</tt> <tt class="py-line"> </tt>
<a name="L1711"></a><tt class="py-lineno">1711</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">elt_list</tt><tt class="py-op">)</tt> <tt class="py-op">%</tt> <tt class="py-number">2</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt id="link-735" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-735', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad dotted name"</tt><tt class="py-op">)</tt> </tt>
<a name="L1712"></a><tt class="py-lineno">1712</tt> <tt class="py-line"> <tt id="link-736" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-736', 'name', 'link-31');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-737" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-737', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-738" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-738', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">elt_list</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">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1713"></a><tt class="py-lineno">1713</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">prefix_name</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="L1714"></a><tt class="py-lineno">1714</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-31');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">prefix_name</tt> <tt class="py-op">+</tt> <tt id="link-740" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-740', 'name', 'link-31');">name</a></tt> </tt>
<a name="L1715"></a><tt class="py-lineno">1715</tt> <tt class="py-line"> </tt>
<a name="L1716"></a><tt class="py-lineno">1716</tt> <tt class="py-line"> <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-number">2</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">elt_list</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-number">2</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1717"></a><tt class="py-lineno">1717</tt> <tt class="py-line"> <tt class="py-name">dot</tt><tt class="py-op">,</tt> <tt class="py-name">identifier</tt> <tt class="py-op">=</tt> <tt class="py-name">elt_list</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-op">,</tt> <tt class="py-name">elt_list</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L1718"></a><tt class="py-lineno">1718</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">dot</tt> <tt class="py-op">!=</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'.'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1719"></a><tt class="py-lineno">1719</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-741" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-741', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad dotted name"</tt><tt class="py-op">)</tt> </tt>
<a name="L1720"></a><tt class="py-lineno">1720</tt> <tt class="py-line"> <tt id="link-742" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-742', 'name', 'link-31');">name</a></tt> <tt class="py-op">=</tt> <tt id="link-743" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-743', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-744" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-744', 'name', 'link-31');">name</a></tt><tt class="py-op">,</tt> <tt id="link-745" class="py-name"><a title="epydoc.docparser.parse_name" class="py-name" href="#" onclick="return doclink('link-745', 'parse_name', 'link-323');">parse_name</a></tt><tt class="py-op">(</tt><tt class="py-name">identifier</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1721"></a><tt class="py-lineno">1721</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-746" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-746', 'name', 'link-31');">name</a></tt> </tt>
</div><a name="L1722"></a><tt class="py-lineno">1722</tt> <tt class="py-line"> </tt>
<a name="split_on"></a><div id="split_on-def"><a name="L1723"></a><tt class="py-lineno">1723</tt> <a class="py-toggle" href="#" id="split_on-toggle" onclick="return toggle('split_on');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#split_on">split_on</a><tt class="py-op">(</tt><tt class="py-param">elt_list</tt><tt class="py-op">,</tt> <tt class="py-param">split_tok</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="split_on-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="split_on-expanded"><a name="L1724"></a><tt class="py-lineno">1724</tt> <tt class="py-line"> <tt class="py-comment"># [xx] add code to guarantee each elt is non-empty.</tt> </tt>
<a name="L1725"></a><tt class="py-lineno">1725</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">result</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>
<a name="L1726"></a><tt class="py-lineno">1726</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">elt_list</tt><tt class="py-op">:</tt> </tt>
<a name="L1727"></a><tt class="py-lineno">1727</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">elt</tt> <tt class="py-op">==</tt> <tt class="py-name">split_tok</tt><tt class="py-op">:</tt> </tt>
<a name="L1728"></a><tt class="py-lineno">1728</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">result</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 class="py-op">]</tt><tt class="py-op">:</tt> <tt class="py-keyword">raise</tt> <tt id="link-747" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-747', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Empty element from split"</tt><tt class="py-op">)</tt> </tt>
<a name="L1729"></a><tt class="py-lineno">1729</tt> <tt class="py-line"> <tt class="py-name">result</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1730"></a><tt class="py-lineno">1730</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1731"></a><tt class="py-lineno">1731</tt> <tt class="py-line"> <tt class="py-name">result</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">append</tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">)</tt> </tt>
<a name="L1732"></a><tt class="py-lineno">1732</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">result</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 class="py-op">]</tt><tt class="py-op">:</tt> <tt class="py-name">result</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="L1733"></a><tt class="py-lineno">1733</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L1734"></a><tt class="py-lineno">1734</tt> <tt class="py-line"> </tt>
<a name="parse_funcdef_arg"></a><div id="parse_funcdef_arg-def"><a name="L1735"></a><tt class="py-lineno">1735</tt> <a class="py-toggle" href="#" id="parse_funcdef_arg-toggle" onclick="return toggle('parse_funcdef_arg');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_funcdef_arg">parse_funcdef_arg</a><tt class="py-op">(</tt><tt class="py-param">elt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_funcdef_arg-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_funcdef_arg-expanded"><a name="L1736"></a><tt class="py-lineno">1736</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1737"></a><tt class="py-lineno">1737</tt> <tt class="py-line"><tt class="py-docstring"> If the given tree token element contains a valid function</tt> </tt>
<a name="L1738"></a><tt class="py-lineno">1738</tt> <tt class="py-line"><tt class="py-docstring"> definition argument (i.e., an identifier token or nested list</tt> </tt>
<a name="L1739"></a><tt class="py-lineno">1739</tt> <tt class="py-line"><tt class="py-docstring"> of identifiers), then return a corresponding string identifier</tt> </tt>
<a name="L1740"></a><tt class="py-lineno">1740</tt> <tt class="py-line"><tt class="py-docstring"> or nested list of string identifiers. Otherwise, raise a</tt> </tt>
<a name="L1741"></a><tt class="py-lineno">1741</tt> <tt class="py-line"><tt class="py-docstring"> ParseError.</tt> </tt>
<a name="L1742"></a><tt class="py-lineno">1742</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1743"></a><tt class="py-lineno">1743</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-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1744"></a><tt class="py-lineno">1744</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">elt</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'('</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1745"></a><tt class="py-lineno">1745</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">elt</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">3</tt><tt class="py-op">:</tt> </tt>
<a name="L1746"></a><tt class="py-lineno">1746</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-748" class="py-name"><a title="epydoc.docparser.parse_funcdef_arg" class="py-name" href="#" onclick="return doclink('link-748', 'parse_funcdef_arg', 'link-617');">parse_funcdef_arg</a></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-op">)</tt> </tt>
<a name="L1747"></a><tt class="py-lineno">1747</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1748"></a><tt class="py-lineno">1748</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt id="link-749" class="py-name"><a title="epydoc.docparser.parse_funcdef_arg" class="py-name" href="#" onclick="return doclink('link-749', 'parse_funcdef_arg', 'link-617');">parse_funcdef_arg</a></tt><tt class="py-op">(</tt><tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
<a name="L1749"></a><tt class="py-lineno">1749</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">e</tt> <tt class="py-keyword">in</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-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1750"></a><tt class="py-lineno">1750</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt> <tt class="py-op">!=</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L1751"></a><tt class="py-lineno">1751</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1752"></a><tt class="py-lineno">1752</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-750" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-750', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad argument -- expected name or tuple"</tt><tt class="py-op">)</tt> </tt>
<a name="L1753"></a><tt class="py-lineno">1753</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">:</tt> </tt>
<a name="L1754"></a><tt class="py-lineno">1754</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">elt</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L1755"></a><tt class="py-lineno">1755</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1756"></a><tt class="py-lineno">1756</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-751" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-751', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad argument -- expected name or tuple"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1757"></a><tt class="py-lineno">1757</tt> <tt class="py-line"> </tt>
<a name="parse_classdef_bases"></a><div id="parse_classdef_bases-def"><a name="L1758"></a><tt class="py-lineno">1758</tt> <a class="py-toggle" href="#" id="parse_classdef_bases-toggle" onclick="return toggle('parse_classdef_bases');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_classdef_bases">parse_classdef_bases</a><tt class="py-op">(</tt><tt class="py-param">elt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_classdef_bases-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_classdef_bases-expanded"><a name="L1759"></a><tt class="py-lineno">1759</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1760"></a><tt class="py-lineno">1760</tt> <tt class="py-line"><tt class="py-docstring"> If the given tree token element contains a valid base list</tt> </tt>
<a name="L1761"></a><tt class="py-lineno">1761</tt> <tt class="py-line"><tt class="py-docstring"> (that contains only dotted names), then return a corresponding</tt> </tt>
<a name="L1762"></a><tt class="py-lineno">1762</tt> <tt class="py-line"><tt class="py-docstring"> list of L{DottedName}s. Otherwise, raise a ParseError.</tt> </tt>
<a name="L1763"></a><tt class="py-lineno">1763</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1764"></a><tt class="py-lineno">1764</tt> <tt class="py-line"><tt class="py-docstring"> @bug: Does not handle either of::</tt> </tt>
<a name="L1765"></a><tt class="py-lineno">1765</tt> <tt class="py-line"><tt class="py-docstring"> - class A( (base.in.parens) ): pass</tt> </tt>
<a name="L1766"></a><tt class="py-lineno">1766</tt> <tt class="py-line"><tt class="py-docstring"> - class B( (lambda:calculated.base)() ): pass</tt> </tt>
<a name="L1767"></a><tt class="py-lineno">1767</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1768"></a><tt class="py-lineno">1768</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">elt</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1769"></a><tt class="py-lineno">1769</tt> <tt class="py-line"> <tt class="py-name">elt</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 class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1770"></a><tt class="py-lineno">1770</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-752" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-752', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Bad base list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1771"></a><tt class="py-lineno">1771</tt> <tt class="py-line"> </tt>
<a name="L1772"></a><tt class="py-lineno">1772</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt id="link-753" class="py-name"><a title="epydoc.docparser.parse_dotted_name" class="py-name" href="#" onclick="return doclink('link-753', 'parse_dotted_name', 'link-295');">parse_dotted_name</a></tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L1773"></a><tt class="py-lineno">1773</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt id="link-754" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-754', 'split_on', 'link-296');">split_on</a></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-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-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
</div><a name="L1774"></a><tt class="py-lineno">1774</tt> <tt class="py-line"> </tt>
<a name="L1775"></a><tt class="py-lineno">1775</tt> <tt class="py-line"><tt class="py-comment"># Used by: base list; 'del'; ...</tt> </tt>
<a name="parse_dotted_name_list"></a><div id="parse_dotted_name_list-def"><a name="L1776"></a><tt class="py-lineno">1776</tt> <a class="py-toggle" href="#" id="parse_dotted_name_list-toggle" onclick="return toggle('parse_dotted_name_list');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_dotted_name_list">parse_dotted_name_list</a><tt class="py-op">(</tt><tt class="py-param">elt_list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_dotted_name_list-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_dotted_name_list-expanded"><a name="L1777"></a><tt class="py-lineno">1777</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1778"></a><tt class="py-lineno">1778</tt> <tt class="py-line"><tt class="py-docstring"> If the given list of tree token elements contains a</tt> </tt>
<a name="L1779"></a><tt class="py-lineno">1779</tt> <tt class="py-line"><tt class="py-docstring"> comma-separated list of dotted names, then return a</tt> </tt>
<a name="L1780"></a><tt class="py-lineno">1780</tt> <tt class="py-line"><tt class="py-docstring"> corresponding list of L{DottedName} objects. Otherwise, raise</tt> </tt>
<a name="L1781"></a><tt class="py-lineno">1781</tt> <tt class="py-line"><tt class="py-docstring"> ParseError.</tt> </tt>
<a name="L1782"></a><tt class="py-lineno">1782</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1783"></a><tt class="py-lineno">1783</tt> <tt class="py-line"> <tt class="py-name">names</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1784"></a><tt class="py-lineno">1784</tt> <tt class="py-line"> </tt>
<a name="L1785"></a><tt class="py-lineno">1785</tt> <tt class="py-line"> <tt class="py-name">state</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1786"></a><tt class="py-lineno">1786</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">elt_list</tt><tt class="py-op">:</tt> </tt>
<a name="L1787"></a><tt class="py-lineno">1787</tt> <tt class="py-line"> <tt class="py-comment"># State 0 -- Expecting a name, or end of arglist</tt> </tt>
<a name="L1788"></a><tt class="py-lineno">1788</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">state</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L1789"></a><tt class="py-lineno">1789</tt> <tt class="py-line"> <tt class="py-comment"># Make sure it's a name</tt> </tt>
<a name="L1790"></a><tt class="py-lineno">1790</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">elt</tt><tt class="py-op">,</tt> <tt class="py-name">tuple</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">:</tt> </tt>
<a name="L1791"></a><tt class="py-lineno">1791</tt> <tt class="py-line"> <tt class="py-name">names</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-755" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-755', 'DottedName', 'link-33');">DottedName</a></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-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1792"></a><tt class="py-lineno">1792</tt> <tt class="py-line"> <tt class="py-name">state</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1793"></a><tt class="py-lineno">1793</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1794"></a><tt class="py-lineno">1794</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-756" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-756', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected a name"</tt><tt class="py-op">)</tt> </tt>
<a name="L1795"></a><tt class="py-lineno">1795</tt> <tt class="py-line"> <tt class="py-comment"># State 1 -- Expecting comma, period, or end of arglist</tt> </tt>
<a name="L1796"></a><tt class="py-lineno">1796</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">state</tt> <tt class="py-op">==</tt> <tt class="py-number">1</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">if</tt> <tt class="py-name">elt</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">'.'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1798"></a><tt class="py-lineno">1798</tt> <tt class="py-line"> <tt class="py-name">state</tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
<a name="L1799"></a><tt class="py-lineno">1799</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">elt</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</tt><tt class="py-op">,</tt> <tt class="py-string">','</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1800"></a><tt class="py-lineno">1800</tt> <tt class="py-line"> <tt class="py-name">state</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L1801"></a><tt class="py-lineno">1801</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1802"></a><tt class="py-lineno">1802</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-757" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-757', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected '.' or ',' or end of list"</tt><tt class="py-op">)</tt> </tt>
<a name="L1803"></a><tt class="py-lineno">1803</tt> <tt class="py-line"> <tt class="py-comment"># State 2 -- Continuation of dotted name.</tt> </tt>
<a name="L1804"></a><tt class="py-lineno">1804</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">elif</tt> <tt class="py-name">state</tt> <tt class="py-op">==</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L1805"></a><tt class="py-lineno">1805</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-name">tuple</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">:</tt> </tt>
<a name="L1806"></a><tt class="py-lineno">1806</tt> <tt class="py-line"> <tt class="py-name">names</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 id="link-758" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-758', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">names</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">elt</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="L1807"></a><tt class="py-lineno">1807</tt> <tt class="py-line"> <tt class="py-name">state</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L1808"></a><tt class="py-lineno">1808</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1809"></a><tt class="py-lineno">1809</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-759" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-759', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected a name"</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">state</tt> <tt class="py-op">==</tt> <tt class="py-number">2</tt><tt class="py-op">:</tt> </tt>
<a name="L1811"></a><tt class="py-lineno">1811</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-760" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-760', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected a name"</tt><tt class="py-op">)</tt> </tt>
<a name="L1812"></a><tt class="py-lineno">1812</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">names</tt> </tt>
</div><a name="L1813"></a><tt class="py-lineno">1813</tt> <tt class="py-line"> </tt>
<a name="parse_string"></a><div id="parse_string-def"><a name="L1814"></a><tt class="py-lineno">1814</tt> <a class="py-toggle" href="#" id="parse_string-toggle" onclick="return toggle('parse_string');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_string">parse_string</a><tt class="py-op">(</tt><tt class="py-param">elt_list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_string-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_string-expanded"><a name="L1815"></a><tt class="py-lineno">1815</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">elt_list</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">elt_list</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-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">STRING</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"># [xx] use something safer here? But it needs to deal with</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"># any string type (eg r"foo\bar" etc).</tt> </tt>
<a name="L1818"></a><tt class="py-lineno">1818</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">eval</tt><tt class="py-op">(</tt><tt class="py-name">elt_list</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-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1819"></a><tt class="py-lineno">1819</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1820"></a><tt class="py-lineno">1820</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-761" class="py-name"><a title="epydoc.docparser.ParseError
epydoc.markup.ParseError" class="py-name" href="#" onclick="return doclink('link-761', 'ParseError', 'link-87');">ParseError</a></tt><tt class="py-op">(</tt><tt class="py-string">"Expected a string"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1821"></a><tt class="py-lineno">1821</tt> <tt class="py-line"> </tt>
<a name="L1822"></a><tt class="py-lineno">1822</tt> <tt class="py-line"><tt class="py-comment"># ['1', 'b', 'c']</tt> </tt>
<a name="parse_string_list"></a><div id="parse_string_list-def"><a name="L1823"></a><tt class="py-lineno">1823</tt> <a class="py-toggle" href="#" id="parse_string_list-toggle" onclick="return toggle('parse_string_list');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#parse_string_list">parse_string_list</a><tt class="py-op">(</tt><tt class="py-param">elt_list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="parse_string_list-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="parse_string_list-expanded"><a name="L1824"></a><tt class="py-lineno">1824</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">elt_list</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">elt_list</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1825"></a><tt class="py-lineno">1825</tt> <tt class="py-line"> <tt class="py-name">elt_list</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-number">0</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-keyword">in</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-op">:</tt> </tt>
<a name="L1826"></a><tt class="py-lineno">1826</tt> <tt class="py-line"> <tt class="py-name">elt_list</tt> <tt class="py-op">=</tt> <tt class="py-name">elt_list</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-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>
<a name="L1827"></a><tt class="py-lineno">1827</tt> <tt class="py-line"> </tt>
<a name="L1828"></a><tt class="py-lineno">1828</tt> <tt class="py-line"> <tt class="py-name">string_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L1829"></a><tt class="py-lineno">1829</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">string_elt</tt> <tt class="py-keyword">in</tt> <tt id="link-762" class="py-name"><a title="epydoc.docparser.split_on" class="py-name" href="#" onclick="return doclink('link-762', 'split_on', 'link-296');">split_on</a></tt><tt class="py-op">(</tt><tt class="py-name">elt_list</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">OP</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>
<a name="L1830"></a><tt class="py-lineno">1830</tt> <tt class="py-line"> <tt class="py-name">string_list</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-763" class="py-name"><a title="epydoc.docparser.parse_string" class="py-name" href="#" onclick="return doclink('link-763', 'parse_string', 'link-102');">parse_string</a></tt><tt class="py-op">(</tt><tt class="py-name">string_elt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L1831"></a><tt class="py-lineno">1831</tt> <tt class="py-line"> </tt>
<a name="L1832"></a><tt class="py-lineno">1832</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">string_list</tt> </tt>
</div><a name="L1833"></a><tt class="py-lineno">1833</tt> <tt class="py-line"> </tt>
<a name="L1834"></a><tt class="py-lineno">1834</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1835"></a><tt class="py-lineno">1835</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Variable Manipulation</tt> </tt>
<a name="L1836"></a><tt class="py-lineno">1836</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1837"></a><tt class="py-lineno">1837</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="set_variable"></a><div id="set_variable-def"><a name="L1838"></a><tt class="py-lineno">1838</tt> <a class="py-toggle" href="#" id="set_variable-toggle" onclick="return toggle('set_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#set_variable">set_variable</a><tt class="py-op">(</tt><tt class="py-param">namespace</tt><tt class="py-op">,</tt> <tt class="py-param">var_doc</tt><tt class="py-op">,</tt> <tt class="py-param">preserve_docstring</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="set_variable-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_variable-expanded"><a name="L1839"></a><tt class="py-lineno">1839</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1840"></a><tt class="py-lineno">1840</tt> <tt class="py-line"><tt class="py-docstring"> Add var_doc to namespace. If namespace already contains a</tt> </tt>
<a name="L1841"></a><tt class="py-lineno">1841</tt> <tt class="py-line"><tt class="py-docstring"> variable with the same name, then discard the old variable. If</tt> </tt>
<a name="L1842"></a><tt class="py-lineno">1842</tt> <tt class="py-line"><tt class="py-docstring"> C{preserve_docstring} is true, then keep the old variable's</tt> </tt>
<a name="L1843"></a><tt class="py-lineno">1843</tt> <tt class="py-line"><tt class="py-docstring"> docstring when overwriting a variable.</tt> </tt>
<a name="L1844"></a><tt class="py-lineno">1844</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1845"></a><tt class="py-lineno">1845</tt> <tt class="py-line"> <tt class="py-comment"># Choose which dictionary we'll be storing the variable in.</tt> </tt>
<a name="L1846"></a><tt class="py-lineno">1846</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">namespace</tt><tt class="py-op">,</tt> <tt id="link-764" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-764', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1847"></a><tt class="py-lineno">1847</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1848"></a><tt class="py-lineno">1848</tt> <tt class="py-line"> </tt>
<a name="L1849"></a><tt class="py-lineno">1849</tt> <tt class="py-line"> <tt class="py-comment"># This happens when the class definition has not been parsed, e.g. in</tt> </tt>
<a name="L1850"></a><tt class="py-lineno">1850</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># sf bug #1693253 on ``Exception.x = y``</tt> </tt>
<a name="L1851"></a><tt class="py-lineno">1851</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-765" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-765', 'sort_spec', 'link-71');">sort_spec</a></tt> <tt class="py-keyword">is</tt> <tt id="link-766" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-766', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1852"></a><tt class="py-lineno">1852</tt> <tt class="py-line"> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-767" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-767', 'sort_spec', 'link-71');">sort_spec</a></tt> <tt class="py-op">=</tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-768" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-768', 'variables', 'link-70');">variables</a></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="L1853"></a><tt class="py-lineno">1853</tt> <tt class="py-line"> </tt>
<a name="L1854"></a><tt class="py-lineno">1854</tt> <tt class="py-line"> <tt class="py-comment"># If we already have a variable with this name, then remove the</tt> </tt>
<a name="L1855"></a><tt class="py-lineno">1855</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># old VariableDoc from the sort_spec list; and if we gave its</tt> </tt>
<a name="L1856"></a><tt class="py-lineno">1856</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># value a canonical name, then delete it.</tt> </tt>
<a name="L1857"></a><tt class="py-lineno">1857</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-op">.</tt><tt id="link-769" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-769', 'name', 'link-31');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-770" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-770', 'variables', 'link-70');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1858"></a><tt class="py-lineno">1858</tt> <tt class="py-line"> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-771" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-771', 'sort_spec', 'link-71');">sort_spec</a></tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-772" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-772', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1859"></a><tt class="py-lineno">1859</tt> <tt class="py-line"> <tt class="py-name">old_var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-773" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-773', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-774" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-774', 'name', 'link-31');">name</a></tt><tt class="py-op">]</tt> </tt>
<a name="L1860"></a><tt class="py-lineno">1860</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">old_var_doc</tt><tt class="py-op">.</tt><tt id="link-775" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-775', 'is_alias', 'link-300');">is_alias</a></tt> <tt class="py-op">==</tt> <tt class="py-name">False</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1861"></a><tt class="py-lineno">1861</tt> <tt class="py-line"> <tt class="py-name">old_var_doc</tt><tt class="py-op">.</tt><tt id="link-776" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-776', 'value', 'link-135');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-777" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-777', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1862"></a><tt class="py-lineno">1862</tt> <tt class="py-line"> <tt class="py-name">old_var_doc</tt><tt class="py-op">.</tt><tt id="link-778" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-778', 'value', 'link-135');">value</a></tt><tt class="py-op">.</tt><tt id="link-779" 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-779', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-780" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-780', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L1863"></a><tt class="py-lineno">1863</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">preserve_docstring</tt> <tt class="py-keyword">and</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-781" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-781', 'docstring', 'link-531');">docstring</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-782" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-782', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1864"></a><tt class="py-lineno">1864</tt> <tt class="py-line"> <tt class="py-name">old_var_doc</tt><tt class="py-op">.</tt><tt id="link-783" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-783', 'docstring', 'link-531');">docstring</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-784" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-784', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1865"></a><tt class="py-lineno">1865</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-785" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-785', 'docstring', 'link-531');">docstring</a></tt> <tt class="py-op">=</tt> <tt class="py-name">old_var_doc</tt><tt class="py-op">.</tt><tt id="link-786" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-786', 'docstring', 'link-531');">docstring</a></tt> </tt>
<a name="L1866"></a><tt class="py-lineno">1866</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-787" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-787', 'docstring_lineno', 'link-555');">docstring_lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">old_var_doc</tt><tt class="py-op">.</tt><tt id="link-788" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-788', 'docstring_lineno', 'link-555');">docstring_lineno</a></tt> </tt>
<a name="L1867"></a><tt class="py-lineno">1867</tt> <tt class="py-line"> <tt class="py-comment"># Add the variable to the namespace.</tt> </tt>
<a name="L1868"></a><tt class="py-lineno">1868</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-789" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-789', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-790" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-790', 'name', 'link-31');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt> </tt>
<a name="L1869"></a><tt class="py-lineno">1869</tt> <tt class="py-line"> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-791" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-791', 'sort_spec', 'link-71');">sort_spec</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 id="link-792" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-792', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1870"></a><tt class="py-lineno">1870</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-793" 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-793', 'container', 'link-250');">container</a></tt> <tt class="py-keyword">is</tt> <tt id="link-794" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-794', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L1871"></a><tt class="py-lineno">1871</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-795" 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-795', 'container', 'link-250');">container</a></tt> <tt class="py-op">=</tt> <tt class="py-name">namespace</tt> </tt>
</div><a name="L1872"></a><tt class="py-lineno">1872</tt> <tt class="py-line"> </tt>
<a name="del_variable"></a><div id="del_variable-def"><a name="L1873"></a><tt class="py-lineno">1873</tt> <a class="py-toggle" href="#" id="del_variable-toggle" onclick="return toggle('del_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#del_variable">del_variable</a><tt class="py-op">(</tt><tt class="py-param">namespace</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="del_variable-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="del_variable-expanded"><a name="L1874"></a><tt class="py-lineno">1874</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">namespace</tt><tt class="py-op">,</tt> <tt id="link-796" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-796', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1875"></a><tt class="py-lineno">1875</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L1876"></a><tt class="py-lineno">1876</tt> <tt class="py-line"> </tt>
<a name="L1877"></a><tt class="py-lineno">1877</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-797" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-797', 'name', 'link-31');">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 class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-798" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-798', 'variables', 'link-70');">variables</a></tt><tt class="py-op">:</tt> </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">len</tt><tt class="py-op">(</tt><tt id="link-799" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-799', 'name', 'link-31');">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="L1879"></a><tt class="py-lineno">1879</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-800" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-800', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt id="link-801" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-801', 'name', 'link-31');">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>
<a name="L1880"></a><tt class="py-lineno">1880</tt> <tt class="py-line"> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-802" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.sort_spec" class="py-name" href="#" onclick="return doclink('link-802', 'sort_spec', 'link-71');">sort_spec</a></tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt id="link-803" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-803', 'name', 'link-31');">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>
<a name="L1881"></a><tt class="py-lineno">1881</tt> <tt class="py-line"> <tt class="py-keyword">del</tt> <tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-804" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-804', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt id="link-805" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-805', 'name', 'link-31');">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>
<a name="L1882"></a><tt class="py-lineno">1882</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-806" class="py-name"><a title="epydoc.apidoc.VariableDoc.is_alias" class="py-name" href="#" onclick="return doclink('link-806', 'is_alias', 'link-300');">is_alias</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-807" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-807', 'value', 'link-135');">value</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt id="link-808" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-808', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1883"></a><tt class="py-lineno">1883</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-809" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-809', 'value', 'link-135');">value</a></tt><tt class="py-op">.</tt><tt id="link-810" 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-810', 'canonical_name', 'link-37');">canonical_name</a></tt> <tt class="py-op">=</tt> <tt id="link-811" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-811', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> </tt>
<a name="L1884"></a><tt class="py-lineno">1884</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1885"></a><tt class="py-lineno">1885</tt> <tt class="py-line"> <tt id="link-812" class="py-name"><a title="epydoc.docparser.del_variable" class="py-name" href="#" onclick="return doclink('link-812', 'del_variable', 'link-530');">del_variable</a></tt><tt class="py-op">(</tt><tt class="py-name">namespace</tt><tt class="py-op">.</tt><tt id="link-813" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-813', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt id="link-814" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-814', 'name', 'link-31');">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 id="link-815" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-815', 'value', 'link-135');">value</a></tt><tt class="py-op">,</tt> <tt id="link-816" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-816', 'name', 'link-31');">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>
</div><a name="L1886"></a><tt class="py-lineno">1886</tt> <tt class="py-line"> </tt>
<a name="L1887"></a><tt class="py-lineno">1887</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</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">#{ Name Lookup</tt> </tt>
<a name="L1889"></a><tt class="py-lineno">1889</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1890"></a><tt class="py-lineno">1890</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="lookup_name"></a><div id="lookup_name-def"><a name="L1891"></a><tt class="py-lineno">1891</tt> <a class="py-toggle" href="#" id="lookup_name-toggle" onclick="return toggle('lookup_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#lookup_name">lookup_name</a><tt class="py-op">(</tt><tt class="py-param">identifier</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="lookup_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="lookup_name-expanded"><a name="L1892"></a><tt class="py-lineno">1892</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1893"></a><tt class="py-lineno">1893</tt> <tt class="py-line"><tt class="py-docstring"> Find and return the documentation for the variable named by</tt> </tt>
<a name="L1894"></a><tt class="py-lineno">1894</tt> <tt class="py-line"><tt class="py-docstring"> the given identifier.</tt> </tt>
<a name="L1895"></a><tt class="py-lineno">1895</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L1896"></a><tt class="py-lineno">1896</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: L{VariableDoc} or C{None}</tt> </tt>
<a name="L1897"></a><tt class="py-lineno">1897</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1898"></a><tt class="py-lineno">1898</tt> <tt class="py-line"> <tt class="py-comment"># We need to check 3 namespaces: locals, globals, and builtins.</tt> </tt>
<a name="L1899"></a><tt class="py-lineno">1899</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># Note that this is true even if we're in a version of python with</tt> </tt>
<a name="L1900"></a><tt class="py-lineno">1900</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># nested scopes, because nested scope lookup does not apply to</tt> </tt>
<a name="L1901"></a><tt class="py-lineno">1901</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># nested class definitions, and we're not worried about variables</tt> </tt>
<a name="L1902"></a><tt class="py-lineno">1902</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># in nested functions.</tt> </tt>
<a name="L1903"></a><tt class="py-lineno">1903</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">identifier</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="L1904"></a><tt class="py-lineno">1904</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">'identifier must be a string'</tt><tt class="py-op">)</tt> </tt>
<a name="L1905"></a><tt class="py-lineno">1905</tt> <tt class="py-line"> </tt>
<a name="L1906"></a><tt class="py-lineno">1906</tt> <tt class="py-line"> <tt class="py-comment"># Locals</tt> </tt>
<a name="L1907"></a><tt class="py-lineno">1907</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">parent_docs</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 id="link-817" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-817', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1908"></a><tt class="py-lineno">1908</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parent_docs</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 id="link-818" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-818', 'variables', 'link-70');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1909"></a><tt class="py-lineno">1909</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parent_docs</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 id="link-819" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-819', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">identifier</tt><tt class="py-op">]</tt> </tt>
<a name="L1910"></a><tt class="py-lineno">1910</tt> <tt class="py-line"> </tt>
<a name="L1911"></a><tt class="py-lineno">1911</tt> <tt class="py-line"> <tt class="py-comment"># Globals (aka the containing module)</tt> </tt>
<a name="L1912"></a><tt class="py-lineno">1912</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">parent_docs</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-820" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-820', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1913"></a><tt class="py-lineno">1913</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">parent_docs</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-821" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-821', 'variables', 'link-70');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1914"></a><tt class="py-lineno">1914</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parent_docs</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-822" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-822', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">identifier</tt><tt class="py-op">]</tt> </tt>
<a name="L1915"></a><tt class="py-lineno">1915</tt> <tt class="py-line"> </tt>
<a name="L1916"></a><tt class="py-lineno">1916</tt> <tt class="py-line"> <tt class="py-comment"># Builtins</tt> </tt>
<a name="L1917"></a><tt class="py-lineno">1917</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">builtins</tt> <tt class="py-op">=</tt> <tt id="link-823" class="py-name"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-823', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-824" class="py-name"><a title="epydoc.docintrospecter" class="py-name" href="#" onclick="return doclink('link-824', 'docintrospecter', 'link-4');">docintrospecter</a></tt><tt class="py-op">.</tt><tt id="link-825" class="py-name"><a title="epydoc.docintrospecter.introspect_docs" class="py-name" href="#" onclick="return doclink('link-825', 'introspect_docs', 'link-26');">introspect_docs</a></tt><tt class="py-op">(</tt><tt class="py-name">__builtin__</tt><tt class="py-op">)</tt> </tt>
<a name="L1918"></a><tt class="py-lineno">1918</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">builtins</tt><tt class="py-op">,</tt> <tt id="link-826" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-826', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></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 class="py-keyword">if</tt> <tt class="py-name">identifier</tt> <tt class="py-keyword">in</tt> <tt class="py-name">builtins</tt><tt class="py-op">.</tt><tt id="link-827" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-827', 'variables', 'link-70');">variables</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1920"></a><tt class="py-lineno">1920</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">builtins</tt><tt class="py-op">.</tt><tt id="link-828" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-828', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">identifier</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"># We didn't find it; return None.</tt> </tt>
<a name="L1923"></a><tt class="py-lineno">1923</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L1924"></a><tt class="py-lineno">1924</tt> <tt class="py-line"> </tt>
<a name="lookup_variable"></a><div id="lookup_variable-def"><a name="L1925"></a><tt class="py-lineno">1925</tt> <a class="py-toggle" href="#" id="lookup_variable-toggle" onclick="return toggle('lookup_variable');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#lookup_variable">lookup_variable</a><tt class="py-op">(</tt><tt class="py-param">dotted_name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="lookup_variable-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="lookup_variable-expanded"><a name="L1926"></a><tt class="py-lineno">1926</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">,</tt> <tt id="link-829" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-829', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1927"></a><tt class="py-lineno">1927</tt> <tt class="py-line"> <tt class="py-comment"># If it's a simple identifier, use lookup_name.</tt> </tt>
<a name="L1928"></a><tt class="py-lineno">1928</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">dotted_name</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="L1929"></a><tt class="py-lineno">1929</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-830" class="py-name"><a title="epydoc.docparser.lookup_name" class="py-name" href="#" onclick="return doclink('link-830', 'lookup_name', 'link-684');">lookup_name</a></tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</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">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1930"></a><tt class="py-lineno">1930</tt> <tt class="py-line"> </tt>
<a name="L1931"></a><tt class="py-lineno">1931</tt> <tt class="py-line"> <tt class="py-comment"># If it's a dotted name with multiple pieces, look up the</tt> </tt>
<a name="L1932"></a><tt class="py-lineno">1932</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># namespace containing the var (=parent) first; and then</tt> </tt>
<a name="L1933"></a><tt class="py-lineno">1933</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># look for the var in that namespace.</tt> </tt>
<a name="L1934"></a><tt class="py-lineno">1934</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1935"></a><tt class="py-lineno">1935</tt> <tt class="py-line"> <tt class="py-name">parent</tt> <tt class="py-op">=</tt> <tt id="link-831" class="py-name"><a title="epydoc.docparser.lookup_value" class="py-name" href="#" onclick="return doclink('link-831', 'lookup_value', 'link-495');">lookup_value</a></tt><tt class="py-op">(</tt><tt class="py-name">dotted_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-name">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1936"></a><tt class="py-lineno">1936</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">parent</tt><tt class="py-op">,</tt> <tt id="link-832" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-832', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1937"></a><tt class="py-lineno">1937</tt> <tt class="py-line"> <tt class="py-name">dotted_name</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-keyword">in</tt> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt id="link-833" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-833', 'variables', 'link-70');">variables</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1938"></a><tt class="py-lineno">1938</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt id="link-834" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-834', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt class="py-name">dotted_name</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="L1939"></a><tt class="py-lineno">1939</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1940"></a><tt class="py-lineno">1940</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> <tt class="py-comment"># var not found.</tt> </tt>
</div><a name="L1941"></a><tt class="py-lineno">1941</tt> <tt class="py-line"> </tt>
<a name="lookup_value"></a><div id="lookup_value-def"><a name="L1942"></a><tt class="py-lineno">1942</tt> <a class="py-toggle" href="#" id="lookup_value-toggle" onclick="return toggle('lookup_value');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#lookup_value">lookup_value</a><tt class="py-op">(</tt><tt class="py-param">dotted_name</tt><tt class="py-op">,</tt> <tt class="py-param">parent_docs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="lookup_value-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="lookup_value-expanded"><a name="L1943"></a><tt class="py-lineno">1943</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L1944"></a><tt class="py-lineno">1944</tt> <tt class="py-line"><tt class="py-docstring"> Find and return the documentation for the value contained in</tt> </tt>
<a name="L1945"></a><tt class="py-lineno">1945</tt> <tt class="py-line"><tt class="py-docstring"> the variable with the given name in the current namespace.</tt> </tt>
<a name="L1946"></a><tt class="py-lineno">1946</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L1947"></a><tt class="py-lineno">1947</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">,</tt> <tt id="link-835" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-835', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1948"></a><tt class="py-lineno">1948</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt id="link-836" class="py-name"><a title="epydoc.docparser.lookup_name" class="py-name" href="#" onclick="return doclink('link-836', 'lookup_name', 'link-684');">lookup_name</a></tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</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">parent_docs</tt><tt class="py-op">)</tt> </tt>
<a name="L1949"></a><tt class="py-lineno">1949</tt> <tt class="py-line"> </tt>
<a name="L1950"></a><tt class="py-lineno">1950</tt> <tt class="py-line"> <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-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">)</tt><tt class="py-op">)</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">if</tt> <tt class="py-name">var_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1952"></a><tt class="py-lineno">1952</tt> <tt class="py-line"> </tt>
<a name="L1953"></a><tt class="py-lineno">1953</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-837" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-837', 'value', 'link-135');">value</a></tt><tt class="py-op">,</tt> <tt id="link-838" class="py-name"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-838', 'NamespaceDoc', 'link-181');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1954"></a><tt class="py-lineno">1954</tt> <tt class="py-line"> <tt class="py-name">var_dict</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-839" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-839', 'value', 'link-135');">value</a></tt><tt class="py-op">.</tt><tt id="link-840" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-840', 'variables', 'link-70');">variables</a></tt> </tt>
<a name="L1955"></a><tt class="py-lineno">1955</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-841" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-841', 'value', 'link-135');">value</a></tt> <tt class="py-keyword">is</tt> <tt id="link-842" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-842', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1956"></a><tt class="py-lineno">1956</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-843" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-843', 'imported_from', 'link-167');">imported_from</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-844" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-844', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1957"></a><tt class="py-lineno">1957</tt> <tt class="py-line"> <tt class="py-name">src_name</tt> <tt class="py-op">=</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-845" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-845', 'imported_from', 'link-167');">imported_from</a></tt> <tt class="py-op">+</tt> <tt class="py-name">dotted_name</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="L1958"></a><tt class="py-lineno">1958</tt> <tt class="py-line"> <tt class="py-comment"># [xx] do I want to create a proxy here??</tt> </tt>
<a name="L1959"></a><tt class="py-lineno">1959</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt id="link-846" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-846', 'GenericValueDoc', 'link-506');">GenericValueDoc</a></tt><tt class="py-op">(</tt><tt id="link-847" class="py-name"><a title="epydoc.apidoc.ValueDoc.proxy_for" class="py-name" href="#" onclick="return doclink('link-847', 'proxy_for', 'link-396');">proxy_for</a></tt><tt class="py-op">=</tt><tt class="py-name">src_name</tt><tt class="py-op">,</tt> </tt>
<a name="L1960"></a><tt class="py-lineno">1960</tt> <tt class="py-line"> <tt id="link-848" class="py-name"><a title="epydoc.apidoc.ValueDoc.parse_repr" class="py-name" href="#" onclick="return doclink('link-848', 'parse_repr', 'link-504');">parse_repr</a></tt><tt class="py-op">=</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
<a name="L1961"></a><tt class="py-lineno">1961</tt> <tt class="py-line"> <tt id="link-849" class="py-name"><a title="epydoc.apidoc.APIDoc.docs_extracted_by" class="py-name" href="#" onclick="return doclink('link-849', 'docs_extracted_by', 'link-78');">docs_extracted_by</a></tt><tt class="py-op">=</tt><tt class="py-string">'parser'</tt><tt class="py-op">)</tt> </tt>
<a name="L1962"></a><tt class="py-lineno">1962</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1963"></a><tt class="py-lineno">1963</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1964"></a><tt class="py-lineno">1964</tt> <tt class="py-line"> </tt>
<a name="L1965"></a><tt class="py-lineno">1965</tt> <tt class="py-line"> <tt class="py-name">var_doc</tt> <tt class="py-op">=</tt> <tt class="py-name">var_dict</tt><tt class="py-op">.</tt><tt class="py-name">get</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</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="L1966"></a><tt class="py-lineno">1966</tt> <tt class="py-line"> </tt>
<a name="L1967"></a><tt class="py-lineno">1967</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-name">None</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L1968"></a><tt class="py-lineno">1968</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">var_doc</tt><tt class="py-op">.</tt><tt id="link-850" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-850', 'value', 'link-135');">value</a></tt> </tt>
</div><a name="L1969"></a><tt class="py-lineno">1969</tt> <tt class="py-line"> </tt>
<a name="L1970"></a><tt class="py-lineno">1970</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1971"></a><tt class="py-lineno">1971</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Docstring Comments</tt> </tt>
<a name="L1972"></a><tt class="py-lineno">1972</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1973"></a><tt class="py-lineno">1973</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="add_docstring_from_comments"></a><div id="add_docstring_from_comments-def"><a name="L1974"></a><tt class="py-lineno">1974</tt> <a class="py-toggle" href="#" id="add_docstring_from_comments-toggle" onclick="return toggle('add_docstring_from_comments');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#add_docstring_from_comments">add_docstring_from_comments</a><tt class="py-op">(</tt><tt class="py-param">api_doc</tt><tt class="py-op">,</tt> <tt class="py-param">comments</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="add_docstring_from_comments-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="add_docstring_from_comments-expanded"><a name="L1975"></a><tt class="py-lineno">1975</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">api_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt> <tt class="py-keyword">or</tt> <tt class="py-keyword">not</tt> <tt class="py-name">comments</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L1976"></a><tt class="py-lineno">1976</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-851" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-851', 'docstring', 'link-531');">docstring</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</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-name">line</tt> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">,</tt> <tt id="link-852" class="py-name"><a title="epydoc.apidoc.RoutineDoc.lineno" class="py-name" href="#" onclick="return doclink('link-852', 'lineno', 'link-207');">lineno</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">comments</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L1977"></a><tt class="py-lineno">1977</tt> <tt class="py-line"> <tt class="py-name">api_doc</tt><tt class="py-op">.</tt><tt id="link-853" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring_lineno" class="py-name" href="#" onclick="return doclink('link-853', 'docstring_lineno', 'link-555');">docstring_lineno</a></tt> <tt class="py-op">=</tt> <tt class="py-name">comments</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-number">1</tt><tt class="py-op">]</tt> </tt>
</div><a name="L1978"></a><tt class="py-lineno">1978</tt> <tt class="py-line"> </tt>
<a name="L1979"></a><tt class="py-lineno">1979</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1980"></a><tt class="py-lineno">1980</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Tree tokens</tt> </tt>
<a name="L1981"></a><tt class="py-lineno">1981</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L1982"></a><tt class="py-lineno">1982</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="_join_toktree"></a><div id="_join_toktree-def"><a name="L1983"></a><tt class="py-lineno">1983</tt> <a class="py-toggle" href="#" id="_join_toktree-toggle" onclick="return toggle('_join_toktree');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_join_toktree">_join_toktree</a><tt class="py-op">(</tt><tt class="py-param">s1</tt><tt class="py-op">,</tt> <tt class="py-param">s2</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_join_toktree-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_join_toktree-expanded"><a name="L1984"></a><tt class="py-lineno">1984</tt> <tt class="py-line"> <tt class="py-comment"># Join them. s1 = left side; s2 = right side.</tt> </tt>
<a name="L1985"></a><tt class="py-lineno">1985</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">s2</tt><tt class="py-op">==</tt><tt class="py-string">''</tt> <tt class="py-keyword">or</tt> <tt class="py-name">s1</tt><tt class="py-op">==</tt><tt class="py-string">''</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L1986"></a><tt class="py-lineno">1986</tt> <tt class="py-line"> <tt class="py-name">s1</tt> <tt class="py-keyword">in</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-keyword">or</tt> <tt class="py-name">s2</tt> <tt class="py-keyword">in</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-string">')'</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-keyword">or</tt> </tt>
<a name="L1987"></a><tt class="py-lineno">1987</tt> <tt class="py-line"> <tt class="py-name">s2</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</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-keyword">or</tt> <tt class="py-name">s1</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-keyword">in</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-string">'{'</tt><tt class="py-op">,</tt><tt class="py-string">'.'</tt><tt class="py-op">,</tt><tt class="py-string">'\n'</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="L1988"></a><tt class="py-lineno">1988</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">s2</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-name">s1</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-keyword">not</tt> <tt class="py-keyword">in</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-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1989"></a><tt class="py-lineno">1989</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">s1</tt><tt class="py-op">,</tt><tt class="py-name">s2</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">elif</tt> <tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">==</tt><tt class="py-string">'tight'</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L1991"></a><tt class="py-lineno">1991</tt> <tt class="py-line"> <tt class="py-name">s1</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-keyword">in</tt> <tt class="py-string">'+-*/=,'</tt> <tt class="py-keyword">or</tt> <tt class="py-name">s2</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-string">'+-*/=,'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L1992"></a><tt class="py-lineno">1992</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">s1</tt><tt class="py-op">,</tt> <tt class="py-name">s2</tt><tt class="py-op">)</tt> </tt>
<a name="L1993"></a><tt class="py-lineno">1993</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</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-string">'%s %s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">s1</tt><tt class="py-op">,</tt> <tt class="py-name">s2</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1995"></a><tt class="py-lineno">1995</tt> <tt class="py-line"> </tt>
<a name="_pp_toktree_add_piece"></a><div id="_pp_toktree_add_piece-def"><a name="L1996"></a><tt class="py-lineno">1996</tt> <a class="py-toggle" href="#" id="_pp_toktree_add_piece-toggle" onclick="return toggle('_pp_toktree_add_piece');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_pp_toktree_add_piece">_pp_toktree_add_piece</a><tt class="py-op">(</tt><tt class="py-param">spacing</tt><tt class="py-op">,</tt> <tt class="py-param">pieces</tt><tt class="py-op">,</tt> <tt class="py-param">piece</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pp_toktree_add_piece-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pp_toktree_add_piece-expanded"><a name="L1997"></a><tt class="py-lineno">1997</tt> <tt class="py-line"> <tt class="py-name">s1</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-op">]</tt> </tt>
<a name="L1998"></a><tt class="py-lineno">1998</tt> <tt class="py-line"> <tt class="py-name">s2</tt> <tt class="py-op">=</tt> <tt class="py-name">piece</tt> </tt>
<a name="L1999"></a><tt class="py-lineno">1999</tt> <tt class="py-line"> </tt>
<a name="L2000"></a><tt class="py-lineno">2000</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">s2</tt><tt class="py-op">==</tt><tt class="py-string">''</tt> <tt class="py-keyword">or</tt> <tt class="py-name">s1</tt><tt class="py-op">==</tt><tt class="py-string">''</tt> <tt class="py-keyword">or</tt> </tt>
<a name="L2001"></a><tt class="py-lineno">2001</tt> <tt class="py-line"> <tt class="py-name">s1</tt> <tt class="py-keyword">in</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-keyword">or</tt> <tt class="py-name">s2</tt> <tt class="py-keyword">in</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-string">')'</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-keyword">or</tt> </tt>
<a name="L2002"></a><tt class="py-lineno">2002</tt> <tt class="py-line"> <tt class="py-name">s2</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</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-keyword">or</tt> <tt class="py-name">s1</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-keyword">in</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-string">'{'</tt><tt class="py-op">,</tt><tt class="py-string">'.'</tt><tt class="py-op">,</tt><tt class="py-string">'\n'</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="L2003"></a><tt class="py-lineno">2003</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">s2</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-name">s1</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-keyword">not</tt> <tt class="py-keyword">in</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-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2004"></a><tt class="py-lineno">2004</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L2005"></a><tt class="py-lineno">2005</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">==</tt><tt class="py-string">'tight'</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2006"></a><tt class="py-lineno">2006</tt> <tt class="py-line"> <tt class="py-name">s1</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-keyword">in</tt> <tt class="py-string">'+-*/=,'</tt> <tt class="py-keyword">or</tt> <tt class="py-name">s2</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-keyword">in</tt> <tt class="py-string">'+-*/=,'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2007"></a><tt class="py-lineno">2007</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L2008"></a><tt class="py-lineno">2008</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2009"></a><tt class="py-lineno">2009</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">)</tt> </tt>
<a name="L2010"></a><tt class="py-lineno">2010</tt> <tt class="py-line"> </tt>
<a name="L2011"></a><tt class="py-lineno">2011</tt> <tt class="py-line"> <tt class="py-name">pieces</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">piece</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2012"></a><tt class="py-lineno">2012</tt> <tt class="py-line"> </tt>
<a name="pp_toktree"></a><div id="pp_toktree-def"><a name="L2013"></a><tt class="py-lineno">2013</tt> <a class="py-toggle" href="#" id="pp_toktree-toggle" onclick="return toggle('pp_toktree');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#pp_toktree">pp_toktree</a><tt class="py-op">(</tt><tt class="py-param">elts</tt><tt class="py-op">,</tt> <tt class="py-param">spacing</tt><tt class="py-op">=</tt><tt class="py-string">'normal'</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pp_toktree-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="pp_toktree-expanded"><a name="L2014"></a><tt class="py-lineno">2014</tt> <tt class="py-line"> <tt class="py-name">pieces</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">''</tt><tt class="py-op">]</tt> </tt>
<a name="L2015"></a><tt class="py-lineno">2015</tt> <tt class="py-line"> <tt id="link-854" class="py-name" targets="Function epydoc.docparser._pp_toktree()=epydoc.docparser-module.html#_pp_toktree"><a title="epydoc.docparser._pp_toktree" class="py-name" href="#" onclick="return doclink('link-854', '_pp_toktree', 'link-854');">_pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">elts</tt><tt class="py-op">,</tt> <tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</tt><tt class="py-op">)</tt> </tt>
<a name="L2016"></a><tt class="py-lineno">2016</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">pieces</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2017"></a><tt class="py-lineno">2017</tt> <tt class="py-line"> </tt>
<a name="_pp_toktree"></a><div id="_pp_toktree-def"><a name="L2018"></a><tt class="py-lineno">2018</tt> <a class="py-toggle" href="#" id="_pp_toktree-toggle" onclick="return toggle('_pp_toktree');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_pp_toktree">_pp_toktree</a><tt class="py-op">(</tt><tt class="py-param">elts</tt><tt class="py-op">,</tt> <tt class="py-param">spacing</tt><tt class="py-op">,</tt> <tt class="py-param">indent</tt><tt class="py-op">,</tt> <tt class="py-param">pieces</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_pp_toktree-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_pp_toktree-expanded"><a name="L2019"></a><tt class="py-lineno">2019</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt> <tt class="py-op">=</tt> <tt id="link-855" class="py-name" targets="Function epydoc.docparser._pp_toktree_add_piece()=epydoc.docparser-module.html#_pp_toktree_add_piece"><a title="epydoc.docparser._pp_toktree_add_piece" class="py-name" href="#" onclick="return doclink('link-855', '_pp_toktree_add_piece', 'link-855');">_pp_toktree_add_piece</a></tt> </tt>
<a name="L2020"></a><tt class="py-lineno">2020</tt> <tt class="py-line"> </tt>
<a name="L2021"></a><tt class="py-lineno">2021</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">elts</tt><tt class="py-op">:</tt> </tt>
<a name="L2022"></a><tt class="py-lineno">2022</tt> <tt class="py-line"> <tt class="py-comment"># Put a blank line before class & def statements.</tt> </tt>
<a name="L2023"></a><tt class="py-lineno">2023</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">elt</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'class'</tt><tt class="py-op">)</tt> <tt class="py-keyword">or</tt> <tt class="py-name">elt</tt> <tt class="py-op">==</tt> <tt class="py-op">(</tt><tt class="py-name">token</tt><tt class="py-op">.</tt><tt class="py-name">NAME</tt><tt class="py-op">,</tt> <tt class="py-string">'def'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2024"></a><tt class="py-lineno">2024</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</tt><tt class="py-op">,</tt> <tt class="py-string">'\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L2025"></a><tt class="py-lineno">2025</tt> <tt class="py-line"> </tt>
<a name="L2026"></a><tt class="py-lineno">2026</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-name">tuple</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2027"></a><tt class="py-lineno">2027</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">NEWLINE</tt><tt class="py-op">:</tt> </tt>
<a name="L2028"></a><tt class="py-lineno">2028</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</tt><tt class="py-op">,</tt> <tt class="py-string">' '</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-op">)</tt> </tt>
<a name="L2029"></a><tt class="py-lineno">2029</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</tt><tt class="py-op">,</tt> <tt class="py-string">'\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</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-keyword">elif</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">INDENT</tt><tt class="py-op">:</tt> </tt>
<a name="L2031"></a><tt class="py-lineno">2031</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</tt><tt class="py-op">,</tt> <tt class="py-string">' '</tt><tt class="py-op">)</tt> </tt>
<a name="L2032"></a><tt class="py-lineno">2032</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L2033"></a><tt class="py-lineno">2033</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">elt</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">token</tt><tt class="py-op">.</tt><tt class="py-name">DEDENT</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">assert</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-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">' '</tt> </tt>
<a name="L2035"></a><tt class="py-lineno">2035</tt> <tt class="py-line"> <tt class="py-name">pieces</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="L2036"></a><tt class="py-lineno">2036</tt> <tt class="py-line"> <tt class="py-name">indent</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L2037"></a><tt class="py-lineno">2037</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">elt</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">tokenize</tt><tt class="py-op">.</tt><tt class="py-name">COMMENT</tt><tt class="py-op">:</tt> </tt>
<a name="L2038"></a><tt class="py-lineno">2038</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</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-op">.</tt><tt class="py-name">rstrip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt><tt class="py-op">)</tt> </tt>
<a name="L2039"></a><tt class="py-lineno">2039</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-string">' '</tt><tt class="py-op">*</tt><tt class="py-name">indent</tt><tt class="py-op">)</tt> </tt>
<a name="L2040"></a><tt class="py-lineno">2040</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2041"></a><tt class="py-lineno">2041</tt> <tt class="py-line"> <tt class="py-name">add_piece</tt><tt class="py-op">(</tt><tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</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-op">)</tt> </tt>
<a name="L2042"></a><tt class="py-lineno">2042</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2043"></a><tt class="py-lineno">2043</tt> <tt class="py-line"> <tt id="link-856" class="py-name"><a title="epydoc.docparser._pp_toktree" class="py-name" href="#" onclick="return doclink('link-856', '_pp_toktree', 'link-854');">_pp_toktree</a></tt><tt class="py-op">(</tt><tt class="py-name">elt</tt><tt class="py-op">,</tt> <tt class="py-name">spacing</tt><tt class="py-op">,</tt> <tt class="py-name">indent</tt><tt class="py-op">,</tt> <tt class="py-name">pieces</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2044"></a><tt class="py-lineno">2044</tt> <tt class="py-line"> </tt>
<a name="L2045"></a><tt class="py-lineno">2045</tt> <tt class="py-line"><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2046"></a><tt class="py-lineno">2046</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#{ Helper Functions</tt> </tt>
<a name="L2047"></a><tt class="py-lineno">2047</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#/////////////////////////////////////////////////////////////////</tt> </tt>
<a name="L2048"></a><tt class="py-lineno">2048</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="get_module_encoding"></a><div id="get_module_encoding-def"><a name="L2049"></a><tt class="py-lineno">2049</tt> <a class="py-toggle" href="#" id="get_module_encoding-toggle" onclick="return toggle('get_module_encoding');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#get_module_encoding">get_module_encoding</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_module_encoding-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_module_encoding-expanded"><a name="L2050"></a><tt class="py-lineno">2050</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2051"></a><tt class="py-lineno">2051</tt> <tt class="py-line"><tt class="py-docstring"> @see: U{PEP 263<http://www.python.org/peps/pep-0263.html>}</tt> </tt>
<a name="L2052"></a><tt class="py-lineno">2052</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2053"></a><tt class="py-lineno">2053</tt> <tt class="py-line"> <tt class="py-name">module_file</tt> <tt class="py-op">=</tt> <tt id="link-857" class="py-name"><a title="epydoc.gui.EpydocGUI.open" class="py-name" href="#" onclick="return doclink('link-857', 'open', 'link-211');">open</a></tt><tt class="py-op">(</tt><tt id="link-858" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-858', 'filename', 'link-30');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-string">'rU'</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">try</tt><tt class="py-op">:</tt> </tt>
<a name="L2055"></a><tt class="py-lineno">2055</tt> <tt class="py-line"> <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">module_file</tt><tt class="py-op">.</tt><tt id="link-859" class="py-name"><a title="epydoc.docintrospecter._DevNull.readline" class="py-name" href="#" onclick="return doclink('link-859', 'readline', 'link-218');">readline</a></tt><tt class="py-op">(</tt><tt class="py-op">)</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-number">2</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt>
<a name="L2056"></a><tt class="py-lineno">2056</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">lines</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">startswith</tt><tt class="py-op">(</tt><tt class="py-string">'\xef\xbb\xbf'</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">return</tt> <tt class="py-string">'utf-8'</tt> </tt>
<a name="L2058"></a><tt class="py-lineno">2058</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2059"></a><tt class="py-lineno">2059</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">:</tt> </tt>
<a name="L2060"></a><tt class="py-lineno">2060</tt> <tt class="py-line"> <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">search</tt><tt class="py-op">(</tt><tt class="py-string">"coding[:=]\s*([-\w.]+)"</tt><tt class="py-op">,</tt> <tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L2061"></a><tt class="py-lineno">2061</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L2062"></a><tt class="py-lineno">2062</tt> <tt class="py-line"> </tt>
<a name="L2063"></a><tt class="py-lineno">2063</tt> <tt class="py-line"> <tt class="py-comment"># Fall back on Python's default encoding.</tt> </tt>
<a name="L2064"></a><tt class="py-lineno">2064</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">return</tt> <tt class="py-string">'iso-8859-1'</tt> <tt class="py-comment"># aka 'latin-1'</tt> </tt>
<a name="L2065"></a><tt class="py-lineno">2065</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L2066"></a><tt class="py-lineno">2066</tt> <tt class="py-line"> <tt class="py-name">module_file</tt><tt class="py-op">.</tt><tt id="link-860" class="py-name"><a title="epydoc.cli.HTMLLogger.close
epydoc.docintrospecter._DevNull.close
epydoc.log.Logger.close
epydoc.log.close" class="py-name" href="#" onclick="return doclink('link-860', 'close', 'link-189');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L2067"></a><tt class="py-lineno">2067</tt> <tt class="py-line"> </tt>
<a name="_get_module_name"></a><div id="_get_module_name-def"><a name="L2068"></a><tt class="py-lineno">2068</tt> <a class="py-toggle" href="#" id="_get_module_name-toggle" onclick="return toggle('_get_module_name');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.docparser-module.html#_get_module_name">_get_module_name</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">package_doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_get_module_name-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="_get_module_name-expanded"><a name="L2069"></a><tt class="py-lineno">2069</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2070"></a><tt class="py-lineno">2070</tt> <tt class="py-line"><tt class="py-docstring"> Return (dotted_name, is_package)</tt> </tt>
<a name="L2071"></a><tt class="py-lineno">2071</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2072"></a><tt class="py-lineno">2072</tt> <tt class="py-line"> <tt id="link-861" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-861', 'name', 'link-31');">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'.py\w?$'</tt><tt class="py-op">,</tt> <tt class="py-string">''</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-862" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-862', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-863" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-863', 'filename', 'link-30');">filename</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="L2073"></a><tt class="py-lineno">2073</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-864" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-864', 'name', 'link-31');">name</a></tt> <tt class="py-op">==</tt> <tt class="py-string">'__init__'</tt><tt class="py-op">:</tt> </tt>
<a name="L2074"></a><tt class="py-lineno">2074</tt> <tt class="py-line"> <tt id="link-865" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-865', 'is_package', 'link-76');">is_package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L2075"></a><tt class="py-lineno">2075</tt> <tt class="py-line"> <tt id="link-866" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-866', 'name', 'link-31');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-867" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-867', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-868" class="py-name"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-868', 'path', 'link-0');">path</a></tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt id="link-869" class="py-name"><a title="epydoc.apidoc.ModuleDoc.filename" class="py-name" href="#" onclick="return doclink('link-869', 'filename', 'link-30');">filename</a></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 class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L2076"></a><tt class="py-lineno">2076</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2077"></a><tt class="py-lineno">2077</tt> <tt class="py-line"> <tt id="link-870" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-870', 'is_package', 'link-76');">is_package</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L2078"></a><tt class="py-lineno">2078</tt> <tt class="py-line"> </tt>
<a name="L2079"></a><tt class="py-lineno">2079</tt> <tt class="py-line"> <tt class="py-comment"># [XX] if the module contains a script, then `name` may not</tt> </tt>
<a name="L2080"></a><tt class="py-lineno">2080</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># necessarily be a valid identifier -- which will cause</tt> </tt>
<a name="L2081"></a><tt class="py-lineno">2081</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># DottedName to raise an exception. Is that what I want?</tt> </tt>
<a name="L2082"></a><tt class="py-lineno">2082</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">package_doc</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</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">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-871" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-871', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt id="link-872" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-872', 'name', 'link-31');">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">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2085"></a><tt class="py-lineno">2085</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-873" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-873', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">package_doc</tt><tt class="py-op">.</tt><tt id="link-874" 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-874', 'canonical_name', 'link-37');">canonical_name</a></tt><tt class="py-op">,</tt> <tt id="link-875" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-875', 'name', 'link-31');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L2086"></a><tt class="py-lineno">2086</tt> <tt class="py-line"> </tt>
<a name="L2087"></a><tt class="py-lineno">2087</tt> <tt class="py-line"> <tt class="py-comment"># Check if the module looks like it's shadowed by a variable.</tt> </tt>
<a name="L2088"></a><tt class="py-lineno">2088</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># If so, then add a "'" to the end of its canonical name, to</tt> </tt>
<a name="L2089"></a><tt class="py-lineno">2089</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># distinguish it from the variable.</tt> </tt>
<a name="L2090"></a><tt class="py-lineno">2090</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">package_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 id="link-876" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-876', 'name', 'link-31');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">package_doc</tt><tt class="py-op">.</tt><tt id="link-877" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-877', 'variables', 'link-70');">variables</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-name">vardoc</tt> <tt class="py-op">=</tt> <tt class="py-name">package_doc</tt><tt class="py-op">.</tt><tt id="link-878" class="py-name"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-878', 'variables', 'link-70');">variables</a></tt><tt class="py-op">[</tt><tt id="link-879" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-879', 'name', 'link-31');">name</a></tt><tt class="py-op">]</tt> </tt>
<a name="L2092"></a><tt class="py-lineno">2092</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">vardoc</tt><tt class="py-op">.</tt><tt id="link-880" class="py-name"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-880', 'value', 'link-135');">value</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-881" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-881', 'UNKNOWN', 'link-38');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L2093"></a><tt class="py-lineno">2093</tt> <tt class="py-line"> <tt class="py-name">vardoc</tt><tt class="py-op">.</tt><tt id="link-882" class="py-name"><a title="epydoc.apidoc.VariableDoc.imported_from" class="py-name" href="#" onclick="return doclink('link-882', 'imported_from', 'link-167');">imported_from</a></tt> <tt class="py-op">!=</tt> <tt class="py-name">dotted_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L2094"></a><tt class="py-lineno">2094</tt> <tt class="py-line"> <tt id="link-883" 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-883', 'log', 'link-50');">log</a></tt><tt class="py-op">.</tt><tt id="link-884" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-884', 'warning', 'link-214');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">"Module %s might be shadowed by a variable with "</tt> </tt>
<a name="L2095"></a><tt class="py-lineno">2095</tt> <tt class="py-line"> <tt class="py-string">"the same name."</tt> <tt class="py-op">%</tt> <tt class="py-name">dotted_name</tt><tt class="py-op">)</tt> </tt>
<a name="L2096"></a><tt class="py-lineno">2096</tt> <tt class="py-line"> <tt class="py-name">dotted_name</tt> <tt class="py-op">=</tt> <tt id="link-885" class="py-name"><a title="epydoc.apidoc.DottedName" class="py-name" href="#" onclick="return doclink('link-885', 'DottedName', 'link-33');">DottedName</a></tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">dotted_name</tt><tt class="py-op">)</tt><tt class="py-op">+</tt><tt class="py-string">"'"</tt><tt class="py-op">)</tt> </tt>
<a name="L2097"></a><tt class="py-lineno">2097</tt> <tt class="py-line"> </tt>
<a name="L2098"></a><tt class="py-lineno">2098</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">dotted_name</tt><tt class="py-op">,</tt> <tt id="link-886" class="py-name"><a title="epydoc.apidoc.ModuleDoc.is_package" class="py-name" href="#" onclick="return doclink('link-886', 'is_package', 'link-76');">is_package</a></tt> </tt>
</div><a name="L2099"></a><tt class="py-lineno">2099</tt> <tt class="py-line"> </tt>
<a name="flatten"></a><div id="flatten-def"><a name="L2100"></a><tt class="py-lineno">2100</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.docparser-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="L2101"></a><tt class="py-lineno">2101</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L2102"></a><tt class="py-lineno">2102</tt> <tt class="py-line"><tt class="py-docstring"> @return: a flat list containing the leaves of the given nested</tt> </tt>
<a name="L2103"></a><tt class="py-lineno">2103</tt> <tt class="py-line"><tt class="py-docstring"> list.</tt> </tt>
<a name="L2104"></a><tt class="py-lineno">2104</tt> <tt class="py-line"><tt class="py-docstring"> @param lst: The nested list that should be flattened.</tt> </tt>
<a name="L2105"></a><tt class="py-lineno">2105</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L2106"></a><tt class="py-lineno">2106</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="L2107"></a><tt class="py-lineno">2107</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="L2108"></a><tt class="py-lineno">2108</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="L2109"></a><tt class="py-lineno">2109</tt> <tt class="py-line"> <tt id="link-887" class="py-name" targets="Function epydoc.docparser.flatten()=epydoc.docparser-module.html#flatten"><a title="epydoc.docparser.flatten" class="py-name" href="#" onclick="return doclink('link-887', 'flatten', 'link-887');">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="L2110"></a><tt class="py-lineno">2110</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L2111"></a><tt class="py-lineno">2111</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="L2112"></a><tt class="py-lineno">2112</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">out</tt> </tt>
</div><a name="L2113"></a><tt class="py-lineno">2113</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:39 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>
|
