1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
|
#!/usr/bin/env python2
# -*- coding: utf-8 -*-
'''
This is the main PythonTeX script. It should be launched via pythontex.py.
Two versions of this script are provided. One, with name ending in "2", runs
under Python 2.7. The other, with name ending in "3", runs under Python 3.2+.
This script needs to be able to import pythontex_engines.py; in general it
should be in the same directory.
Licensed under the BSD 3-Clause License:
Copyright (c) 2012-2014, Geoffrey M. Poore
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the <organization> nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
'''
# Imports
#// Python 2
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
#\\ End Python 2
import sys
import os
import argparse
import codecs
import time
from hashlib import sha1
from collections import defaultdict, OrderedDict, namedtuple
from re import match, sub, search
import subprocess
import multiprocessing
from pygments.styles import get_all_styles
from pythontex_engines import *
import textwrap
import platform
if sys.version_info[0] == 2:
try:
import cPickle as pickle
except:
import pickle
from io import open
else:
import pickle
# Script parameters
# Version
__version__ = '0.14'
class Pytxcode(object):
def __init__(self, data, gobble):
self.delims, self.code = data.split('#\n', 1)
self.family, self.session, self.restart, self.instance, self.command, self.context, self.args_run, self.args_prettyprint, self.input_file, self.line = self.delims.split('#')
self.instance_int = int(self.instance)
self.line_int = int(self.line)
self.key_run = self.family + '#' + self.session + '#' + self.restart
self.key_typeset = self.key_run + '#' + self.instance
self.hashable_delims_run = self.key_typeset + '#' + self.command + '#' + self.context + '#' + self.args_run
self.hashable_delims_typeset = self.key_typeset + '#' + self.command + '#' + self.context + '#' + self.args_run
if len(self.command) > 1:
self.is_inline = False
# Environments start on the next line
self.line_int += 1
self.line = str(self.line_int)
else:
self.is_inline = True
self.is_extfile = True if self.session.startswith('EXT:') else False
if self.is_extfile:
self.extfile = os.path.expanduser(os.path.normcase(self.session.replace('EXT:', '', 1)))
self.key_typeset = self.key_typeset.replace('EXT:', '')
self.is_cc = True if self.family.startswith('CC:') else False
self.is_pyg = True if self.family.startswith('PYG') else False
self.is_verb = True if self.restart.endswith('verb') else False
if self.is_cc:
self.instance += 'CC'
self.cc_type, self.cc_pos = self.family.split(':')[1:]
if self.is_verb or self.is_pyg or self.is_cc:
self.is_cons = False
else:
self.is_cons = engine_dict[self.family].console
self.is_code = False if self.is_verb or self.is_pyg or self.is_cc or self.is_cons else True
if self.command in ('c', 'code') or (self.command == 'i' and not self.is_cons):
self.is_typeset = False
else:
self.is_typeset = True
if gobble == 'auto':
self.code = textwrap.dedent(self.code)
def process_argv(data, temp_data):
'''
Process command line options using the argparse module.
Most options are passed via the file of code, rather than via the command
line.
'''
# Create a command line argument parser
parser = argparse.ArgumentParser()
parser.add_argument('TEXNAME',
help='LaTeX file, with or without .tex extension')
parser.add_argument('--version', action='version',
version='PythonTeX {0}'.format(data['version']))
parser.add_argument('--encoding', default='UTF-8',
help='encoding for all text files (see codecs module for encodings)')
parser.add_argument('--error-exit-code', default='true',
choices=('true', 'false'),
help='return exit code of 1 if there are errors (not desirable with some TeX editors and workflows)')
group_run = parser.add_mutually_exclusive_group()
group_run.add_argument('--runall', nargs='?', default='false',
const='true', choices=('true', 'false'),
help='run ALL code; equivalent to package option')
group_run.add_argument('--rerun', default='errors',
choices=('never', 'modified', 'errors', 'warnings', 'always'),
help='set conditions for rerunning code; equivalent to package option')
parser.add_argument('--hashdependencies', nargs='?', default='false',
const='true', choices=('true', 'false'),
help='hash dependencies (such as external data) to check for modification, rather than using mtime; equivalent to package option')
parser.add_argument('-j', '--jobs', metavar='N', default=None, type=int,
help='Allow N jobs at once; defaults to cpu_count().')
parser.add_argument('-v', '--verbose', default=False, action='store_true',
help='verbose output')
parser.add_argument('--interpreter', default=None, help='set a custom interpreter; argument should be in the form "<interpreter>:<command>, <interp>:<cmd>, ..." where <interpreter> is "python", "ruby", etc., and <command> is the command for invoking the interpreter; argument may also be in the form of a Python dictionary')
group_debug = parser.add_mutually_exclusive_group()
group_debug.add_argument('--debug', nargs='?', default=None,
const='default',
metavar='<family>:<session>:<restart>',
help='Run the specified session (or default session) with the default debugger, if available. If there is only one session, it need not be specified. If the session name is unambiguous, it is sufficient. The full <family>:<session>:<restart> (for example, py:default:default) is only needed when the session name alone would be ambiguous.')
group_debug.add_argument('--interactive', nargs='?', default=None,
const='default',
metavar='<family>:<session>:<restart>',
help='Run the specified session (or default session) in interactive mode. If there is only one session, it need not be specified. If the session name is unambiguous, it is sufficient. The full <family>:<session>:<restart> (for example, py:default:default) is only needed when the session name alone would be ambiguous.')
args = parser.parse_args()
# Store the parsed argv in data and temp_data
data['encoding'] = args.encoding
if args.error_exit_code == 'true':
temp_data['error_exit_code'] = True
else:
temp_data['error_exit_code'] = False
# runall can be mapped onto rerun, so both are stored under rerun
if args.runall == 'true':
temp_data['rerun'] = 'always'
else:
temp_data['rerun'] = args.rerun
# hashdependencies need only be in temp_data, since changing it would
# change hashes (hashes of mtime vs. file contents)
if args.hashdependencies == 'true':
temp_data['hashdependencies'] = True
else:
temp_data['hashdependencies'] = False
if args.jobs is None:
try:
jobs = multiprocessing.cpu_count()
except NotImplementedError:
jobs = 1
temp_data['jobs'] = jobs
else:
temp_data['jobs'] = args.jobs
temp_data['verbose'] = args.verbose
temp_data['debug'] = args.debug
temp_data['interactive'] = args.interactive
# Update interpreter_dict based on interpreter
set_python_interpreter = False
if args.interpreter is not None:
interp_list = args.interpreter.lstrip('{').rstrip('}').split(',')
for interp in interp_list:
if interp:
try:
k, v = interp.split(':')
k = k.strip(' \'"')
v = v.strip(' \'"')
interpreter_dict[k] = v
if k == 'python':
set_python_interpreter = True
except:
print('Invalid --interpreter argument')
return sys.exit(2)
# If the Python interpreter wasn't set, then try to set an appropriate
# default value, based on how PythonTeX was launched (pythontex.py,
# pythontex2.py, or pythontex3.py).
if not set_python_interpreter:
if temp_data['python'] == 2:
if platform.system() == 'Windows':
try:
subprocess.check_output(['py', '--version'])
interpreter_dict['python'] = 'py -2'
except:
msg = '''
* PythonTeX error:
You have launched PythonTeX using pythontex{0}.py
directly. This should only be done when you want
to use Python version {0}, but have a different
version installed as the default. (Otherwise, you
should start PythonTeX with pythontex.py.) For
this to work correctly, you should install Python
version 3.3+, which has a Windows wrapper (py) that
PythonTeX can use to run the correct version of
Python. If you do not want to install Python 3.3+,
you can also use the --interpreter command-line
option to tell PythonTeX how to access the version
of Python you wish to use.
'''.format(temp_data['python'])
print(textwrap.dedent(msg[1:]))
return sys.exit(2)
else:
interpreter_dict['python'] = 'python2'
elif temp_data['python'] == 3:
if platform.system() == 'Windows':
try:
subprocess.check_output(['py', '--version'])
interpreter_dict['python'] = 'py -3'
except:
msg = '''
* PythonTeX error:
You have launched PythonTeX using pythontex{0}.py
directly. This should only be done when you want
to use Python version {0}, but have a different
version installed as the default. (Otherwise, you
should start PythonTeX with pythontex.py.) For
this to work correctly, you should install Python
version 3.3+, which has a Windows wrapper (py) that
PythonTeX can use to run the correct version of
Python. If you do not want to install Python 3.3+,
you can also use the --interpreter command-line
option to tell PythonTeX how to access the version
of Python you wish to use.
'''.format(temp_data['python'])
print(textwrap.dedent(msg[1:]))
return sys.exit(2)
else:
interpreter_dict['python'] = 'python3'
if args.TEXNAME is not None:
# Determine if we a dealing with just a filename, or a name plus
# path. If there's a path, we need to make the document directory
# the current working directory.
dir, raw_jobname = os.path.split(args.TEXNAME)
dir = os.path.expanduser(os.path.normcase(dir))
if dir:
os.chdir(dir)
sys.path.append(dir)
# If necessary, strip off an extension to find the raw jobname that
# corresponds to the .pytxcode.
if not os.path.exists(raw_jobname + '.pytxcode'):
raw_jobname = raw_jobname.rsplit('.', 1)[0]
if not os.path.exists(raw_jobname + '.pytxcode'):
print('* PythonTeX error')
print(' Code file ' + raw_jobname + '.pytxcode does not exist.')
print(' Run LaTeX to create it.')
return sys.exit(1)
# We need a "sanitized" version of the jobname, with spaces and
# asterisks replaced with hyphens. This is done to avoid TeX issues
# with spaces in file names, paralleling the approach taken in
# pythontex.sty. From now on, we will use the sanitized version every
# time we create a file that contains the jobname string. The raw
# version will only be used in reference to pre-existing files created
# on the TeX side, such as the .pytxcode file.
jobname = raw_jobname.replace(' ', '-').replace('"', '').replace('*', '-')
# Store the results in data
data['raw_jobname'] = raw_jobname
data['jobname'] = jobname
# We need to check to make sure that the "sanitized" jobname doesn't
# lead to a collision with a file that already has that name, so that
# two files attempt to use the same PythonTeX folder.
#
# If <jobname>.<ext> and <raw_jobname>.<ext> both exist, where <ext>
# is a common LaTeX extension, we exit. We operate under the
# assumption that there should be only a single file <jobname> in the
# document root directory that has a common LaTeX extension. That
# could be false, but if so, the user probably has worse things to
# worry about than a potential PythonTeX output collision.
# If <jobname>* and <raw_jobname>* both exist, we issue a warning but
# attempt to proceed.
if jobname != raw_jobname:
resolved = False
for ext in ('.tex', '.ltx', '.dtx'):
if os.path.isfile(raw_jobname + ext):
if os.path.isfile(jobname + ext):
print('* PythonTeX error')
print(' Directory naming collision between the following files:')
print(' ' + raw_jobname + ext)
print(' ' + jobname + ext)
return sys.exit(1)
else:
resolved = True
break
if not resolved:
ls = os.listdir('.')
for file in ls:
if file.startswith(jobname):
print('* PythonTeX warning')
print(' Potential directory naming collision between the following names:')
print(' ' + raw_jobname)
print(' ' + jobname + '*')
print(' Attempting to proceed.')
temp_data['warnings'] += 1
break
def load_code_get_settings(data, temp_data):
'''
Load the code file, preprocess the code, and extract the settings.
'''
# Bring in the .pytxcode file as a single string
raw_jobname = data['raw_jobname']
encoding = data['encoding']
# The error checking here is a little redundant
if os.path.isfile(raw_jobname + '.pytxcode'):
f = open(raw_jobname + '.pytxcode', 'r', encoding=encoding)
pytxcode = f.read()
f.close()
else:
print('* PythonTeX error')
print(' Code file ' + raw_jobname + '.pytxcode does not exist.')
print(' Run LaTeX to create it.')
return sys.exit(1)
# Split code and settings
try:
pytxcode, pytxsettings = pytxcode.rsplit('=>PYTHONTEX:SETTINGS#', 1)
except:
print('The .pytxcode file appears to have an outdated format or be invalid')
print('Run LaTeX to make sure the file is current')
return sys.exit(1)
# Prepare to process settings
#
# Create a dict for storing settings.
settings = {}
# Create a dict for storing Pygments settings.
# Each dict entry will itself be a dict.
pygments_settings = defaultdict(dict)
# Create a dict of processing functions, and generic processing functions
settings_func = dict()
def set_kv_data(k, v):
if v == 'true':
settings[k] = True
elif v == 'false':
settings[k] = False
else:
settings[k] = v
# Need a function for when assignment is only needed if not default value
def set_kv_temp_data_if_not_default(k, v):
if v != 'default':
if v == 'true':
temp_data[k] = True
elif v == 'false':
temp_data[k] = False
else:
temp_data[k] = v
def set_kv_data_fvextfile(k, v):
# Error checking on TeX side should be enough, but be careful anyway
try:
v = int(v)
except ValueError:
print('* PythonTeX error')
print(' Unable to parse package option fvextfile.')
return sys.exit(1)
if v < 0:
settings[k] = sys.maxsize
elif v == 0:
settings[k] = 1
print('* PythonTeX warning')
print(' Invalid value for package option fvextfile.')
temp_data['warnings'] += 1
else:
settings[k] = v
def set_kv_pygments(k, v):
family, lexer_opts, options = v.replace(' ','').split('|')
lexer = None
lex_dict = {}
opt_dict = {}
if lexer_opts:
for l in lexer_opts.split(','):
if '=' in l:
k, v = l.split('=', 1)
if k == 'lexer':
lexer = l
else:
lex_dict[k] = v
else:
lexer = l
if options:
for o in options.split(','):
if '=' in o:
k, v = o.split('=', 1)
if v in ('true', 'True'):
v = True
elif v in ('false', 'False'):
v = False
else:
k = option
v = True
opt_dict[k] = v
if family != ':GLOBAL':
if 'lexer' in pygments_settings[':GLOBAL']:
lexer = pygments_settings[':GLOBAL']['lexer']
lex_dict.update(pygments_settings[':GLOBAL']['lexer_options'])
opt_dict.update(pygments_settings[':GLOBAL']['formatter_options'])
if 'style' not in opt_dict:
opt_dict['style'] = 'default'
opt_dict['commandprefix'] = 'PYG' + opt_dict['style']
if lexer is not None:
pygments_settings[family]['lexer'] = lexer
pygments_settings[family]['lexer_options'] = lex_dict
pygments_settings[family]['formatter_options'] = opt_dict
settings_func['version'] = set_kv_data
settings_func['outputdir'] = set_kv_data
settings_func['workingdir'] = set_kv_data
settings_func['workingdirset'] = set_kv_data
settings_func['gobble'] = set_kv_data
settings_func['rerun'] = set_kv_temp_data_if_not_default
settings_func['hashdependencies'] = set_kv_temp_data_if_not_default
settings_func['makestderr'] = set_kv_data
settings_func['stderrfilename'] = set_kv_data
settings_func['keeptemps'] = set_kv_data
settings_func['pyfuture'] = set_kv_data
settings_func['pyconfuture'] = set_kv_data
settings_func['pygments'] = set_kv_data
settings_func['fvextfile'] = set_kv_data_fvextfile
settings_func['pygglobal'] = set_kv_pygments
settings_func['pygfamily'] = set_kv_pygments
settings_func['pyconbanner'] = set_kv_data
settings_func['pyconfilename'] = set_kv_data
settings_func['depythontex'] = set_kv_data
# Process settings
for line in pytxsettings.split('\n'):
if line:
key, val = line.split('=', 1)
try:
settings_func[key](key, val)
except KeyError:
print('* PythonTeX warning')
print(' Unknown option "' + key + '"')
temp_data['warnings'] += 1
# Check for compatility between the .pytxcode and the script
if 'version' not in settings or settings['version'] != data['version']:
print('* PythonTeX error')
print(' The version of the PythonTeX scripts does not match the last code')
print(' saved by the document--run LaTeX to create an updated version.\n')
sys.exit(1)
# Store all results that haven't already been stored.
data['settings'] = settings
data['pygments_settings'] = pygments_settings
# Create a tuple of vital quantities that invalidate old saved data
# Don't need to include outputdir, because if that changes, no old output
# fvextfile could be checked on a case-by-case basis, which would result
# in faster output, but that would involve a good bit of additional
# logic, which probably isn't worth it for a feature that will rarely be
# changed.
data['vitals'] = (data['version'], data['encoding'],
settings['gobble'], settings['fvextfile'])
# Create tuples of vital quantities
data['code_vitals'] = (settings['workingdir'], settings['keeptemps'],
settings['makestderr'], settings['stderrfilename'])
data['cons_vitals'] = (settings['workingdir'])
data['typeset_vitals'] = ()
# Pass any customizations to types
for k in engine_dict:
engine_dict[k].customize(pyfuture=settings['pyfuture'],
pyconfuture=settings['pyconfuture'],
pyconbanner=settings['pyconbanner'],
pyconfilename=settings['pyconfilename'])
# Store code
# Do this last, so that Pygments settings are available
if pytxcode.startswith('=>PYTHONTEX#'):
gobble = settings['gobble']
temp_data['pytxcode'] = [Pytxcode(c, gobble) for c in pytxcode.split('=>PYTHONTEX#')[1:]]
else:
temp_data['pytxcode'] = []
def set_upgrade_compatibility(data, old, temp_data):
'''
When upgrading, modify settings to maintain backward compatibility when
possible and important
'''
if (old['version'].startswith('v') and
not data['settings']['workingdirset'] and
data['settings']['outputdir'] != '.'):
old['compatibility'] = '0.13'
do_upgrade_compatibility(data, old, temp_data)
def do_upgrade_compatibility(data, old_data, temp_data):
if 'compatibility' in old_data:
c = old_data['compatibility']
if (c == '0.13' and not data['settings']['workingdirset'] and
data['settings']['outputdir'] != '.'):
data['compatibility'] = c
data['settings']['workingdir'] = data['settings']['outputdir']
msg = '''
**** PythonTeX upgrade message ****
Beginning with v0.14, the default working directory is the document
directory rather than the output directory. PythonTeX has detected
that you have been using the output directory as the working directory.
It will continue to use the output directory for now. To keep your
current settings long-term and avoid seeing this message in the future,
add the following command to the preamble of your document, right after
the "\\usepackage{pythontex}": "\setpythontexworkingdir{<outputdir>}".
If you wish to continue with the new settings instead, simply delete
the file with extension .pkl in the output directory, and run PythonTeX.
**** End PythonTeX upgrade message ****
'''
temp_data['upgrade_message'] = textwrap.dedent(msg)
def get_old_data(data, old_data, temp_data):
'''
Load data from the last run, if it exists, into the dict old_data.
Determine the path to the PythonTeX scripts, either by using a previously
found, saved path or via kpsewhich.
The old data is used for determining when PythonTeX has been upgraded,
when any settings have changed, when code has changed (via hashes), and
what files may need to be cleaned up. The location of the PythonTeX
scripts is needed so that they can be imported by the scripts created by
PythonTeX. The location of the scripts is confirmed even if they were
previously located, to make sure that the path is still valid. Finding
the scripts depends on having a TeX installation that includes the
Kpathsea library (TeX Live and MiKTeX, possibly others).
All code that relies on old_data is written based on the assumption that
if old_data exists and has the current PythonTeX version, then it
contains all needed information. Thus, all code relying on old_data must
check that it was loaded and that it has the current version. If not,
code should adapt gracefully.
'''
# Create a string containing the name of the data file
pythontex_data_file = os.path.expanduser(os.path.normcase(os.path.join(data['settings']['outputdir'], 'pythontex_data.pkl')))
# Load the old data if it exists (read as binary pickle)
if os.path.isfile(pythontex_data_file):
f = open(pythontex_data_file, 'rb')
old = pickle.load(f)
f.close()
# Check for compabilility
if 'vitals' in old and data['vitals'] == old['vitals']:
temp_data['loaded_old_data'] = True
old_data.update(old)
do_upgrade_compatibility(data, old_data, temp_data)
else:
if 'version' in old and old['version'] != data['version']:
set_upgrade_compatibility(data, old, temp_data)
temp_data['loaded_old_data'] = False
# Clean up all old files
if 'files' in old:
for key in old['files']:
for f in old['files'][key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
if 'pygments_files' in old:
for key in old['pygments_files']:
for f in old['pygments_files'][key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
else:
temp_data['loaded_old_data'] = False
# Set the utilspath
# Assume that if the utils aren't in the same location as
# `pythontex.py`, then they are somewhere else on `sys.path` that
# will always be available (for example, installed as a Python module),
# and thus specifying a path isn't necessary.
if os.path.isfile(os.path.join(sys.path[0], 'pythontex_utils.py')):
# Need the path with forward slashes, so escaping isn't necessary
data['utilspath'] = sys.path[0].replace('\\', '/')
else:
data['utilspath'] = ''
def modified_dependencies(key, data, old_data, temp_data):
hashdependencies = temp_data['hashdependencies']
if key not in old_data['dependencies']:
return False
else:
old_dep_hash_dict = old_data['dependencies'][key]
workingdir = data['settings']['workingdir']
for dep in old_dep_hash_dict.keys():
# We need to know if the path is relative (based off the
# working directory) or absolute. We can't use
# os.path.isabs() alone for determining the distinction,
# because we must take into account the possibility of an
# initial ~ (tilde) standing for the home directory.
dep_file = os.path.expanduser(os.path.normcase(dep))
if not os.path.isabs(dep_file):
dep_file = os.path.expanduser(os.path.normcase(os.path.join(workingdir, dep_file)))
if not os.path.isfile(dep_file):
print('* PythonTeX error')
print(' Cannot find dependency "' + dep + '"')
print(' It belongs to ' + key.replace('#', ':'))
print(' Relative paths to dependencies must be specified from the working directory.')
temp_data['errors'] += 1
# A removed dependency should trigger an error, but it
# shouldn't cause code to execute. Running the code
# again would just give more errors when it can't find
# the dependency. (There won't be issues when a
# dependency is added or removed, because that would
# involve modifying code, which would trigger
# re-execution.)
elif hashdependencies:
# Read and hash the file in binary. Opening in text mode
# would require an unnecessary decoding and encoding cycle.
f = open(dep_file, 'rb')
hasher = sha1()
h = hasher(f.read()).hexdigest()
f.close()
if h != old_dep_hash_dict[dep][1]:
return True
else:
mtime = os.path.getmtime(dep_file)
if mtime != old_dep_hash_dict[dep][0]:
return True
return False
def should_rerun(hash, old_hash, old_exit_status, key, rerun, data, old_data, temp_data):
# #### Need to clean up arg passing here
if rerun == 'never':
if (hash != old_hash or modified_dependencies(key, data, old_data, temp_data)):
print('* PythonTeX warning')
print(' Session ' + key.replace('#', ':') + ' has rerun=never')
print(' But its code or dependencies have been modified')
temp_data['warnings'] += 1
return False
elif rerun == 'modified':
if (hash != old_hash or modified_dependencies(key, data, old_data, temp_data)):
return True
else:
return False
elif rerun == 'errors':
if (hash != old_hash or modified_dependencies(key, data, old_data, temp_data) or
old_exit_status[0] != 0):
return True
else:
return False
elif rerun == 'warnings':
if (hash != old_hash or modified_dependencies(key, data, old_data, temp_data) or
old_exit_status != (0, 0)):
return True
else:
return False
elif rerun == 'always':
return True
def hash_all(data, temp_data, old_data, engine_dict):
'''
Hash the code to see what has changed and needs to be updated.
Save the hashes in hashdict. Create update_code, a list of bools
regarding whether code should be executed. Create update_pygments, a
list of bools determining what needs updated Pygments highlighting.
Update pygments_settings to account for Pygments (as opposed to PythonTeX)
commands and environments.
'''
# Note that the PythonTeX information that accompanies code must be
# hashed in addition to the code itself; the code could stay the same,
# but its context or args could change, which might require that code be
# executed. All of the PythonTeX information is hashed except for the
# input line number. Context-dependent code is going too far if
# it depends on that.
# Create variables to more easily access parts of data
pytxcode = temp_data['pytxcode']
encoding = data['encoding']
loaded_old_data = temp_data['loaded_old_data']
rerun = temp_data['rerun']
pygments_settings = data['pygments_settings']
# Calculate cumulative hashes for all code that is executed
# Calculate individual hashes for all code that will be typeset
code_hasher = defaultdict(sha1)
cons_hasher = defaultdict(sha1)
cc_hasher = defaultdict(sha1)
typeset_hasher = defaultdict(sha1)
for c in pytxcode:
if c.is_code:
code_hasher[c.key_run].update(c.hashable_delims_run.encode(encoding))
code_encoded = c.code.encode(encoding)
code_hasher[c.key_run].update(code_encoded)
if c.is_typeset:
typeset_hasher[c.key_typeset].update(c.hashable_delims_typeset.encode(encoding))
typeset_hasher[c.key_typeset].update(code_encoded)
typeset_hasher[c.key_typeset].update(c.args_prettyprint.encode(encoding))
elif c.is_cons:
cons_hasher[c.key_run].update(c.hashable_delims_run.encode(encoding))
code_encoded = c.code.encode(encoding)
cons_hasher[c.key_run].update(code_encoded)
if c.is_typeset:
typeset_hasher[c.key_typeset].update(c.hashable_delims_typeset.encode(encoding))
typeset_hasher[c.key_typeset].update(code_encoded)
typeset_hasher[c.key_typeset].update(c.args_prettyprint.encode(encoding))
elif c.is_cc:
cc_hasher[c.cc_type].update(c.hashable_delims_run.encode(encoding))
cc_hasher[c.cc_type].update(c.code.encode(encoding))
elif c.is_typeset:
typeset_hasher[c.key_typeset].update(c.hashable_delims_typeset.encode(encoding))
typeset_hasher[c.key_typeset].update(c.code.encode(encoding))
typeset_hasher[c.key_typeset].update(c.args_prettyprint.encode(encoding))
# Store hashes
code_hash_dict = {}
for key in code_hasher:
family = key.split('#', 1)[0]
code_hash_dict[key] = (code_hasher[key].hexdigest(),
cc_hasher[family].hexdigest(),
engine_dict[family].get_hash())
data['code_hash_dict'] = code_hash_dict
cons_hash_dict = {}
for key in cons_hasher:
family = key.split('#', 1)[0]
cons_hash_dict[key] = (cons_hasher[key].hexdigest(),
cc_hasher[family].hexdigest(),
engine_dict[family].get_hash())
data['cons_hash_dict'] = cons_hash_dict
typeset_hash_dict = {}
for key in typeset_hasher:
typeset_hash_dict[key] = typeset_hasher[key].hexdigest()
data['typeset_hash_dict'] = typeset_hash_dict
# See what needs to be updated.
# In the process, copy over macros and files that may be reused.
code_update = {}
cons_update = {}
pygments_update = {}
macros = defaultdict(list)
files = defaultdict(list)
pygments_macros = {}
pygments_files = {}
typeset_cache = {}
dependencies = defaultdict(dict)
exit_status = {}
pygments_settings_changed = {}
if loaded_old_data:
old_macros = old_data['macros']
old_files = old_data['files']
old_pygments_macros = old_data['pygments_macros']
old_pygments_files = old_data['pygments_files']
old_typeset_cache = old_data['typeset_cache']
old_dependencies = old_data['dependencies']
old_exit_status = old_data['exit_status']
old_code_hash_dict = old_data['code_hash_dict']
old_cons_hash_dict = old_data['cons_hash_dict']
old_typeset_hash_dict = old_data['typeset_hash_dict']
old_pygments_settings = old_data['pygments_settings']
for s in pygments_settings:
if (s in old_pygments_settings and
pygments_settings[s] == old_pygments_settings[s]):
pygments_settings_changed[s] = False
else:
pygments_settings_changed[s] = True
# If old data was loaded (and thus is compatible) determine what has
# changed so that only
# modified code may be executed. Otherwise, execute everything.
# We don't have to worry about checking for changes in pyfuture, because
# custom code and default code are hashed. The treatment of keeptemps
# could be made more efficient (if changed to 'none', just delete old temp
# files rather than running everything again), but given that it is
# intended as a debugging aid, that probable isn't worth it.
# We don't have to worry about hashdependencies changing, because if it
# does the hashes won't match (file contents vs. mtime) and thus code will
# be re-executed.
if loaded_old_data and data['code_vitals'] == old_data['code_vitals']:
# Compare the hash values, and set which code needs to be run
for key in code_hash_dict:
if (key in old_code_hash_dict and
not should_rerun(code_hash_dict[key], old_code_hash_dict[key], old_exit_status[key], key, rerun, data, old_data, temp_data)):
code_update[key] = False
macros[key] = old_macros[key]
files[key] = old_files[key]
dependencies[key] = old_dependencies[key]
exit_status[key] = old_exit_status[key]
else:
code_update[key] = True
else:
for key in code_hash_dict:
code_update[key] = True
if loaded_old_data and data['cons_vitals'] == old_data['cons_vitals']:
# Compare the hash values, and set which code needs to be run
for key in cons_hash_dict:
if (key in old_cons_hash_dict and
not should_rerun(cons_hash_dict[key], old_cons_hash_dict[key], old_exit_status[key], key, rerun, data, old_data, temp_data)):
cons_update[key] = False
macros[key] = old_macros[key]
files[key] = old_files[key]
typeset_cache[key] = old_typeset_cache[key]
dependencies[key] = old_dependencies[key]
exit_status[key] = old_exit_status[key]
else:
cons_update[key] = True
else:
for key in cons_hash_dict:
cons_update[key] = True
if loaded_old_data and data['typeset_vitals'] == old_data['typeset_vitals']:
for key in typeset_hash_dict:
family = key.split('#', 1)[0]
if family in pygments_settings:
if (not pygments_settings_changed[family] and
key in old_typeset_hash_dict and
typeset_hash_dict[key] == old_typeset_hash_dict[key]):
pygments_update[key] = False
if key in old_pygments_macros:
pygments_macros[key] = old_pygments_macros[key]
if key in old_pygments_files:
pygments_files[key] = old_pygments_files[key]
else:
pygments_update[key] = True
else:
pygments_update[key] = False
# Make sure Pygments styles are up-to-date
pygments_style_list = list(get_all_styles())
if pygments_style_list != old_data['pygments_style_list']:
pygments_style_defs = {}
# Lazy import
from pygments.formatters import LatexFormatter
for s in pygments_style_list:
formatter = LatexFormatter(style=s, commandprefix='PYG'+s)
pygments_style_defs[s] = formatter.get_style_defs()
else:
pygments_style_defs = old_data['pygments_style_defs']
else:
for key in typeset_hash_dict:
family = key.split('#', 1)[0]
if family in pygments_settings:
pygments_update[key] = True
else:
pygments_update[key] = False
# Create Pygments styles
pygments_style_list = list(get_all_styles())
pygments_style_defs = {}
# Lazy import
from pygments.formatters import LatexFormatter
for s in pygments_style_list:
formatter = LatexFormatter(style=s, commandprefix='PYG'+s)
pygments_style_defs[s] = formatter.get_style_defs()
# Save to data
temp_data['code_update'] = code_update
temp_data['cons_update'] = cons_update
temp_data['pygments_update'] = pygments_update
data['macros'] = macros
data['files'] = files
data['pygments_macros'] = pygments_macros
data['pygments_style_list'] = pygments_style_list
data['pygments_style_defs'] = pygments_style_defs
data['pygments_files'] = pygments_files
data['typeset_cache'] = typeset_cache
data['dependencies'] = dependencies
data['exit_status'] = exit_status
# Clean up for code that will be run again, and for code that no longer
# exists.
if loaded_old_data:
# Take care of code files
for key in code_hash_dict:
if code_update[key] and key in old_files:
for f in old_files[key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
for key in old_code_hash_dict:
if key not in code_hash_dict:
for f in old_files[key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
# Take care of old console files
for key in cons_hash_dict:
if cons_update[key] and key in old_files:
for f in old_files[key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
for key in old_cons_hash_dict:
if key not in cons_hash_dict:
for f in old_files[key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
# Take care of old Pygments files
# The approach here is a little different since there isn't a
# Pygments-specific hash dict, but there is a Pygments-specific
# dict of lists of files.
for key in pygments_update:
if pygments_update[key] and key in old_pygments_files:
for f in old_pygments_files[key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
for key in old_pygments_files:
if key not in pygments_update:
for f in old_pygments_files[key]:
f = os.path.expanduser(os.path.normcase(f))
if os.path.isfile(f):
os.remove(f)
def parse_code_write_scripts(data, temp_data, engine_dict):
'''
Parse the code file into separate scripts, and write them to file.
'''
code_dict = defaultdict(list)
cc_dict_begin = defaultdict(list)
cc_dict_end = defaultdict(list)
cons_dict = defaultdict(list)
pygments_list = []
# Create variables to ease data access
encoding = data['encoding']
utilspath = data['utilspath']
outputdir = data['settings']['outputdir']
workingdir = data['settings']['workingdir']
pytxcode = temp_data['pytxcode']
code_update = temp_data['code_update']
cons_update = temp_data['cons_update']
pygments_update = temp_data['pygments_update']
files = data['files']
debug = temp_data['debug']
interactive = temp_data['interactive']
# Tweak the update dicts to work with debug command-line option.
# #### This should probably be refactored later, once the debug interface
# stabilizes
if debug is not None or interactive is not None:
if debug is not None:
arg = debug
else:
arg = interactive
for k in cons_update:
cons_update[k] = False
if ':' in arg:
# May need to refine in light of substitution of `:` -> `_`
# in session names?
arg_key = arg.replace(':', '#')
if arg_key not in code_update:
return sys.exit('Session {0} does not exist'.format(arg))
else:
for k in code_update:
code_update[k] = False
code_update[arg_key] = True
if debug is not None:
temp_data['debug_key'] = arg_key
else:
temp_data['interactive_key'] = arg_key
else:
session_count_dict = defaultdict(list)
for k in code_update:
s = k.split('#')[1]
session_count_dict[s].append(k)
if arg not in session_count_dict:
if arg in cons_update:
return sys.exit('Console sessions are not currently supported for interactive mode.')
else:
return sys.exit('Session "{0}" does not exist.'.format(arg))
elif len(session_count_dict[arg]) > 1:
return sys.exit('Ambiguous session name "{0}"; please specify <family>:<session>:<restart>'.format(arg))
else:
for k in code_update:
code_update[k] = False
arg_key = session_count_dict[arg][0]
code_update[arg_key] = True
if debug is not None:
temp_data['debug_key'] = arg_key
else:
temp_data['interactive_key'] = arg_key
# We need to keep track of the last instance for each session, so
# that duplicates can be eliminated. Some LaTeX environments process
# their content multiple times and thus will create duplicates. We
# need to initialize everything at -1, since instances begin at zero.
def negative_one():
return -1
last_instance = defaultdict(negative_one)
for c in pytxcode:
if c.instance_int > last_instance[c.key_run]:
last_instance[c.key_run] = c.instance_int
if c.is_code:
if code_update[c.key_run]:
code_dict[c.key_run].append(c)
if c.is_typeset and pygments_update[c.key_typeset]:
pygments_list.append(c)
elif c.is_cons:
# Only append to Pygments if not run, since Pygments is
# automatically taken care of during run for console content
if cons_update[c.key_run]:
cons_dict[c.key_run].append(c)
elif c.is_typeset and pygments_update[c.key_typeset]:
pygments_list.append(c)
elif (c.is_pyg or c.is_verb) and pygments_update[c.key_typeset]:
pygments_list.append(c)
elif c.is_cc:
if c.cc_pos == 'begin':
cc_dict_begin[c.cc_type].append(c)
else:
cc_dict_end[c.cc_type].append(c)
# Save
temp_data['code_dict'] = code_dict
temp_data['cc_dict_begin'] = cc_dict_begin
temp_data['cc_dict_end'] = cc_dict_end
temp_data['cons_dict'] = cons_dict
temp_data['pygments_list'] = pygments_list
# Save the code sessions that need to be updated
# Keep track of the files that are created
# Also accumulate error indices for handling stderr
code_index_dict = {}
for key in code_dict:
family, session, restart = key.split('#')
fname = os.path.join(outputdir, family + '_' + session + '_' + restart + '.' + engine_dict[family].extension)
# Want to keep track of files without expanding user, but need to
# expand user when actually writing files
files[key].append(fname)
sessionfile = open(os.path.expanduser(os.path.normcase(fname)), 'w', encoding=encoding)
script, code_index = engine_dict[family].get_script(encoding,
utilspath,
outputdir,
workingdir,
cc_dict_begin[family],
code_dict[key],
cc_dict_end[family],
debug,
interactive)
for lines in script:
sessionfile.write(lines)
sessionfile.close()
code_index_dict[key] = code_index
temp_data['code_index_dict'] = code_index_dict
# Write synchronization file if in debug mode
if debug is not None:
# Might improve tracking/cleanup of syncdb files
key = temp_data['debug_key']
family, session, restart = key.split('#')
basename = key.replace('#', '_')
syncdb_fname = os.path.join(outputdir, basename + '.' + engine_dict[family].extension + '.syncdb')
files[key].append(syncdb_fname)
# #### In future version, try to use currfile to get this information
# automatically via the .pytxcode
main_doc_fname = None
for ext in ('.tex', '.ltx', '.dtx'):
if os.path.isfile(data['raw_jobname'] + ext):
main_doc_fname = data['raw_jobname'] + ext
break
if not main_doc_fname:
return sys.exit('Could not determine extension for main file "{0}"'.format(data['raw_jobname']))
main_code_fname = basename + '.' + engine_dict[family].extension
f = open(os.path.expanduser(os.path.normcase(syncdb_fname)), 'w', encoding='utf8')
f.write('{0},,{1},,\n'.format(main_code_fname, main_doc_fname))
# All paths are relative to the main code file. So if there is ever
# an option for creating other code files, in other locations, then
# the relative paths to those files will need to be specified.
for e in code_index_dict[key].values():
# #### Probably redo approach so this conversion isn't needed
if not e.input_file:
input_file = main_doc_fname
else:
input_file = e.input_file
if ',' in input_file or ',' in main_code_fname:
line = '"{0}",{1},"{2}",{3},{4}\n'.format(main_code_fname, e.lines_total+1, input_file, e.line_int, e.lines_input)
else:
line = '{0},{1},{2},{3},{4}\n'.format(main_code_fname, e.lines_total+1, input_file, e.line_int, e.lines_input)
f.write(line)
f.close()
def do_multiprocessing(data, temp_data, old_data, engine_dict):
jobname = data['jobname']
encoding = data['encoding']
outputdir = data['settings']['outputdir']
workingdir = data['settings']['workingdir']
keeptemps = data['settings']['keeptemps']
fvextfile = data['settings']['fvextfile']
pygments_settings = data['pygments_settings']
jobs = temp_data['jobs']
verbose = temp_data['verbose']
code_dict = temp_data['code_dict']
cons_dict = temp_data['cons_dict']
cc_dict_begin = temp_data['cc_dict_begin']
cc_dict_end = temp_data['cc_dict_end']
pygments_list = temp_data['pygments_list']
pygments_style_defs = data['pygments_style_defs']
files = data['files']
macros = data['macros']
pygments_files = data['pygments_files']
pygments_macros = data['pygments_macros']
typeset_cache = data['typeset_cache']
errors = temp_data['errors']
warnings = temp_data['warnings']
makestderr = data['settings']['makestderr']
stderrfilename = data['settings']['stderrfilename']
code_index_dict = temp_data['code_index_dict']
hashdependencies = temp_data['hashdependencies']
dependencies = data['dependencies']
exit_status = data['exit_status']
start_time = data['start_time']
debug = temp_data['debug']
interactive = temp_data['interactive']
# If in debug or interactive mode, short-circuit the whole process
# #### This should probably be refactored later, once debugging is more
# mature
if debug is not None or interactive is not None:
import shlex
if debug is not None:
print('Entering debug mode for "{0}"\n'.format(debug) + '-'*20 + '\n')
key = temp_data['debug_key']
else:
print('Entering interactive mode for "{0}"\n'.format(interactive) + '-'*20 + '\n')
key = temp_data['interactive_key']
basename = key.replace('#', '_')
family, session, restart = key.split('#')
# #### Revise as debugging is expanded
if debug is not None and engine_dict[family].language != 'python':
return sys.exit('Currently, debug only supports Python')
if debug is not None:
# #### Eventually, should move to pythontex_engines.py and
# provide means for customization
command = '{python} {debug} {file}.py --interactive'
command = command.replace('{python}', interpreter_dict['python'])
command = command.replace('{debug}', '"{0}"'.format(os.path.join(sys.path[0], 'syncpdb.py')))
else:
command = engine_dict[family].command + ' --interactive'
# Need to be in script directory so that pdb and any other tools that
# expect this will function correctly.
orig_cwd = os.getcwd()
if outputdir:
os.chdir(os.path.expanduser(os.path.normcase(outputdir)))
# Note that command is a string, which must be converted to list
# Must double-escape any backslashes so that they survive `shlex.split()`
script = basename
if os.path.isabs(os.path.expanduser(os.path.normcase(outputdir))):
script_full = os.path.expanduser(os.path.normcase(os.path.join(outputdir, basename)))
else:
script_full = os.path.expanduser(os.path.normcase(os.path.join(orig_cwd, outputdir, basename)))
# `shlex.split()` only works with Unicode after 2.7.2
if (sys.version_info.major == 2 and sys.version_info.micro < 3):
exec_cmd = shlex.split(bytes(command.format(file=script.replace('\\', '\\\\'), File=script_full.replace('\\', '\\\\'))))
exec_cmd = [unicode(elem) for elem in exec_cmd]
else:
exec_cmd = shlex.split(command.format(file=script.replace('\\', '\\\\'), File=script_full.replace('\\', '\\\\')))
try:
proc = subprocess.Popen(exec_cmd)
except WindowsError as e:
if e.errno == 2:
# Batch files won't be found when called without extension. They
# would be found if `shell=True`, but then getting the right
# exit code is tricky. So we perform some `cmd` trickery that
# is essentially equivalent to `shell=True`, but gives correct
# exit codes. Note that `subprocess.Popen()` works with strings
# under Windows; a list is not required.
exec_cmd_string = ' '.join(exec_cmd)
exec_cmd_string = 'cmd /C "@echo off & call {0} & if errorlevel 1 exit 1"'.format(exec_cmd_string)
proc = subprocess.Popen(exec_cmd_string)
else:
raise
proc.wait()
os.chdir(orig_cwd)
# Do a basic update of pickled data
# This is only really needed for tracking the code file and the
# synchronization file (if it was created)
if temp_data['loaded_old_data'] and key in old_data['exit_status']:
exit_status[key] = old_data['exit_status'][key]
else:
exit_status[key] = (None, None)
if temp_data['loaded_old_data']:
data['last_new_file_time'] = old_data['last_new_file_time']
else:
data['last_new_file_time'] = start_time
pythontex_data_file = os.path.expanduser(os.path.normcase(os.path.join(outputdir, 'pythontex_data.pkl')))
f = open(pythontex_data_file, 'wb')
pickle.dump(data, f, -1)
f.close()
return
# Create a pool for multiprocessing. Set the maximum number of
# concurrent processes to a user-specified value for jobs. If the user
# has not specified a value, then it will be None, and
# multiprocessing.Pool() will use cpu_count().
pool = multiprocessing.Pool(jobs)
tasks = []
# If verbose, print a list of processes
if verbose:
print('\n* PythonTeX will run the following processes')
print(' with working directory {0}'.format(workingdir))
print(' (maximum concurrent processes = {0})'.format(jobs))
# Add code processes. Note that everything placed in the codedict
# needs to be executed, based on previous testing, except for custom code.
for key in code_dict:
family = key.split('#')[0]
# Uncomment the following for debugging, and comment out what follows
'''run_code(encoding, outputdir, workingdir, code_dict[key],
engine_dict[family].language,
engine_dict[family].command,
engine_dict[family].created,
engine_dict[family].extension,
makestderr, stderrfilename,
code_index_dict[key],
engine_dict[family].errors,
engine_dict[family].warnings,
engine_dict[family].linenumbers,
engine_dict[family].lookbehind,
keeptemps, hashdependencies)'''
tasks.append(pool.apply_async(run_code, [encoding, outputdir,
workingdir, code_dict[key],
engine_dict[family].language,
engine_dict[family].command,
engine_dict[family].created,
engine_dict[family].extension,
makestderr, stderrfilename,
code_index_dict[key],
engine_dict[family].errors,
engine_dict[family].warnings,
engine_dict[family].linenumbers,
engine_dict[family].lookbehind,
keeptemps, hashdependencies]))
if verbose:
print(' - Code process ' + key.replace('#', ':'))
# Add console processes
for key in cons_dict:
family = key.split('#')[0]
if engine_dict[family].language.startswith('python'):
if family in pygments_settings:
# Uncomment the following for debugging
'''python_console(jobname, encoding, outputdir, workingdir,
fvextfile, pygments_settings[family],
cc_dict_begin[family], cons_dict[key],
cc_dict_end[family], engine_dict[family].startup,
engine_dict[family].banner,
engine_dict[family].filename)'''
tasks.append(pool.apply_async(python_console, [jobname, encoding,
outputdir, workingdir,
fvextfile,
pygments_settings[family],
cc_dict_begin[family],
cons_dict[key],
cc_dict_end[family],
engine_dict[family].startup,
engine_dict[family].banner,
engine_dict[family].filename]))
else:
tasks.append(pool.apply_async(python_console, [jobname, encoding,
outputdir, workingdir,
fvextfile,
None,
cc_dict_begin[family],
cons_dict[key],
cc_dict_end[family],
engine_dict[family].startup,
engine_dict[family].banner,
engine_dict[family].filename]))
else:
print('* PythonTeX error')
print(' Currently, non-Python consoles are not supported')
errors += 1
if verbose:
print(' - Console process ' + key.replace('#', ':'))
# Add a Pygments process
if pygments_list:
tasks.append(pool.apply_async(do_pygments, [encoding, outputdir,
fvextfile,
pygments_list,
pygments_settings,
typeset_cache]))
if verbose:
print(' - Pygments process')
# Execute the processes
pool.close()
pool.join()
# Get the outputs of processes
# Get the files and macros created. Get the number of errors and warnings
# produced. Get any messages returned. Get the exit_status, which is a
# dictionary of code that failed and thus must be run again (its hash is
# set to a null string). Keep track of whether there were any new files,
# so that the last time of file creation in .pytxmcr can be updated.
new_files = False
messages = []
for task in tasks:
result = task.get()
if result['process'] == 'code':
key = result['key']
files[key].extend(result['files'])
if result['files']:
new_files = True
macros[key].extend(result['macros'])
dependencies[key] = result['dependencies']
errors += result['errors']
warnings += result['warnings']
exit_status[key] = (result['errors'], result['warnings'])
messages.extend(result['messages'])
elif result['process'] == 'console':
key = result['key']
files[key].extend(result['files'])
if result['files']:
new_files = True
macros[key].extend(result['macros'])
pygments_files.update(result['pygments_files'])
pygments_macros.update(result['pygments_macros'])
dependencies[key] = result['dependencies']
typeset_cache[key] = result['typeset_cache']
errors += result['errors']
warnings += result['warnings']
exit_status[key] = (result['errors'], result['warnings'])
messages.extend(result['messages'])
elif result['process'] == 'pygments':
pygments_files.update(result['pygments_files'])
for k in result['pygments_files']:
if result['pygments_files'][k]:
new_files = True
break
pygments_macros.update(result['pygments_macros'])
errors += result['errors']
warnings += result['warnings']
messages.extend(result['messages'])
# Do a quick check to see if any dependencies were modified since the
# beginning of the run. If so, reset them so they will run next time and
# issue a warning
unresolved_dependencies = False
unresolved_sessions = []
for key in dependencies:
for dep, val in dependencies[key].items():
if val[0] > start_time:
unresolved_dependencies = True
dependencies[key][dep] = (None, None)
unresolved_sessions.append(key.replace('#', ':'))
if unresolved_dependencies:
print('* PythonTeX warning')
print(' The following have dependencies that have been modified')
print(' Run PythonTeX again to resolve dependencies')
for s in set(unresolved_sessions):
print(' - ' + s)
warnings += 1
# Save all content (only needs to be done if code was indeed run).
# Save a commented-out time corresponding to the last time PythonTeX ran
# and created files, so that tools like latexmk can easily detect when
# another run is needed.
if tasks:
if new_files or not temp_data['loaded_old_data']:
last_new_file_time = start_time
else:
last_new_file_time = old_data['last_new_file_time']
data['last_new_file_time'] = last_new_file_time
macro_file = open(os.path.expanduser(os.path.normcase(os.path.join(outputdir, jobname + '.pytxmcr'))), 'w', encoding=encoding)
macro_file.write('%Last time of file creation: ' + str(last_new_file_time) + '\n\n')
for key in macros:
macro_file.write(''.join(macros[key]))
macro_file.close()
pygments_macro_file = open(os.path.expanduser(os.path.normcase(os.path.join(outputdir, jobname + '.pytxpyg'))), 'w', encoding=encoding)
# Only save Pygments styles that are used
style_set = set([pygments_settings[k]['formatter_options']['style'] for k in pygments_settings if k != ':GLOBAL'])
for key in pygments_style_defs:
if key in style_set:
pygments_macro_file.write(''.join(pygments_style_defs[key]))
for key in pygments_macros:
pygments_macro_file.write(''.join(pygments_macros[key]))
pygments_macro_file.close()
pythontex_data_file = os.path.expanduser(os.path.normcase(os.path.join(outputdir, 'pythontex_data.pkl')))
f = open(pythontex_data_file, 'wb')
pickle.dump(data, f, -1)
f.close()
# Print any errors and warnings.
if messages:
print('\n'.join(messages))
sys.stdout.flush()
# Store errors and warnings back into temp_data
# This is needed because they are ints and thus immutable
temp_data['errors'] = errors
temp_data['warnings'] = warnings
def run_code(encoding, outputdir, workingdir, code_list, language, command,
command_created, extension, makestderr, stderrfilename,
code_index, errorsig, warningsig, linesig, stderrlookbehind,
keeptemps, hashdependencies):
'''
Function for multiprocessing code files
'''
import shlex
# Create what's needed for storing results
family = code_list[0].family
session = code_list[0].session
key_run = code_list[0].key_run
files = []
macros = []
dependencies = {}
errors = 0
warnings = 0
unknowns = 0
messages = []
# Create message lists only for stderr, one for undelimited stderr and
# one for delimited, so it's easy to keep track of if there is any
# stderr. These are added onto messages at the end.
err_messages_ud = []
err_messages_d = []
# We need to let the user know we are switching code files
# We check at the end to see if there were indeed any errors and warnings
# and if not, clear messages.
messages.append('\n---- Messages for ' + key_run.replace('#', ':') + ' ----')
# Open files for stdout and stderr, run the code, then close the files
basename = key_run.replace('#', '_')
out_file_name = os.path.expanduser(os.path.normcase(os.path.join(outputdir, basename + '.out')))
err_file_name = os.path.expanduser(os.path.normcase(os.path.join(outputdir, basename + '.err')))
out_file = open(out_file_name, 'w', encoding=encoding)
err_file = open(err_file_name, 'w', encoding=encoding)
# Note that command is a string, which must be converted to list
# Must double-escape any backslashes so that they survive `shlex.split()`
script = os.path.expanduser(os.path.normcase(os.path.join(outputdir, basename)))
if os.path.isabs(script):
script_full = script
else:
script_full = os.path.expanduser(os.path.normcase(os.path.join(os.getcwd(), outputdir, basename)))
# `shlex.split()` only works with Unicode after 2.7.2
if (sys.version_info.major == 2 and sys.version_info.micro < 3):
exec_cmd = shlex.split(bytes(command.format(file=script.replace('\\', '\\\\'), File=script_full.replace('\\', '\\\\'))))
exec_cmd = [unicode(elem) for elem in exec_cmd]
else:
exec_cmd = shlex.split(command.format(file=script.replace('\\', '\\\\'), File=script_full.replace('\\', '\\\\')))
# Add any created files due to the command
# This needs to be done before attempts to execute, to prevent orphans
for f in command_created:
files.append(f.format(file=script))
try:
proc = subprocess.Popen(exec_cmd, stdout=out_file, stderr=err_file)
except WindowsError as e:
if e.errno == 2:
# Batch files won't be found when called without extension. They
# would be found if `shell=True`, but then getting the right
# exit code is tricky. So we perform some `cmd` trickery that
# is essentially equivalent to `shell=True`, but gives correct
# exit codes. Note that `subprocess.Popen()` works with strings
# under Windows; a list is not required.
exec_cmd_string = ' '.join(exec_cmd)
exec_cmd_string = 'cmd /C "@echo off & call {0} & if errorlevel 1 exit 1"'.format(exec_cmd_string)
proc = subprocess.Popen(exec_cmd_string, stdout=out_file, stderr=err_file)
else:
raise
proc.wait()
out_file.close()
err_file.close()
# Process saved stdout into file(s) that are included in the TeX document.
#
# Go through the saved output line by line, and save any printed content
# to its own file, named based on instance.
#
# The very end of the stdout lists dependencies, if any, so we start by
# removing and processing those.
if not os.path.isfile(out_file_name):
messages.append('* PythonTeX error')
messages.append(' Missing output file for ' + key_run.replace('#', ':'))
errors += 1
else:
f = open(out_file_name, 'r', encoding=encoding)
out = f.read()
f.close()
try:
out, created = out.rsplit('=>PYTHONTEX:CREATED#\n', 1)
out, deps = out.rsplit('=>PYTHONTEX:DEPENDENCIES#\n', 1)
valid_stdout = True
except:
valid_stdout = False
if proc.returncode == 0:
raise ValueError('Missing "created" and/or "dependencies" delims in stdout; invalid template?')
if valid_stdout:
# Add created files to created list
for c in created.splitlines():
if os.path.isabs(os.path.expanduser(os.path.normcase(c))):
files.append(c)
else:
files.append(os.path.join(workingdir, c))
# Create a set of dependencies, to eliminate duplicates in the event
# that there are any. This is mainly useful when dependencies are
# automatically determined (for example, through redefining open()),
# may be specified multiple times as a result, and are hashed (and
# of a large enough size that hashing time is non-negligible).
deps = set([dep for dep in deps.splitlines()])
# Process dependencies; get mtimes and (if specified) hashes
for dep in deps:
dep_file = os.path.expanduser(os.path.normcase(dep))
if not os.path.isabs(dep_file):
dep_file = os.path.expanduser(os.path.normcase(os.path.join(workingdir, dep_file)))
if not os.path.isfile(dep_file):
# If we can't find the file, we return a null hash and issue
# an error. We don't need to change the exit status. If the
# code does depend on the file, there will be a separate
# error when the code attempts to use the file. If the code
# doesn't really depend on the file, then the error will be
# raised again anyway the next time PythonTeX runs when the
# dependency is listed but not found.
dependencies[dep] = (None, None)
messages.append('* PythonTeX error')
messages.append(' Cannot find dependency "' + dep + '"')
messages.append(' It belongs to ' + key_run.replace('#', ':'))
messages.append(' Relative paths to dependencies must be specified from the working directory.')
errors += 1
elif hashdependencies:
# Read and hash the file in binary. Opening in text mode
# would require an unnecessary decoding and encoding cycle.
hasher = sha1()
f = open(dep_file, 'rb')
hasher.update(f.read())
f.close()
dependencies[dep] = (os.path.getmtime(dep_file), hasher.hexdigest())
else:
dependencies[dep] = (os.path.getmtime(dep_file), '')
for block in out.split('=>PYTHONTEX:STDOUT#')[1:]:
if block:
delims, content = block.split('#\n', 1)
if content:
instance, command = delims.split('#')
if instance.endswith('CC'):
messages.append('* PythonTeX warning')
messages.append(' Custom code for "' + family + '" attempted to print or write to stdout')
messages.append(' This is not supported; use a normal code command or environment')
messages.append(' The following content was written:')
messages.append('')
messages.extend([' ' + l for l in content.splitlines()])
warnings += 1
elif command == 'i':
content = r'\pytx@SVMCR{pytx@MCR@' + key_run.replace('#', '@') + '@' + instance + '}\n' + content.rstrip('\n') + '\\endpytx@SVMCR\n\n'
macros.append(content)
else:
fname = os.path.join(outputdir, basename + '_' + instance + '.stdout')
f = open(os.path.expanduser(os.path.normcase(fname)), 'w', encoding=encoding)
f.write(content)
f.close()
files.append(fname)
# Process stderr
if not os.path.isfile(err_file_name):
messages.append('* PythonTeX error')
messages.append(' Missing stderr file for ' + key_run.replace('#', ':'))
errors += 1
else:
# Open error and code files.
f = open(err_file_name, encoding=encoding)
err = f.readlines()
f.close()
# Divide stderr into an undelimited and a delimited portion
found = False
for n, line in enumerate(err):
if line.startswith('=>PYTHONTEX:STDERR#'):
found = True
err_ud = err[:n]
err_d = err[n:]
break
if not found:
err_ud = err
err_d = []
# Create a dict for storing any stderr content that will be saved
err_dict = defaultdict(list)
# Create the full basename that will be replaced in stderr
# We need two versions, one with the correct slashes for the OS,
# and one with the opposite slashes. This is needed when a language
# doesn't obey the OS's slash convention in paths given in stderr.
# For example, Windows uses backslashes, but Ruby under Windows uses
# forward in paths given in stderr.
# #### Consider os.path.normcase(), making search case-insensitive
outputdir_exp = os.path.expanduser(outputdir)
fullbasename_correct = os.path.join(outputdir_exp, basename)
if '\\' in fullbasename_correct:
fullbasename_reslashed = fullbasename_correct.replace('\\', '/')
else:
fullbasename_reslashed = fullbasename_correct.replace('/', '\\')
if err_ud:
it = iter(code_index.items())
index_now = next(it)
index_next = index_now
start_errgobble = None
for n, line in enumerate(err_ud):
if basename in line:
# Get the gobbleation. This is used to determine if
# other lines containing the basename are a continuation,
# or separate messages.
errgobble = match('(\s*)', line).groups()[0]
if start_errgobble is None:
start_errgobble = errgobble
# Only issue a message and track down the line numer if
# this is indeed the start of a new message, rather than
# a continuation of an old message that happens to
# contain the basename
if errgobble == start_errgobble:
# Determine the corresponding line number in the document
found = False
for pattern in linesig:
try:
errlinenum = int(search(pattern, line).groups()[0])
found = True
break
except:
pass
if found:
while index_next[1].lines_total < errlinenum:
try:
index_now, index_next = index_next, next(it)
except:
break
if errlinenum > index_now[1].lines_total + index_now[1].lines_input:
doclinenum = str(index_now[1].line_int + index_now[1].lines_input)
else:
doclinenum = str(index_now[1].line_int + errlinenum - index_now[1].lines_total - 1)
input_file = index_now[1].input_file
else:
doclinenum = '??'
input_file = '??'
# Try to determine if we are dealing with an error or a
# warning.
found = False
index = n
if stderrlookbehind:
while index >= 0:
# The order here is important. If a line matches
# both the error and warning patterns, default to
# error.
past_line = err_ud[index]
if (index < n and basename in past_line):
break
for pattern in warningsig:
if pattern in past_line:
warnings += 1
alert_type = 'warning'
found = True
break
for pattern in errorsig:
if pattern in past_line:
errors += 1
alert_type = 'error'
found = True
break
if found:
break
index -= 1
else:
while index < len(err_ud):
# The order here is important. If a line matches
# both the error and warning patterns, default to
# error.
future_line = err_ud[index]
if (index > n and basename in future_line and
future_line.startswith(start_errgobble)):
break
for pattern in warningsig:
if pattern in future_line:
warnings += 1
alert_type = 'warning'
found = True
break
for pattern in errorsig:
if pattern in future_line:
errors += 1
alert_type = 'error'
found = True
break
if found:
break
index += 1
# If an error or warning wasn't positively identified,
# increment unknowns.
if not found:
unknowns += 1
alert_type = 'unknown'
if input_file:
err_messages_ud.append('* PythonTeX stderr - {0} on line {1} in "{2}":'.format(alert_type, doclinenum, input_file))
else:
err_messages_ud.append('* PythonTeX stderr - {0} on line {1}:'.format(alert_type, doclinenum))
err_messages_ud.append(' ' + line.replace(outputdir_exp, '<outputdir>').rstrip('\n'))
else:
err_messages_ud.append(' ' + line.rstrip('\n'))
# Create .stderr
if makestderr and err_messages_ud:
process = False
it = iter(code_index.items())
index_now = next(it)
index_next = index_now
it_last = it
index_now_last = index_now
index_next_last = index_next
err_key_last_int = -1
for n, line in enumerate(err_ud):
if basename in line:
# Determine the corresponding line number in the document
found = False
for pattern in linesig:
try:
errlinenum = int(search(pattern, line).groups()[0])
found = True
break
except:
pass
if found:
if index_next[1].lines_total >= errlinenum:
it = it_last
index_now = index_now_last
index_next = index_next_last
else:
it_last = it
index_now_last = index_now
index_next_last = index_next
while index_next[1].lines_total < errlinenum:
try:
index_now, index_next = index_next, next(it)
except:
index_now = index_next
break
if index_now[0].endswith('CC'):
process = False
else:
process = True
if len(index_now[1].command) > 1:
if errlinenum > index_now[1].lines_total + index_now[1].lines_input:
codelinenum = str(index_now[1].lines_user + index_now[1].lines_input + 1)
else:
codelinenum = str(index_now[1].lines_user + errlinenum - index_now[1].lines_total - index_now[1].inline_count)
else:
codelinenum = '1'
else:
codelinenum = '??'
messages.append('* PythonTeX error')
messages.append(' Line number ' + str(errlinenum) + ' could not be synced with the document')
messages.append(' Content from stderr is not delimited, and cannot be resolved')
errors += 1
process = False
if process:
if int(index_now[0]) > err_key_last_int:
err_key = basename + '_' + index_now[0]
err_key_last_int = int(index_now[0])
line = line.replace(str(errlinenum), str(codelinenum), 1)
if fullbasename_correct in line:
fullbasename = fullbasename_correct
else:
fullbasename = fullbasename_reslashed
if stderrfilename == 'full':
line = line.replace(fullbasename, basename)
elif stderrfilename == 'session':
line = line.replace(fullbasename, session)
elif stderrfilename == 'genericfile':
line = line.replace(fullbasename + '.' + extension, '<file>')
elif stderrfilename == 'genericscript':
line = line.replace(fullbasename + '.' + extension, '<script>')
err_dict[err_key].append(line)
elif process:
err_dict[err_key].append(line)
if err_d:
start_errgobble = None
msg = []
found_basename = False
for n, line in enumerate(err_d):
if line.startswith('=>PYTHONTEX:STDERR#'):
# Store the last group of messages. Messages
# can't be directly appended to the main list, because
# a PythonTeX message must be inserted at the beginning
# of each chunk of stderr that never references
# the script that was executed. If the script is never
# referenced, then line numbers aren't automatically
# synced. These types of situations are created by
# warnings.warn() etc.
if msg:
if not found_basename:
# Get line number for command or beginning of
# environment
instance = last_delim.split('#')[1]
doclinenum = str(code_index[instance].line_int)
input_file = code_index[instance].input_file
# Try to identify alert. We have to parse all
# lines for signs of errors and warnings. This
# may result in overcounting, but it's the best
# we can do--otherwise, we could easily
# undercount, or, finding a warning, miss a
# subsequent error. When this code is actually
# used, it's already a sign that normal parsing
# has failed.
found_error = False
found_warning = False
for l in msg:
for pattern in warningsig:
if pattern in l:
warnings += 1
found_warning = True
for pattern in errorsig:
if pattern in l:
errors += 1
found_warning = True
if found_error:
alert_type = 'error'
elif found_warning:
alert_type = 'warning'
else:
unknowns += 1
alert_type = 'unknown'
if input_file:
err_messages_d.append('* PythonTeX stderr - {0} near line {1} in "{2}":'.format(alert_type, doclinenum, input_file))
else:
err_messages_d.append('* PythonTeX stderr - {0} near line {1}:'.format(alert_type, doclinenum))
err_messages_d.extend(msg)
msg = []
found_basename = False
# Never process delimiting info until it is used
# Rather, store the index of the last delimiter
last_delim = line
elif basename in line:
found_basename = True
# Get the gobbleation. This is used to determine if
# other lines containing the basename are a continuation,
# or separate messages.
errgobble = match('(\s*)', line).groups()[0]
if start_errgobble is None:
start_errgobble = errgobble
# Only issue a message and track down the line numer if
# this is indeed the start of a new message, rather than
# a continuation of an old message that happens to
# contain the basename
if errgobble == start_errgobble:
# Determine the corresponding line number in the document
found = False
for pattern in linesig:
try:
errlinenum = int(search(pattern, line).groups()[0])
found = True
break
except:
pass
if found:
# Get info from last delim
instance, command = last_delim.split('#')[1:-1]
# Calculate the line number in the document
ei = code_index[instance]
if errlinenum > ei.lines_total + ei.lines_input:
doclinenum = str(ei.line_int + ei.lines_input)
else:
doclinenum = str(ei.line_int + errlinenum - ei.lines_total - 1)
input_file = ei.input_file
else:
doclinenum = '??'
input_file = '??'
# Try to determine if we are dealing with an error or a
# warning.
found = False
index = n
if stderrlookbehind:
while index >= 0:
# The order here is important. If a line matches
# both the error and warning patterns, default to
# error.
past_line = err_d[index]
if (past_line.startswith('=>PYTHONTEX:STDERR#') or
(index < n and basename in past_line)):
break
for pattern in warningsig:
if pattern in past_line:
warnings += 1
alert_type = 'warning'
found = True
break
for pattern in errorsig:
if pattern in past_line:
errors += 1
alert_type = 'error'
found = True
break
if found:
break
index -= 1
else:
while index < len(err_d):
# The order here is important. If a line matches
# both the error and warning patterns, default to
# error.
future_line = err_d[index]
if (future_line.startswith('=>PYTHONTEX:STDERR#') or
(index > n and basename in future_line and future_line.startswith(start_errgobble))):
break
for pattern in warningsig:
if pattern in future_line:
warnings += 1
alert_type = 'warning'
found = True
break
for pattern in errorsig:
if pattern in future_line:
errors += 1
alert_type = 'error'
found = True
break
if found:
break
index += 1
# If an error or warning wasn't positively identified,
# assume error for safety but indicate uncertainty.
if not found:
unknowns += 1
alert_type = 'unknown'
if input_file:
msg.append('* PythonTeX stderr - {0} on line {1} in "{2}":'.format(alert_type, doclinenum, input_file))
else:
msg.append('* PythonTeX stderr - {0} on line {1}:'.format(alert_type, doclinenum))
# Clean up the stderr format a little, to keep it compact
line = line.replace(outputdir_exp, '<outputdir>').rstrip('\n')
if '/<outputdir>' in line or '\\<outputdir>' in line:
line = sub(r'(?:(?:[A-Za-z]:\\)|(?:~?/)).*<outputdir>', '<outputdir>', line)
msg.append(' ' + line)
else:
msg.append(' ' + line.rstrip('\n'))
# Deal with any leftover messages
if msg:
if not found_basename:
# Get line number for command or beginning of
# environment
instance = last_delim.split('#')[1]
doclinenum = str(code_index[instance].line_int)
input_file = code_index[instance].input_file
# Try to identify alert. We have to parse all
# lines for signs of errors and warnings. This
# may result in overcounting, but it's the best
# we can do--otherwise, we could easily
# undercount, or, finding a warning, miss a
# subsequent error. When this code is actually
# used, it's already a sign that normal parsing
# has failed.
found_error = False
found_warning = False
for l in msg:
for pattern in warningsig:
if pattern in l:
warnings += 1
found_warning = True
for pattern in errorsig:
if pattern in l:
errors += 1
found_warning = True
if found_error:
alert_type = 'error'
elif found_warning:
alert_type = 'warning'
else:
unknowns += 1
alert_type = 'unknown'
if input_file:
err_messages_d.append('* PythonTeX stderr - {0} near line {1} in "{2}":'.format(alert_type, doclinenum, input_file))
else:
err_messages_d.append('* PythonTeX stderr - {0} near line {1}:'.format(alert_type, doclinenum))
err_messages_d.extend(msg)
# Create .stderr
if makestderr and err_messages_d:
process = False
for n, line in enumerate(err_d):
if line.startswith('=>PYTHONTEX:STDERR#'):
instance, command = line.split('#')[1:-1]
if instance.endswith('CC'):
process = False
else:
process = True
err_key = basename + '_' + instance
elif process and basename in line:
found = False
for pattern in linesig:
try:
errlinenum = int(search(pattern, line).groups()[0])
found = True
break
except:
pass
if found:
# Calculate the line number in the document
# Account for inline
ei = code_index[instance]
# Store the `instance` in case it's
# incremented later
last_instance = instance
# If the error or warning was actually triggered
# later on (for example, multiline string with
# missing final delimiter), look ahead and
# determine the correct instance, so that
# we get the correct line number. We don't
# associate the created stderr with this later
# instance, however, but rather with the instance
# in which the error began. Doing that might
# possibly be preferable in some cases, but would
# also require that the current stderr be split
# between multiple instances, requiring extra
# parsing.
while errlinenum > ei.lines_total + ei.lines_input:
next_instance = str(int(instance) + 1)
if next_instance in code_index:
next_ei = code_index[next_instance]
if errlinenum > next_ei.lines_total:
instance = next_instance
ei = next_ei
else:
break
else:
break
if len(command) > 1:
if errlinenum > ei.lines_total + ei.lines_input:
codelinenum = str(ei.lines_user + ei.lines_input + 1)
else:
codelinenum = str(ei.lines_user + errlinenum - ei.lines_total - ei.inline_count)
else:
codelinenum = '1'
# Reset `instance`, in case incremented
instance = last_instance
else:
codelinenum = '??'
messages.append('* PythonTeX notice')
messages.append(' Line number ' + str(errlinenum) + ' could not be synced with the document')
line = line.replace(str(errlinenum), str(codelinenum), 1)
if fullbasename_correct in line:
fullbasename = fullbasename_correct
else:
fullbasename = fullbasename_reslashed
if stderrfilename == 'full':
line = line.replace(fullbasename, basename)
elif stderrfilename == 'session':
line = line.replace(fullbasename, session)
elif stderrfilename == 'genericfile':
line = line.replace(fullbasename + '.' + extension, '<file>')
elif stderrfilename == 'genericscript':
line = line.replace(fullbasename + '.' + extension, '<script>')
err_dict[err_key].append(line)
elif process:
err_dict[err_key].append(line)
if err_dict:
for err_key in err_dict:
stderr_file_name = os.path.join(outputdir, err_key + '.stderr')
f = open(os.path.expanduser(os.path.normcase(stderr_file_name)), 'w', encoding=encoding)
f.write(''.join(err_dict[err_key]))
f.close()
files.append(stderr_file_name)
# Clean up temp files, and update the list of existing files
if keeptemps == 'none':
for ext in [extension, 'pytxmcr', 'out', 'err']:
fname = os.path.expanduser(os.path.normcase(os.path.join(outputdir, basename + '.' + ext)))
if os.path.isfile(fname):
os.remove(fname)
elif keeptemps == 'code':
for ext in ['pytxmcr', 'out', 'err']:
fname = os.path.expanduser(os.path.normcase(os.path.join(outputdir, basename + '.' + ext)))
if os.path.isfile(fname):
os.remove(fname)
files.append(os.path.join(outputdir, basename + '.' + extension))
elif keeptemps == 'all':
for ext in [extension, 'pytxmcr', 'out', 'err']:
files.append(os.path.join(outputdir, basename + '.' + ext))
# Take care of any unknowns, based on exit code
# Interpret the exit code as an indicator of whether there were errors,
# and treat unknowns accordingly. This will cause all warnings to be
# misinterpreted as errors if warnings trigger a nonzero exit code.
# It will also cause all warnings to be misinterpreted as errors if there
# is a single error that causes a nonzero exit code. That isn't ideal,
# but shouldn't be a problem, because as soon as the error(s) are fixed,
# the exit code will be zero, and then all unknowns will be interpreted
# as warnings.
if unknowns:
if proc.returncode == 0:
unknowns_type = 'warnings'
warnings += unknowns
else:
unknowns_type = 'errors'
errors += unknowns
unknowns_message = '''
* PythonTeX notice
{0} message(s) could not be classified
Interpreted as {1}, based on the return code(s)'''
messages[0] += textwrap.dedent(unknowns_message.format(unknowns, unknowns_type))
# Take care of anything that has escaped detection thus far.
if proc.returncode == 1 and not errors:
errors += 1
command_message = '''
* PythonTeX error
An error occurred but no error messages were identified.
This may indicate a bad command or missing program.
The following command was executed:
"{0}"'''
messages[0] += textwrap.dedent(command_message.format(' '.join(exec_cmd)))
# Add any stderr messages; otherwise, clear the default message header
if err_messages_ud:
messages.extend(err_messages_ud)
if err_messages_d:
messages.extend(err_messages_d)
if len(messages) == 1:
messages = []
# Return a dict of dicts of results
return {'process': 'code',
'key': key_run,
'files': files,
'macros': macros,
'dependencies': dependencies,
'errors': errors,
'warnings': warnings,
'messages': messages}
def do_pygments(encoding, outputdir, fvextfile, pygments_list,
pygments_settings, typeset_cache):
'''
Create Pygments content.
To be run during multiprocessing.
'''
# Lazy import
from pygments import highlight
from pygments.lexers import get_lexer_by_name
from pygments.formatters import LatexFormatter
# Create what's needed for storing results
pygments_files = defaultdict(list)
pygments_macros = defaultdict(list)
errors = 0
warnings = 0
messages = []
messages.append('\n---- Messages for Pygments ----')
# Create dicts of formatters and lexers.
formatter = dict()
lexer = dict()
for codetype in pygments_settings:
if codetype != ':GLOBAL':
formatter[codetype] = LatexFormatter(**pygments_settings[codetype]['formatter_options'])
lexer[codetype] = get_lexer_by_name(pygments_settings[codetype]['lexer'],
**pygments_settings[codetype]['lexer_options'])
# Actually parse and highlight the code.
for c in pygments_list:
if c.is_cons:
content = typeset_cache[c.key_run][c.instance]
elif c.is_extfile:
if os.path.isfile(c.extfile):
f = open(c.extfile, encoding=encoding)
content = f.read()
f.close()
else:
content = None
messages.append('* PythonTeX error')
messages.append(' Could not find external file ' + c.extfile)
messages.append(' The file was not pygmentized')
else:
content = c.code
processed = highlight(content, lexer[c.family], formatter[c.family])
if c.is_inline or content.count('\n') < fvextfile:
# Highlighted code brought in via macros needs SaveVerbatim
if c.args_prettyprint:
processed = sub(r'\\begin{Verbatim}\[(.+)\]',
r'\\begin{{pytx@SaveVerbatim}}[\1, {4}]{{pytx@{0}@{1}@{2}@{3}}}'.format(c.family, c.session, c.restart, c.instance, c.args_prettyprint), processed, count=1)
else:
processed = sub(r'\\begin{Verbatim}\[(.+)\]',
r'\\begin{{pytx@SaveVerbatim}}[\1]{{pytx@{0}@{1}@{2}@{3}}}'.format(c.family, c.session, c.restart, c.instance), processed, count=1)
processed = processed.rsplit('\\', 1)[0] + '\\end{pytx@SaveVerbatim}\n\n'
pygments_macros[c.key_typeset].append(processed)
else:
if c.args_prettyprint:
processed = sub(r'\\begin{Verbatim}\[(.+)\]',
r'\\begin{{pytx@Verbatim}}[\1, {4}]{{pytx@{0}@{1}@{2}@{3}}}'.format(c.family, c.session, c.restart, c.instance, c.args_prettyprint), processed, count=1)
else:
processed = sub(r'\\begin{Verbatim}\[(.+)\]',
r'\\begin{{pytx@Verbatim}}[\1]{{pytx@{0}@{1}@{2}@{3}}}'.format(c.family, c.session, c.restart, c.instance), processed, count=1)
processed = processed.rsplit('\\', 1)[0] + '\\end{pytx@Verbatim}\n\n'
fname = os.path.join(outputdir, c.key_typeset.replace('#', '_') + '.pygtex')
f = open(os.path.expanduser(os.path.normcase(fname)), 'w', encoding=encoding)
f.write(processed)
f.close()
pygments_files[c.key_typeset].append(fname)
if len(messages) == 1:
messages = []
# Return a dict of dicts of results
return {'process': 'pygments',
'pygments_files': pygments_files,
'pygments_macros': pygments_macros,
'errors': errors,
'warnings': warnings,
'messages': messages}
def python_console(jobname, encoding, outputdir, workingdir, fvextfile,
pygments_settings, cc_begin_list, cons_list, cc_end_list,
startup, banner, filename):
'''
Use Python's ``code`` module to typeset emulated Python interactive
sessions, optionally highlighting with Pygments.
'''
# Create what's needed for storing results
key_run = cons_list[0].key_run
files = []
macros = []
pygments_files = defaultdict(list)
pygments_macros = defaultdict(list)
typeset_cache = {}
dependencies = {}
errors = 0
warnings = 0
messages = []
messages.append('\n---- Messages for ' + key_run.replace('#', ':') + ' ----')
# Lazy import what's needed
import code
from collections import deque
if sys.version_info[0] == 2:
# Need a Python 2 interface to io.StringIO that can accept bytes
import io
class StringIO(io.StringIO):
_orig_write = io.StringIO.write
def write(self, s):
self._orig_write(unicode(s))
else:
from io import StringIO
# Create a custom console class
class Console(code.InteractiveConsole):
'''
A subclass of code.InteractiveConsole that takes a list and treats it
as a series of console input.
'''
def __init__(self, banner, filename):
if banner == 'none':
self.banner = 'NULL BANNER'
elif banner == 'standard':
cprt = 'Type "help", "copyright", "credits" or "license" for more information.'
self.banner = 'Python {0} on {1}\n{2}'.format(sys.version, sys.platform, cprt)
elif banner == 'pyversion':
self.banner = 'Python ' + '.'.join(str(sys.version_info[n]) for n in (0, 1, 2))
else:
self.banner = None
if filename == 'console':
self.filename = '<console>'
elif filename == 'stdin':
self.filename = '<stdin>'
else:
self.filename = None
code.InteractiveConsole.__init__(self, filename=self.filename)
self.iostdout = StringIO()
def consolize(self, startup, cons_list):
self.console_code = deque()
# Delimiters are passed straight through and need newlines
self.console_code.append('=>PYTHONTEX#STARTUP##\n')
cons_config = '''
import os
import sys
docdir = os.getcwd()
if os.path.isdir('{workingdir}'):
os.chdir('{workingdir}')
if os.getcwd() not in sys.path:
sys.path.append(os.getcwd())
else:
sys.exit('Cannot find directory "{workingdir}"')
if docdir not in sys.path:
sys.path.append(docdir)
del docdir
'''
cons_config = cons_config.format(workingdir=os.path.expanduser(os.path.normcase(workingdir)))[1:]
self.console_code.extend(textwrap.dedent(cons_config).splitlines())
# Code is processed and doesn't need newlines
self.console_code.extend(startup.splitlines())
for c in cons_list:
self.console_code.append('=>PYTHONTEX#{0}#{1}#\n'.format(c.instance, c.command))
self.console_code.extend(c.code.splitlines())
old_stdout = sys.stdout
sys.stdout = self.iostdout
self.interact(self.banner)
sys.stdout = old_stdout
self.session_log = self.iostdout.getvalue()
def raw_input(self, prompt):
# Have to do a lot of looping and trying to make sure we get
# something valid to execute
try:
line = self.console_code.popleft()
except IndexError:
raise EOFError
while line.startswith('=>PYTHONTEX#'):
# Get new lines until we get one that doesn't begin with a
# delimiter. Then write the last delimited line.
old_line = line
try:
line = self.console_code.popleft()
self.write(old_line)
except IndexError:
raise EOFError
if line or prompt == sys.ps2:
self.write('{0}{1}\n'.format(prompt, line))
else:
self.write('\n')
return line
def write(self, data):
self.iostdout.write(data)
# Need to combine all custom code and user code to pass to consolize
cons_list = cc_begin_list + cons_list + cc_end_list
# Create a dict for looking up exceptions. This is needed for startup
# commands and for code commands and environments, since their output
# isn't typeset
cons_index = {}
for c in cons_list:
cons_index[c.instance] = c.line
# Consolize the code
# If the working directory is changed as part of the console code,
# then we need to get back to where we were.
con = Console(banner, filename)
cwd = os.getcwd()
con.consolize(startup, cons_list)
os.chdir(cwd)
# Set up Pygments, if applicable
if pygments_settings is not None:
pygmentize = True
# Lazy import
from pygments import highlight
from pygments.lexers import get_lexer_by_name
from pygments.formatters import LatexFormatter
formatter = LatexFormatter(**pygments_settings['formatter_options'])
lexer = get_lexer_by_name(pygments_settings['lexer'],
**pygments_settings['lexer_options'])
else:
pygmentize = False
# Process the console output
output = con.session_log.split('=>PYTHONTEX#')
# Extract banner
if banner == 'none':
banner_text = ''
else:
banner_text = output[0]
# Ignore the beginning, because it's the banner
for block in output[1:]:
delims, console_content = block.split('#\n', 1)
if console_content:
instance, command = delims.split('#')
if instance == 'STARTUP':
exception = False
console_content_lines = console_content.splitlines()
for line in console_content_lines:
if (not line.startswith(sys.ps1) and
not line.startswith(sys.ps2) and
line and not line.isspace()):
exception = True
break
if exception:
if 'Error:' in console_content:
errors += 1
alert_type = 'error'
elif 'Warning:' in console_content:
warnings += 1
alert_type = 'warning'
else:
errors += 1
alert_type = 'error (?)'
messages.append('* PythonTeX stderr - {0} in console startup code:'.format(alert_type))
for line in console_content_lines:
messages.append(' ' + line)
elif command in ('c', 'code'):
exception = False
console_content_lines = console_content.splitlines()
for line in console_content_lines:
if (line and not line.startswith(sys.ps1) and
not line.startswith(sys.ps2) and
not line.isspace()):
exception = True
break
if exception:
if 'Error:' in console_content:
errors += 1
alert_type = 'error'
elif 'Warning:' in console_content:
warnings += 1
alert_type = 'warning'
else:
errors += 1
alert_type = 'error (?)'
if instance.endswith('CC'):
messages.append('* PythonTeX stderr - {0} near line {1} in custom code for console:'.format(alert_type, cons_index[instance]))
else:
messages.append('* PythonTeX stderr - {0} near line {1} in console code:'.format(alert_type, cons_index[instance]))
messages.append(' Console code is not typeset, and should have no output')
for line in console_content_lines:
messages.append(' ' + line)
else:
if command == 'i':
# Currently, there isn't any error checking for invalid
# content; it is assumed that a single line of commands
# was entered, producing one or more lines of output.
# Given that the current ``\pycon`` command doesn't
# allow line breaks to be written to the .pytxcode, that
# should be a reasonable assumption.
console_content = console_content.split('\n', 1)[1]
elif console_content.endswith('\n\n'):
# Trim unwanted trailing newlines
console_content = console_content[:-1]
if banner_text is not None and command == 'console':
# Append banner to first appropriate environment
console_content = banner_text + console_content
banner_text = None
# Cache
key_typeset = key_run + '#' + instance
typeset_cache[instance] = console_content
# Process for LaTeX
if pygmentize:
processed = highlight(console_content, lexer, formatter)
if console_content.count('\n') < fvextfile:
processed = sub(r'\\begin{Verbatim}\[(.+)\]',
r'\\begin{{pytx@SaveVerbatim}}[\1]{{pytx@{0}}}'.format(key_typeset.replace('#', '@')),
processed, count=1)
processed = processed.rsplit('\\', 1)[0] + '\\end{pytx@SaveVerbatim}\n\n'
pygments_macros[key_typeset].append(processed)
else:
processed = sub(r'\\begin{Verbatim}\[(.+)\]',
r'\\begin{{pytx@Verbatim}}[\1]{{pytx@{0}}}'.format(key_typeset.replace('#', '@')),
processed, count=1)
processed = processed.rsplit('\\', 1)[0] + '\\end{pytx@Verbatim}\n\n'
fname = os.path.join(outputdir, key_typeset.replace('#', '_') + '.pygtex')
f = open(os.path.expanduser(os.path.normcase(fname)), 'w', encoding=encoding)
f.write(processed)
f.close()
pygments_files[key_typeset].append(fname)
else:
if console_content.count('\n') < fvextfile:
processed = ('\\begin{{pytx@SaveVerbatim}}{{pytx@{0}}}\n'.format(key_typeset.replace('#', '@')) +
console_content + '\\end{pytx@SaveVerbatim}\n\n')
macros.append(processed)
else:
processed = ('\\begin{pytx@Verbatim}\n' + console_content +
'\\end{pytx@Verbatim}\n\n')
fname = os.path.join(outputdir, key_typeset.replace('#', '_') + '.tex')
f = open(os.path.expanduser(os.path.normcase(fname)), 'w', encoding=encoding)
f.write(processed)
f.close()
files.append(fname)
if len(messages) == 1:
messages = []
# Return a dict of dicts of results
return {'process': 'console',
'key': key_run,
'files': files,
'macros': macros,
'pygments_files': pygments_files,
'pygments_macros': pygments_macros,
'typeset_cache': typeset_cache,
'dependencies': dependencies,
'errors': errors,
'warnings': warnings,
'messages': messages}
def main(python=None):
# Create dictionaries for storing data.
#
# All data that must be saved for subsequent runs is stored in "data".
# (We start off by saving the script version, a global var, in this dict.)
# All data that is only created for this run is stored in "temp_data".
# (We start off by creating keys for keeping track of errors and warnings.)
# All old data will eventually be loaded into "old_data".
# Since dicts are mutable data types, these dicts can be modified
# from within functions, as long as the dicts are passed to the functions.
# For simplicity, variables will often be created within functions to
# refer to dictionary values.
data = {'version': __version__, 'start_time': time.time()}
temp_data = {'errors': 0, 'warnings': 0, 'python': python}
old_data = dict()
# Process command-line options.
#
# This gets the raw_jobname (actual job name), jobname (a sanitized job
# name, used for creating files named after the jobname), and any options.
process_argv(data, temp_data)
# If there aren't errors in argv, and the program is going to run
# (rather than just exit due to --version or --help command-line options),
# print PythonTeX version. Flush to make the message go out immediately,
# so that the user knows PythonTeX has started.
print('This is PythonTeX {0}'.format(__version__))
sys.stdout.flush()
# Once we have the encoding (from argv), we set stdout and stderr to use
# this encoding. Later, we will parse the saved stderr of scripts
# executed via multiprocessing subprocesses, and print the parsed results
# to stdout. The saved stderr uses the same encoding that was used
# for the files that created it (this is important for code containing
# unicode characters), so we also need stdout for the main PythonTeX
# script to support this encoding. Setting stderr encoding is primarily
# a matter of symmetry. Ideally, pythontex*.py will be bug-free,
# and stderr won't be needed!
if sys.version_info[0] == 2:
sys.stdout = codecs.getwriter(data['encoding'])(sys.stdout, 'strict')
sys.stderr = codecs.getwriter(data['encoding'])(sys.stderr, 'strict')
else:
sys.stdout = codecs.getwriter(data['encoding'])(sys.stdout.buffer, 'strict')
sys.stderr = codecs.getwriter(data['encoding'])(sys.stderr.buffer, 'strict')
# Load the code and process the settings it passes from the TeX side.
#
# This gets a list containing the code (the part of the code file
# containing the settings is removed) and the processed settings.
load_code_get_settings(data, temp_data)
# Now that the settings are loaded, check if outputdir exits.
# If not, create it.
if not os.path.isdir(os.path.expanduser(os.path.normcase(data['settings']['outputdir']))):
os.mkdir(os.path.expanduser(os.path.normcase(data['settings']['outputdir'])))
# Load/create old_data
get_old_data(data, old_data, temp_data)
# Hash the code. Determine what needs to be executed. Determine whether
# Pygments should be used. Update pygments_settings to account for
# Pygments commands and environments (as opposed to PythonTeX commands
# and environments).
hash_all(data, temp_data, old_data, engine_dict)
# Parse the code and write scripts for execution.
parse_code_write_scripts(data, temp_data, engine_dict)
# Execute the code and perform Pygments highlighting via multiprocessing.
do_multiprocessing(data, temp_data, old_data, engine_dict)
# Skip exit message if in debug mode
# #### May want to refactor
if temp_data['debug'] is not None or temp_data['interactive'] is not None:
if 'upgrade_message' in temp_data:
print(temp_data['upgrade_message'])
sys.exit()
# Print exit message
print('\n--------------------------------------------------')
# If some rerun settings are used, there may be unresolved errors or
# warnings; if so, print a summary of those along with the current
# error and warning summary
unresolved_errors = 0
unresolved_warnings = 0
if temp_data['rerun'] in ('errors', 'modified', 'never'):
global_update = {}
global_update.update(temp_data['code_update'])
global_update.update(temp_data['cons_update'])
for key in data['exit_status']:
if not global_update[key]:
unresolved_errors += data['exit_status'][key][0]
unresolved_warnings += data['exit_status'][key][1]
if unresolved_warnings != 0 or unresolved_errors != 0:
print('PythonTeX: {0}'.format(data['raw_jobname']))
print(' - Old: {0} error(s), {1} warnings(s)'.format(unresolved_errors, unresolved_warnings))
print(' - Current: {0} error(s), {1} warnings(s)'.format(temp_data['errors'], temp_data['warnings']))
else:
print('PythonTeX: {0} - {1} error(s), {2} warning(s)\n'.format(data['raw_jobname'], temp_data['errors'], temp_data['warnings']))
if 'upgrade_message' in temp_data:
print(temp_data['upgrade_message'])
# Exit with appropriate exit code based on user settings.
if temp_data['error_exit_code'] and temp_data['errors'] > 0:
sys.exit(1)
else:
sys.exit()
# The "if" statement is needed for multiprocessing under Windows; see the
# multiprocessing documentation. It is also needed in this case when the
# script is invoked via the wrapper.
if __name__ == '__main__':
#// Python 2
if sys.version_info.major != 2:
sys.exit('This version of the PythonTeX script requires Python 2.')
#\\ End Python 2
#// Python 3
#if sys.version_info.major != 3:
# sys.exit('This version of the PythonTeX script requires Python 3.')
#\\ End Python 3
main(python=sys.version_info.major)
|