1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>apsw.shell — APSW 3.46.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../_static/apsw.css?v=3c7e2631" />
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=d98f5d2b"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="copyright" title="Copyright" href="../../copyright.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home">
APSW
<img src="../../_static/apswlogo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.46.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tips.html">Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../example.html">Example/Tour</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../install.html">Installation and customization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../extensions.html">Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../apsw.html">APSW Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connection.html">Connections to a database</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cursor.html">Cursors (executing SQL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../blob.html">Blob Input/Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backup.html">Backup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../vtable.html">Virtual Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../vfs.html">Virtual File System (VFS)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../shell.html">Shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../bestpractice.html">Best Practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ext.html">Various interesting and useful bits of functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">Exceptions and Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../execution.html">Execution and tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dbapi.html">DBAPI notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../pysqlite.html">sqlite3 module differences</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../benchmarking.html">Benchmarking</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../copyright.html">Copyright and License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../changes.html">Change History</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../py-modindex.html">Module Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../genindex.html">Index</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">APSW</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
<li class="breadcrumb-item"><a href="../apsw.html">apsw</a></li>
<li class="breadcrumb-item active">apsw.shell</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apsw.shell</h1><div class="highlight"><pre>
<span></span><span class="ch">#!/usr/bin/env python3</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span class="c1"># mypy: ignore-errors</span>
<span class="kn">import</span> <span class="nn">argparse</span>
<span class="kn">import</span> <span class="nn">base64</span>
<span class="kn">import</span> <span class="nn">code</span>
<span class="kn">import</span> <span class="nn">codecs</span>
<span class="kn">import</span> <span class="nn">contextlib</span>
<span class="kn">import</span> <span class="nn">csv</span>
<span class="kn">import</span> <span class="nn">dataclasses</span>
<span class="kn">import</span> <span class="nn">inspect</span>
<span class="kn">import</span> <span class="nn">io</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">shlex</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">textwrap</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">traceback</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">TextIO</span>
<span class="kn">import</span> <span class="nn">apsw</span>
<span class="kn">import</span> <span class="nn">apsw.ext</span>
<div class="viewcode-block" id="Shell">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell">[docs]</a>
<span class="k">class</span> <span class="nc">Shell</span><span class="p">:</span>
<span class="w"> </span><span class="sd">"""Implements a SQLite shell</span>
<span class="sd"> :param stdin: Where to read input from (default sys.stdin)</span>
<span class="sd"> :param stdout: Where to send output (default sys.stdout)</span>
<span class="sd"> :param stderr: Where to send errors (default sys.stderr)</span>
<span class="sd"> :param encoding: Default encoding for files opened/created by the</span>
<span class="sd"> Shell. If you want stdin/out/err to use a particular encoding</span>
<span class="sd"> then you need to provide them `already configured</span>
<span class="sd"> <https://docs.python.org/3/library/codecs.html#codecs.open>`__ that way.</span>
<span class="sd"> :param args: This should be program arguments only (ie if</span>
<span class="sd"> passing in sys.argv do not include sys.argv[0] which is the</span>
<span class="sd"> program name. You can also pass in None and then call</span>
<span class="sd"> :meth:`process_args` if you want to catch any errors</span>
<span class="sd"> in handling the arguments yourself.</span>
<span class="sd"> :param db: A existing :class:`~apsw.Connection` you wish to use</span>
<span class="sd"> Errors and diagnostics are only ever sent to error output</span>
<span class="sd"> (self.stderr) and never to the regular output (self.stdout).</span>
<span class="sd"> Shell commands begin with a dot (eg .help). They are implemented</span>
<span class="sd"> as a method named after the command (eg command_help). The method</span>
<span class="sd"> is passed one parameter which is the list of arguments to the</span>
<span class="sd"> command.</span>
<span class="sd"> Output modes are implemented by functions named after the mode (eg</span>
<span class="sd"> output_column for columns).</span>
<span class="sd"> When you request help the help information is automatically</span>
<span class="sd"> generated from the docstrings for the command and output</span>
<span class="sd"> functions.</span>
<span class="sd"> You should not use a Shell object concurrently from multiple</span>
<span class="sd"> threads. It is one huge set of state information which would</span>
<span class="sd"> become inconsistent if used simultaneously.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="Shell.Error">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.Error">[docs]</a>
<span class="k">class</span> <span class="nc">Error</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Class raised on errors. The expectation is that the error</span>
<span class="sd"> will be displayed by the shell as text so there are no</span>
<span class="sd"> specific subclasses as the distinctions between different</span>
<span class="sd"> types of errors doesn't matter."""</span>
<span class="k">pass</span></div>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">stdin</span><span class="p">:</span> <span class="n">TextIO</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">stdout</span><span class="p">:</span> <span class="n">TextIO</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">stderr</span><span class="p">:</span> <span class="n">TextIO</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">encoding</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"utf8"</span><span class="p">,</span>
<span class="n">args</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">db</span><span class="p">:</span> <span class="n">apsw</span><span class="o">.</span><span class="n">Connection</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Create instance, set defaults and do argument processing."""</span>
<span class="c1"># The parameter doc has to be in main class doc as sphinx</span>
<span class="c1"># ignores any described here</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exceptions</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">history_file</span> <span class="o">=</span> <span class="s2">"~/.sqlite_history"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bindings</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">db</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="o">=</span> <span class="n">db</span><span class="p">,</span> <span class="n">db</span><span class="o">.</span><span class="n">filename</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
<span class="c1"># keep a reference around allowing switching connections</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db_references</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prompt</span> <span class="o">=</span> <span class="s2">"sqlite> "</span>
<span class="bp">self</span><span class="o">.</span><span class="n">moreprompt</span> <span class="o">=</span> <span class="s2">" ..> "</span>
<span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">=</span> <span class="s2">"|"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bail</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changes</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">echo</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timer</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nullvalue</span> <span class="o">=</span> <span class="s2">""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_list</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_table</span> <span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="s2">"table"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">widths</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># do we truncate output in list mode?</span>
<span class="bp">self</span><span class="o">.</span><span class="n">truncate</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># a stack of previous outputs</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_stack</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># other stuff</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_encoding</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span> <span class="ow">or</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdin</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_original_stdout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span> <span class="ow">or</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span> <span class="ow">or</span> <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span>
<span class="c1"># default to box output</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_using_a_terminal</span><span class="p">()</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"output_box"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_box</span>
<span class="bp">self</span><span class="o">.</span><span class="n">box_options</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"quote"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s2">"string_sanitize"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"null"</span><span class="p">:</span> <span class="s2">"NULL"</span><span class="p">,</span>
<span class="s2">"truncate"</span><span class="p">:</span> <span class="mi">4096</span><span class="p">,</span>
<span class="s2">"text_width"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_terminal_width</span><span class="p">(</span><span class="mi">32</span><span class="p">),</span>
<span class="s2">"use_unicode"</span><span class="p">:</span> <span class="kc">True</span>
<span class="p">}</span>
<span class="c1"># we don't become interactive until the command line args are</span>
<span class="c1"># successfully parsed and acted upon</span>
<span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># current colouring object</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_colour</span><span class="p">()</span> <span class="c1"># set to default</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_using_readline</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_input_stack</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">input_line_number</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_calculate_output_modes</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_input</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">args</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"Processing command line arguments"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">()</span>
<span class="k">raise</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_using_a_terminal</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_using_a_terminal</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="p">,</span> <span class="s2">"isatty"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">isatty</span><span class="p">()</span> <span class="ow">and</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"isatty"</span><span class="p">,</span>
<span class="kc">None</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_ensure_db</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="s2">"The database isn't opened until first use. This function ensures it is now open."</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_db</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span> <span class="o">=</span> <span class="s2">":memory:"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span><span class="p">,</span>
<span class="n">flags</span><span class="o">=</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_OPEN_URI</span> <span class="o">|</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_OPEN_READWRITE</span>
<span class="o">|</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_OPEN_CREATE</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_db</span>
<span class="k">def</span> <span class="nf">_set_db</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">newv</span><span class="p">):</span>
<span class="s2">"Sets the open database (or None) and filename"</span>
<span class="p">(</span><span class="n">db</span><span class="p">,</span> <span class="n">dbfilename</span><span class="p">)</span> <span class="o">=</span> <span class="n">newv</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_db</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span><span class="o">.</span><span class="n">close</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span> <span class="o">=</span> <span class="n">db</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span> <span class="o">=</span> <span class="n">dbfilename</span>
<span class="n">db</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_ensure_db</span><span class="p">,</span> <span class="n">_set_db</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s2">"The current :class:`~apsw.Connection`"</span><span class="p">)</span>
<div class="viewcode-block" id="Shell.process_args">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.process_args">[docs]</a>
<span class="k">def</span> <span class="nf">process_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Process command line options specified in args. It is safe to</span>
<span class="sd"> call this multiple times. We try to be compatible with SQLite shell</span>
<span class="sd"> argument parsing.</span>
<span class="sd"> :param args: A list of string options. Do not include the</span>
<span class="sd"> program as args[0]</span>
<span class="sd"> :returns: A tuple of (databasefilename, initfiles,</span>
<span class="sd"> sqlncommands). This is provided for informational purposes</span>
<span class="sd"> only - they have already been acted upon. An example use</span>
<span class="sd"> is that the SQLite shell does not enter the main interactive</span>
<span class="sd"> loop if any sql/commands were provided.</span>
<span class="sd"> The first non-option is the database file name. Each</span>
<span class="sd"> remaining non-option is treated as a complete input (ie it</span>
<span class="sd"> isn't joined with others looking for a trailing semi-colon).</span>
<span class="sd"> The SQLite shell uses single dash in front of options. We</span>
<span class="sd"> allow both single and double dashes. When an unrecognized</span>
<span class="sd"> argument is encountered then</span>
<span class="sd"> :meth:`process_unknown_args` is called.</span>
<span class="sd"> """</span>
<span class="c1"># we don't use argparse as we need to be compatible with what</span>
<span class="c1"># SQLite's C code does</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">args</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span><span class="p">,</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="c1"># are options still valid?</span>
<span class="n">options</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># have we seen the database name?</span>
<span class="n">havedbname</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># List of init files to read</span>
<span class="n">inits</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># List of sql/dot commands</span>
<span class="n">sqls</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">args</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">options</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"-"</span><span class="p">):</span>
<span class="n">options</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">havedbname</span><span class="p">:</span>
<span class="c1"># grab new database</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">havedbname</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">sqls</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="c1"># remove initial single or double dash</span>
<span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"-"</span><span class="p">):</span>
<span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"init"</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"You need to specify a filename after -init"</span><span class="p">)</span>
<span class="n">inits</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"header"</span> <span class="ow">or</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"noheader"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"header"</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"echo"</span><span class="p">,</span> <span class="s2">"bail"</span><span class="p">,</span> <span class="s2">"interactive"</span><span class="p">):</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">True</span><span class="p">)</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"batch"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"separator"</span><span class="p">,</span> <span class="s2">"nullvalue"</span><span class="p">,</span> <span class="s2">"encoding"</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"You need to specify a value after -"</span> <span class="o">+</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"command_"</span> <span class="o">+</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])([</span><span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]])</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"version"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">apsw</span><span class="o">.</span><span class="n">sqlite_lib_version</span><span class="p">()</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># A pretty gnarly thing to do</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"help"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">usage</span><span class="p">())</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"no-colour"</span><span class="p">,</span> <span class="s2">"no-color"</span><span class="p">,</span> <span class="s2">"nocolour"</span><span class="p">,</span> <span class="s2">"nocolor"</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colour_scheme</span> <span class="o">=</span> <span class="s2">"off"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_out_colour</span><span class="p">()</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="c1"># only remaining known args are output modes</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"output_"</span> <span class="o">+</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_mode</span><span class="p">(</span><span class="n">args</span><span class="p">[:</span><span class="mi">1</span><span class="p">])</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">continue</span>
<span class="n">newargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">process_unknown_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
<span class="k">if</span> <span class="n">newargs</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Unrecognized argument '"</span> <span class="o">+</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"'"</span><span class="p">)</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">newargs</span>
<span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">inits</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_read</span><span class="p">([</span><span class="n">f</span><span class="p">])</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">sqls</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_complete_line</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span><span class="p">,</span> <span class="n">inits</span><span class="p">,</span> <span class="n">sqls</span></div>
<div class="viewcode-block" id="Shell.process_unknown_args">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.process_unknown_args">[docs]</a>
<span class="k">def</span> <span class="nf">process_unknown_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""This is called when :meth:`process_args` encounters an</span>
<span class="sd"> argument it doesn't understand. Override this method if you</span>
<span class="sd"> want to be able to understand additional command line arguments.</span>
<span class="sd"> :param args: A list of the remaining arguments. The initial one will</span>
<span class="sd"> have had the leading dashes removed (eg if it was --foo on the command</span>
<span class="sd"> line then args[0] will be "foo"</span>
<span class="sd"> :returns: None if you don't recognize the argument either. Otherwise</span>
<span class="sd"> return the list of remaining arguments after you have processed</span>
<span class="sd"> yours.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="Shell.usage">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.usage">[docs]</a>
<span class="k">def</span> <span class="nf">usage</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="s2">"Returns the usage message."</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s2">"""</span>
<span class="s2">Usage: python3 -m apsw [OPTIONS] FILENAME [SQL|CMD] [SQL|CMD]...</span>
<span class="s2">FILENAME is the name of a SQLite database. A new database is</span>
<span class="s2">created if the file does not exist. If omitted or an empty</span>
<span class="s2">string then an in-memory database is created.</span>
<span class="s2">OPTIONS include:</span>
<span class="s2"> -init filename read/process named file</span>
<span class="s2"> -echo print commands before execution</span>
<span class="s2"> -[no]header turn headers on or off</span>
<span class="s2"> -bail stop after hitting the first error</span>
<span class="s2"> -interactive force interactive I/O (command editing and colour)</span>
<span class="s2"> -batch force batch I/O (no banners or editing)</span>
<span class="s2"> -column set output mode to 'column'</span>
<span class="s2"> -csv set output mode to 'csv'</span>
<span class="s2"> -html set output mode to 'html'</span>
<span class="s2"> -line set output mode to 'line'</span>
<span class="s2"> -list set output mode to 'list'</span>
<span class="s2"> -python set output mode to 'python'</span>
<span class="s2"> -jsonl set output mode to 'jsonl'</span>
<span class="s2"> -separator 'x' set output field separator (|)</span>
<span class="s2"> -nullvalue 'text' set text string for NULL values</span>
<span class="s2"> -version show SQLite version</span>
<span class="s2"> -encoding 'name' the encoding to use for files</span>
<span class="s2"> opened via .import, .read & .output</span>
<span class="s2"> -nocolour disables interactive colour output</span>
<span class="s2">"""</span>
<span class="k">return</span> <span class="n">msg</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span></div>
<span class="c1">###</span>
<span class="c1">### Value formatting routines. They take a value and return a</span>
<span class="c1">### text formatting of them. Mostly used by the various output's</span>
<span class="c1">### but also by random other pieces of code.</span>
<span class="c1">###</span>
<span class="c1"># bytes that are ok in C strings - no need for quoting</span>
<span class="n">_printable</span> <span class="o">=</span> <span class="p">[</span>
<span class="nb">ord</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="s2">"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789~!@#$%^&*()`_-+=</span><span class="si">{}</span><span class="s2">[]:;,.<>/?|"</span>
<span class="p">]</span>
<span class="k">def</span> <span class="nf">_fmt_c_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">:</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLiteValue</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
<span class="s2">"Format as a C string including surrounding double quotes"</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="n">op</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'"'</span><span class="p">]</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">:</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\\\</span><span class="s2">"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\r</span><span class="s2">"</span><span class="p">:</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">r"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">:</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">n"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span><span class="p">:</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">t"</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_printable</span><span class="p">:</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span> <span class="o">+</span> <span class="n">c</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="n">op</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'"'</span><span class="p">)</span>
<span class="k">return</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">op</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">v</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">'"'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">nullvalue</span> <span class="o">+</span> <span class="s1">'"'</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="n">o</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span>
<span class="n">fromc</span> <span class="o">=</span> <span class="nb">chr</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'"'</span><span class="p">]</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span>
<span class="k">if</span> <span class="n">o</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_printable</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fromc</span><span class="p">(</span><span class="n">c</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">x</span><span class="si">%02X</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">o</span><span class="p">(</span><span class="n">c</span><span class="p">),</span> <span class="p">))</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'"'</span><span class="p">)</span>
<span class="k">return</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># number of some kind</span>
<span class="k">return</span> <span class="s1">'"</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="p">)</span>
<span class="k">def</span> <span class="nf">_fmt_html_col</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="s2">"Format as HTML (mainly escaping &/</>"</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span>\
<span class="n">replace</span><span class="p">(</span><span class="s2">"&"</span><span class="p">,</span> <span class="s2">"&amp;"</span><span class="p">)</span><span class="o">.</span> \
<span class="n">replace</span><span class="p">(</span><span class="s2">">"</span><span class="p">,</span> <span class="s2">"&gt;"</span><span class="p">)</span><span class="o">.</span> \
<span class="n">replace</span><span class="p">(</span><span class="s2">"<"</span><span class="p">,</span> <span class="s2">"&lt;"</span><span class="p">)</span><span class="o">.</span> \
<span class="n">replace</span><span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s2">"&apos;"</span><span class="p">)</span><span class="o">.</span> \
<span class="n">replace</span><span class="p">(</span><span class="s1">'"'</span><span class="p">,</span> <span class="s2">"&quot;"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_fmt_json_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="s2">"Format a value."</span>
<span class="c1"># JSON doesn't have a binary type so we base64 encode it</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">'"'</span> <span class="o">+</span> <span class="n">base64</span><span class="o">.</span><span class="n">encodebytes</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">"ascii"</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">+</span> <span class="s1">'"'</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">ensure_ascii</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_fmt_python</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="s2">"Format as python literal"</span>
<span class="k">if</span> <span class="n">v</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">"None"</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'b"'</span><span class="p">]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_printable</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="n">i</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">x</span><span class="si">%02X</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="p">))</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'"'</span><span class="p">)</span>
<span class="k">return</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="p">)</span>
<span class="k">def</span> <span class="nf">_fmt_sql_identifier</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="s2">"Return the identifier quoted in SQL syntax if needed (eg table and column names)"</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> <span class="c1"># yes sqlite does allow zero length identifiers</span>
<span class="k">return</span> <span class="s1">'""'</span>
<span class="n">nonalnum</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">"[A-Za-z_0-9]+"</span><span class="p">,</span> <span class="s2">""</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">nonalnum</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sqlite_reserved</span><span class="p">:</span>
<span class="c1"># Ok providing it doesn't start with a digit</span>
<span class="k">if</span> <span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="s2">"0123456789"</span><span class="p">:</span>
<span class="k">return</span> <span class="n">v</span>
<span class="c1"># double quote it unless there are any double quotes in it</span>
<span class="k">if</span> <span class="s1">'"'</span> <span class="ow">in</span> <span class="n">nonalnum</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">"[</span><span class="si">%s</span><span class="s2">]"</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="p">)</span>
<span class="k">return</span> <span class="s1">'"</span><span class="si">%s</span><span class="s1">"'</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="p">)</span>
<span class="k">def</span> <span class="nf">_fmt_text_col</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="s2">"Regular text formatting"</span>
<span class="k">if</span> <span class="n">v</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">nullvalue</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">v</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="c1"># sqlite gives back raw bytes!</span>
<span class="k">return</span> <span class="s2">"<Binary data>"</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="p">)</span>
<span class="c1">###</span>
<span class="c1">### The various output routines. They are always called with the</span>
<span class="c1">### header irrespective of the setting allowing for some per query</span>
<span class="c1">### setup. (see output_column for example). The doc strings are</span>
<span class="c1">### used to generate help.</span>
<span class="c1">###</span>
<span class="k">def</span> <span class="nf">output_column</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Items left aligned in space padded columns. They are</span>
<span class="sd"> truncated if they do not fit. If the width hasn't been</span>
<span class="sd"> specified for a column then 10 is used unless the column name</span>
<span class="sd"> (header) is longer in which case that width is used. Use the</span>
<span class="sd"> .width command to change column sizes.</span>
<span class="sd"> """</span>
<span class="c1"># as an optimization we calculate self._actualwidths which is</span>
<span class="c1"># reset for each query</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">gw</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="k">if</span> <span class="n">n</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">widths</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">widths</span><span class="p">[</span><span class="n">n</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">widths</span><span class="p">[</span><span class="n">n</span><span class="p">]</span>
<span class="c1"># if width is not present or 0 then autosize</span>
<span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">line</span><span class="p">[</span><span class="n">n</span><span class="p">])</span>
<span class="k">return</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">text</span><span class="p">),</span> <span class="mi">10</span><span class="p">)</span>
<span class="n">widths</span> <span class="o">=</span> <span class="p">[</span><span class="n">gw</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">))]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">truncate</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_actualwidths</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"%"</span> <span class="o">+</span> <span class="p">(</span><span class="s2">"-</span><span class="si">%d</span><span class="s2">.</span><span class="si">%d</span><span class="s2">s"</span><span class="p">,</span> <span class="s2">"</span><span class="si">%d</span><span class="s2">.</span><span class="si">%d</span><span class="s2">s"</span><span class="p">)[</span><span class="n">w</span> <span class="o"><</span> <span class="mi">0</span><span class="p">]</span> <span class="o">%</span> <span class="p">(</span><span class="nb">abs</span><span class="p">(</span><span class="n">w</span><span class="p">),</span> <span class="nb">abs</span><span class="p">(</span><span class="n">w</span><span class="p">))</span> <span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="n">widths</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_actualwidths</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"%"</span> <span class="o">+</span> <span class="p">(</span><span class="s2">"-</span><span class="si">%d</span><span class="s2">s"</span><span class="p">,</span> <span class="s2">"</span><span class="si">%d</span><span class="s2">s"</span><span class="p">)[</span><span class="n">w</span> <span class="o"><</span> <span class="mi">0</span><span class="p">]</span> <span class="o">%</span> <span class="p">(</span><span class="nb">abs</span><span class="p">(</span><span class="n">w</span><span class="p">),</span> <span class="p">)</span> <span class="k">for</span> <span class="n">w</span> <span class="ow">in</span> <span class="n">widths</span><span class="p">]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="p">:</span>
<span class="c1"># output the headers</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="n">cols</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">c</span><span class="o">.</span><span class="n">header</span> <span class="o">+</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_actualwidths</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">]),</span> <span class="p">))</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">header_</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">))</span>
<span class="p">]</span>
<span class="c1"># sqlite shell uses two spaces between columns</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cols</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">c</span> <span class="ow">is</span> <span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="p">[</span><span class="s2">"off"</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output_column</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="p">[</span><span class="s2">"-"</span> <span class="o">*</span> <span class="nb">abs</span><span class="p">(</span><span class="n">widths</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">widths</span><span class="p">))])</span>
<span class="k">return</span>
<span class="n">cols</span> <span class="o">=</span> <span class="p">[</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">_actualwidths</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">]),</span> <span class="p">))</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">))</span>
<span class="p">]</span>
<span class="c1"># sqlite shell uses two spaces between columns</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cols</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">output_columns</span> <span class="o">=</span> <span class="n">output_column</span>
<span class="k">def</span> <span class="nf">output_csv</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Items in csv format (comma separated). Use tabs mode for tab</span>
<span class="sd"> separated. You can use the .separator command to use a</span>
<span class="sd"> different one after switching mode. A separator of comma uses</span>
<span class="sd"> double quotes for quoting while other separators do not do any</span>
<span class="sd"> quoting. The Python csv library used for this only supports</span>
<span class="sd"> single character separators.</span>
<span class="sd"> """</span>
<span class="c1"># we use self._csv for the work, setup when header is</span>
<span class="c1"># supplied. _csv is a tuple of a StringIO and the csv.writer</span>
<span class="c1"># instance.</span>
<span class="n">fixdata</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">StringIO</span><span class="p">()</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">==</span> <span class="s2">","</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"dialect"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"excel"</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"dialect"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"excel-tab"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"quoting"</span><span class="p">]</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">QUOTE_NONE</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"delimiter"</span><span class="p">]</span> <span class="o">=</span> <span class="n">fixdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">separator</span><span class="p">)</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"doublequote"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># csv module is bug ridden junk - I already say no</span>
<span class="c1"># quoting so it still looks for the quotechar and then</span>
<span class="c1"># gets upset that it can't be quoted. Which bit of no</span>
<span class="c1"># quoting was ambiguous?</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"quotechar"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\x00</span><span class="s2">"</span>
<span class="n">writer</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">writer</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_csv</span> <span class="o">=</span> <span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">writer</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output_csv</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">header</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="n">line</span> <span class="o">=</span> <span class="p">[</span><span class="n">c</span><span class="o">.</span><span class="n">header</span> <span class="o">+</span> <span class="n">fixdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">l</span><span class="p">))</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">header_</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">fixdata</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">x</span><span class="p">)))</span>
<span class="n">line</span> <span class="o">=</span> <span class="p">[</span><span class="n">fmt</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_csv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">writerow</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_csv</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
<span class="c1"># csv lib always does DOS eol</span>
<span class="k">assert</span> <span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"</span><span class="se">\r\n</span><span class="s2">"</span><span class="p">))</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">t</span><span class="p">[:</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span>
<span class="c1"># should not be other eol irregularities</span>
<span class="k">assert</span> <span class="p">(</span><span class="ow">not</span> <span class="n">t</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"</span><span class="se">\r</span><span class="s2">"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">t</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">t</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_csv</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">truncate</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_csv</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">output_html</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="s2">"HTML table style"</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">header</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_html_col</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">header_</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_html_col</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="n">line</span> <span class="o">=</span> <span class="p">[</span><span class="n">fmt</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">]</span>
<span class="n">out</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"<TR>"</span><span class="p">]</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"<TD>"</span><span class="p">,</span> <span class="s2">"<TH>"</span><span class="p">)[</span><span class="n">header</span><span class="p">])</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">l</span><span class="p">)</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"</TD></span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"</TH></span><span class="se">\n</span><span class="s2">"</span><span class="p">)[</span><span class="n">header</span><span class="p">])</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</TR></span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">output_insert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Lines as SQL insert statements. The table name is "table"</span>
<span class="sd"> unless you specified a different one as the second parameter</span>
<span class="sd"> to the .mode command.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="n">out</span> <span class="o">=</span> <span class="s2">"INSERT INTO "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_table</span> <span class="o">+</span> <span class="s2">" VALUES("</span> <span class="o">+</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">fmt</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">])</span> <span class="o">+</span> <span class="s2">");</span><span class="se">\n</span><span class="s2">"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">output_json</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">:</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Output a JSON array. Blobs are output as base64 encoded strings.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span> <span class="k">return</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_json_value</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="n">out</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_json_value</span><span class="p">(</span><span class="n">k</span><span class="p">),</span> <span class="n">fmt</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">row</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">columns</span><span class="p">)]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span>
<span class="p">(</span><span class="s2">"["</span> <span class="k">if</span> <span class="n">line</span><span class="o">.</span><span class="n">is_first</span> <span class="k">else</span> <span class="s2">""</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"{ "</span> <span class="o">+</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"}"</span> <span class="o">+</span> <span class="p">(</span><span class="s2">"]"</span> <span class="k">if</span> <span class="n">line</span><span class="o">.</span><span class="n">is_last</span> <span class="k">else</span> <span class="s2">","</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">output_jsonl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">:</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Output as JSON objects, newline separated. Blobs are output as base64 encoded strings.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span> <span class="k">return</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_json_value</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="n">out</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_json_value</span><span class="p">(</span><span class="n">k</span><span class="p">),</span> <span class="n">fmt</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">row</span><span class="p">[</span><span class="n">i</span><span class="p">]))</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">columns</span><span class="p">)]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"{ "</span> <span class="o">+</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"}</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">output_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> One value per line in the form 'column = value' with a blank</span>
<span class="sd"> line between rows.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="mi">5</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="o">></span> <span class="n">w</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">l</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_line_info</span> <span class="o">=</span> <span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="n">w</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="si">%*s</span><span class="s2"> = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_line_info</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="n">i</span><span class="p">],</span> <span class="n">fmt</span><span class="p">(</span><span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">])))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">output_lines</span> <span class="o">=</span> <span class="n">output_line</span>
<span class="k">def</span> <span class="nf">output_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="s2">"All items on one line with separator"</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">header</span> <span class="o">+</span> <span class="n">x</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">header_</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_text_col</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">fmt</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">line</span><span class="p">])</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">output_python</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="s2">"Tuples in Python source form for each row"</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">header</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_python</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">header_</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_python</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s1">'('</span> <span class="o">+</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">fmt</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">])</span> <span class="o">+</span> <span class="s2">"),</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">output_tcl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">line</span><span class="p">):</span>
<span class="s2">"Outputs TCL/C style strings using current separator"</span>
<span class="c1"># In theory you could paste the output into your source ...</span>
<span class="k">if</span> <span class="n">header</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">header</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">header</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_c_string</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">header_</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_c_string</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">fmt</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">line</span><span class="p">])</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">_fqt_kwargs</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">output_box</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">column_names</span><span class="p">,</span> <span class="n">rows</span><span class="p">):</span>
<span class="s2">"Outputs using line drawing and auto sizing columns"</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fqt_kwargs</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># figure out default args</span>
<span class="n">sig</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">format_query_table</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_fqt_kwargs</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">k</span><span class="p">:</span> <span class="n">v</span><span class="o">.</span><span class="n">default</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">default</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">inspect</span><span class="o">.</span><span class="n">Signature</span><span class="o">.</span><span class="n">empty</span> <span class="ow">and</span> <span class="n">k</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"db"</span><span class="p">,</span> <span class="s2">"query"</span><span class="p">,</span> <span class="s2">"bindings"</span><span class="p">}</span>
<span class="p">}</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fqt_kwargs</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">box_options</span><span class="p">)</span>
<span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s2">"text_width"</span><span class="p">]</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"text_width"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_terminal_width</span><span class="p">(</span><span class="mi">32</span><span class="p">)</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s2">"colour"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="p">[</span><span class="s2">"off"</span><span class="p">]})</span>
<span class="n">rows</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">row</span><span class="p">)</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">format_query_table</span><span class="o">.</span><span class="n">_format_table</span><span class="p">(</span><span class="n">column_names</span><span class="p">,</span> <span class="n">rows</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span>
<span class="n">output_box</span><span class="o">.</span><span class="n">all_at_once</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">output_table</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="s2">"Outputs using ascii line drawing and strongly sanitized text"</span>
<span class="c1"># this function isn't actually called - output_box is used</span>
<span class="mi">1</span> <span class="o">/</span> <span class="mi">0</span>
<span class="k">def</span> <span class="nf">output_qbox</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="s2">"Outputs using line drawing and auto sizing columns quoting values"</span>
<span class="c1"># this function isn't actually called - output_box is used</span>
<span class="mi">1</span> <span class="o">/</span> <span class="mi">0</span>
<span class="k">def</span> <span class="nf">_output_summary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">summary</span><span class="p">):</span>
<span class="c1"># internal routine to output a summary line or two</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">summary</span> <span class="o">+</span> <span class="n">summary</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">summary_</span><span class="p">)</span>
<span class="c1">###</span>
<span class="c1">### Various routines</span>
<span class="c1">###</span>
<div class="viewcode-block" id="Shell.cmdloop">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.cmdloop">[docs]</a>
<span class="k">def</span> <span class="nf">cmdloop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">intro</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">transient</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Runs the main interactive command loop.</span>
<span class="sd"> :param intro: Initial text banner to display instead of the</span>
<span class="sd"> default. Make sure you newline terminate it.</span>
<span class="sd"> :param transient: Additional message about being connected to</span>
<span class="sd"> a transient in memory database</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">intro</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">intro</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"""</span>
<span class="s2">SQLite version </span><span class="si">{</span><span class="w"> </span><span class="n">apsw</span><span class="o">.</span><span class="n">sqlite_lib_version</span><span class="p">()</span><span class="w"> </span><span class="si">}</span><span class="s2"> (APSW </span><span class="si">{</span><span class="w"> </span><span class="n">apsw</span><span class="o">.</span><span class="n">apsw_version</span><span class="p">()</span><span class="w"> </span><span class="si">}</span><span class="s2">)</span>
<span class="s2">Enter ".help" for instructions</span>
<span class="s2">"""</span>
<span class="n">intro</span> <span class="o">=</span> <span class="n">intro</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="ow">and</span> <span class="n">intro</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">intro</span> <span class="o">+</span> <span class="n">intro</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">intro_</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span><span class="p">:</span>
<span class="n">transient</span> <span class="o">=</span> <span class="n">transient</span> <span class="ow">or</span> <span class="s2">"Connected to a transient in-memory database.</span><span class="se">\n</span><span class="s2">"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">transient</span> <span class="o">+</span> <span class="n">transient</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">transient_</span><span class="p">)</span>
<span class="n">using_readline</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdin</span> <span class="ow">is</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdin</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">readline</span>
<span class="n">old_completer</span> <span class="o">=</span> <span class="n">readline</span><span class="o">.</span><span class="n">get_completer</span><span class="p">()</span>
<span class="n">readline</span><span class="o">.</span><span class="n">set_completer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">complete</span><span class="p">)</span>
<span class="n">readline</span><span class="o">.</span><span class="n">parse_and_bind</span><span class="p">(</span><span class="s2">"tab: complete"</span><span class="p">)</span>
<span class="n">using_readline</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">readline</span><span class="o">.</span><span class="n">read_history_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">history_file</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">using_readline</span><span class="p">:</span>
<span class="c1"># we drop completion cache because it contains</span>
<span class="c1"># table and column names which could have changed</span>
<span class="c1"># with last executed SQL</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_completion_cache</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_using_readline</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_complete_line</span><span class="p">()</span>
<span class="k">if</span> <span class="n">command</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># EOF</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">return</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_complete_line</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_append_input_description</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">UnicodeDecodeError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">if</span> <span class="n">using_readline</span><span class="p">:</span>
<span class="n">readline</span><span class="o">.</span><span class="n">set_completer</span><span class="p">(</span><span class="n">old_completer</span><span class="p">)</span>
<span class="n">readline</span><span class="o">.</span><span class="n">set_history_length</span><span class="p">(</span><span class="mi">256</span><span class="p">)</span>
<span class="n">readline</span><span class="o">.</span><span class="n">write_history_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">history_file</span><span class="p">))</span></div>
<div class="viewcode-block" id="Shell.handle_exception">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.handle_exception">[docs]</a>
<span class="k">def</span> <span class="nf">handle_exception</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Handles the current exception, printing a message to stderr as appropriate.</span>
<span class="sd"> It will reraise the exception if necessary (eg if bail is true)"""</span>
<span class="n">eclass</span><span class="p">,</span> <span class="nb">eval</span><span class="p">,</span> <span class="n">etb</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">eval</span><span class="p">,</span> <span class="ne">SystemExit</span><span class="p">):</span>
<span class="nb">eval</span><span class="o">.</span><span class="n">_handle_exception_saw_this</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">raise</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="nb">eval</span><span class="p">,</span> <span class="s2">"_handle_exception_saw_this"</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_out_colour</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">error</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">eval</span><span class="p">,</span> <span class="ne">KeyboardInterrupt</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handle_interrupt</span><span class="p">()</span>
<span class="n">text</span> <span class="o">=</span> <span class="s2">"Interrupted"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">eval</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">text</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">):</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">text</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">pref</span> <span class="o">=</span> <span class="s2">"At "</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pref</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="n">i</span> <span class="o">+</span> <span class="s2">"From "</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="n">pref</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">exceptions</span><span class="p">:</span>
<span class="n">stack</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">etb</span><span class="p">:</span>
<span class="n">stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">etb</span><span class="o">.</span><span class="n">tb_frame</span><span class="p">)</span>
<span class="n">etb</span> <span class="o">=</span> <span class="n">etb</span><span class="o">.</span><span class="n">tb_next</span>
<span class="k">for</span> <span class="n">frame</span> <span class="ow">in</span> <span class="n">stack</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">Frame </span><span class="si">%s</span><span class="s2"> in </span><span class="si">%s</span><span class="s2"> at line </span><span class="si">%d</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">frame</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span><span class="p">,</span> <span class="n">frame</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_filename</span><span class="p">,</span> <span class="n">frame</span><span class="o">.</span><span class="n">f_lineno</span><span class="p">))</span>
<span class="nb">vars</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">frame</span><span class="o">.</span><span class="n">f_locals</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
<span class="nb">vars</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">vars</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="nb">repr</span><span class="p">(</span><span class="n">v</span><span class="p">)[:</span><span class="mi">80</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="s2">"<Unable to convert to string>"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="si">%10s</span><span class="s2"> = </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">eclass</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="nb">eval</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">error_</span><span class="p">)</span>
<span class="nb">eval</span><span class="o">.</span><span class="n">_handle_exception_saw_this</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">bail</span><span class="p">:</span>
<span class="k">raise</span></div>
<span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span><span class="p">(</span><span class="o">**</span><span class="p">({</span><span class="s2">"slots"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s2">"frozen"</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span> <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span> <span class="k">else</span> <span class="p">{}))</span>
<span class="k">class</span> <span class="nc">_qd</span><span class="p">:</span>
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
<span class="n">remaining</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
<span class="n">error_text</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
<span class="n">error_offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span>
<span class="n">exception</span><span class="p">:</span> <span class="ne">Exception</span> <span class="o">|</span> <span class="kc">None</span>
<span class="n">explain</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">_query_details</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">,</span> <span class="n">bindings</span><span class="p">)</span> <span class="o">-></span> <span class="n">_qd</span><span class="p">:</span>
<span class="s2">"Internal routine to iterate over statements"</span>
<span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">saved</span> <span class="o">=</span> <span class="n">sql</span>
<span class="n">explain</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">et</span><span class="p">(</span><span class="n">cursor</span><span class="p">,</span> <span class="n">statement</span><span class="p">,</span> <span class="n">bindings</span><span class="p">):</span>
<span class="k">nonlocal</span> <span class="n">saved</span><span class="p">,</span> <span class="n">explain</span>
<span class="n">saved</span> <span class="o">=</span> <span class="n">statement</span>
<span class="n">explain</span> <span class="o">=</span> <span class="n">cursor</span><span class="o">.</span><span class="n">is_explain</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">cur</span><span class="o">.</span><span class="n">exec_trace</span> <span class="o">=</span> <span class="n">et</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">bindings</span><span class="p">)</span>
<span class="k">except</span> <span class="n">apsw</span><span class="o">.</span><span class="n">ExecTraceAbort</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">except</span> <span class="n">apsw</span><span class="o">.</span><span class="n">BindingsError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">_qd</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s2">"You must used named bindings (eg $name) and .parameter set"</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">explain</span><span class="p">)</span>
<span class="k">except</span> <span class="n">apsw</span><span class="o">.</span><span class="n">Error</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">_qd</span><span class="p">(</span><span class="n">sql</span><span class="p">[:</span> <span class="nb">len</span><span class="p">(</span><span class="n">saved</span><span class="p">)],</span> <span class="n">sql</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">saved</span><span class="p">)</span> <span class="p">:],</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="s2">"error_offset"</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">),</span> <span class="n">e</span><span class="p">,</span> <span class="n">explain</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">var</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">_qd</span><span class="p">(</span>
<span class="kc">None</span><span class="p">,</span>
<span class="kc">None</span><span class="p">,</span>
<span class="sa">f</span><span class="s2">"No binding present for '</span><span class="si">{</span><span class="w"> </span><span class="n">var</span><span class="w"> </span><span class="si">}</span><span class="s2">' - use .parameter set </span><span class="si">{</span><span class="w"> </span><span class="n">var</span><span class="w"> </span><span class="si">}</span><span class="s2"> VALUE to provide one"</span><span class="p">,</span>
<span class="o">-</span><span class="mi">1</span><span class="p">,</span>
<span class="n">e</span><span class="p">,</span>
<span class="n">explain</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">_qd</span><span class="p">(</span><span class="n">sql</span><span class="p">[:</span><span class="nb">len</span><span class="p">(</span><span class="n">saved</span><span class="p">)],</span> <span class="n">sql</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">saved</span><span class="p">):],</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="n">explain</span><span class="p">)</span>
<div class="viewcode-block" id="Shell.process_sql">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.process_sql">[docs]</a>
<span class="k">def</span> <span class="nf">process_sql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">bindings</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">internal</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">summary</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Processes SQL text consisting of one or more statements</span>
<span class="sd"> :param sql: SQL to execute</span>
<span class="sd"> :param bindings: bindings for the *sql*</span>
<span class="sd"> :param internal: If True then this is an internal execution</span>
<span class="sd"> (eg the .tables or .database command). When executing</span>
<span class="sd"> internal sql timings are not shown nor is the SQL echoed.</span>
<span class="sd"> :param summary: If not None then should be a tuple of two</span>
<span class="sd"> items. If the ``sql`` returns any data then the first item</span>
<span class="sd"> is printed before the first row, and the second item is</span>
<span class="sd"> printed after the last row. An example usage is the .find</span>
<span class="sd"> command which shows table names.</span>
<span class="sd"> """</span>
<span class="n">changes_start</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">total_changes</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">fixws</span><span class="p">(</span><span class="n">s</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">"\s"</span><span class="p">,</span> <span class="s2">" "</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">UNICODE</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">fmt_sql</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">></span> <span class="mi">4096</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="p">[:</span><span class="mi">4096</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">internal</span> <span class="ow">and</span> <span class="n">bindings</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">bindings</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">bindings</span>
<span class="k">while</span> <span class="n">sql</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
<span class="n">qd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_query_details</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">bindings</span><span class="p">)</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">qd</span><span class="o">.</span><span class="n">remaining</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">internal</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">echo</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_error</span><span class="p">(</span><span class="n">fmt_sql</span><span class="p">(</span><span class="n">qd</span><span class="o">.</span><span class="n">query</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">qd</span><span class="o">.</span><span class="n">error_text</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="w"> </span><span class="n">qd</span><span class="o">.</span><span class="n">error_text</span><span class="w"> </span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">qd</span><span class="o">.</span><span class="n">error_offset</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">offset</span> <span class="o">=</span> <span class="n">qd</span><span class="o">.</span><span class="n">error_offset</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">qd</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">"utf8"</span><span class="p">)</span>
<span class="n">before</span><span class="p">,</span> <span class="n">after</span> <span class="o">=</span> <span class="n">fixws</span><span class="p">(</span><span class="n">query</span><span class="p">[:</span><span class="n">offset</span><span class="p">][</span><span class="o">-</span><span class="mi">35</span><span class="p">:]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">"utf8"</span><span class="p">)),</span> \
<span class="n">fixws</span><span class="p">(</span><span class="n">query</span><span class="p">[</span><span class="n">offset</span><span class="p">:][:</span><span class="mi">35</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">"utf8"</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">" "</span><span class="p">,</span> <span class="n">before</span> <span class="o">+</span> <span class="n">after</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">" "</span> <span class="o">+</span> <span class="p">(</span><span class="s2">" "</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">before</span><span class="p">))</span> <span class="o">+</span> <span class="s2">"^--- error here"</span><span class="p">,</span> <span class="n">file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span>
<span class="n">qd</span><span class="o">.</span><span class="n">exception</span><span class="o">.</span><span class="n">_handle_exception_saw_this</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">raise</span> <span class="n">qd</span><span class="o">.</span><span class="n">exception</span>
<span class="k">if</span> <span class="n">qd</span><span class="o">.</span><span class="n">explain</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> <span class="c1"># explain</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">widths</span> <span class="o">=</span> <span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">13</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">truncate</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_column</span>
<span class="k">elif</span> <span class="n">qd</span><span class="o">.</span><span class="n">explain</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span> <span class="c1"># explain query plan</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">widths</span> <span class="o">=</span> <span class="p">[</span><span class="o">-</span><span class="mi">4</span><span class="p">,</span> <span class="o">-</span><span class="mi">6</span><span class="p">,</span> <span class="mi">22</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">truncate</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_column</span>
<span class="n">use_prow</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">sig</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">)</span>
<span class="n">param_name</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">keys</span><span class="p">())[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">sig</span><span class="o">.</span><span class="n">parameters</span><span class="p">[</span><span class="n">param_name</span><span class="p">]</span>
<span class="n">use_prow</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">annotation</span> <span class="o">==</span> <span class="s2">"Shell.Row"</span>
<span class="n">timing_start</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_resource_usage</span><span class="p">()</span>
<span class="n">column_names</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">rows</span> <span class="o">=</span> <span class="p">[]</span> <span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">,</span> <span class="s2">"all_at_once"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> <span class="k">else</span> <span class="kc">None</span>
<span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">exec_trace</span><span class="p">:</span>
<span class="n">cur</span><span class="o">.</span><span class="n">exec_trace</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="kc">True</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">row_trace</span><span class="p">:</span>
<span class="n">cur</span><span class="o">.</span><span class="n">row_trace</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">:</span> <span class="n">y</span>
<span class="k">for</span> <span class="n">prow</span> <span class="ow">in</span> <span class="n">Shell</span><span class="o">.</span><span class="n">PositionRow</span><span class="p">(</span><span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">qd</span><span class="o">.</span><span class="n">query</span><span class="p">,</span> <span class="n">bindings</span><span class="p">)):</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">prow</span><span class="o">.</span><span class="n">row</span>
<span class="k">if</span> <span class="n">column_names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">column_names</span> <span class="o">=</span> <span class="n">prow</span><span class="o">.</span><span class="n">columns</span>
<span class="k">if</span> <span class="n">qd</span><span class="o">.</span><span class="n">explain</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="c1"># column 2 is "notused"</span>
<span class="n">column_names</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">c</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">column_names</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">)</span>
<span class="k">if</span> <span class="n">summary</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_summary</span><span class="p">(</span><span class="n">summary</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="n">rows</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">column_names</span><span class="p">)</span>
<span class="k">if</span> <span class="n">qd</span><span class="o">.</span><span class="n">explain</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">row</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">c</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">row</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">prow</span> <span class="k">if</span> <span class="n">use_prow</span> <span class="k">else</span> <span class="n">row</span>
<span class="k">if</span> <span class="n">rows</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">(</span><span class="kc">False</span><span class="p">,</span> <span class="n">row</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">rows</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">row</span><span class="p">)</span>
<span class="k">if</span> <span class="n">column_names</span> <span class="ow">and</span> <span class="n">rows</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span><span class="p">(</span><span class="n">column_names</span><span class="p">,</span> <span class="n">rows</span><span class="p">)</span>
<span class="k">if</span> <span class="n">column_names</span> <span class="ow">and</span> <span class="n">summary</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_summary</span><span class="p">(</span><span class="n">summary</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">timer</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">display_timing</span><span class="p">(</span><span class="n">timing_start</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_resource_usage</span><span class="p">())</span>
<span class="k">if</span> <span class="n">qd</span><span class="o">.</span><span class="n">explain</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_output</span><span class="p">()</span>
<span class="n">changes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">total_changes</span><span class="p">()</span> <span class="o">-</span> <span class="n">changes_start</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">internal</span> <span class="ow">and</span> <span class="n">changes</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">changes</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"changes: "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">changes</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">changes</span><span class="p">))</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">"total changes: "</span> <span class="o">+</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">total_changes</span><span class="p">(),</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">total_changes</span><span class="p">()))</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.process_command">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.process_command">[docs]</a>
<span class="k">def</span> <span class="nf">process_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Processes a dot command.</span>
<span class="sd"> It is split into parts using :func:`shlex.split`</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">echo</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"."</span>
<span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">fn</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"command_"</span> <span class="o">+</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">fn</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Unknown command </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2">. Enter </span><span class="se">\"</span><span class="s2">.help</span><span class="se">\"</span><span class="s2"> for help"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">))</span>
<span class="c1"># special handling for .parameter set because we need the value to preserve quoting</span>
<span class="c1"># '33' and 33 are different</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">3</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"parameter"</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"set"</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">command</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">command</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s2">"set"</span><span class="p">)</span> <span class="o">+</span> <span class="mi">4</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span> <span class="o">+</span> <span class="mi">1</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">+</span> <span class="p">[</span><span class="n">command</span><span class="p">[</span><span class="n">pos</span><span class="p">:]]</span>
<span class="c1"># special handling for shell / py because we want to preserve the text exactly</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"shell"</span><span class="p">,</span> <span class="s2">"py"</span><span class="p">}:</span>
<span class="n">rest</span> <span class="o">=</span> <span class="n">command</span><span class="p">[</span><span class="n">command</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]):]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="n">rest</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">rest</span><span class="p">]</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">fn</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span></div>
<span class="c1">###</span>
<span class="c1">### Commands start here</span>
<span class="c1">###</span>
<span class="k">def</span> <span class="nf">_boolean_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="s2">"Parse and verify boolean parameter"</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"on"</span><span class="p">,</span> <span class="s2">"off"</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="n">name</span> <span class="o">+</span> <span class="s2">" expected ON or OFF"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"on"</span>
<span class="c1"># Note that doc text is used for generating help output.</span>
<span class="k">def</span> <span class="nf">command_backup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""backup ?DB? FILE: Backup DB (default "main") to FILE</span>
<span class="sd"> Copies the contents of the current database to FILE</span>
<span class="sd"> overwriting whatever was in FILE. If you have attached databases</span>
<span class="sd"> then you can specify their name instead of the default of "main".</span>
<span class="sd"> The backup is done at the page level - SQLite copies the pages</span>
<span class="sd"> as is. There is no round trip through SQL code.</span>
<span class="sd"> """</span>
<span class="n">dbname</span> <span class="o">=</span> <span class="s2">"main"</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">dbname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Backup takes one or two parameters"</span><span class="p">)</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">backup</span><span class="p">(</span><span class="s2">"main"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">,</span> <span class="n">dbname</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">b</span><span class="o">.</span><span class="n">done</span><span class="p">:</span>
<span class="n">b</span><span class="o">.</span><span class="n">step</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">b</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
<span class="n">out</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_bail</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""bail ON|OFF: Stop after hitting an error (default OFF)</span>
<span class="sd"> If an error is encountered while processing commands or SQL</span>
<span class="sd"> then exit. (Note this is different than SQLite shell which</span>
<span class="sd"> only exits for errors in SQL.)</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bail</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"bail"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_cd</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""cd ?DIR?: Changes current directory</span>
<span class="sd"> If no directory supplied then change to home directory"""</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Too many directories"</span><span class="p">)</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">cmd</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s2">"~"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">d</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"'</span><span class="si">{</span><span class="w"> </span><span class="n">d</span><span class="w"> </span><span class="si">}</span><span class="s2">' is not a directory"</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_changes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""changes ON|OFF: Show changes from last SQL and total changes (default OFF)</span>
<span class="sd"> After executing SQL that makes changes, the number of affected</span>
<span class="sd"> rows is displayed as well as a running count of all changes.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"changes"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_close</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""close: Closes the current database</span>
<span class="sd"> Use .open to open a database, or .connection to switch to another</span>
<span class="sd"> connection</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Unexpected arguments"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""connection ?NUMBER?: List connections, or switch active connection</span>
<span class="sd"> This covers all connections, not just those started in this</span>
<span class="sd"> shell. Closed connections are not shown.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db_references</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">)</span>
<span class="n">dbs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">apsw</span><span class="o">.</span><span class="n">connections</span><span class="p">():</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">filename</span>
<span class="k">except</span> <span class="n">apsw</span><span class="o">.</span><span class="n">ConnectionClosedError</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">dbs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">co</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">dbs</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">co</span><span class="o">.</span><span class="n">bold</span> <span class="o">+</span> <span class="s2">"(Current connection is closed)"</span> <span class="o">+</span> <span class="n">co</span><span class="o">.</span><span class="n">bold_</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">dbs</span><span class="p">):</span>
<span class="n">sel</span> <span class="o">=</span> <span class="s2">"*"</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="ow">is</span> <span class="n">c</span> <span class="k">else</span> <span class="s2">" "</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span>
<span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="w"> </span><span class="n">co</span><span class="o">.</span><span class="n">bold</span><span class="si">}{</span><span class="w"> </span><span class="n">sel</span><span class="w"> </span><span class="si">}{</span><span class="w"> </span><span class="n">co</span><span class="o">.</span><span class="n">bold_</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="w"> </span><span class="n">co</span><span class="o">.</span><span class="n">vnumber</span><span class="w"> </span><span class="si">}{</span><span class="w"> </span><span class="n">i</span><span class="si">:</span><span class="s2"> 2</span><span class="si">}{</span><span class="w"> </span><span class="n">co</span><span class="o">.</span><span class="n">vnumber_</span><span class="w"> </span><span class="si">}</span><span class="s2"> - (</span><span class="si">{</span><span class="w"> </span><span class="n">c</span><span class="o">.</span><span class="n">open_vfs</span><span class="w"> </span><span class="si">}</span><span class="s2">) </span><span class="se">\"</span><span class="si">{</span><span class="w"> </span><span class="n">co</span><span class="o">.</span><span class="n">vstring</span><span class="w"> </span><span class="si">}{</span><span class="w"> </span><span class="n">c</span><span class="o">.</span><span class="n">filename</span><span class="w"> </span><span class="si">}{</span><span class="w"> </span><span class="n">co</span><span class="o">.</span><span class="n">vstring_</span><span class="w"> </span><span class="si">}</span><span class="se">\"\n</span><span class="s2">"</span>
<span class="p">)</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">dbs</span><span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">c</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span> <span class="o">=</span> <span class="n">c</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">filename</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Too many arguments"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_colour</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="o">=</span><span class="p">[]):</span>
<span class="w"> </span><span class="sd">"""colour SCHEME: Selects a colour scheme</span>
<span class="sd"> If using a colour terminal in interactive mode then output is</span>
<span class="sd"> automatically coloured to make it more readable. Use 'off' to</span>
<span class="sd"> turn off colour, and no name or 'default' for the default colour</span>
<span class="sd"> scheme.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Too many colour schemes"</span><span class="p">)</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">cmd</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">or</span> <span class="s2">"default"</span>
<span class="k">if</span> <span class="n">c</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No such colour scheme: "</span> <span class="o">+</span> <span class="n">c</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colour_scheme</span> <span class="o">=</span> <span class="n">c</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_out_colour</span><span class="p">()</span>
<span class="n">command_color</span> <span class="o">=</span> <span class="n">command_colour</span>
<span class="k">def</span> <span class="nf">command_databases</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""databases: Lists names and files of attached databases</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"databases command doesn't take any parameters"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_column</span>
<span class="bp">self</span><span class="o">.</span><span class="n">truncate</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">widths</span> <span class="o">=</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">58</span><span class="p">]</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span><span class="s2">"pragma database_list"</span><span class="p">,</span> <span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_output</span><span class="p">()</span>
<span class="n">_dbconfig_ignore</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"SQLITE_DBCONFIG_MAINDBNAME"</span><span class="p">,</span> <span class="s2">"SQLITE_DBCONFIG_LOOKASIDE"</span><span class="p">,</span> <span class="s2">"SQLITE_DBCONFIG_MAX"</span><span class="p">,</span>
<span class="s2">"SQLITE_DBCONFIG_STMT_SCANSTATUS"</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">command_dbconfig</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""dbconfig ?NAME VALUE?: Show all dbconfig, or set a specific one</span>
<span class="sd"> With no arguments lists all settings. Supply a name and integer value</span>
<span class="sd"> to change. For example:</span>
<span class="sd"> .dbconfig enable_fkey 1</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">outputs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">apsw</span><span class="o">.</span><span class="n">mapping_db_config</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="nb">str</span> <span class="ow">or</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dbconfig_ignore</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">pretty</span> <span class="o">=</span> <span class="n">k</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"SQLITE_DBCONFIG_"</span><span class="p">):]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">outputs</span><span class="p">[</span><span class="n">pretty</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">apsw</span><span class="p">,</span> <span class="n">k</span><span class="p">),</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">outputs</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">outputs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">w</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">k</span> <span class="o">+</span> <span class="s2">": "</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_value</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Expected zero or two parameters"</span><span class="p">)</span>
<span class="n">key</span> <span class="o">=</span> <span class="s2">"SQLITE_DBCONFIG_"</span> <span class="o">+</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">apsw</span><span class="o">.</span><span class="n">mapping_db_config</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Unknown config option </span><span class="si">{</span><span class="w"> </span><span class="n">key</span><span class="w"> </span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
<span class="n">v</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">apsw</span><span class="p">,</span> <span class="n">key</span><span class="p">),</span> <span class="nb">int</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">+</span> <span class="s2">": "</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_value</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_dbinfo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""dbinfo ?NAME?: Shows summary and file information about the database</span>
<span class="sd"> This includes the numbers of tables, indices etc, as well as fields from</span>
<span class="sd"> the files as returned by :func:`apsw.ext.dbinfo`.</span>
<span class="sd"> NAME defaults to 'main', and can be the attached name of a database.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"too many parameters"</span><span class="p">)</span>
<span class="n">schema</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="n">cmd</span> <span class="k">else</span> <span class="s2">"main"</span>
<span class="k">def</span> <span class="nf">total</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="sa">f</span><span class="s2">"select count(*) from [</span><span class="si">{</span><span class="w"> </span><span class="n">schema</span><span class="w"> </span><span class="si">}</span><span class="s2">].sqlite_schema where type='</span><span class="si">{</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="si">}</span><span class="s2">'"</span><span class="p">)</span><span class="o">.</span><span class="n">get</span>
<span class="n">outputs</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="s2">"number of tables"</span><span class="p">,</span> <span class="n">total</span><span class="p">(</span><span class="s2">"table"</span><span class="p">)),</span>
<span class="p">(</span><span class="s2">"number of indexes"</span><span class="p">,</span> <span class="n">total</span><span class="p">(</span><span class="s2">"index"</span><span class="p">)),</span>
<span class="p">(</span><span class="s2">"number of triggers"</span><span class="p">,</span> <span class="n">total</span><span class="p">(</span><span class="s2">"trigger"</span><span class="p">)),</span>
<span class="p">(</span><span class="s2">"number of views"</span><span class="p">,</span> <span class="n">total</span><span class="p">(</span><span class="s2">"view"</span><span class="p">)),</span>
<span class="p">(</span><span class="s2">"schema size"</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="sa">f</span><span class="s2">"select total(length(sql)) from [</span><span class="si">{</span><span class="w"> </span><span class="n">schema</span><span class="w"> </span><span class="si">}</span><span class="s2">].sqlite_schema"</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">)),</span>
<span class="p">]</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">info</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">dbinfo</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">,</span> <span class="n">schema</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">outputs</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"journal mode"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"journal_mode"</span><span class="p">)))</span>
<span class="k">if</span> <span class="n">info</span><span class="p">:</span>
<span class="n">outputs</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">v</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">dataclasses</span><span class="o">.</span><span class="n">asdict</span><span class="p">(</span><span class="n">info</span><span class="p">)</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">outputs</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"filename"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">filename</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">outputs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="p">(</span><span class="s2">"filename"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">filename_wal</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"journal_mode"</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"wal"</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">filename_journal</span><span class="p">))</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">outputs</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">outputs</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">w</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">k</span> <span class="o">+</span> <span class="s2">": "</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_value</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""dump ?TABLE? [TABLE...]: Dumps all or specified tables in SQL text format</span>
<span class="sd"> The table name is treated as like pattern so you can use % as</span>
<span class="sd"> a wildcard. You can use dump to make a text based backup of</span>
<span class="sd"> the database. It is also useful for comparing differences or</span>
<span class="sd"> making the data available to other databases. Indices and</span>
<span class="sd"> triggers for the table(s) are also dumped. Finally views</span>
<span class="sd"> matching the table pattern name are dumped.</span>
<span class="sd"> Note that if you are dumping virtual tables such as used by</span>
<span class="sd"> the FTS5 module then they may use other tables to store</span>
<span class="sd"> information. For example if you create a FTS5 table named</span>
<span class="sd"> *recipes* then it also creates *recipes_content*,</span>
<span class="sd"> *recipes_segdir* etc. Consequently to dump this example</span>
<span class="sd"> correctly use:</span>
<span class="sd"> .dump recipes recipes_%</span>
<span class="sd"> If the database is empty or no tables/views match then there</span>
<span class="sd"> is no output.</span>
<span class="sd"> """</span>
<span class="c1"># Simple tables are easy to dump. More complicated is dealing</span>
<span class="c1"># with virtual tables, foreign keys etc.</span>
<span class="c1"># Lock the database while doing the dump so nothing changes</span>
<span class="c1"># under our feet</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span><span class="s2">"BEGIN IMMEDIATE"</span><span class="p">,</span> <span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># Used in comment() - see issue 142</span>
<span class="n">outputstrtype</span> <span class="o">=</span> <span class="nb">str</span>
<span class="c1"># Python 2.3 can end up with nonsense like "en_us" so we fall</span>
<span class="c1"># back to ascii in that case</span>
<span class="n">outputstrencoding</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"encoding"</span><span class="p">,</span> <span class="s2">"ascii"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">codecs</span><span class="o">.</span><span class="n">lookup</span><span class="p">(</span><span class="n">outputstrencoding</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="n">outputstrencoding</span> <span class="o">=</span> <span class="s2">"ascii"</span>
<span class="k">def</span> <span class="nf">unicodify</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">outputstrtype</span><span class="p">):</span>
<span class="c1"># See issue 142 - it may not be in an expected encoding</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">outputstrencoding</span><span class="p">,</span> <span class="s2">"replace"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">s</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># first pass -see if virtual tables or foreign keys are in</span>
<span class="c1"># use. If they are we emit pragmas to deal with them, but</span>
<span class="c1"># prefer not to emit them</span>
<span class="n">v</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"virtuals"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">"foreigns"</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span>
<span class="k">def</span> <span class="nf">check</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">sql</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"sqlite_"</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">sql</span> <span class="o">=</span> <span class="n">sql</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">"^\s*create\s+virtual\s+.*"</span><span class="p">,</span> <span class="n">sql</span><span class="p">):</span>
<span class="n">v</span><span class="p">[</span><span class="s2">"virtuals"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># pragma table_info doesn't tell us if foreign keys</span>
<span class="c1"># are involved so we guess if any the various strings are</span>
<span class="c1"># in the sql somewhere</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">".*\b(foreign\s*key|references)\b.*"</span><span class="p">,</span> <span class="n">sql</span><span class="p">):</span>
<span class="n">v</span><span class="p">[</span><span class="s2">"foreigns"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"%"</span><span class="p">]</span>
<span class="n">tables</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">sql</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
<span class="s2">"SELECT name,sql FROM sqlite_schema "</span>
<span class="s2">"WHERE sql NOT NULL AND type IN ('table','view') "</span>
<span class="s2">"AND tbl_name LIKE ?1"</span><span class="p">,</span> <span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="p">)):</span>
<span class="k">if</span> <span class="n">check</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">sql</span><span class="p">)</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">:</span>
<span class="n">tables</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">tables</span><span class="p">:</span>
<span class="k">return</span>
<span class="c1"># will we need to analyze anything later?</span>
<span class="n">analyze_needed</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">stat</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
<span class="s2">"select name from sqlite_schema where sql not null and type='table' and tbl_name like 'sqlite_stat%'"</span>
<span class="p">):</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"select * from "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">stat</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="s2">" WHERE tbl=?"</span><span class="p">,</span>
<span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="p">))</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">analyze_needed</span><span class="p">:</span>
<span class="n">analyze_needed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="n">analyze_needed</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">blank</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">comment</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">unicodify</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">textwrap</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="mi">78</span><span class="p">,</span> <span class="n">initial_indent</span><span class="o">=</span><span class="s2">"-- "</span><span class="p">,</span> <span class="n">subsequent_indent</span><span class="o">=</span><span class="s2">"-- "</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">pats</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">([(</span><span class="n">x</span><span class="p">,</span> <span class="s2">"(All)"</span><span class="p">)[</span><span class="n">x</span> <span class="o">==</span> <span class="s2">"%"</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">])</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"SQLite dump (by APSW </span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">apsw_version</span><span class="p">(),</span> <span class="p">))</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"SQLite version "</span> <span class="o">+</span> <span class="n">apsw</span><span class="o">.</span><span class="n">sqlite_lib_version</span><span class="p">())</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Date: "</span> <span class="o">+</span> <span class="n">unicodify</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">"</span><span class="si">%c</span><span class="s2">"</span><span class="p">)))</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Tables like: "</span> <span class="o">+</span> <span class="n">pats</span><span class="p">)</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Database: "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">filename</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">getpass</span>
<span class="kn">import</span> <span class="nn">socket</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"User: </span><span class="si">%s</span><span class="s2"> @ </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">unicodify</span><span class="p">(</span><span class="n">getpass</span><span class="o">.</span><span class="n">getuser</span><span class="p">()),</span> <span class="n">unicodify</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">gethostname</span><span class="p">())))</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="n">blank</span><span class="p">()</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"The values of various per-database settings"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"PRAGMA page_size="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"page_size"</span><span class="p">))</span> <span class="o">+</span> <span class="s2">";</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"PRAGMA encoding='"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"encoding"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"';</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">vac</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s2">"NONE"</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s2">"FULL"</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s2">"INCREMENTAL"</span><span class="p">}</span>
<span class="n">vacvalue</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"auto_vacuum"</span><span class="p">)</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"PRAGMA auto_vacuum="</span> <span class="o">+</span> <span class="n">vac</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">vacvalue</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">vacvalue</span><span class="p">))</span> <span class="o">+</span> <span class="s2">";</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"PRAGMA max_page_count="</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"max_page_count"</span><span class="p">))</span> <span class="o">+</span> <span class="s2">";</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">blank</span><span class="p">()</span>
<span class="c1"># different python versions have different requirements</span>
<span class="c1"># about specifying cmp to sort routine so we use this</span>
<span class="c1"># portable workaround with a decorated list instead</span>
<span class="n">dectables</span> <span class="o">=</span> <span class="p">[(</span><span class="n">x</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">]</span>
<span class="n">dectables</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="n">tables</span> <span class="o">=</span> <span class="p">[</span><span class="n">y</span> <span class="k">for</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="ow">in</span> <span class="n">dectables</span><span class="p">]</span>
<span class="n">virtuals</span> <span class="o">=</span> <span class="n">v</span><span class="p">[</span><span class="s2">"virtuals"</span><span class="p">]</span>
<span class="n">foreigns</span> <span class="o">=</span> <span class="n">v</span><span class="p">[</span><span class="s2">"foreigns"</span><span class="p">]</span>
<span class="k">if</span> <span class="n">virtuals</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"This pragma is needed to restore virtual tables"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"PRAGMA writable_schema=ON;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">foreigns</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"This pragma turns off checking of foreign keys "</span>
<span class="s2">"as tables would be inconsistent while restoring. It was introduced "</span>
<span class="s2">"in SQLite 3.6.19."</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"PRAGMA foreign_keys=OFF;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">virtuals</span> <span class="ow">or</span> <span class="n">foreigns</span><span class="p">:</span>
<span class="n">blank</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"BEGIN TRANSACTION;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">blank</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">sqldef</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="c1"># return formatted sql watching out for embedded</span>
<span class="c1"># comments at the end forcing trailing ; onto next</span>
<span class="c1"># line https://sqlite.org/src/info/c04a8b8a4f</span>
<span class="k">if</span> <span class="s2">"--"</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">nl</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">nl</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">return</span> <span class="n">s</span> <span class="o">+</span> <span class="n">nl</span> <span class="o">+</span> <span class="s2">";</span><span class="se">\n</span><span class="s2">"</span>
<span class="c1"># do the table dumping loops</span>
<span class="n">oldtable</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_table</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_insert</span>
<span class="c1"># Dump the table</span>
<span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">:</span>
<span class="k">for</span> <span class="n">sql</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT sql FROM sqlite_schema WHERE name=?1 AND type='table'"</span><span class="p">,</span>
<span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="p">)):</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Table "</span> <span class="o">+</span> <span class="n">table</span><span class="p">)</span>
<span class="c1"># Special treatment for virtual tables - they</span>
<span class="c1"># get called back on drops and creates and</span>
<span class="c1"># could thwart us so we have to manipulate</span>
<span class="c1"># sqlite_schema directly</span>
<span class="k">if</span> <span class="n">sql</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()[:</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="p">[</span><span class="s2">"create"</span><span class="p">,</span> <span class="s2">"virtual"</span><span class="p">,</span> <span class="s2">"table"</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"DELETE FROM sqlite_schema WHERE name="</span> <span class="o">+</span> <span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">table</span><span class="p">)</span> <span class="o">+</span>
<span class="s2">" AND type='table';</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span>
<span class="s2">"INSERT INTO sqlite_schema(type,name,tbl_name,rootpage,sql) VALUES('table',</span><span class="si">%s</span><span class="s2">,</span><span class="si">%s</span><span class="s2">,0,</span><span class="si">%s</span><span class="s2">);</span><span class="se">\n</span><span class="s2">"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">table</span><span class="p">),</span> <span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">table</span><span class="p">),</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">sql</span><span class="p">[</span><span class="mi">0</span><span class="p">])))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"DROP TABLE IF EXISTS "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">table</span><span class="p">)</span> <span class="o">+</span> <span class="s2">";</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">sqldef</span><span class="p">(</span><span class="n">sql</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_table</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span><span class="s2">"select * from "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">table</span><span class="p">),</span> <span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># Now any indices or triggers</span>
<span class="n">first</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">sql</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
<span class="s2">"SELECT name,sql FROM sqlite_schema "</span>
<span class="s2">"WHERE sql NOT NULL AND type IN ('index', 'trigger') "</span>
<span class="s2">"AND tbl_name=?1 AND name NOT LIKE 'sqlite_%' "</span>
<span class="s2">"ORDER BY lower(name)"</span><span class="p">,</span> <span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="p">)):</span>
<span class="k">if</span> <span class="n">first</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Triggers and indices on "</span> <span class="o">+</span> <span class="n">table</span><span class="p">)</span>
<span class="n">first</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">sqldef</span><span class="p">(</span><span class="n">sql</span><span class="p">))</span>
<span class="n">blank</span><span class="p">()</span>
<span class="c1"># Views done last. They have to be done in the same order as they are in sqlite_schema</span>
<span class="c1"># as they could refer to each other</span>
<span class="n">first</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">sql</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT name,sql FROM sqlite_schema "</span>
<span class="s2">"WHERE sql NOT NULL AND type='view' "</span>
<span class="s2">"AND name IN ( "</span> <span class="o">+</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">])</span> <span class="o">+</span> <span class="s2">") ORDER BY _ROWID_"</span><span class="p">):</span>
<span class="k">if</span> <span class="n">first</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Views"</span><span class="p">)</span>
<span class="n">first</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"DROP VIEW IF EXISTS </span><span class="si">%s</span><span class="s2">;</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">name</span><span class="p">),</span> <span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">sqldef</span><span class="p">(</span><span class="n">sql</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">first</span><span class="p">:</span>
<span class="n">blank</span><span class="p">()</span>
<span class="c1"># sqlite sequence</span>
<span class="c1"># does it exist</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"select * from sqlite_schema where name='sqlite_sequence'"</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()):</span>
<span class="n">first</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">tables</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"select seq from main.sqlite_sequence where name=?1"</span><span class="p">,</span> <span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="p">))</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">v</span><span class="p">):</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">first</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"For primary key autoincrements the next id "</span>
<span class="s2">"to use is stored in sqlite_sequence"</span><span class="p">)</span>
<span class="n">first</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span>
<span class="s1">'DELETE FROM main.sqlite_sequence WHERE name=</span><span class="si">%s</span><span class="s1">;</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">t</span><span class="p">),</span> <span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s1">'INSERT INTO main.sqlite_sequence VALUES (</span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">);</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">(</span><span class="n">t</span><span class="p">),</span> <span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">0</span><span class="p">]))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">first</span><span class="p">:</span>
<span class="n">blank</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_table</span> <span class="o">=</span> <span class="n">oldtable</span>
<span class="c1"># analyze</span>
<span class="k">if</span> <span class="n">analyze_needed</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"You had used the analyze command on these tables before. Rerun for this new data."</span><span class="p">)</span>
<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">analyze_needed</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"ANALYZE "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s2">";</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">blank</span><span class="p">()</span>
<span class="c1"># user version pragma</span>
<span class="n">uv</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">pragma</span><span class="p">(</span><span class="s2">"user_version"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">uv</span><span class="p">:</span>
<span class="n">comment</span><span class="p">(</span>
<span class="s2">"Your database may need this. It is sometimes used to keep track of the schema version."</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"pragma user_version=</span><span class="si">%d</span><span class="s2">;"</span> <span class="o">%</span> <span class="p">(</span><span class="n">uv</span><span class="p">,</span> <span class="p">))</span>
<span class="n">blank</span><span class="p">()</span>
<span class="c1"># Save it all</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"COMMIT TRANSACTION;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># cleanup pragmas</span>
<span class="k">if</span> <span class="n">foreigns</span><span class="p">:</span>
<span class="n">blank</span><span class="p">()</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Restoring foreign key checking back on. Note that SQLite 3.6.19 is off by default"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"PRAGMA foreign_keys=ON;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">virtuals</span><span class="p">:</span>
<span class="n">blank</span><span class="p">()</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"Restoring writable schema back to default"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"PRAGMA writable_schema=OFF;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># schema reread</span>
<span class="n">blank</span><span class="p">()</span>
<span class="n">comment</span><span class="p">(</span><span class="s2">"We need to force SQLite to reread the schema because otherwise it doesn't know that "</span>
<span class="s2">"the virtual tables we inserted directly into sqlite_schema exist."</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"BEGIN;</span><span class="se">\n</span><span class="s2">CREATE TABLE no_such_table(x,y,z);</span><span class="se">\n</span><span class="s2">ROLLBACK;</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span><span class="s2">"END"</span><span class="p">,</span> <span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_echo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""echo ON|OFF: If ON then each SQL statement or command is printed before execution (default OFF)</span>
<span class="sd"> The SQL statement or command is sent to error output so that</span>
<span class="sd"> it is not intermingled with regular output.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">echo</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"echo"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<div class="viewcode-block" id="Shell.set_encoding">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.set_encoding">[docs]</a>
<span class="k">def</span> <span class="nf">set_encoding</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enc</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Saves *enc* as the default encoding, after verifying that</span>
<span class="sd"> it is valid. You can also include :error to specify error</span>
<span class="sd"> handling - eg 'cp437:replace'</span>
<span class="sd"> """</span>
<span class="n">enc</span> <span class="o">=</span> <span class="n">enc</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">enc</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="n">enc</span><span class="p">,</span> <span class="n">errors</span> <span class="o">=</span> <span class="n">enc</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">enc</span> <span class="o">=</span> <span class="n">enc</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">errors</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">codecs</span><span class="o">.</span><span class="n">lookup</span><span class="p">(</span><span class="n">enc</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">LookupError</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No known encoding '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">enc</span><span class="p">,</span> <span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">errors</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">codecs</span><span class="o">.</span><span class="n">lookup_error</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">LookupError</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No known codec error handler '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">errors</span><span class="p">,</span> <span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="n">enc</span><span class="p">,</span> <span class="n">errors</span></div>
<span class="k">def</span> <span class="nf">command_encoding</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""encoding ENCODING: Set the encoding used for new files opened via .output and imports</span>
<span class="sd"> SQLite and APSW/Python work internally using Unicode and characters.</span>
<span class="sd"> Files however are a sequence of bytes. An encoding describes</span>
<span class="sd"> how to convert between bytes and characters. The default</span>
<span class="sd"> encoding is utf8 and that is generally the best value to use</span>
<span class="sd"> when other programs give you a choice.</span>
<span class="sd"> You can also specify an error handler. For example</span>
<span class="sd"> `cp437:replace` will use code page 437 and any Unicode</span>
<span class="sd"> codepoints not present in cp437 will be replaced (typically</span>
<span class="sd"> with something like a question mark). Other error handlers</span>
<span class="sd"> include `ignore`, `strict` (default) and `xmlcharrefreplace`.</span>
<span class="sd"> This command affects files opened after setting the encoding</span>
<span class="sd"> as well as imports.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Encoding takes one argument"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_encoding</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">command_exceptions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""exceptions ON|OFF: If ON then detailed tracebacks are shown on exceptions (default OFF)</span>
<span class="sd"> Normally when an exception occurs the error string only is</span>
<span class="sd"> displayed. However it is sometimes useful to get a full</span>
<span class="sd"> traceback. An example would be when you are developing</span>
<span class="sd"> virtual tables and using the shell to exercise them. In</span>
<span class="sd"> addition to displaying each stack frame, the local variables</span>
<span class="sd"> within each frame are also displayed.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exceptions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"exceptions"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_exit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""exit ?CODE?: Exit this program with optional exit code"""</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Too many parameters for exit"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">cmd</span> <span class="k">else</span> <span class="nb">int</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="w"> </span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="w"> </span><span class="si">}</span><span class="s2"> isn't an exit code"</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""find value ?TABLE?: Searches all columns of all tables for a value</span>
<span class="sd"> The find command helps you locate data across your database</span>
<span class="sd"> for example to find a string or any references to an id.</span>
<span class="sd"> You can specify a like pattern to limit the search to a subset</span>
<span class="sd"> of tables (eg specifying CUSTOMER% for all tables beginning</span>
<span class="sd"> with CUSTOMER).</span>
<span class="sd"> The value will be treated as a string and/or integer if</span>
<span class="sd"> possible. If value contains '%' or '_' then it is also treated as</span>
<span class="sd"> a like pattern.</span>
<span class="sd"> This command can take a long time to execute needing to scan</span>
<span class="sd"> all of the relevant tables, rows, and columns.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"At least one argument required and at most two accepted"</span><span class="p">)</span>
<span class="n">tablefilter</span> <span class="o">=</span> <span class="s2">"%"</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">tablefilter</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">querytemplate</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">queryparams</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">qp</span><span class="p">():</span> <span class="c1"># binding for current queryparams</span>
<span class="k">return</span> <span class="s2">"?"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">queryparams</span><span class="p">))</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="s1">'%'</span> <span class="ow">in</span> <span class="n">s</span> <span class="ow">or</span> <span class="s1">'_'</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="n">queryparams</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="n">querytemplate</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> LIKE "</span> <span class="o">+</span> <span class="n">qp</span><span class="p">())</span>
<span class="n">queryparams</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="n">querytemplate</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> = "</span> <span class="o">+</span> <span class="n">qp</span><span class="p">())</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">i</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="n">queryparams</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="n">querytemplate</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> = "</span> <span class="o">+</span> <span class="n">qp</span><span class="p">())</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="n">querytemplate</span> <span class="o">=</span> <span class="s2">" OR "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">querytemplate</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT name FROM sqlite_schema WHERE type='table' AND name LIKE ?1"</span><span class="p">,</span>
<span class="p">(</span><span class="n">tablefilter</span><span class="p">,</span> <span class="p">)):</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
<span class="n">query</span> <span class="o">=</span> <span class="s2">"SELECT * from </span><span class="si">%s</span><span class="s2"> WHERE "</span> <span class="o">%</span> <span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="p">)</span>
<span class="n">colq</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">column</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma table_info(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="n">t</span><span class="p">,</span> <span class="p">)):</span>
<span class="n">colq</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">querytemplate</span> <span class="o">%</span> <span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">column</span><span class="p">),</span> <span class="p">)</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">queryparams</span><span class="p">)))</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">query</span> <span class="o">+</span> <span class="s2">" OR "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">colq</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queryparams</span><span class="p">,</span> <span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">summary</span><span class="o">=</span><span class="p">(</span><span class="s2">"Table "</span> <span class="o">+</span> <span class="n">table</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">command_header</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""header(s) ON|OFF: Display the column names in output (default OFF)</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"header"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="n">command_headers</span> <span class="o">=</span> <span class="n">command_header</span>
<span class="n">_help_info</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">command_help</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""help ?COMMAND?: Shows list of commands and their usage</span>
<span class="sd"> If COMMAND is specified then shows detail about that COMMAND.</span>
<span class="sd"> ``.help all`` will show detailed help about all commands.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">:</span>
<span class="c1"># buildup help database</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"command_"</span><span class="p">):</span>
<span class="k">continue</span>
<span class="c1"># help is 3 parts</span>
<span class="c1"># - the syntax string (eg backup ?dbname? filename)</span>
<span class="c1"># - the one liner description (eg saves database to filename)</span>
<span class="c1"># - the multi-liner detailed description</span>
<span class="c1"># We grab this from the doc string for the function in the form</span>
<span class="c1"># syntax: one liner\nmulti\nliner</span>
<span class="n">d</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span><span class="o">.</span><span class="vm">__doc__</span>
<span class="k">assert</span> <span class="n">d</span><span class="p">,</span> <span class="n">c</span> <span class="o">+</span> <span class="s2">" command must have documentation"</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">c</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"command_"</span><span class="p">):]</span>
<span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"headers"</span><span class="p">,</span> <span class="s2">"color"</span><span class="p">):</span> <span class="k">continue</span>
<span class="k">while</span> <span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">:</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">d</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">firstline</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">firstline</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">,</span> <span class="n">c</span> <span class="o">+</span> <span class="s2">" command must have usage: description doc"</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># work around textwrap bug</span>
<span class="n">multi</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">multi</span> <span class="o">=</span> <span class="n">textwrap</span><span class="o">.</span><span class="n">dedent</span><span class="p">(</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s2">"mode"</span><span class="p">:</span>
<span class="n">firstline</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">firstline</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">+</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_output_modes</span><span class="p">)</span>
<span class="n">multi</span> <span class="o">=</span> <span class="n">multi</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_output_modes_detail</span><span class="p">)</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s2">"colour"</span><span class="p">:</span>
<span class="n">colours</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="n">colours</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="n">firstline</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">firstline</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="s2">" from "</span> <span class="o">+</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">colours</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">multi</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># All whitespace</span>
<span class="n">multi</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># break into paragraphs</span>
<span class="n">lines</span> <span class="o">=</span> <span class="n">multi</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># make whitespace only lines be empty</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">lines</span><span class="p">)):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">lines</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
<span class="n">lines</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="s2">""</span>
<span class="n">multi</span> <span class="o">=</span> <span class="p">[</span><span class="n">lines</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
<span class="k">if</span> <span class="n">multi</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">and</span> <span class="n">l</span> <span class="ow">and</span> <span class="n">l</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span> <span class="o">==</span> <span class="n">l</span><span class="p">:</span>
<span class="n">multi</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+=</span> <span class="s2">" "</span> <span class="o">+</span> <span class="n">l</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">multi</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">l</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">c</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.'</span> <span class="o">+</span> <span class="n">firstline</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="n">firstline</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="n">multi</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">tw</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_terminal_width</span><span class="p">(</span><span class="mi">32</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">commands</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="n">commands</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="n">w</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">command</span> <span class="ow">in</span> <span class="n">commands</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">command</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span> <span class="o">></span> <span class="n">w</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">command</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span>
<span class="n">out</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">command</span> <span class="ow">in</span> <span class="n">commands</span><span class="p">:</span>
<span class="n">hi</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">command</span><span class="p">]</span>
<span class="c1"># usage string</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="c1"># space padding (including 2 for between columns)</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="n">w</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">0</span><span class="p">])))</span>
<span class="c1"># usage message wrapped if need be</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="n">w</span><span class="p">))</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">textwrap</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">tw</span> <span class="o">-</span> <span class="n">w</span> <span class="o">-</span> <span class="mi">2</span><span class="p">)))</span>
<span class="c1"># newline</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"all"</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="n">cmd</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="n">w</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">command</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">command</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span> <span class="o">></span> <span class="n">w</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">command</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span>
<span class="k">for</span> <span class="n">command</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">if</span> <span class="n">command</span> <span class="o">==</span> <span class="s2">"headers"</span><span class="p">:</span> <span class="n">command</span> <span class="o">=</span> <span class="s2">"header"</span>
<span class="k">if</span> <span class="n">command</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No such command </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="p">))</span>
<span class="n">out</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">hi</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help_info</span><span class="p">[</span><span class="n">command</span><span class="p">]</span>
<span class="c1"># usage string</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="c1"># space padding (2)</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="n">w</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">0</span><span class="p">])))</span>
<span class="c1"># usage message wrapped if need be</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="mi">2</span> <span class="o">+</span> <span class="n">w</span><span class="p">))</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">textwrap</span><span class="o">.</span><span class="n">wrap</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">tw</span> <span class="o">-</span> <span class="n">w</span> <span class="o">-</span> <span class="mi">2</span><span class="p">))</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">hi</span><span class="p">[</span><span class="mi">2</span><span class="p">]:</span>
<span class="c1"># newlines</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># detailed message</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">para</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">hi</span><span class="p">[</span><span class="mi">2</span><span class="p">]):</span>
<span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">textwrap</span><span class="o">.</span><span class="n">fill</span><span class="p">(</span><span class="n">para</span><span class="p">,</span> <span class="n">tw</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="c1"># if not first one then print separator header</span>
<span class="k">if</span> <span class="n">command</span> <span class="o">!=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">"="</span> <span class="o">*</span> <span class="n">tw</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_import</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""import FILE TABLE: Imports separated data from FILE into TABLE</span>
<span class="sd"> Reads data from the file into the named table using the</span>
<span class="sd"> current separator and encoding. For example if the separator</span>
<span class="sd"> is currently a comma then the file should be CSV (comma</span>
<span class="sd"> separated values).</span>
<span class="sd"> All values read in are supplied to SQLite as strings. If you</span>
<span class="sd"> want SQLite to treat them as other types then declare your</span>
<span class="sd"> columns appropriately. For example declaring a column 'REAL'</span>
<span class="sd"> will result in the values being stored as floating point if</span>
<span class="sd"> they can be safely converted.</span>
<span class="sd"> Another alternative is to create a temporary table, insert the</span>
<span class="sd"> values into that and then use casting.:</span>
<span class="sd"> CREATE TEMPORARY TABLE import(a,b,c);</span>
<span class="sd"> .import filename import</span>
<span class="sd"> CREATE TABLE final AS SELECT cast(a as BLOB), cast(b as INTEGER),</span>
<span class="sd"> cast(c as CHAR) from import;</span>
<span class="sd"> DROP TABLE import;</span>
<span class="sd"> You can also get more sophisticated using the SQL CASE</span>
<span class="sd"> operator. For example this will turn zero length strings into</span>
<span class="sd"> null:</span>
<span class="sd"> SELECT CASE col WHEN '' THEN null ELSE col END FROM ...</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"import takes two parameters"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">final</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># start transaction so database can't be changed</span>
<span class="c1"># underneath us</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"BEGIN IMMEDIATE"</span><span class="p">)</span>
<span class="n">final</span> <span class="o">=</span> <span class="s2">"ROLLBACK"</span>
<span class="c1"># how many columns?</span>
<span class="n">ncols</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma table_info("</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">+</span> <span class="s2">")"</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">())</span>
<span class="k">if</span> <span class="n">ncols</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No such table '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="p">))</span>
<span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">sql</span> <span class="o">=</span> <span class="s2">"insert into </span><span class="si">%s</span><span class="s2"> values(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">"?"</span> <span class="o">*</span> <span class="n">ncols</span><span class="p">))</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">==</span> <span class="s2">","</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"dialect"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"excel"</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"dialect"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"excel-tab"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"quoting"</span><span class="p">]</span> <span class="o">=</span> <span class="n">csv</span><span class="o">.</span><span class="n">QUOTE_NONE</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"delimiter"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"doublequote"</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">kwargs</span><span class="p">[</span><span class="s2">"quotechar"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\x00</span><span class="s2">"</span>
<span class="n">row</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_csvin_wrapper</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="o">!=</span> <span class="n">ncols</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"row </span><span class="si">%d</span><span class="s2"> has </span><span class="si">%d</span><span class="s2"> columns but should have </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">row</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">),</span> <span class="n">ncols</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error inserting row </span><span class="si">{</span><span class="w"> </span><span class="n">row</span><span class="w"> </span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
<span class="k">raise</span>
<span class="n">row</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"COMMIT"</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">if</span> <span class="n">final</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">final</span><span class="p">)</span>
<span class="k">raise</span>
<span class="k">def</span> <span class="nf">_csvin_wrapper</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">dialect</span><span class="p">):</span>
<span class="c1"># Returns a csv reader that works around python bugs and uses</span>
<span class="c1"># dialect dict to configure reader</span>
<span class="n">thefile</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">csv</span><span class="o">.</span><span class="n">reader</span><span class="p">(</span><span class="n">thefile</span><span class="p">,</span> <span class="o">**</span><span class="n">dialect</span><span class="o">.</span><span class="n">copy</span><span class="p">()):</span>
<span class="k">yield</span> <span class="n">line</span>
<span class="n">thefile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">command_autoimport</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""autoimport FILENAME ?TABLE?: Imports filename creating a table and automatically working out separators and data types (alternative to .import command)</span>
<span class="sd"> The import command requires that you precisely pre-setup the</span>
<span class="sd"> table and schema, and set the data separators (eg commas or</span>
<span class="sd"> tabs). This command figures out the separator and csv dialect</span>
<span class="sd"> automatically. There must be at least two columns and two rows.</span>
<span class="sd"> If the table is not specified then the basename of the file</span>
<span class="sd"> will be used.</span>
<span class="sd"> Additionally the type of the contents of each column is also</span>
<span class="sd"> deduced - for example if it is a number or date. Empty values</span>
<span class="sd"> are turned into nulls. Dates are normalized into YYYY-MM-DD</span>
<span class="sd"> format and DateTime are normalized into ISO8601 format to</span>
<span class="sd"> allow easy sorting and searching. 4 digit years must be used</span>
<span class="sd"> to detect dates. US (swapped day and month) versus rest of</span>
<span class="sd"> the world is also detected providing there is at least one</span>
<span class="sd"> value that resolves the ambiguity.</span>
<span class="sd"> Care is taken to ensure that columns looking like numbers are</span>
<span class="sd"> only treated as numbers if they do not have unnecessary</span>
<span class="sd"> leading zeroes or plus signs. This is to avoid treating phone</span>
<span class="sd"> numbers and similar number like strings as integers.</span>
<span class="sd"> This command can take quite some time on large files as they</span>
<span class="sd"> are effectively imported twice. The first time is to</span>
<span class="sd"> determine the format and the types for each column while the</span>
<span class="sd"> second pass actually imports the data.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Expected one or two parameters"</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"File </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2"> does not exist"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">))</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">tablename</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">tablename</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">final</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"BEGIN IMMEDIATE"</span><span class="p">)</span>
<span class="n">final</span> <span class="o">=</span> <span class="s2">"ROLLBACK"</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">tablename</span><span class="p">:</span>
<span class="n">tablename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]))[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma table_info(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">tablename</span><span class="p">),</span> <span class="p">))</span><span class="o">.</span><span class="n">fetchall</span><span class="p">():</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Table </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2"> already exists"</span> <span class="o">%</span> <span class="p">(</span><span class="n">tablename</span><span class="p">,</span> <span class="p">))</span>
<span class="c1"># The types we support deducing</span>
<span class="k">def</span> <span class="nf">DateUS</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> <span class="c1"># US formatted date with wrong ordering of day and month</span>
<span class="k">return</span> <span class="n">DateWorld</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">switchdm</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">DateWorld</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">switchdm</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> <span class="c1"># Sensibly formatted date as used anywhere else in the world</span>
<span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getdate</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="n">switchdm</span><span class="p">:</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="n">d</span><span class="p">,</span> <span class="n">m</span>
<span class="k">if</span> <span class="n">m</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">m</span> <span class="o">></span> <span class="mi">12</span> <span class="ow">or</span> <span class="n">d</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">d</span> <span class="o">></span> <span class="mi">31</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%d</span><span class="s2">-</span><span class="si">%02d</span><span class="s2">-</span><span class="si">%02d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">DateTimeUS</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> <span class="c1"># US date and time</span>
<span class="k">return</span> <span class="n">DateTimeWorld</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">switchdm</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">DateTimeWorld</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="n">switchdm</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> <span class="c1"># Sensible date and time</span>
<span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getdatetime</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="n">switchdm</span><span class="p">:</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="n">d</span><span class="p">,</span> <span class="n">m</span>
<span class="k">if</span> <span class="n">m</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">m</span> <span class="o">></span> <span class="mi">12</span> <span class="ow">or</span> <span class="n">d</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">d</span> <span class="o">></span> <span class="mi">31</span> <span class="ow">or</span> <span class="n">h</span> <span class="o"><</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">h</span> <span class="o">></span> <span class="mi">23</span> <span class="ow">or</span> <span class="n">M</span> <span class="o"><</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">M</span> <span class="o">></span> <span class="mi">59</span> <span class="ow">or</span> <span class="n">s</span> <span class="o"><</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">s</span> <span class="o">></span> <span class="mi">65</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%d</span><span class="s2">-</span><span class="si">%02d</span><span class="s2">-</span><span class="si">%02d</span><span class="s2">T</span><span class="si">%02d</span><span class="s2">:</span><span class="si">%02d</span><span class="s2">:</span><span class="si">%02d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span><span class="p">,</span> <span class="n">h</span><span class="p">,</span> <span class="n">M</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">Number</span><span class="p">(</span><span class="n">v</span><span class="p">):</span> <span class="c1"># we really don't want phone numbers etc to match</span>
<span class="c1"># Python's float & int constructors allow whitespace which we don't</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="sa">r</span><span class="s2">"\s"</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">if</span> <span class="n">v</span> <span class="o">==</span> <span class="s2">"0"</span><span class="p">:</span> <span class="k">return</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"+"</span><span class="p">:</span> <span class="c1"># idd prefix</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">"^[0-9]+$"</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="k">if</span> <span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"0"</span><span class="p">:</span> <span class="k">raise</span> <span class="ne">ValueError</span> <span class="c1"># also a phone number</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="n">v</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"0"</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">v</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"0."</span><span class="p">):</span> <span class="c1"># deceptive not a number</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="c1"># Work out the file format</span>
<span class="n">formats</span> <span class="o">=</span> <span class="p">[{</span><span class="s2">"dialect"</span><span class="p">:</span> <span class="s2">"excel"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"dialect"</span><span class="p">:</span> <span class="s2">"excel-tab"</span><span class="p">}]</span>
<span class="n">seps</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"|"</span><span class="p">,</span> <span class="s2">";"</span><span class="p">,</span> <span class="s2">":"</span><span class="p">]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">seps</span><span class="p">:</span>
<span class="n">seps</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">separator</span><span class="p">)</span>
<span class="k">for</span> <span class="n">sep</span> <span class="ow">in</span> <span class="n">seps</span><span class="p">:</span>
<span class="n">formats</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">"quoting"</span><span class="p">:</span> <span class="n">csv</span><span class="o">.</span><span class="n">QUOTE_NONE</span><span class="p">,</span> <span class="s2">"delimiter"</span><span class="p">:</span> <span class="n">sep</span><span class="p">,</span> <span class="s2">"doublequote"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">"quotechar"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\x00</span><span class="s2">"</span><span class="p">})</span>
<span class="n">possibles</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">encodingissue</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># format is copy() on every use. This appears bizarre and</span>
<span class="c1"># unnecessary. However Python 2.3 and 2.4 somehow manage</span>
<span class="c1"># to empty it if not copied.</span>
<span class="k">for</span> <span class="nb">format</span> <span class="ow">in</span> <span class="n">formats</span><span class="p">:</span>
<span class="n">ncols</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="n">lines</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_csvin_wrapper</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">format</span><span class="o">.</span><span class="n">copy</span><span class="p">()):</span>
<span class="k">if</span> <span class="n">lines</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">lines</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">ncols</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="c1"># data type guess setup</span>
<span class="n">datas</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ncols</span><span class="p">):</span>
<span class="n">datas</span><span class="o">.</span><span class="n">append</span><span class="p">([</span><span class="n">DateUS</span><span class="p">,</span> <span class="n">DateWorld</span><span class="p">,</span> <span class="n">DateTimeUS</span><span class="p">,</span> <span class="n">DateTimeWorld</span><span class="p">,</span> <span class="n">Number</span><span class="p">])</span>
<span class="n">allblanks</span> <span class="o">=</span> <span class="p">[</span><span class="kc">True</span><span class="p">]</span> <span class="o">*</span> <span class="n">ncols</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="o">!=</span> <span class="n">ncols</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Expected </span><span class="si">%d</span><span class="s2"> columns - got </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">ncols</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)))</span>
<span class="n">lines</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ncols</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="k">continue</span>
<span class="n">allblanks</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="k">continue</span>
<span class="c1"># remove datas that give ValueError</span>
<span class="n">d</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">dd</span> <span class="ow">in</span> <span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">dd</span><span class="p">(</span><span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>
<span class="n">d</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dd</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">d</span>
<span class="k">if</span> <span class="n">ncols</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">lines</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="c1"># if a particular column was allblank then clear datas for it</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ncols</span><span class="p">):</span>
<span class="k">if</span> <span class="n">allblanks</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">possibles</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="nb">format</span><span class="o">.</span><span class="n">copy</span><span class="p">(),</span> <span class="n">ncols</span><span class="p">,</span> <span class="n">lines</span><span class="p">,</span> <span class="n">datas</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">UnicodeDecodeError</span><span class="p">:</span>
<span class="n">encodingissue</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">if</span> <span class="n">s</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">errors</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">possibles</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="n">encodingissue</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span>
<span class="s2">"The file is probably not in the current encoding </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2"> and didn't match a known file format"</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">))</span>
<span class="n">v</span> <span class="o">=</span> <span class="s2">"File doesn't appear to match a known type."</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">errors</span><span class="p">):</span>
<span class="n">v</span> <span class="o">+=</span> <span class="s2">" Errors reported:</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s2">" "</span> <span class="o">+</span> <span class="n">e</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">errors</span><span class="p">])</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">possibles</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"File matches more than one type!"</span><span class="p">)</span>
<span class="nb">format</span><span class="p">,</span> <span class="n">ncols</span><span class="p">,</span> <span class="n">lines</span><span class="p">,</span> <span class="n">datas</span> <span class="o">=</span> <span class="n">possibles</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="nb">format</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"dialect"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">fmt</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">fmt</span> <span class="o">=</span> <span class="s2">"(delimited by </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">format</span><span class="p">[</span><span class="s2">"delimiter"</span><span class="p">],</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"Detected Format </span><span class="si">%s</span><span class="s2"> Columns </span><span class="si">%d</span><span class="s2"> Rows </span><span class="si">%d</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">fmt</span><span class="p">,</span> <span class="n">ncols</span><span class="p">,</span> <span class="n">lines</span><span class="p">))</span>
<span class="c1"># Header row</span>
<span class="n">reader</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_csvin_wrapper</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">format</span><span class="p">)</span>
<span class="k">for</span> <span class="n">header</span> <span class="ow">in</span> <span class="n">reader</span><span class="p">:</span>
<span class="k">break</span>
<span class="c1"># Check schema</span>
<span class="n">identity</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ncols</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Column #</span><span class="si">%d</span><span class="s2"> </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2"> has ambiguous data format - </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="n">header</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">d</span><span class="o">.</span><span class="vm">__name__</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]])))</span>
<span class="k">if</span> <span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">identity</span>
<span class="c1"># Make the table</span>
<span class="n">sql</span> <span class="o">=</span> <span class="s2">"CREATE TABLE </span><span class="si">%s</span><span class="s2">(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">tablename</span><span class="p">),</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">h</span><span class="p">)</span> <span class="k">for</span> <span class="n">h</span> <span class="ow">in</span> <span class="n">header</span><span class="p">]))</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
<span class="c1"># prep work for each row</span>
<span class="n">sql</span> <span class="o">=</span> <span class="s2">"INSERT INTO </span><span class="si">%s</span><span class="s2"> VALUES(</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">tablename</span><span class="p">),</span> <span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s2">"?"</span><span class="p">]</span> <span class="o">*</span> <span class="n">ncols</span><span class="p">))</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">reader</span><span class="p">:</span>
<span class="n">vals</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">ncols</span><span class="p">):</span>
<span class="n">l</span> <span class="o">=</span> <span class="n">line</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">l</span><span class="p">:</span>
<span class="n">vals</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">vals</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">datas</span><span class="p">[</span><span class="n">i</span><span class="p">](</span><span class="n">l</span><span class="p">))</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">vals</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"COMMIT"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"Auto-import into table </span><span class="se">\"</span><span class="si">%s</span><span class="se">\"</span><span class="s2"> complete</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">tablename</span><span class="p">,</span> <span class="p">))</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">if</span> <span class="n">final</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">final</span><span class="p">)</span>
<span class="k">raise</span>
<span class="k">def</span> <span class="nf">_getdate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="c1"># Returns a tuple of 3 items y,m,d from string v</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">"^([0-9]+)[^0-9]([0-9]+)[^0-9]([0-9]+)$"</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)),</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">2</span><span class="p">)),</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">3</span><span class="p">))</span>
<span class="k">if</span> <span class="n">d</span> <span class="o">></span> <span class="mi">1000</span><span class="p">:</span> <span class="c1"># swap order</span>
<span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="n">d</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">y</span>
<span class="k">if</span> <span class="n">y</span> <span class="o"><</span> <span class="mi">1000</span> <span class="ow">or</span> <span class="n">y</span> <span class="o">></span> <span class="mi">9999</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">return</span> <span class="n">y</span><span class="p">,</span> <span class="n">m</span><span class="p">,</span> <span class="n">d</span>
<span class="k">def</span> <span class="nf">_getdatetime</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="c1"># must be at least HH:MM</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">"^([0-9]+)[^0-9]([0-9]+)[^0-9]([0-9]+)[^0-9]+([0-9]+)[^0-9]([0-9]+)([^0-9]([0-9]+))?$"</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="n">items</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">7</span><span class="p">))</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">items</span><span class="p">)):</span>
<span class="k">if</span> <span class="n">items</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">items</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">items</span> <span class="o">=</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">items</span><span class="p">]</span>
<span class="k">if</span> <span class="n">items</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">></span> <span class="mi">1000</span><span class="p">:</span>
<span class="n">items</span> <span class="o">=</span> <span class="p">[</span><span class="n">items</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">items</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">items</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="n">items</span><span class="p">[</span><span class="mi">3</span><span class="p">:]</span>
<span class="k">if</span> <span class="n">items</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o"><</span> <span class="mi">1000</span> <span class="ow">or</span> <span class="n">items</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">></span> <span class="mi">9999</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span>
<span class="k">return</span> <span class="n">items</span>
<span class="k">def</span> <span class="nf">command_indices</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""indices TABLE: Lists all indices on table TABLE</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"indices takes one table name"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_list</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span>
<span class="s2">"SELECT name FROM sqlite_schema WHERE type='index' AND tbl_name LIKE ?1 "</span>
<span class="s2">"UNION ALL SELECT name FROM sqlite_temp_schema WHERE type='index' AND tbl_name LIKE "</span>
<span class="s2">"?1 ORDER by name"</span><span class="p">,</span>
<span class="n">cmd</span><span class="p">,</span>
<span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_output</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""load FILE ?ENTRY?: Loads a SQLite extension library</span>
<span class="sd"> Note: Extension loading may not be enabled in the SQLite</span>
<span class="sd"> library version you are using.</span>
<span class="sd"> By default sqlite3_extension_init is called in the library but</span>
<span class="sd"> you can specify an alternate entry point.</span>
<span class="sd"> If you get an error about the extension not being found you</span>
<span class="sd"> may need to explicitly specify the directory. For example if</span>
<span class="sd"> it is in the current directory then use:</span>
<span class="sd"> .load ./extension.so</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"load takes one or two parameters"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">enable_load_extension</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Extension loading is not supported"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="o">*</span><span class="n">cmd</span><span class="p">)</span>
<div class="viewcode-block" id="Shell.log_handler">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.log_handler">[docs]</a>
<span class="k">def</span> <span class="nf">log_handler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span>
<span class="s2">"Called with SQLite log messages when logging is ON"</span>
<span class="n">code</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"( </span><span class="si">{</span><span class="w"> </span><span class="n">code</span><span class="w"> </span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="w"> </span><span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">result_string</span><span class="p">(</span><span class="n">code</span><span class="p">)</span><span class="w"> </span><span class="si">}</span><span class="s2"> ) "</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_error</span><span class="p">(</span><span class="n">code</span> <span class="o">+</span> <span class="n">message</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">command_log</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="s2">"log ON|OFF: Shows SQLite log messages (default off)"</span>
<span class="n">setting</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"log"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">)</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_CONFIG_LOG</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">log_handler</span> <span class="k">if</span> <span class="n">setting</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
<span class="n">_output_modes</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">command_mode</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""mode MODE ?OPTIONS?: Sets output mode to one of"""</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Specify an output mode"</span><span class="p">)</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">w</span> <span class="o">==</span> <span class="s2">"tabs"</span><span class="p">:</span>
<span class="n">w</span> <span class="o">=</span> <span class="s2">"list"</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"output_"</span> <span class="o">+</span> <span class="n">w</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Expected a valid output mode: "</span> <span class="o">+</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_output_modes</span><span class="p">))</span>
<span class="n">m</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"output_"</span> <span class="o">+</span> <span class="n">w</span><span class="p">)</span>
<span class="c1"># argument parsing</span>
<span class="k">if</span> <span class="n">w</span> <span class="o">==</span> <span class="s2">"insert"</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Output mode </span><span class="si">%s</span><span class="s2"> doesn't take parameters"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="n">table_name</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="k">else</span> <span class="s2">"table"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_table</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_sql_identifier</span><span class="p">(</span><span class="n">table_name</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">m</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">w</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"box"</span><span class="p">,</span> <span class="s2">"qbox"</span><span class="p">,</span> <span class="s2">"table"</span><span class="p">}:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Output mode </span><span class="si">%s</span><span class="s2"> doesn't take parameters"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"csv"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">=</span> <span class="s2">","</span>
<span class="k">elif</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"tabs"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">truncate</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="n">m</span>
<span class="k">return</span>
<span class="n">defaults</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"quote"</span><span class="p">:</span> <span class="n">w</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"qbox"</span><span class="p">},</span>
<span class="s2">"string_sanitize"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"box"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s2">"table"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s2">"qbox"</span><span class="p">:</span> <span class="mi">1</span>
<span class="p">}[</span><span class="n">w</span><span class="p">],</span>
<span class="s2">"null"</span><span class="p">:</span> <span class="s2">"NULL"</span><span class="p">,</span>
<span class="s2">"truncate"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"box"</span><span class="p">:</span> <span class="mi">1024</span><span class="p">,</span>
<span class="s2">"table"</span><span class="p">:</span> <span class="mi">2048</span><span class="p">,</span>
<span class="s2">"qbox"</span><span class="p">:</span> <span class="mi">4096</span>
<span class="p">}[</span><span class="n">w</span><span class="p">],</span>
<span class="s2">"text_width"</span><span class="p">:</span> <span class="mi">0</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="k">else</span> <span class="mi">80</span><span class="p">,</span>
<span class="s2">"use_unicode"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"box"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s2">"table"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s2">"qbox"</span><span class="p">:</span> <span class="kc">True</span>
<span class="p">}[</span><span class="n">w</span><span class="p">],</span>
<span class="s2">"word_wrap"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="p">}</span>
<span class="c1"># argparse unfortunately tries to do too much and really is about program arguments,</span>
<span class="c1"># but it isn't worthwhile re-implementing this</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span><span class="n">allow_abbrev</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">usage</span><span class="o">=</span><span class="sa">f</span><span class="s2">".mode </span><span class="si">{</span><span class="w"> </span><span class="n">w</span><span class="w"> </span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">prog</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="s2">"exit_on_error"</span><span class="p">):</span>
<span class="n">p</span><span class="o">.</span><span class="n">exit_on_error</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">p</span><span class="o">.</span><span class="n">set_defaults</span><span class="p">(</span><span class="o">**</span><span class="n">defaults</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--quote"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"quote"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"store_true"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Show values in SQL syntax [</span><span class="si">%(default)s</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--no-quote"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"quote"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"store_false"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Show values as strings"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s2">"--string-sanitize"</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span>
<span class="n">choices</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"How much to clean up string characters (0 - none, 1 - medium, 2 - everything) [</span><span class="si">%(default)s</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--null"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"How to show NULL [</span><span class="si">%(default)s</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--truncate"</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"How many characters to truncate long output at [</span><span class="si">%(default)s</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--width"</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span>
<span class="n">dest</span><span class="o">=</span><span class="s2">"text_width"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Maximum width of the table [Screen width if terminal, else 80 chars]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--unicode"</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s2">"store_true"</span><span class="p">,</span>
<span class="n">dest</span><span class="o">=</span><span class="s2">"use_unicode"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Use unicode line drawing [</span><span class="si">%(default)s</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--no-unicode"</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s2">"store_true"</span><span class="p">,</span>
<span class="n">dest</span><span class="o">=</span><span class="s2">"use_unicode"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Use ascii line drawing like +=-+ "</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--word-wrap"</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s2">"store_true"</span><span class="p">,</span>
<span class="n">dest</span><span class="o">=</span><span class="s2">"word_wrap"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Wrap text at word boundaries [</span><span class="si">%(default)s</span><span class="s2">]"</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--no-word-wrap"</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s2">"store_false"</span><span class="p">,</span>
<span class="n">dest</span><span class="o">=</span><span class="s2">"word_wrap"</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s2">"Wrap at column width ignoring words"</span><span class="p">)</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">io</span><span class="o">.</span><span class="n">StringIO</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">with</span> <span class="n">contextlib</span><span class="o">.</span><span class="n">redirect_stderr</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="k">with</span> <span class="n">contextlib</span><span class="o">.</span><span class="n">redirect_stdout</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">box_options</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span>
<span class="k">except</span><span class="p">:</span>
<span class="c1"># bare except because SystemExit can be raised</span>
<span class="k">raise</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="n">text</span><span class="o">.</span><span class="n">getvalue</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_box</span>
<span class="c1"># needed so command completion and help can use it</span>
<span class="k">def</span> <span class="nf">_calculate_output_modes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">modes</span> <span class="o">=</span> <span class="p">[</span><span class="n">m</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"output_"</span><span class="p">):]</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="k">if</span> <span class="n">m</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"output_"</span><span class="p">)]</span>
<span class="n">modes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"tabs"</span><span class="p">)</span>
<span class="n">modes</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_modes</span> <span class="o">=</span> <span class="n">modes</span>
<span class="n">detail</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="n">modes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">m</span> <span class="ow">in</span> <span class="p">{</span><span class="s1">'tabs'</span><span class="p">,</span> <span class="s2">"column"</span><span class="p">,</span> <span class="s2">"line"</span><span class="p">}:</span>
<span class="k">continue</span>
<span class="n">d</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"output_"</span> <span class="o">+</span> <span class="n">m</span><span class="p">)</span><span class="o">.</span><span class="vm">__doc__</span>
<span class="k">assert</span> <span class="n">d</span><span class="p">,</span> <span class="s2">"output mode "</span> <span class="o">+</span> <span class="n">m</span> <span class="o">+</span> <span class="s2">" needs doc"</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">" "</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">while</span> <span class="s2">" "</span> <span class="ow">in</span> <span class="n">d</span><span class="p">:</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">" "</span><span class="p">,</span> <span class="s2">" "</span><span class="p">)</span>
<span class="n">detail</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">m</span> <span class="o">+</span> <span class="s2">": "</span> <span class="o">+</span> <span class="n">d</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_modes_detail</span> <span class="o">=</span> <span class="n">detail</span>
<span class="k">def</span> <span class="nf">command_nullvalue</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""nullvalue STRING: Print STRING in place of null values</span>
<span class="sd"> This affects textual output modes like column and list and</span>
<span class="sd"> sets how SQL null values are shown. The default is a zero</span>
<span class="sd"> length string. Insert mode and dumps are not affected by this</span>
<span class="sd"> setting. You can use double quotes to supply a zero length</span>
<span class="sd"> string. For example:</span>
<span class="sd"> .nullvalue "" # the default</span>
<span class="sd"> .nullvalue <NULL> # rather obvious</span>
<span class="sd"> .nullvalue " \\t " # A tab surrounded by spaces</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"nullvalue takes exactly one parameter"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nullvalue</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixup_backslashes</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">command_open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""open ?OPTIONS? ?FILE?: Opens a database connection</span>
<span class="sd"> Options are:</span>
<span class="sd"> --wipe Closes any existing connections in this process referring to</span>
<span class="sd"> the same file and deletes the database file, journals etc</span>
<span class="sd"> before opening</span>
<span class="sd"> --vfs VFS Which vfs to use when opening</span>
<span class="sd"> If FILE is omitted then a memory database is opened</span>
<span class="sd"> """</span>
<span class="n">wipe</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">vfs</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">dbname</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">cmd</span>
<span class="k">while</span> <span class="n">c</span><span class="p">:</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"--"</span><span class="p">):</span>
<span class="k">if</span> <span class="n">p</span> <span class="o">==</span> <span class="s2">"--wipe"</span><span class="p">:</span>
<span class="n">wipe</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">p</span> <span class="o">==</span> <span class="s2">"--vfs"</span><span class="p">:</span>
<span class="n">vfs</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">continue</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Unknown open param: "</span> <span class="o">+</span> <span class="n">p</span><span class="p">)</span>
<span class="k">if</span> <span class="n">dbname</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Too many arguments: "</span> <span class="o">+</span> <span class="n">p</span><span class="p">)</span>
<span class="n">dbname</span> <span class="o">=</span> <span class="n">p</span>
<span class="k">if</span> <span class="n">wipe</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dbname</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"You must specify a filename with --wipe"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">apsw</span><span class="o">.</span><span class="n">connections</span><span class="p">():</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">filename</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">samefile</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">filename</span><span class="p">,</span> <span class="n">dbname</span><span class="p">):</span>
<span class="n">c</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span> <span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">ConnectionClosedError</span><span class="p">,</span> <span class="ne">FileNotFoundError</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">for</span> <span class="n">suffix</span> <span class="ow">in</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"-journal"</span><span class="p">,</span> <span class="s2">"-wal"</span><span class="p">,</span> <span class="s2">"-shm"</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">dbname</span> <span class="o">+</span> <span class="n">suffix</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db_references</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span> <span class="o">=</span> <span class="n">dbname</span> <span class="k">if</span> <span class="n">dbname</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="s2">""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_db</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dbfilename</span><span class="p">,</span>
<span class="n">vfs</span><span class="o">=</span><span class="n">vfs</span><span class="p">,</span>
<span class="n">flags</span><span class="o">=</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_OPEN_URI</span> <span class="o">|</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_OPEN_READWRITE</span>
<span class="o">|</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_OPEN_CREATE</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_output</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""output FILENAME: Send output to FILENAME (or stdout)</span>
<span class="sd"> If the FILENAME is 'stdout' then output is sent to standard</span>
<span class="sd"> output from when the shell was started. The file is opened</span>
<span class="sd"> using the current encoding (change with 'encoding' command).</span>
<span class="sd"> """</span>
<span class="c1"># Flush everything</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="p">,</span> <span class="s2">"flush"</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span> <span class="c1"># see issue 117</span>
<span class="k">pass</span>
<span class="c1"># we will also close stdout but only do so once we have a</span>
<span class="c1"># replacement so that stdout is always valid</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"You must specify a filename"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">fname</span> <span class="o">==</span> <span class="s2">"stdout"</span><span class="p">:</span>
<span class="n">old</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_original_stdout</span><span class="p">:</span>
<span class="n">old</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_original_stdout</span>
<span class="k">if</span> <span class="n">old</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># done here in case close raises exception</span>
<span class="n">old</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">return</span>
<span class="n">newf</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">old</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_original_stdout</span><span class="p">:</span>
<span class="n">old</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span> <span class="o">=</span> <span class="n">newf</span>
<span class="k">if</span> <span class="n">old</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">old</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_out_colour</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_parameter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""parameter CMD ...: Maintain named bindings you can use in your queries.</span>
<span class="sd"> Specify a subcommand:</span>
<span class="sd"> list -- shows current bindings</span>
<span class="sd"> clear -- deletes all bindings</span>
<span class="sd"> unset NAME -- deletes named binding</span>
<span class="sd"> set NAME VALUE -- sets binding to VALUE</span>
<span class="sd"> The value must be a valid SQL literal or expression. For example</span>
<span class="sd"> `3` will be an integer 3 while '3' will be a string.</span>
<span class="sd"> Example::</span>
<span class="sd"> .parameter set floor 10.99</span>
<span class="sd"> .parameter set text 'Acme''s Glove'</span>
<span class="sd"> SELECT * FROM sales WHERE price > $floor AND description != $text;</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"clear"</span><span class="p">,</span> <span class="s2">"init"</span><span class="p">}:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bindings</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">return</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"list"</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">bindings</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"No parameters set</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">return</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">bindings</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bindings</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">k</span> <span class="o">+</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">w</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_value</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"unset"</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">bindings</span><span class="p">[</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span>
<span class="k">return</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"'</span><span class="si">{</span><span class="w"> </span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="w"> </span><span class="si">}</span><span class="s2">' is not in parameters"</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span> <span class="ow">and</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"set"</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="sa">f</span><span class="s2">"select (</span><span class="si">{</span><span class="w"> </span><span class="n">cmd</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="w"> </span><span class="si">}</span><span class="s2">)"</span><span class="p">)</span><span class="o">.</span><span class="n">get</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Does not appear to be a valid SQLite value: </span><span class="si">{</span><span class="w"> </span><span class="n">cmd</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="w"> </span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bindings</span><span class="p">[</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]]</span> <span class="o">=</span> <span class="n">v</span>
<span class="k">return</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">".parameter command not understood. Use .help parameter to get usage"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_print</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""print STRING: print the literal STRING</span>
<span class="sd"> If more than one argument is supplied then they are printed</span>
<span class="sd"> space separated. You can use backslash escapes such as \\n</span>
<span class="sd"> and \\t.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">fixup_backslashes</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">])</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_prompt</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""prompt MAIN ?CONTINUE?: Changes the prompts for first line and continuation lines</span>
<span class="sd"> The default is to print 'sqlite> ' for the main prompt where</span>
<span class="sd"> you can enter a dot command or a SQL statement. If the SQL</span>
<span class="sd"> statement is not complete then you are</span>
<span class="sd"> prompted for more using the continuation prompt which defaults</span>
<span class="sd"> to ' ..> '. Example:</span>
<span class="sd"> .prompt "command> " "more command> "</span>
<span class="sd"> You can use backslash escapes such as \\n and \\t.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o"><</span> <span class="mi">1</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"prompt takes one or two arguments"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prompt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixup_backslashes</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">moreprompt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixup_backslashes</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">command_py</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""py ?PYTHON?: Starts a python REPL or runs the Python statement provided</span>
<span class="sd"> The namespace provided includes ``apsw`` for the module, ``shell`` for this</span>
<span class="sd"> shell and ``db`` for the current database.</span>
<span class="sd"> Using the .output command does not affect output from this command. You</span>
<span class="sd"> can write to `shell.stdout` and `shell.stderr`.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="nb">vars</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"shell"</span><span class="p">:</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">"apsw"</span><span class="p">:</span> <span class="n">apsw</span><span class="p">,</span> <span class="s2">"db"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">}</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
<span class="n">interp</span> <span class="o">=</span> <span class="n">code</span><span class="o">.</span><span class="n">InteractiveInterpreter</span><span class="p">(</span><span class="nb">locals</span><span class="o">=</span><span class="nb">vars</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># we have to make sys.excepthook and sys.__excepthook__ be</span>
<span class="c1"># the same otherwise the traceback includes methods in the</span>
<span class="c1"># code module. Ubuntu's apport messes with excepthook</span>
<span class="n">hook</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">excepthook</span>
<span class="n">sys</span><span class="o">.</span><span class="n">excepthook</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">__excepthook__</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">interp</span><span class="o">.</span><span class="n">runsource</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">excepthook</span> <span class="o">=</span> <span class="n">hook</span>
<span class="k">if</span> <span class="n">res</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_error</span><span class="p">(</span><span class="s2">"Incomplete Python statement</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># this should be locals (plural) but the method is written</span>
<span class="c1"># in singular and works due to being passed as a positional</span>
<span class="c1"># argument</span>
<span class="n">code</span><span class="o">.</span><span class="n">interact</span><span class="p">(</span><span class="n">local</span><span class="o">=</span><span class="nb">vars</span><span class="p">,</span> <span class="n">exitmsg</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">intro</span> <span class="o">+</span> <span class="s2">"Returning to APSW shell"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">intro_</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_read</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""read FILENAME: Processes SQL and commands in FILENAME (or Python if FILENAME ends with .py)</span>
<span class="sd"> Treats the specified file as input (a mixture or SQL and/or</span>
<span class="sd"> dot commands). If the filename ends in .py then it is treated</span>
<span class="sd"> as Python code instead.</span>
<span class="sd"> For Python code the symbol 'db' refers to the current database,</span>
<span class="sd"> 'shell' refers to the instance of the shell and 'apsw' is the</span>
<span class="sd"> apsw module.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"read takes a single filename"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".py"</span><span class="p">):</span>
<span class="n">g</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">g</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">'apsw'</span><span class="p">:</span> <span class="n">apsw</span><span class="p">,</span> <span class="s1">'shell'</span><span class="p">:</span> <span class="bp">self</span><span class="p">,</span> <span class="s1">'db'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">})</span>
<span class="c1"># compile step is needed to associate name with code</span>
<span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">"rb"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">exec</span><span class="p">(</span><span class="nb">compile</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">(),</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s1">'exec'</span><span class="p">),</span> <span class="n">g</span><span class="p">,</span> <span class="n">g</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">f</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">"r"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_input</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdin</span> <span class="o">=</span> <span class="n">f</span>
<span class="bp">self</span><span class="o">.</span><span class="n">interactive</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">input_line_number</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_complete_line</span><span class="p">()</span>
<span class="k">if</span> <span class="n">line</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">break</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_complete_line</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_append_input_description</span><span class="p">()</span>
<span class="k">raise</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_input</span><span class="p">()</span>
<span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_restore</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""restore ?DB? FILE: Restore database from FILE into DB (default "main")</span>
<span class="sd"> Copies the contents of FILE to the current database (default "main").</span>
<span class="sd"> The backup is done at the page level - SQLite copies the pages as</span>
<span class="sd"> is. There is no round trip through SQL code.</span>
<span class="sd"> """</span>
<span class="n">dbname</span> <span class="o">=</span> <span class="s2">"main"</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">dbname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">fname</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Restore takes one or two parameters"</span><span class="p">)</span>
<span class="nb">input</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">Connection</span><span class="p">(</span><span class="n">fname</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">backup</span><span class="p">(</span><span class="n">dbname</span><span class="p">,</span> <span class="nb">input</span><span class="p">,</span> <span class="s2">"main"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">b</span><span class="o">.</span><span class="n">done</span><span class="p">:</span>
<span class="n">b</span><span class="o">.</span><span class="n">step</span><span class="p">()</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">b</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
<span class="nb">input</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_schema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""schema ?TABLE? [TABLE...]: Shows SQL for table</span>
<span class="sd"> If you give one or more tables then their schema is listed</span>
<span class="sd"> (including indices). If you don't specify any then all</span>
<span class="sd"> schemas are listed. TABLE is a like pattern so you can use % for</span>
<span class="sd"> wildcards.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_list</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'%'</span><span class="p">]</span>
<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span>
<span class="s2">"SELECT sql||';' FROM "</span>
<span class="s2">"(SELECT sql sql, type type, tbl_name tbl_name, name name "</span>
<span class="s2">"FROM sqlite_schema UNION ALL "</span>
<span class="s2">"SELECT sql, type, tbl_name, name FROM sqlite_temp_schema) "</span>
<span class="s2">"WHERE tbl_name LIKE ?1 AND type!='meta' AND sql NOTNULL AND name NOT LIKE 'sqlite_%' "</span>
<span class="s2">"ORDER BY substr(type,2,1), name"</span><span class="p">,</span> <span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="p">),</span>
<span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_output</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_separator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""separator STRING: Change separator for output mode and .import</span>
<span class="sd"> You can use quotes and backslashes. For example to set the</span>
<span class="sd"> separator to space tab space you can use:</span>
<span class="sd"> .separator " \\t "</span>
<span class="sd"> The setting is automatically changed when you switch to csv or</span>
<span class="sd"> tabs output mode. You should also set it before doing an</span>
<span class="sd"> import (ie , for CSV and \\t for TSV).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"separator takes exactly one parameter"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">separator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fixup_backslashes</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">_shows</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"echo"</span><span class="p">,</span> <span class="s2">"headers"</span><span class="p">,</span> <span class="s2">"mode"</span><span class="p">,</span> <span class="s2">"changes"</span><span class="p">,</span> <span class="s2">"nullvalue"</span><span class="p">,</span> <span class="s2">"output"</span><span class="p">,</span> <span class="s2">"separator"</span><span class="p">,</span> <span class="s2">"width"</span><span class="p">,</span> <span class="s2">"exceptions"</span><span class="p">,</span>
<span class="s2">"encoding"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_shell</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""shell CMD ARGS...: Run CMD ARGS in a system shell</span>
<span class="sd"> Note that output goes to the process standard output, not</span>
<span class="sd"> whatever the shell .output command has configured.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Specify command and arguments to run"</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
<span class="n">res</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="n">res</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_error</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Exit code </span><span class="si">{</span><span class="w"> </span><span class="n">res</span><span class="w"> </span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_show</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""show: Show the current values for various settings."""</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"show takes at most one parameter"</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
<span class="n">what</span> <span class="o">=</span> <span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">what</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_shows</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Unknown show: '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">what</span><span class="p">,</span> <span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">what</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">outs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_shows</span><span class="p">:</span>
<span class="n">k</span> <span class="o">=</span> <span class="n">i</span>
<span class="k">if</span> <span class="n">what</span> <span class="ow">and</span> <span class="n">i</span> <span class="o">!=</span> <span class="n">what</span><span class="p">:</span>
<span class="k">continue</span>
<span class="c1"># boolean settings</span>
<span class="k">if</span> <span class="n">i</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"echo"</span><span class="p">,</span> <span class="s2">"headers"</span><span class="p">,</span> <span class="s2">"exceptions"</span><span class="p">,</span> <span class="s2">"changes"</span><span class="p">):</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="s2">"headers"</span><span class="p">:</span> <span class="n">i</span> <span class="o">=</span> <span class="s2">"header"</span>
<span class="n">v</span> <span class="o">=</span> <span class="s2">"off"</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">):</span>
<span class="n">v</span> <span class="o">=</span> <span class="s2">"on"</span>
<span class="k">elif</span> <span class="n">i</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"nullvalue"</span><span class="p">,</span> <span class="s2">"separator"</span><span class="p">):</span>
<span class="n">v</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fmt_c_string</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">i</span> <span class="o">==</span> <span class="s2">"mode"</span><span class="p">:</span>
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_modes</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">==</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"output_"</span> <span class="o">+</span> <span class="n">v</span><span class="p">):</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">"Bug: didn't find output mode"</span>
<span class="k">elif</span> <span class="n">i</span> <span class="o">==</span> <span class="s2">"output"</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span> <span class="ow">is</span> <span class="bp">self</span><span class="o">.</span><span class="n">_original_stdout</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="s2">"stdout"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">,</span> <span class="s2">"<unknown stdout>"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">i</span> <span class="o">==</span> <span class="s2">"width"</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="s2">"</span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">widths</span><span class="p">])</span>
<span class="k">elif</span> <span class="n">i</span> <span class="o">==</span> <span class="s2">"encoding"</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">v</span> <span class="o">+=</span> <span class="s2">" (Errors "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">encoding</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="s2">")"</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">assert</span> <span class="kc">False</span><span class="p">,</span> <span class="s2">"Bug: unknown show handling"</span>
<span class="n">outs</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">))</span>
<span class="c1"># find width of k column</span>
<span class="n">l</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">outs</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="o">></span> <span class="n">l</span><span class="p">:</span>
<span class="n">l</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">outs</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"</span><span class="si">%*.*s</span><span class="s2">: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">l</span><span class="p">,</span> <span class="n">l</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">command_tables</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""tables ?PATTERN?: Lists names of tables matching LIKE pattern</span>
<span class="sd"> This also returns views.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">push_output</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">output_list</span>
<span class="bp">self</span><span class="o">.</span><span class="n">header</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'%'</span><span class="p">]</span>
<span class="c1"># The SQLite shell code filters out sqlite_ prefixes if</span>
<span class="c1"># you specified an argument else leaves them in. It also</span>
<span class="c1"># has a hand coded output mode that does space separation</span>
<span class="c1"># plus wrapping at 80 columns.</span>
<span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span>
<span class="s2">"SELECT name FROM sqlite_schema "</span>
<span class="s2">"WHERE type IN ('table', 'view') AND name NOT LIKE 'sqlite_%' "</span>
<span class="s2">"AND name like ?1 "</span>
<span class="s2">"UNION ALL "</span>
<span class="s2">"SELECT name FROM sqlite_temp_schema "</span>
<span class="s2">"WHERE type IN ('table', 'view') AND name NOT LIKE 'sqlite_%' "</span>
<span class="s2">"ORDER BY 1"</span><span class="p">,</span> <span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="p">),</span>
<span class="n">internal</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pop_output</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">command_timeout</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""timeout MS: Try opening locked tables for MS milliseconds</span>
<span class="sd"> If a database is locked by another process SQLite will keep</span>
<span class="sd"> retrying. This sets how many thousandths of a second it will</span>
<span class="sd"> keep trying for. If you supply zero or a negative number then</span>
<span class="sd"> all busy handlers are disabled.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"timeout takes a number"</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">t</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> is not a number"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">set_busy_timeout</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_timer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""timer ON|OFF: Control printing of time and resource usage after each query</span>
<span class="sd"> The values displayed are in seconds when shown as floating</span>
<span class="sd"> point or an absolute count. Only items that have changed</span>
<span class="sd"> since starting the query are shown. On non-Windows platforms</span>
<span class="sd"> considerably more information can be shown.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_boolean_command</span><span class="p">(</span><span class="s2">"timer"</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_resource_usage</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Timing not supported by this Python version/platform"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timer</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timer</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">def</span> <span class="nf">command_version</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="s2">"version: Displays SQLite, APSW, and Python version information"</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No parameters taken"</span><span class="p">)</span>
<span class="n">versions</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"SQLite"</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="w"> </span><span class="n">apsw</span><span class="o">.</span><span class="n">sqlite_lib_version</span><span class="p">()</span><span class="w"> </span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="w"> </span><span class="n">apsw</span><span class="o">.</span><span class="n">sqlite3_sourceid</span><span class="p">()</span><span class="w"> </span><span class="si">}</span><span class="s2">"</span><span class="p">,</span>
<span class="s2">"Python"</span><span class="p">:</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="w"> </span><span class="n">sys</span><span class="o">.</span><span class="n">version</span><span class="w"> </span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="w"> </span><span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="w"> </span><span class="si">}</span><span class="s2">"</span><span class="p">,</span>
<span class="s2">"APSW"</span><span class="p">:</span> <span class="n">apsw</span><span class="o">.</span><span class="n">apsw_version</span><span class="p">(),</span>
<span class="s2">"APSW file"</span><span class="p">:</span> <span class="n">apsw</span><span class="o">.</span><span class="vm">__file__</span><span class="p">,</span>
<span class="s2">"Amalgamation"</span><span class="p">:</span> <span class="n">apsw</span><span class="o">.</span><span class="n">using_amalgamation</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">maxw</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">versions</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">versions</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">maxw</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">))</span> <span class="o">+</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="w"> </span><span class="n">k</span><span class="w"> </span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="w"> </span><span class="n">v</span><span class="si">}</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_vfsname</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="s2">"vfsname: VFS name for database, or attached names"</span>
<span class="n">dbnames</span> <span class="o">=</span> <span class="n">cmd</span> <span class="ow">or</span> <span class="p">[</span><span class="s2">"main"</span><span class="p">]</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">dbnames</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">vfsname</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">""</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_format_vfs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vfs</span><span class="p">):</span>
<span class="n">w</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">vfs</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">vfs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">w</span> <span class="o">-</span> <span class="nb">len</span><span class="p">(</span><span class="n">k</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">k</span> <span class="o">+</span> <span class="s2">": "</span><span class="p">)</span>
<span class="n">vout</span> <span class="o">=</span> <span class="s2">"0x</span><span class="si">%x</span><span class="s2">"</span> <span class="o">%</span> <span class="n">v</span> <span class="k">if</span> <span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"x"</span><span class="p">)</span> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_value</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_vfsinfo</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="s2">"vfsinfo: Shows detailed information about the VFS for the database"</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No parameters taken"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">vfs</span> <span class="ow">in</span> <span class="n">apsw</span><span class="o">.</span><span class="n">vfs_details</span><span class="p">():</span>
<span class="k">if</span> <span class="n">vfs</span><span class="p">[</span><span class="s2">"zName"</span><span class="p">]</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">open_vfs</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_format_vfs</span><span class="p">(</span><span class="n">vfs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_vfslist</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="s2">"vfslist: Shows detailed information about all the VFS available"</span>
<span class="k">if</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"No parameters taken"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">vfs</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">vfs_details</span><span class="p">()):</span>
<span class="k">if</span> <span class="n">i</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_format_vfs</span><span class="p">(</span><span class="n">vfs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">command_width</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""width NUM NUM ...: Set the column widths for "column" mode</span>
<span class="sd"> In "column" output mode, each column is a fixed width with values truncated to</span>
<span class="sd"> fit. Specify new widths using this command. Use a negative number</span>
<span class="sd"> to right justify and zero for default column width.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"You need to specify some widths!"</span><span class="p">)</span>
<span class="n">w</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">cmd</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">w</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">i</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"'</span><span class="si">%s</span><span class="s2">' is not a valid number"</span> <span class="o">%</span> <span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">widths</span> <span class="o">=</span> <span class="n">w</span>
<span class="k">def</span> <span class="nf">_terminal_width</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">minimum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Works out the terminal width which is used for word wrapping</span>
<span class="sd"> some output (eg .help)"""</span>
<span class="n">w</span> <span class="o">=</span> <span class="mi">80</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># we don't use shutil version because it can't be passed a</span>
<span class="c1"># file descriptor</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">():</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">get_terminal_size</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">fileno</span><span class="p">())</span><span class="o">.</span><span class="n">columns</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="nb">max</span><span class="p">(</span><span class="n">w</span><span class="p">,</span> <span class="n">minimum</span><span class="p">)</span>
<div class="viewcode-block" id="Shell.push_output">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.push_output">[docs]</a>
<span class="k">def</span> <span class="nf">push_output</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Saves the current output settings onto a stack. See</span>
<span class="sd"> :meth:`pop_output` for more details as to why you would use</span>
<span class="sd"> this."""</span>
<span class="n">o</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="s2">"separator"</span><span class="p">,</span> <span class="s2">"header"</span><span class="p">,</span> <span class="s2">"nullvalue"</span><span class="p">,</span> <span class="s2">"output"</span><span class="p">,</span> <span class="s2">"widths"</span><span class="p">,</span> <span class="s2">"truncate"</span><span class="p">:</span>
<span class="n">o</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_output_stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">o</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.pop_output">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.pop_output">[docs]</a>
<span class="k">def</span> <span class="nf">pop_output</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Restores most recently pushed output. There are many</span>
<span class="sd"> output parameters such as nullvalue, mode</span>
<span class="sd"> (list/tcl/html/insert etc), column widths, header etc. If you</span>
<span class="sd"> temporarily need to change some settings then</span>
<span class="sd"> :meth:`push_output`, change the settings and then pop the old</span>
<span class="sd"> ones back.</span>
<span class="sd"> A simple example is implementing a command like .dump. Push</span>
<span class="sd"> the current output, change the mode to insert so we get SQL</span>
<span class="sd"> inserts printed and then pop to go back to what was there</span>
<span class="sd"> before.</span>
<span class="sd"> """</span>
<span class="c1"># first item should always be present</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_output_stack</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_output_stack</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">o</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_stack</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">o</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">o</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_append_input_description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""When displaying an error in :meth:`handle_exception` we</span>
<span class="sd"> want to give context such as when the commands being executed</span>
<span class="sd"> came from a .read command (which in turn could execute another</span>
<span class="sd"> .read).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"Line </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_line_number</span><span class="p">,</span> <span class="p">))</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">": "</span> <span class="o">+</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">,</span> <span class="s2">"<stdin>"</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_input_descriptions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">res</span><span class="p">))</span>
<div class="viewcode-block" id="Shell.fixup_backslashes">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.fixup_backslashes">[docs]</a>
<span class="k">def</span> <span class="nf">fixup_backslashes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Implements the various backlash sequences in s such as</span>
<span class="sd"> turning backslash t into a tab.</span>
<span class="sd"> This function is needed because :mod:`shlex` does not do it for us.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span> <span class="k">return</span> <span class="n">s</span>
<span class="c1"># See the resolve_backslashes function in SQLite shell source</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">while</span> <span class="n">i</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>
<span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">continue</span>
<span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Backslash with nothing following"</span><span class="p">)</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"r"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\r</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"n"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span><span class="p">}</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
<span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c1"># advance again</span>
<span class="k">if</span> <span class="n">res</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Unknown backslash sequence </span><span class="se">\\</span><span class="s2">"</span> <span class="o">+</span> <span class="n">c</span><span class="p">)</span>
<span class="k">return</span> <span class="s2">""</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">res</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.write">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.write">[docs]</a>
<span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dest</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
<span class="s2">"Writes text to dest. dest will typically be one of self.stdout or self.stderr."</span>
<span class="n">dest</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.write_error">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.write_error">[docs]</a>
<span class="k">def</span> <span class="nf">write_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
<span class="s2">"Writes text to self.stderr colouring it"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">error</span> <span class="o">+</span> <span class="n">text</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">error_</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.write_value">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.write_value">[docs]</a>
<span class="k">def</span> <span class="nf">write_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">fmt</span><span class="o">=</span><span class="n">apsw</span><span class="o">.</span><span class="n">format_sql_value</span><span class="p">):</span>
<span class="s2">"Writes colourized value to self.stdout converting to text with fmt"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">colour_value</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">fmt</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span></div>
<span class="n">_raw_input</span> <span class="o">=</span> <span class="nb">input</span>
<div class="viewcode-block" id="Shell.get_line">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.get_line">[docs]</a>
<span class="k">def</span> <span class="nf">get_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prompt</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Returns a single line of input (may be incomplete SQL) from self.stdin.</span>
<span class="sd"> If EOF is reached then return None. Do not include trailing</span>
<span class="sd"> newline in return.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdin</span> <span class="ow">is</span> <span class="n">sys</span><span class="o">.</span><span class="n">stdin</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">prompt</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span><span class="o">.</span><span class="n">prompt_</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_using_readline</span><span class="p">:</span>
<span class="c1"># these are needed so that readline knows they are non-printing characters</span>
<span class="n">c</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\x01</span><span class="s2">"</span> <span class="o">+</span> <span class="n">c</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\x02</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\x01</span><span class="s2">"</span> <span class="o">+</span> <span class="n">c</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\x02</span><span class="s2">"</span><span class="p">,</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_raw_input</span><span class="p">(</span><span class="n">c</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">prompt</span> <span class="o">+</span> <span class="n">c</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="c1"># raw_input excludes newline</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="n">prompt</span><span class="p">)</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span> <span class="c1"># includes newline unless last line of file doesn't have one</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span> <span class="c1"># includes newline unless last line of file doesn't have one</span>
<span class="bp">self</span><span class="o">.</span><span class="n">input_line_number</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">except</span> <span class="ne">EOFError</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="c1"># always a \n on the end normally so this is EOF</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">line</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">:</span>
<span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="n">line</span></div>
<div class="viewcode-block" id="Shell.get_complete_line">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.get_complete_line">[docs]</a>
<span class="k">def</span> <span class="nf">get_complete_line</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Returns a complete input.</span>
<span class="sd"> For dot commands it will be one line. For SQL statements it</span>
<span class="sd"> will be as many as is necessary to have a</span>
<span class="sd"> :meth:`~apsw.complete` statement (ie semicolon terminated).</span>
<span class="sd"> Returns None on end of file."""</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_completion_first</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_line</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">prompt</span><span class="p">)</span>
<span class="k">if</span> <span class="n">command</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">command</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">""</span>
<span class="k">if</span> <span class="n">command</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"?"</span><span class="p">:</span> <span class="n">command</span> <span class="o">=</span> <span class="s2">".help "</span> <span class="o">+</span> <span class="n">command</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="c1"># incomplete SQL?</span>
<span class="k">while</span> <span class="n">command</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s2">"."</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">apsw</span><span class="o">.</span><span class="n">complete</span><span class="p">(</span><span class="n">command</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_completion_first</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_line</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">moreprompt</span><span class="p">)</span>
<span class="k">if</span> <span class="n">line</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># unexpected eof</span>
<span class="k">raise</span> <span class="bp">self</span><span class="o">.</span><span class="n">Error</span><span class="p">(</span><span class="s2">"Incomplete SQL (line </span><span class="si">%d</span><span class="s2"> of </span><span class="si">%s</span><span class="s2">): </span><span class="si">%s</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_line_number</span><span class="p">,</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdin</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">,</span> <span class="s2">"<stdin>"</span><span class="p">),</span> <span class="n">command</span><span class="p">))</span>
<span class="k">if</span> <span class="n">line</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"go"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">):</span>
<span class="k">break</span>
<span class="n">command</span> <span class="o">=</span> <span class="n">command</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">line</span>
<span class="k">return</span> <span class="n">command</span>
<span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handle_interrupt</span><span class="p">()</span>
<span class="k">return</span> <span class="s2">""</span></div>
<div class="viewcode-block" id="Shell.handle_interrupt">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.handle_interrupt">[docs]</a>
<span class="k">def</span> <span class="nf">handle_interrupt</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Deal with keyboard interrupt (typically Control-C). It</span>
<span class="sd"> will :meth:`~apsw.Connection.interrupt` the database and print"^C" if interactive."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">interrupt</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">bail</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">interactive</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"^C</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">raise</span></div>
<div class="viewcode-block" id="Shell.process_complete_line">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.process_complete_line">[docs]</a>
<span class="k">def</span> <span class="nf">process_complete_line</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Given some text will call the appropriate method to process</span>
<span class="sd"> it (eg :meth:`process_sql` or :meth:`process_command`)"""</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">command</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">command</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"."</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_command</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">process_sql</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handle_interrupt</span><span class="p">()</span></div>
<div class="viewcode-block" id="Shell.push_input">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.push_input">[docs]</a>
<span class="k">def</span> <span class="nf">push_input</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Saves the current input parameters to a stack. See :meth:`pop_input`."""</span>
<span class="n">d</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="s2">"interactive"</span><span class="p">,</span> <span class="s2">"stdin"</span><span class="p">,</span> <span class="s2">"input_line_number"</span><span class="p">:</span>
<span class="n">d</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_input_stack</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">d</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.pop_input">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.pop_input">[docs]</a>
<span class="k">def</span> <span class="nf">pop_input</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Restore most recently pushed input parameters (interactive,</span>
<span class="sd"> self.stdin, linenumber etc). Use this if implementing a</span>
<span class="sd"> command like read. Push the current input, read the file and</span>
<span class="sd"> then pop the input to go back to before.</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_input_stack</span><span class="p">))</span> <span class="o">></span> <span class="mi">1</span>
<span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_stack</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">d</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span></div>
<div class="viewcode-block" id="Shell.complete">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.complete">[docs]</a>
<span class="k">def</span> <span class="nf">complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return a possible completion for :mod:`readline`</span>
<span class="sd"> This function is called with state starting at zero to get the</span>
<span class="sd"> first completion, then one/two/three etc until you return None. The best</span>
<span class="sd"> implementation is to generate the list when state==0, save it,</span>
<span class="sd"> and provide members on each increase.</span>
<span class="sd"> The default implementation extracts the current full input</span>
<span class="sd"> from readline and then calls :meth:`complete_command` or</span>
<span class="sd"> :meth:`complete_sql` as appropriate saving the results for</span>
<span class="sd"> subsequent calls.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">state</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">readline</span>
<span class="c1"># the whole line</span>
<span class="n">line</span> <span class="o">=</span> <span class="n">readline</span><span class="o">.</span><span class="n">get_line_buffer</span><span class="p">()</span>
<span class="c1"># beginning and end(+1) of the token in line</span>
<span class="n">beg</span> <span class="o">=</span> <span class="n">readline</span><span class="o">.</span><span class="n">get_begidx</span><span class="p">()</span>
<span class="n">end</span> <span class="o">=</span> <span class="n">readline</span><span class="o">.</span><span class="n">get_endidx</span><span class="p">()</span>
<span class="c1"># Are we matching a command?</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_completion_first</span> <span class="ow">and</span> <span class="n">line</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"."</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">completions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">complete_command</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">beg</span><span class="p">,</span> <span class="n">end</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">completions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">complete_sql</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">beg</span><span class="p">,</span> <span class="n">end</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="c1"># Readline swallows any exceptions we raise. We</span>
<span class="c1"># shouldn't be raising any so this is to catch that</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
<span class="k">raise</span>
<span class="k">if</span> <span class="n">state</span> <span class="o">></span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">completions</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">completions</span><span class="p">[</span><span class="n">state</span><span class="p">]</span></div>
<span class="n">_sqlite_keywords</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">keywords</span>
<span class="c1"># reserved words need to be quoted. Only a subset of the keywords are reserved</span>
<span class="c1"># but what the heck</span>
<span class="n">_sqlite_reserved</span> <span class="o">=</span> <span class="n">_sqlite_keywords</span>
<span class="c1"># add a space after each of them except functions which get parentheses</span>
<span class="n">_sqlite_keywords</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="o">+</span> <span class="p">(</span><span class="s2">" "</span><span class="p">,</span> <span class="s2">"("</span><span class="p">)[</span><span class="n">x</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"VALUES"</span><span class="p">,</span> <span class="s2">"CAST"</span><span class="p">)]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">_sqlite_keywords</span><span class="p">]</span>
<span class="n">_sqlite_special_names</span> <span class="o">=</span> <span class="s2">"""_ROWID_ OID ROWID sqlite_schema</span>
<span class="s2"> SQLITE_SEQUENCE"""</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
<span class="n">_pragmas_bool</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"yes"</span><span class="p">,</span> <span class="s2">"true"</span><span class="p">,</span> <span class="s2">"on"</span><span class="p">,</span> <span class="s2">"no"</span><span class="p">,</span> <span class="s2">"false"</span><span class="p">,</span> <span class="s2">"off"</span><span class="p">)</span>
<span class="n">_pragmas</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"analysis_limit="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"application_id"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"auto_vacuum="</span><span class="p">:</span> <span class="p">(</span><span class="s2">"NONE"</span><span class="p">,</span> <span class="s2">"FULL"</span><span class="p">,</span> <span class="s2">"INCREMENTAL"</span><span class="p">),</span>
<span class="s2">"automatic_index="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"busy_timeout="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"cache_size="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"case_sensitive_like="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"cache_spill="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"cell_size_check="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"checkpoint_fullfsync="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"collation_list"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"compile_options"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"data_version"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"database_list"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"defer_foreign_keys="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"encoding="</span><span class="p">:</span> <span class="p">(</span><span class="s1">'UTF-8'</span><span class="p">,</span> <span class="s1">'UTF-16'</span><span class="p">,</span> <span class="s1">'UTF-16le'</span><span class="p">,</span> <span class="s1">'UTF16-16be'</span><span class="p">),</span>
<span class="s2">"foreign_key_check"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"foreign_key_list("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"foreign_keys"</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"freelist_count"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"fullfsync="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"function_list"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"hard_heap_limit="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"ignore_check_constraints"</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"incremental_vacuum("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"index_info("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"index_list("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"index_xinfo("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"integrity_check"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"journal_mode="</span><span class="p">:</span> <span class="p">(</span><span class="s2">"DELETE"</span><span class="p">,</span> <span class="s2">"TRUNCATE"</span><span class="p">,</span> <span class="s2">"PERSIST"</span><span class="p">,</span> <span class="s2">"MEMORY"</span><span class="p">,</span> <span class="s2">"OFF"</span><span class="p">,</span> <span class="s2">"WAL"</span><span class="p">),</span>
<span class="s2">"journal_size_limit="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"legacy_alter_table="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"legacy_file_format="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"locking_mode="</span><span class="p">:</span> <span class="p">(</span><span class="s2">"NORMAL"</span><span class="p">,</span> <span class="s2">"EXCLUSIVE"</span><span class="p">),</span>
<span class="s2">"max_page_count="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"mmap_size="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"module_list"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"optimize("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"page_count;"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"page_size="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"pragma_list;"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"query_only="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"quick_check"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"read_uncommitted="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"recursive_triggers="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"reverse_unordered_selects="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"schema_version"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"secure_delete="</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"shrink_memory"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"soft_heap_limit="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"synchronous="</span><span class="p">:</span> <span class="p">(</span><span class="s2">"OFF"</span><span class="p">,</span> <span class="s2">"NORMAL"</span><span class="p">,</span> <span class="s2">"FULL"</span><span class="p">),</span>
<span class="s2">"table_info("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"table_list"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"table_xinfo("</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"temp_store="</span><span class="p">:</span> <span class="p">(</span><span class="s2">"DEFAULT"</span><span class="p">,</span> <span class="s2">"FILE"</span><span class="p">,</span> <span class="s2">"MEMORY"</span><span class="p">),</span>
<span class="s2">"threads="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"trusted_schema"</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="s2">"user_version="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"wal_autocheckpoint="</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"wal_checkpoint"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"writable_schema"</span><span class="p">:</span> <span class="n">_pragmas_bool</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">def</span> <span class="nf">_get_prev_tokens</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
<span class="s2">"Returns the tokens prior to pos end in the line"</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="sa">r</span><span class="s1">'"?\w+"?'</span><span class="p">,</span> <span class="n">line</span><span class="p">[:</span><span class="n">end</span><span class="p">])</span>
<div class="viewcode-block" id="Shell.complete_sql">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.complete_sql">[docs]</a>
<span class="k">def</span> <span class="nf">complete_sql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">beg</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Provide some completions for SQL</span>
<span class="sd"> :param line: The current complete input line</span>
<span class="sd"> :param token: The word readline is looking for matches</span>
<span class="sd"> :param beg: Integer offset of token in line</span>
<span class="sd"> :param end: Integer end of token in line</span>
<span class="sd"> :return: A list of completions, or an empty list if none</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_completion_cache</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">cur</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">collations</span> <span class="o">=</span> <span class="p">[</span><span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma collation_list"</span><span class="p">)]</span>
<span class="n">databases</span> <span class="o">=</span> <span class="p">[</span><span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma database_list"</span><span class="p">)]</span>
<span class="n">other</span> <span class="o">=</span> <span class="p">[</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma module_list"</span><span class="p">)]</span>
<span class="k">for</span> <span class="n">db</span> <span class="ow">in</span> <span class="n">databases</span><span class="p">:</span>
<span class="k">if</span> <span class="n">db</span> <span class="o">==</span> <span class="s2">"temp"</span><span class="p">:</span>
<span class="n">master</span> <span class="o">=</span> <span class="s2">"sqlite_temp_schema"</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">master</span> <span class="o">=</span> <span class="s2">"[</span><span class="si">%s</span><span class="s2">].sqlite_schema"</span> <span class="o">%</span> <span class="p">(</span><span class="n">db</span><span class="p">,</span> <span class="p">)</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"select * from "</span> <span class="o">+</span> <span class="n">master</span><span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">():</span>
<span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">):</span>
<span class="k">if</span> <span class="n">row</span><span class="p">[</span><span class="n">col</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">other</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">row</span><span class="p">[</span><span class="n">col</span><span class="p">]</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"sqlite_"</span><span class="p">):</span>
<span class="n">other</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="n">col</span><span class="p">])</span>
<span class="k">if</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"table"</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma [</span><span class="si">%s</span><span class="s2">].table_info([</span><span class="si">%s</span><span class="s2">])"</span> <span class="o">%</span> <span class="p">(</span>
<span class="n">db</span><span class="p">,</span>
<span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span>
<span class="p">))</span><span class="o">.</span><span class="n">fetchall</span><span class="p">():</span>
<span class="k">if</span> <span class="n">table</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">other</span><span class="p">:</span>
<span class="n">other</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">table</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">table</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">():</span>
<span class="k">if</span> <span class="n">item</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">other</span><span class="p">:</span>
<span class="n">other</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
<span class="k">except</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLError</span><span class="p">:</span>
<span class="c1"># See https://github.com/rogerbinns/apsw/issues/86</span>
<span class="k">pass</span>
<span class="n">functions</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"pragma function_list"</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">narg</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span>
<span class="n">functions</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">narg</span><span class="p">,</span> <span class="n">functions</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">fmtfunc</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">nargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">nargs</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">name</span> <span class="o">+</span> <span class="s2">"()"</span>
<span class="k">return</span> <span class="n">name</span> <span class="o">+</span> <span class="s2">"("</span>
<span class="n">func_list</span> <span class="o">=</span> <span class="p">[</span><span class="n">fmtfunc</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">narg</span><span class="p">)</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">narg</span> <span class="ow">in</span> <span class="n">functions</span><span class="o">.</span><span class="n">items</span><span class="p">()]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_completion_cache</span> <span class="o">=</span> <span class="p">[</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_sqlite_keywords</span><span class="p">,</span> <span class="n">func_list</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sqlite_special_names</span><span class="p">,</span> <span class="n">collations</span><span class="p">,</span> <span class="n">databases</span><span class="p">,</span> <span class="n">other</span>
<span class="p">]</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_completion_cache</span><span class="p">)):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_completion_cache</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="c1"># be somewhat sensible about pragmas</span>
<span class="k">if</span> <span class="s2">"pragma "</span> <span class="ow">in</span> <span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_prev_tokens</span><span class="p">(</span><span class="n">line</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="n">end</span><span class="p">)</span>
<span class="c1"># pragma foo = bar</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">></span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"pragma"</span><span class="p">:</span>
<span class="c1"># t[-2] should be a valid one</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pragmas</span><span class="p">:</span>
<span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"="</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> <span class="o">==</span> <span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]:</span>
<span class="n">vals</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pragmas</span><span class="p">[</span><span class="n">p</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vals</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="k">return</span> <span class="p">[</span><span class="n">x</span> <span class="o">+</span> <span class="s2">";"</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">vals</span> <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">)]</span>
<span class="c1"># at equals?</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"pragma"</span> <span class="ow">and</span> <span class="n">line</span><span class="p">[:</span><span class="n">end</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">" "</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"="</span><span class="p">):</span>
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pragmas</span><span class="p">:</span>
<span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"="</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> <span class="o">==</span> <span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">vals</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pragmas</span><span class="p">[</span><span class="n">p</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">vals</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="k">return</span> <span class="n">vals</span>
<span class="c1"># pragma foo</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"pragma"</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pragmas</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">)]</span>
<span class="n">res</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">return</span> <span class="n">res</span>
<span class="c1"># pragma</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="ow">and</span> <span class="n">t</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"pragma"</span><span class="p">:</span>
<span class="n">res</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_pragmas</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="n">res</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">return</span> <span class="n">res</span>
<span class="c1"># This is currently not context sensitive (eg it doesn't look</span>
<span class="c1"># to see if last token was 'FROM' and hence next should only</span>
<span class="c1"># be table names. That is a SMOP like pragmas above</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">ut</span> <span class="o">=</span> <span class="n">token</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">for</span> <span class="n">corpus</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_completion_cache</span><span class="p">:</span>
<span class="k">for</span> <span class="n">word</span> <span class="ow">in</span> <span class="n">corpus</span><span class="p">:</span>
<span class="k">if</span> <span class="n">word</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">ut</span><span class="p">):</span>
<span class="c1"># potential match - now match case</span>
<span class="k">if</span> <span class="n">word</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">):</span> <span class="c1"># exact</span>
<span class="k">if</span> <span class="n">word</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">word</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">word</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">):</span> <span class="c1"># lower</span>
<span class="k">if</span> <span class="n">word</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">word</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">word</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">):</span> <span class="c1"># upper</span>
<span class="k">if</span> <span class="n">word</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">word</span><span class="o">.</span><span class="n">upper</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># match letter by letter otherwise readline mangles what was typed in</span>
<span class="n">w</span> <span class="o">=</span> <span class="n">token</span> <span class="o">+</span> <span class="n">word</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">token</span><span class="p">):]</span>
<span class="k">if</span> <span class="n">w</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
<span class="n">res</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">w</span><span class="p">)</span>
<span class="k">return</span> <span class="n">res</span></div>
<span class="c1"># completion for the dot commands are messy because some take</span>
<span class="c1"># variable numbers of parameters and the meanings of the</span>
<span class="c1"># parameters differ depending on how many there are. so</span>
<span class="c1"># we make some effort for some of the commands</span>
<span class="n">_command_params</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"bail"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
<span class="s2">"changes"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
<span class="s2">"echo"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
<span class="s2">"exceptions"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
<span class="s2">"header"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
<span class="s2">"timer"</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">_command_params</span><span class="p">[</span><span class="s2">"headers"</span><span class="p">]</span> <span class="o">=</span> <span class="n">_command_params</span><span class="p">[</span><span class="s2">"header"</span><span class="p">]</span>
<span class="n">_builtin_commands</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="Shell.complete_command">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.complete_command">[docs]</a>
<span class="k">def</span> <span class="nf">complete_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">beg</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Provide some completions for dot commands</span>
<span class="sd"> :param line: The current complete input line</span>
<span class="sd"> :param token: The word readline is looking for matches</span>
<span class="sd"> :param beg: Integer offset of token in line</span>
<span class="sd"> :param end: Integer end of token in line</span>
<span class="sd"> :return: A list of completions, or an empty list if none</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_builtin_commands</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_builtin_commands</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">"."</span> <span class="o">+</span> <span class="n">x</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"command_"</span><span class="p">):]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"command_"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">x</span> <span class="o">!=</span> <span class="s2">"command_headers"</span>
<span class="p">]</span>
<span class="n">t</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_prev_tokens</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="n">end</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">1</span> <span class="ow">and</span> <span class="n">token</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">x</span> <span class="o">+</span> <span class="s2">" "</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_builtin_commands</span> <span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">)]</span>
<span class="n">completions</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"colour"</span><span class="p">,</span> <span class="s2">"color"</span><span class="p">}:</span>
<span class="n">completions</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">elif</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">{</span><span class="s2">"mode"</span><span class="p">}:</span>
<span class="n">completions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_modes</span>
<span class="k">elif</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"help"</span><span class="p">:</span>
<span class="n">completions</span> <span class="o">=</span> <span class="p">[</span><span class="n">v</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_builtin_commands</span><span class="p">]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">"all"</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"dbconfig"</span><span class="p">:</span>
<span class="n">completions</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">v</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"SQLITE_DBCONFIG_"</span><span class="p">):]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">apsw</span><span class="o">.</span><span class="n">mapping_db_config</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="n">v</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dbconfig_ignore</span>
<span class="p">]</span>
<span class="k">elif</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"parameter"</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">or</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">token</span><span class="p">):</span>
<span class="n">completions</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"clear"</span><span class="p">,</span> <span class="s2">"list"</span><span class="p">,</span> <span class="s2">"unset "</span><span class="p">,</span> <span class="s2">"set "</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">t</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"unset"</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">or</span> <span class="n">token</span><span class="p">):</span>
<span class="n">completions</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bindings</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_command_params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">bool</span><span class="p">:</span>
<span class="n">completions</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"on"</span><span class="p">,</span> <span class="s2">"off"</span><span class="p">,</span> <span class="s2">"ON"</span><span class="p">,</span> <span class="s2">"OFF"</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_command_params</span><span class="p">:</span>
<span class="n">completions</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_command_params</span><span class="p">[</span><span class="n">t</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
<span class="k">return</span> <span class="p">[</span><span class="n">v</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">completions</span><span class="p">)</span> <span class="k">if</span> <span class="n">v</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">token</span><span class="p">)</span> <span class="ow">and</span> <span class="n">v</span> <span class="o">!=</span> <span class="n">token</span><span class="p">]</span></div>
<div class="viewcode-block" id="Shell.get_resource_usage">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.get_resource_usage">[docs]</a>
<span class="k">def</span> <span class="nf">get_resource_usage</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return a dict of various numbers (ints or floats). The</span>
<span class="sd"> .timer command shows the difference between before and after</span>
<span class="sd"> results of what this returns by calling :meth:`display_timing`"""</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">"win32"</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">ctypes</span>
<span class="kn">import</span> <span class="nn">platform</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetProcessTimes</span><span class="o">.</span><span class="n">argtypes</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">platform</span><span class="o">.</span><span class="n">architecture</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'64bit'</span> <span class="ow">and</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int64</span> <span class="ow">or</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_int32</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">,</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_void_p</span>
<span class="p">]</span>
<span class="c1"># All 4 out params have to be present. FILETIME is really</span>
<span class="c1"># just a 64 bit quantity in 100 nanosecond granularity</span>
<span class="n">dummy</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_ulonglong</span><span class="p">()</span>
<span class="n">utime</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_ulonglong</span><span class="p">()</span>
<span class="n">stime</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">c_ulonglong</span><span class="p">()</span>
<span class="n">rc</span> <span class="o">=</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetProcessTimes</span><span class="p">(</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">windll</span><span class="o">.</span><span class="n">kernel32</span><span class="o">.</span><span class="n">GetCurrentProcess</span><span class="p">(),</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">dummy</span><span class="p">),</span> <span class="c1"># creation time</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">dummy</span><span class="p">),</span> <span class="c1"># exit time</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">stime</span><span class="p">),</span>
<span class="n">ctypes</span><span class="o">.</span><span class="n">byref</span><span class="p">(</span><span class="n">utime</span><span class="p">))</span>
<span class="k">if</span> <span class="n">rc</span><span class="p">:</span>
<span class="k">return</span> <span class="p">{</span>
<span class="s1">'Wall clock'</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span>
<span class="s1">'User time'</span><span class="p">:</span> <span class="nb">float</span><span class="p">(</span><span class="n">utime</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> <span class="o">/</span> <span class="mi">10000000</span><span class="p">,</span>
<span class="s1">'System time'</span><span class="p">:</span> <span class="nb">float</span><span class="p">(</span><span class="n">stime</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> <span class="o">/</span> <span class="mi">10000000</span>
<span class="p">}</span>
<span class="k">return</span> <span class="p">{}</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">resource</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">resource</span><span class="o">.</span><span class="n">getrusage</span><span class="p">(</span><span class="n">resource</span><span class="o">.</span><span class="n">RUSAGE_SELF</span><span class="p">)</span>
<span class="n">res</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'Wall clock'</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()}</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">desc</span> <span class="ow">in</span> <span class="p">(</span>
<span class="p">(</span><span class="s2">"utime"</span><span class="p">,</span> <span class="s2">"User time"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"stime"</span><span class="p">,</span> <span class="s2">"System time"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"maxrss"</span><span class="p">,</span> <span class="s2">"Max rss"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"idrss"</span><span class="p">,</span> <span class="s2">"Memory"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"isrss"</span><span class="p">,</span> <span class="s2">"Stack"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"ixrss"</span><span class="p">,</span> <span class="s2">"Shared Memory"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"minflt"</span><span class="p">,</span> <span class="s2">"PF (no I/O)"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"majflt"</span><span class="p">,</span> <span class="s2">"PF (I/O)"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"inblock"</span><span class="p">,</span> <span class="s2">"Blocks in"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"oublock"</span><span class="p">,</span> <span class="s2">"Blocks out"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"nsignals"</span><span class="p">,</span> <span class="s2">"Signals"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"nvcsw"</span><span class="p">,</span> <span class="s2">"Voluntary context switches"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"nivcsw"</span><span class="p">,</span> <span class="s2">"Involunary context switches"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"msgrcv"</span><span class="p">,</span> <span class="s2">"Messages received"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"msgsnd"</span><span class="p">,</span> <span class="s2">"Messages sent"</span><span class="p">),</span>
<span class="p">(</span><span class="s2">"nswap"</span><span class="p">,</span> <span class="s2">"Swaps"</span><span class="p">),</span>
<span class="p">):</span>
<span class="n">f</span> <span class="o">=</span> <span class="s2">"ru_"</span> <span class="o">+</span> <span class="n">i</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
<span class="n">res</span><span class="p">[</span><span class="n">desc</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span>
<span class="k">return</span> <span class="n">res</span></div>
<div class="viewcode-block" id="Shell.display_timing">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.display_timing">[docs]</a>
<span class="k">def</span> <span class="nf">display_timing</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">before</span><span class="p">,</span> <span class="n">after</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Writes the difference between before and after to self.stderr.</span>
<span class="sd"> The data is dictionaries returned from</span>
<span class="sd"> :meth:`get_resource_usage`."""</span>
<span class="n">v</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">before</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">after</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span>
<span class="n">v</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="n">v</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">v</span><span class="p">:</span>
<span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">before</span> <span class="ow">and</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">after</span><span class="p">:</span>
<span class="n">one</span> <span class="o">=</span> <span class="n">before</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
<span class="n">two</span> <span class="o">=</span> <span class="n">after</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">two</span> <span class="o">-</span> <span class="n">one</span>
<span class="k">if</span> <span class="n">val</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">float</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"+ </span><span class="si">%s</span><span class="s2">: </span><span class="si">%.4f</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">val</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="s2">"+ </span><span class="si">%s</span><span class="s2">: </span><span class="si">%d</span><span class="se">\n</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">val</span><span class="p">))</span></div>
<span class="c1">### Output helpers</span>
<div class="viewcode-block" id="Shell.Row">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.Row">[docs]</a>
<span class="nd">@dataclasses</span><span class="o">.</span><span class="n">dataclass</span><span class="p">(</span><span class="o">**</span><span class="p">({</span><span class="s2">"slots"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s2">"frozen"</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span> <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span> <span class="k">else</span> <span class="p">{}))</span>
<span class="k">class</span> <span class="nc">Row</span><span class="p">:</span>
<span class="s2">"Returned by :class:`Shell.PositionRow`"</span>
<span class="n">is_first</span><span class="p">:</span> <span class="nb">bool</span>
<span class="n">is_last</span><span class="p">:</span> <span class="nb">bool</span>
<span class="n">row</span><span class="p">:</span> <span class="n">apsw</span><span class="o">.</span><span class="n">SQLiteValues</span>
<span class="n">columns</span><span class="p">:</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span></div>
<div class="viewcode-block" id="Shell.PositionRow">
<a class="viewcode-back" href="../../shell.html#apsw.shell.Shell.PositionRow">[docs]</a>
<span class="k">class</span> <span class="nc">PositionRow</span><span class="p">:</span>
<span class="s2">"Wraps an iterator so you know if a row is first, last, both, or neither"</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">source</span> <span class="o">=</span> <span class="n">source</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rows</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">end</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">columns</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">h</span> <span class="k">for</span> <span class="n">h</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">source</span><span class="o">.</span><span class="n">get_description</span><span class="p">())</span>
<span class="k">except</span> <span class="n">apsw</span><span class="o">.</span><span class="n">ExecutionCompleteError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">columns</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="fm">__next__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">end</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">StopIteration</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
<span class="n">row</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">(</span><span class="n">is_first</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">is_last</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">row</span><span class="o">=</span><span class="n">row</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">columns</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">(</span><span class="n">is_first</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">is_last</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">row</span><span class="o">=</span><span class="n">row</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">columns</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">next</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">source</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">StopIteration</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">end</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">next</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">index</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">(</span><span class="n">is_first</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">is_last</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">row</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="n">columns</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">columns</span><span class="p">)</span>
<span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span>
<span class="k">return</span> <span class="n">Shell</span><span class="o">.</span><span class="n">Row</span><span class="p">(</span><span class="n">is_first</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">is_last</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">row</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">rows</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="n">columns</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">columns</span><span class="p">)</span></div>
<span class="c1">### Colour support</span>
<span class="k">def</span> <span class="nf">_out_colour</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Sets up color for output. Input being interactive doesn't</span>
<span class="c1"># matter. This method needs to be called on all changes to</span>
<span class="c1"># output.</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> <span class="s2">"isatty"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">isatty</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colour</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">colour_scheme</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colour</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_colours</span><span class="p">[</span><span class="s2">"off"</span><span class="p">]</span>
<span class="c1"># This class returns an empty string for all undefined attributes</span>
<span class="c1"># so that it doesn't matter if a colour scheme leaves something</span>
<span class="c1"># out.</span>
<span class="k">class</span> <span class="nc">_colourscheme</span><span class="p">:</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__nonzero__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"_colourscheme("</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="nb">vars</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span> <span class="o">+</span> <span class="s2">")"</span>
<span class="k">def</span> <span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">""</span>
<span class="k">def</span> <span class="nf">colour_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">val</span><span class="p">,</span> <span class="n">formatted</span><span class="p">):</span>
<span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">colour</span>
<span class="k">if</span> <span class="n">val</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">vnull</span> <span class="o">+</span> <span class="n">formatted</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">vnull_</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">vstring</span> <span class="o">+</span> <span class="n">formatted</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">vstring_</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">vblob</span> <span class="o">+</span> <span class="n">formatted</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">vblob_</span>
<span class="c1"># must be a number - we don't distinguish between float/int</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">vnumber</span> <span class="o">+</span> <span class="n">formatted</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">vnumber_</span>
<span class="c1"># The colour definitions - the convention is the name to turn</span>
<span class="c1"># something on and the name with an underscore suffix to turn it</span>
<span class="c1"># off</span>
<span class="n">d</span> <span class="o">=</span> <span class="n">_colourscheme</span><span class="p">(</span><span class="o">**</span><span class="nb">dict</span><span class="p">([(</span><span class="n">v</span><span class="p">,</span> <span class="s2">"</span><span class="se">\x1b</span><span class="s2">["</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"m"</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="p">{</span>
<span class="mi">0</span><span class="p">:</span> <span class="s2">"reset"</span><span class="p">,</span>
<span class="mi">1</span><span class="p">:</span> <span class="s2">"bold"</span><span class="p">,</span>
<span class="mi">4</span><span class="p">:</span> <span class="s2">"underline"</span><span class="p">,</span>
<span class="mi">22</span><span class="p">:</span> <span class="s2">"bold_"</span><span class="p">,</span>
<span class="mi">24</span><span class="p">:</span> <span class="s2">"underline_"</span><span class="p">,</span>
<span class="mi">7</span><span class="p">:</span> <span class="s2">"inverse"</span><span class="p">,</span>
<span class="mi">27</span><span class="p">:</span> <span class="s2">"inverse_"</span><span class="p">,</span>
<span class="mi">30</span><span class="p">:</span> <span class="s2">"fg_black"</span><span class="p">,</span>
<span class="mi">31</span><span class="p">:</span> <span class="s2">"fg_red"</span><span class="p">,</span>
<span class="mi">32</span><span class="p">:</span> <span class="s2">"fg_green"</span><span class="p">,</span>
<span class="mi">33</span><span class="p">:</span> <span class="s2">"fg_yellow"</span><span class="p">,</span>
<span class="mi">34</span><span class="p">:</span> <span class="s2">"fg_blue"</span><span class="p">,</span>
<span class="mi">35</span><span class="p">:</span> <span class="s2">"fg_magenta"</span><span class="p">,</span>
<span class="mi">36</span><span class="p">:</span> <span class="s2">"fg_cyan"</span><span class="p">,</span>
<span class="mi">37</span><span class="p">:</span> <span class="s2">"fg_white"</span><span class="p">,</span>
<span class="mi">39</span><span class="p">:</span> <span class="s2">"fg_"</span><span class="p">,</span>
<span class="mi">40</span><span class="p">:</span> <span class="s2">"bg_black"</span><span class="p">,</span>
<span class="mi">41</span><span class="p">:</span> <span class="s2">"bg_red"</span><span class="p">,</span>
<span class="mi">42</span><span class="p">:</span> <span class="s2">"bg_green"</span><span class="p">,</span>
<span class="mi">43</span><span class="p">:</span> <span class="s2">"bg_yellow"</span><span class="p">,</span>
<span class="mi">44</span><span class="p">:</span> <span class="s2">"bg_blue"</span><span class="p">,</span>
<span class="mi">45</span><span class="p">:</span> <span class="s2">"bg_magenta"</span><span class="p">,</span>
<span class="mi">46</span><span class="p">:</span> <span class="s2">"bg_cyan"</span><span class="p">,</span>
<span class="mi">47</span><span class="p">:</span> <span class="s2">"bg_white"</span><span class="p">,</span>
<span class="mi">49</span><span class="p">:</span> <span class="s2">"bg_"</span>
<span class="p">}</span><span class="o">.</span><span class="n">items</span><span class="p">()]))</span>
<span class="n">_colours</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"off"</span><span class="p">:</span> <span class="n">_colourscheme</span><span class="p">(</span><span class="n">colour_value</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">:</span> <span class="n">y</span><span class="p">)}</span>
<span class="n">_colours</span><span class="p">[</span><span class="s2">"default"</span><span class="p">]</span> <span class="o">=</span> <span class="n">_colourscheme</span><span class="p">(</span><span class="n">prompt</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">bold</span><span class="p">,</span>
<span class="n">prompt_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">bold_</span><span class="p">,</span>
<span class="n">error</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_red</span> <span class="o">+</span> <span class="n">d</span><span class="o">.</span><span class="n">bold</span><span class="p">,</span>
<span class="n">error_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">bold_</span> <span class="o">+</span> <span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">intro</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_blue</span> <span class="o">+</span> <span class="n">d</span><span class="o">.</span><span class="n">bold</span><span class="p">,</span>
<span class="n">intro_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">bold_</span> <span class="o">+</span> <span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">transient</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_green</span><span class="p">,</span>
<span class="n">transient_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">summary</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_blue</span> <span class="o">+</span> <span class="n">d</span><span class="o">.</span><span class="n">bold</span><span class="p">,</span>
<span class="n">summary_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">bold_</span> <span class="o">+</span> <span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">header</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">underline</span><span class="p">,</span>
<span class="n">header_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">underline_</span><span class="p">,</span>
<span class="n">vnull</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_red</span><span class="p">,</span>
<span class="n">vnull_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">vstring</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_yellow</span><span class="p">,</span>
<span class="n">vstring_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">vblob</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_blue</span><span class="p">,</span>
<span class="n">vblob_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">,</span>
<span class="n">vnumber</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_magenta</span><span class="p">,</span>
<span class="n">vnumber_</span><span class="o">=</span><span class="n">d</span><span class="o">.</span><span class="n">fg_</span><span class="p">)</span>
<span class="c1"># unpollute namespace</span>
<span class="k">del</span> <span class="n">d</span>
<span class="k">del</span> <span class="n">_colourscheme</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">del</span> <span class="n">n</span>
<span class="k">del</span> <span class="n">x</span>
<span class="k">del</span> <span class="n">v</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="main">
<a class="viewcode-back" href="../../shell.html#apsw.shell.main">[docs]</a>
<span class="k">def</span> <span class="nf">main</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Docstring must start on second line so dedenting works correctly</span>
<span class="w"> </span><span class="sd">"""</span>
<span class="sd"> Call this to run the :ref:`interactive shell <shell>`. It</span>
<span class="sd"> automatically passes in sys.argv[1:] and exits Python when done.</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">Shell</span><span class="p">()</span>
<span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">cmds</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">process_args</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmds</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">s</span><span class="o">.</span><span class="n">cmdloop</span><span class="p">()</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="ne">SystemExit</span><span class="p">):</span>
<span class="k">raise</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">v</span><span class="p">,</span> <span class="s2">"_handle_exception_saw_this"</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Where did this exception come from?</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span></div>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">'__main__'</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© <a href="../../copyright.html">Copyright</a> 2004-2024, Roger Binns <rogerb@rogerbinns.com>.
<span class="lastupdated">Last updated on Jun 16, 2024.
</span></p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
