summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/piton/piton-french.tex
blob: cd1c2745afc872cd86c6aa61a2d965ca4d55a929 (plain)
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
% -*- coding: utf-8 ; -*-
\documentclass[dvipsnames,svgnames]{article}

\usepackage{fontspec}

\usepackage[french]{babel}
\frenchsetup{og = « , fg = »}

\usepackage[footnotehyper]{piton}
\PitonOptions
  { 
    splittable = 4 ,
    math-comments,
    begin-escape = ! ,
    end-escape = ! ,
    begin-escape-math = \( , 
    end-escape-math = \) ,
    detected-commands = highLight 
  }


\usepackage[executable=python.exe]{pyluatex}

\usepackage{xcolor}

\usepackage{geometry}
\geometry{left=2.8cm,right=2.8cm,top=2.5cm,bottom=2.5cm,papersize={21cm,29.7cm}}

\usepackage{enumitem}
\usepackage{verbatim}
\usepackage{amsmath}
\usepackage{tabularx}
\usepackage{booktabs}
\usepackage{tcolorbox}
\usepackage{luacolor,lua-ul}


\usepackage{caption}

% We use \MakeShortVerb of shortvrb and not \DefineShortVerb of fancyvrb
% because we don't want the contents of short verbatim colored in gray
\usepackage{shortvrb}
\MakeShortVerb{\|}

\usepackage{varwidth}

\skip\footins = 2\bigskipamount

\usepackage{fancyvrb}
\fvset{commandchars=\~\#\@,formatcom=\color{gray}}
\def\emphase{\bgroup\color{RoyalPurple}\let\next=}


\usepackage{titlesec}
\titlespacing*{\section}{0pt}{6.5ex plus 1ex minus .2ex}{4.3ex plus .2ex}
\titlespacing*{\subsection}{0pt}{4.5ex plus 1ex minus .2ex}{2ex plus .2ex}

\def\interitem{\vspace{7mm plus 2 mm minus 3mm}}          


\usepackage[hyperfootnotes = false]{hyperref}

\hypersetup
  {
    pdfinfo = 
      {
        Title = L’extension piton ,
        Subject = Une extension LaTeX ,
        Author = F. Pantigny 
      }
  } 



\usepackage{makeidx}
\makeindex

\NewDocumentCommand{\indexcommand}{m}{\index{#1@\texttt{\textbackslash #1}}}

\NewDocumentCommand{\indexenv}{m}{\index{#1@\texttt{\{#1\}}}}


\NewDocumentCommand {\pkg} {m} {\textsf{#1}}
\NewDocumentCommand {\cls} {m} {\textsf{#1}}

\setlength{\parindent}{0pt}

\def\CC{{C\nolinebreak[4]\hspace{-.05em}\raisebox{.4ex}{\tiny\bfseries ++}}}

\begin{document}



\VerbatimFootnotes


\title{L'extension LaTeX \pkg{piton}\thanks{Ce document correspond à la 
version~\PitonFileVersion\space de \pkg{piton}, à la date du~\PitonFileDate.}} 
\author{F. Pantigny \\ \texttt{fpantigny@wanadoo.fr}}

\maketitle

\begin{abstract}
L'extension \pkg{piton} propose des outils pour composer des codes informatiques en Python, OCaml, C et SQL avec
une coloration syntaxique en utilisant la bibliothèque Lua LPEG. L'extension \pkg{piton} nécessite l'emploi de
LuaLaTeX.
\end{abstract}



\section{Présentation}

L'extension \pkg{piton} utilise la librairie Lua nommée LPEG\footnote{LPEG est une librairie de capture de motifs
  (\emph{pattern-matching} en anglais) pour Lua, écrite en C, fondée sur les PEG (\emph{parsing expression
    grammars}): \url{http://www.inf.puc-rio.br/~roberto/lpeg/}} pour «parser» le code Python, OCaml, C ou SQL et le
composer avec un coloriage syntaxique. Comme elle utilise le Lua de LuaLaTeX, elle fonctionne uniquement avec |lualatex|
(et ne va pas fonctionner avec les autres moteurs de compilation LaTeX, que ce soit |latex|, |pdflatex| ou
|xelatex|). Elle n'utilise aucun programme extérieur et la compilation ne requiert donc pas |--shell-escape|. La
compilation est très rapide puisque tout le travail du parseur est fait par la librairie LPEG, écrite en C.

\bigskip
Voici un exemple de code Python composé avec l'environnement |{Piton}| proposé par \pkg{piton}.


\bigskip
\begin{Piton}
from math import pi

def arctan(x,n=10:int):
    """Calcule la valeur mathématique de arctan(x)

    n est le nombre de termes de la somme
    """
    if x < 0:
        return -arctan(-x) # appel récursif
    elif x > 1: 
        return pi/2 - arctan(1/x) 
        #> (on a utilisé le fait que $\arctan(x)+\arctan(1/x)=\pi/2$ pour $x>0$)\footnote{Cet échappement vers LaTeX a été obtenu en débutant par \ttfamily\#>.} 
    else: 
        s = 0
        for k in range(n):
            s += (-1)**k/(2*k+1)*x**(2*k+1)
        return s 
\end{Piton}



\section{Installation}

L'extension \pkg{piton} est composée de deux fichiers : |piton.sty| et |piton.lua| (le fichier LaTeX |piton.sty|
chargé par |\usepackage| va à son tour charger le fichier |piton.lua|). Les deux fichiers doivent être présents
dans un répertoire où LaTeX pourra les trouver, de préférence dans une arborescence |texmf|. Le mieux reste néanmoins
d'installer \pkg{piton} avec une distribution TeX comme MiKTeX, TeX~Live ou MacTeX.



\section{Utilisation de l'extension}

L'extension \pkg{piton} n'est utilisable qu'avec LuaLaTeX : si un autre moteur de compilation (comme |latex|,
|pdflatex| ou |xelatex|) est utilisé, une erreur fatale sera levée.


\subsection{Choix du langage}

L'extension \pkg{piton} prend en charge quatre langages informatiques : Python, OCaml, SQL et C, ou plutôt \CC. Il
prend aussi en charge un langage minimal appelé «|minimal|» : cf.~p.~\pageref{minimal}.

\smallskip
Par défaut, le langage est Python.

\smallskip
\index{language (clé)}
On peut changer de langage avec la clé |language| de |\PitonOptions| : 

\smallskip
|\PitonOptions{language = C}|

\smallskip
Pour les développeurs, précisons que le nom du langage courant est stocké (en minuscules) dans la variable publique
L3 nommée |\l_piton_language_str|. 

\smallskip
Dans la suite de ce document, on parlera de Python mais les fonctionnalités s'appliquent aussi aux autres langages.



\subsection{Chargement de l'extension}


L'extension \pkg{piton} se charge simplement avec |\usepackage{piton}|.

\smallskip
Si, à la fin du prambule, l'extension \pkg{xcolor} n'a pas été chargée (par l'utilisateur ou par une extension
chargée dans le préambule), \pkg{piton} charge l'extension \pkg{xcolor} avec |\usepackage{xcolor}|, c'est-à-dire
sans aucune option. L'extension \pkg{piton} ne charge pas d'autre extension.

\subsection{Les commandes et environnements à la disposition de l'utilisateur}

\indexenv{Piton}

L'extension \pkg{piton} fournit plusieurs outils pour composer du code Python: les commandes |\piton|,
l'environnement |{Piton}| et la commande |\PitonInputFile|. 

\begin{itemize} \setlength{\fboxsep}{1pt}
\item La commande \colorbox{gray!20}{\ttfamily \textbackslash piton} doit être utilisée pour composer de petits éléments de code à l'intérieur d'un
paragraphe. Par exemple : 

{\color{gray}\verb|\piton{def carré(x): return x*x}|}\qquad 
\piton{def carré(x): return x*x}

La syntaxe et les particularités de la commande sont détaillées ci-après.


\item L'environnement \colorbox{gray!20}{\ttfamily \{Piton\}} doit être utilisé pour composer des codes de
plusieurs lignes. Comme cet environnement prend son argument selon un mode verbatim, il ne peut pas être utilisé
dans l'argument d'une commande LaTeX. Pour les besoins de personnalisation, il est possible de définir de nouveaux
environnements similaires à |{Piton}| en utilisant la commande |\NewPitonEnvironment| : cf. partie
\ref{NewPitonEnvironment} p.~\pageref{NewPitonEnvironment}.

\item La commande \colorbox{gray!20}{\ttfamily \textbackslash PitonInputFile} doit être utilisée pour insérer et
composer un fichier externe.

Il est possible de n'insérer qu'une partie de ce fichier : cf. partie~\ref{part-of-a-file},
p.~\pageref{part-of-a-file}.

La clé |path| de la commande |\PitonOptions| permet de spécifier un chemin pour le fichier à inclure. 
\end{itemize}


\subsection{La syntaxe de la commande \textbackslash piton}

\indexcommand{piton}

La commande |\piton| possède en fait une syntaxe double. Elle est peut être utilisée comme une commande standard de
LaTeX prenant son argument entre accolades (|\piton{...}|), ou bien selon la syntaxe de la commande |\verb| où l'argument est
délimité entre deux caractères identiques (par ex. : \verb!\piton|...|!). On détaille maintenant ces deux syntaxes.

\bigskip
\begin{itemize}
\item {\color{blue} \textsf{Syntaxe} \verb|\piton{...}|}\par\nobreak

Quand son argument est donné entre accolades, la commande |\piton| ne prend pas son argument en mode verbatim. Les
points suivants doivent être remarqués :

\begin{itemize}
\item plusieurs espaces successives sont remplacées par une unique espace, ainsi que les retours à la ligne

{\color{cyan} mais la commande |\|␣ est fournie pour forcer l'insertion d'une espace} ;

\item il n'est pas possible d'utiliser le caractère |%| à l'intérieur, 

{\color{cyan} mais la commande |\%| est fournie pour insérer un |%|} ;

\item les accolades doivent apparaître par paires correctement imbriquées, 

{\color{cyan} mais les commandes |\{| et |\}| sont aussi fournies pour insérer des accolades individuelles} ;

\item les commandes LaTeX\footnote{Cela s'applique aux commandes commençant par une contre-oblique |\| mais
  également aux caractères actifs, c'est-à-dire ceux de catcode~13.} sont complètement développées sans être
exécutées

{\color{cyan} et on peut donc utiliser |\\| pour insérer une contre-oblique}.
\end{itemize}

Les autres caractères (y compris |#|, |^|, |_|, |&|, |$| % $
et |@|) doivent être insérés sans contre-oblique.

\bigskip
\begin{tabular}{>{\color{gray}}w{l}{75mm}@{\hspace*{1cm}}l}
\omit Exemples : \hfil \\
\noalign{\vskip1mm}
\verb|\piton{ma_chaîne = '\\n'}| & 
\piton{ma_chaîne = '\\n' } \\
\verb|\piton{def pair(n): return n\%2==0}| & 
\piton{def pair(n): return n\%2==0 } \\
\verb|\piton{c="#"    # une affectation }| & 
\piton{c="#"     # une affectation } \\
\verb|\piton{c="#" \ \ \ # une affectation }| & 
\piton{c="#" \ \ \ # une affectation } \\
\verb|\piton{my_dict = {'a': 3, 'b': 4}}| &
\piton{my_dict = {'a': 3, 'b': 4}}
\end{tabular}

\bigskip
La commande |\piton| avec son argument entre accolades peut être utilisée dans les arguments des autres commandes LaTeX.\footnote{La commande
  |\piton| peut par exemple être
  utilisée dans une note de bas de page. Exemple : \piton{s = 'Une chaîne'}.}

\bigskip
\item {\color{blue} \textsf{Syntaxe} \verb!\piton|...|!}\par\nobreak

Quand la commande |\piton| prend son argument entre deux caractères identiques, cet argument est pris \emph{en mode
  verbatim}. De ce fait, avec cette syntaxe, la commande |\piton| ne peut \emph{pas} être utilisée dans l'argument d'une
autre fonction.  

\medskip
\begin{tabular}{>{\color{gray}}w{l}{75mm}@{\hspace*{1cm}}l}
\omit Exemples : \hfil \\
\noalign{\vskip1mm}
\verb!\piton|ma_chaîne = '\n'|! & 
\piton|ma_chaîne = '\n'| \\
\verb|\piton!def pair(n): return n%2==0!| & 
\piton!def pair(n): return n%2==0! \\
\verb|\piton+c="#"    # une affectation +| & 
\piton+c="#"     # une affectation + \\
\verb|\piton?my_dict = {'a': 3, 'b': 4}?| &
\piton!my_dict = {'a': 3, 'b': 4}!
\end{tabular}

\end{itemize}



\section{Personnalisation}

Concernant la fonte de caractères utilisée dans les listings produits par l'extension \pkg{piton}, il s'agit
simplement de la fonte mono-chasse courante (\pkg{piton} utilise simplement en interne la commande LaTeX standard
|\ttfamily|). Pour la changer, le mieux est d'utiliser |\setmonofont| de \pkg{fontspec}.

\subsection{Les clés de la commande \textbackslash PitonOptions}

\NewDocumentCommand{\Definition}{m}
  {{\setlength{\fboxsep}{1pt}\colorbox{gray!20}{\ttfamily \vphantom{gl}#1}}}

\indexcommand{PitonOptions}

La commande |\PitonOptions| prend en argument une liste de couples \textsl{clé=valeur}. La portée des réglages
effectués par cette commande est le groupe TeX courant.\footnote{On rappelle que tout environnement LaTeX est, en
  particulier, un groupe.}

Ces clés peuvent aussi être appliquées à un environnement |{Piton}| individuel (entre crochets).

\begin{itemize}
\item La clé \Definition{language} spécifie le langage informatique considéré (la casse n'est pas prise en compte).
Cinq valeurs sont possibles : |Python|, |OCaml|, |C|, |SQL| et |minimal|. La valeur initiale est |Python|.

\item \index{path} La clé \Definition{path} indique un chemin où seront cherchés les fichiers inclus par
|\PitonInputFile|. 

\item \index{gobble}\label{gobble} La clé \Definition{gobble} prend comme valeur un entier positif $n$ : les $n$
premiers caractères de chaque ligne sont alors retirés (avant formatage du code) dans les environnements |{Piton}|.
Ces $n$ caractères ne sont pas nécessairement des espaces.

\item \index{auto-gobble}\index{gobble!auto-gobble} Quand la clé \Definition{auto-gobble} est activée, l'extension \pkg{piton} détermine la valeur minimale $n$
du nombre d'espaces successifs débutant chaque ligne (non vide) de l'environnement |{Piton}| et applique |gobble|
avec cette valeur de~$n$.

\item \index{env-gobble}\index{gobble!env-gobble}
Quand la clé \Definition{env-gobble} est activée, \pkg{piton} analyse la dernière ligne de l'environnement,
c'est-à-dire celle qui contient le |\end{Piton}| et détermine si cette ligne ne comporte que des espaces suivis par
|\end{Piton}|. Si c'est le cas, \pkg{piton} calcule le nombre $n$ de ces espaces et applique |gobble| avec cette
valeur de~$n$. Le nom de cette clé vient de \emph{environment gobble}: le nombre d'espaces à retirer ne dépend que
de la position des délimiteurs |\begin{Piton}| et |\end{Piton}| de l'environnement.

\item \index{write} La clé \Definition{write} prend en argument un nom de fichier (avec l'extension) et écrit le
contenu\footnote{En fait, il ne s'agit pas exactement du contenu de l'environnement mais de la valeur renvoyée par
  l'instruction Lua 
  |piton.get_last_code()| qui en est une version dans les surcharges de formatage LaTeX (voir la partie \ref{API}, p.~\pageref{API}).} de l'environnement courant dans ce fichier. À la première utilisation du fichier par \pkg{piton}, celui-ci
est effacé.

\item \index{path-write} \colorbox{yellow!50}{\bfseries Nouveau 2.5}\enskip La clé \Definition{path-write} indique
un chemin où seront écrits les fichiers écrits par l'emploi de la clé |write| précédente.

\item \index{line-numbers} La clé \Definition{line-numbers} active la numérotation des lignes (en débordement à
gauche) dans les environnements |{Piton}| et dans les listings produits par la commande |\PitonInputFile|.

Cette clé propose en fait plusieurs sous-clés.
\begin{itemize}
\item La clé \Definition{line-numbers/skip-empty-lines} demande que les lignes vides (qui ne contiennent que des
espaces) soient considérées comme non existantes en ce qui concerne la numérotation des lignes (si la clé
|/absolute| est active, la clé |/skip-empty-lines| n'a pas d'effet dans |\PitonInputFile|). La valeur initiale de
cette clé est |true| (et non |false|).\footnote{Avec le langage Python, les lignes vides des \emph{docstrings} sont
  prises en compte.}

\item La clé \Definition{line/numbers/label-empty-lines} demande que les labels (c'est-à-dire les numéros) des lignes vides
soient affichés. Si la clé |/skip-empty-lines| est active, la clé |/label-empty-lines| est sans effet. La
valeur initiale de cette clé est |true|.

\item La clé \Definition{line-numbers/absolute} demande, pour les listings générés par |\PitonInputFile|, que les numéros de
lignes affichés soient absolus (c'est-à-dire ceux du fichier d'origine). Elle n'a d'intérêt que si on n'insère qu'une
partie du fichier (cf. part~\ref{part-of-a-file}, p.~\pageref{part-of-a-file}). La clé |/absolute| est sans effet dans les environnements |{Piton}|.

\item La clé \Definition{line-numbers/resume} reprend la numérotation là où elle avait été laissée au dernier listing. En fait,
la clé |line-numbers/resume| a un alias, qui est |resume| tout court. 

\item La clé \Definition{line-numbers/start} impose que la numérotation commence à ce numéro. 

\item La clé \Definition{line-numbers/sep} est la distance horizontale entre les numéros de lignes (insérés par |line-numbers|)
et les lignes du code informatique. La valeur initiale est 0.7~em.
\end{itemize}

Pour la commmodité, un dispositif de factorisation du préfixe |line-numbers| est disponible, c'est-à-dire que l'on
peut écrire :

\begin{Verbatim}
\PitonOptions
  {
    line-numbers = 
      { 
        skip-empty-lines = false ,
        label-empty-lines = false ,
        sep = 1 em
      }
  }
\end{Verbatim}


\item \index{left-margin} La clé \Definition{left-margin} fixe une marge sur la gauche. Cette clé peut être utile, en particulier, en
conjonction avec la clé |line-numbers| si on ne souhaite pas que les numéros de ligne soient dans une position en
débordement sur la gauche.

Il est possible de donner à la clé |left-margin| la valeur spéciale~|auto|. Avec cette valeur, une marge est
insérée automatiquement pour les numéros de ligne quand la clé |line-numbers| est utilisée. Voir un exemple à la
partie \ref{example-numbering} p.~\pageref{example-numbering}.

\item \index{background-color} La clé \Definition{background-color} fixe la couleur de fond des environnements |{Piton}| et des listings
produits par |\PitonInputFile| (ce fond a une largeur que l'on peut fixer avec la clé |width| décrite ci-dessous).
La clé |background-color| accepte une couleur définie «à la volée», c'est-à-dire que l'on peut écrire par exemple
|background-color = [cmyk]{0.1,0.05,0,0}|

\smallskip
La clé |background-color| accepte aussi en argument une \emph{liste} de couleurs. Les lignes sont alors coloriées
de manière cyclique avec ces couleurs.

\emph{Exemple} : |\PitonOptions{background-color = {gray!5,white}}|

\item \index{prompt-background-color} Avec la clé \Definition{prompt-background-color}, \pkg{piton} ajoute un fond coloré aux lignes débutant par
le prompt «|>>>|» (et sa continuation «|...|») caractéristique des consoles Python avec boucle \textsc{repl}
(\emph{read-eval-print loop}). Pour un exemple d'utilisation de cette clé, voir la partie \ref{pythonrepl}
p.~\pageref{pythonrepl}.

\item \index{width} La clé \Definition{width} fixe la largeur du listing produit. Cette largeur s'applique aux fonds colorés
spécifiés par les clés |background-color| et |prompt-background-color| et également quand une coupure automatique
des lignes est demandée par |break-lines| (cf.~\ref{line-breaks}, p.~\pageref{line-breaks}).

Cette clé peut prendre comme valeur une longueur explicite mais aussi la valeur spéciale~|min|. Avec cette valeur,
la largeur sera calculée à partir de la largeur maximale des lignes de code. Attention : l'usage de cette valeur
spéciale~|min| requiert deux compilations LuaLaTeX\footnote{La largeur maximale est calculée lors de la première
compilation, écrite sur le fichier~|aux|, puis réutilisée lors de la compilation suivante. Certains outils comme
|latexmk| (utilisé par Overleaf) effectuent automatiquement un nombre suffisant de compilations.}.

Pour un exemple d'utilisation de |width=min|, voir la partie~\ref{example-comments} sur les exemples, p.~\pageref{example-comments}.

\item \index{show-spaces-in-strings} En activant la clé \Definition{show-spaces-in-strings}, les espaces dans les
chaînes de caractères\footnote{Pour le language Python, cela ne s'applique que pour les chaînes courtes, c'est-à-dire
celles délimitées par~\verb|'| ou~\verb|"|. En OCaml, cela ne s'applique pas pour les \emph{quoted strings}.} sont
matérialisés par le caractère ␣ (U+2423 : \textsc{open box}). Bien sûr, le caractère U+2423 doit être présent dans la fonte mono-chasse utilisée.\footnote{L'extension \pkg{piton} utilise
  simplement la fonte mono-chasse courante. Pour la changer, le mieux est d'utiliser |\setmonofont| de
  \pkg{fontspec}.}\par\nobreak
%
\begingroup
\PitonOptions{show-spaces-in-strings}
Exemple : \piton{my_string = 'Très bonne réponse'}
\endgroup

\item \index{show-spaces} Avec la clé \Definition{show-spaces}, tous les espaces sont matérialisés (et aucune
coupure de ligne ne peut plus intervenir sur ces espaces matérialisés, même si la clé |break-lines|\footnote{cf.
  \ref{line-breaks} p.~\pageref{line-breaks}.} est active). Il faut néanmoins remarquer que les espaces en fin de
ligne sont tous supprimés par \pkg{piton}. Les tabulations de début de ligne sont représentées par des flèches.
\end{itemize}

\bigskip

\begingroup
\fvset{commandchars=\~\&\@,formatcom=\small\color{gray}}
\begin{Verbatim}
~emphase&\begin{Piton}[language=C,line-numbers,auto-gobble,background-color = gray!15]@
    void bubbleSort(int arr[], int n) {
        int temp;
        int swapped;
        for (int i = 0; i < n-1; i++) {
            swapped = 0;
            for (int j = 0; j < n - i - 1; j++) {
                if (arr[j] > arr[j + 1]) {
                    temp = arr[j];
                    arr[j] = arr[j + 1];
                    arr[j + 1] = temp;
                    swapped = 1; 
                }
            }
            if (!swapped) break;
        }
    }   
\end{Piton}
\end{Verbatim}
\endgroup


\begin{Piton}[language=C,line-numbers,auto-gobble,background-color = gray!15]
    void bubbleSort(int arr[], int n) {
        int temp;
        int swapped;
        for (int i = 0; i < n-1; i++) {
            swapped = 0;
            for (int j = 0; j < n - i - 1; j++) {
                if (arr[j] > arr[j + 1]) {
                    temp = arr[j];
                    arr[j] = arr[j + 1];
                    arr[j + 1] = temp;
                    swapped = 1; 
                }
            }
            if (!swapped) break;
        }
    }   
\end{Piton}




\bigskip
La commande |\PitonOptions| propose d'autres clés qui seront décrites plus loin (voir en particulier la coupure des
pages et des lignes p.~\pageref{breakable}).


\subsection{Les styles}

\label{styles}
\index{styles (concept de \pkg{piton})}

\subsubsection{Notion de style}

L'extension \pkg{piton} fournit la commande |\SetPitonStyle| pour personnaliser les différents styles utilisés pour
formater les éléments syntaxiques des listings Python. Ces personnalisations ont une portée qui correspond au
groupe TeX courant.\footnote{On rappelle que tout environnement LaTeX est, en particulier, un groupe.}

\bigskip
\indexcommand{SetPitonStyle}
La commande |\SetPitonStyle| prend en argument une liste de couples \textsl{clé=valeur}. Les clés sont les noms des
styles et les valeurs sont les instructions LaTeX de formatage correspondantes.

\bigskip
Ces instructions LaTeX doivent être des instructions de formatage du type de |\bfseries|, |\slshape|,
|\color{...}|, etc. (les commandes de ce type sont parfois qualifiées de \emph{semi-globales}). Il est aussi
possible de mettre, \emph{à la fin de la liste d'instructions}, une commande LaTeX prenant exactement un argument.

\bigskip
Voici un exemple qui change le style utilisé pour le nom d'une fonction Python, au moment de sa définition
(c'est-à-dire après le mot-clé |def|). Elle utilise la commande |\highLight| de \pkg{lua-ul} (qui nécessite
lui-même le chargement de \pkg{luacolor}).

\begin{Verbatim}
\SetPitonStyle
  { Name.Function = \bfseries \hightLight[red!50] }
\end{Verbatim}

Ici, |\highLight[red!50]| doit être considéré comme le nom d'une fonction LaTeX qui prend exactement un argument,
puisque, habituellement, elle est utilisée avec |\highLight[red!50]{|\texttt{\slshape text}|}|.

\medskip
\begingroup
\SetPitonStyle 
  { Name.Function = \bfseries \highLight[red!50] }
Avec ce réglage, on obtient : \piton{def cube(x) : return x * x * x }
\endgroup


\bigskip
L'usage des différents styles suivant le langage informatique considéré est décrit dans la partie \ref{Semantic}, à
partir de la page \pageref{Semantic}. 



\bigskip
\indexcommand{PitonStyle}
La commande |\PitonStyle| prend en argument le nom d'un style et permet de récupérer la valeur (en tant que liste
d'instructions LaTeX) de ce style.

\smallskip
Par exemple, on peut écrire, dans le texte courant, |{\PitonStyle{Keyword}{function}}| et on aura 
le mot {\PitonStyle{Keyword}{function}} formaté comme un mot-clé.

\smallskip
La syntaxe |{\PitonStyle{|\textsl{\texttt{style}}|}{...}}| est nécessaire pour pouvoir tenir compte à la fois des commandes
semi-globales et des commandes à argument présentes dans la valeur courante du style \texttt{\textsl{style}}.


\subsubsection{Styles locaux et globaux}

Un style peut être défini de manière globale avec la commande |\SetPitonStyle|. Cela veut dire qu'il s'appliquera
par défaut à tous les langages informatiques qui utilisent ce style.

\medskip
Par exemple, avec la commande 
\begin{Verbatim}
\SetPitonStyle{Comment = \color{gray}}
\end{Verbatim}
tous les commentaires (que ce soit en Python, en C, en OCaml, etc.) seront composés en gris.

\bigskip
Mais il est aussi possible de définir un style localement pour un certain langage informatique en passant le nom du
langage en argument optionnel (entre crochets) de la commande |\SetPitonStyle|.\footnote{On rappelle que, dans
  \pkg{piton}, les noms des langages informatiques ne sont pas sensibles à la casse.}

\medskip
Par exemple, avec la commande 
\begin{Verbatim}
\SetPitonStyle~emphase#[SQL]@{Keywords = \color[HTML]{006699} \bfseries \MakeUppercase}
\end{Verbatim}
les mots-clés dans les listings SQL seront composés en lettres capitales, même s'ils s'apparaissent en minuscules
dans le fichier source LaTeX (on rappelle que, en SQL, les mot-clés ne sont pas sensibles à la casse et donc forcer
leur mise en capitales peut être envisagé).

\medskip
Comme on s'en doute, si un langage informatique utilise un certain style et que ce style n'est pas défini
localement pour ce langage, c'est la version globale qui est utilisée. Cette notion de globalité n'a pas de
rapport avec la notion de liaison locale de TeX (notion de groupe TeX).\footnote{Du point de vue des groupes de
  TeX, les liaisons faites par |\SetPitonStyle| sont toujours locales.}

\medskip
Les styles fournis par défaut par \pkg{piton} sont tous définis globalement.

\bigskip
\subsubsection{Le style UserFunction}

\index{UserFunction (style)}

\bigskip
Il existe un style spécial nommé |UserFunction|. Ce style s'applique aux noms des fonctions précédemment définies
par l'utilisateur (par exemple, avec le langage Python, ces noms de fonctions sont ceux qui apparaissent après le
mot-clé \piton{def} dans un listing Python précédent). La valeur initiale de ce style est nulle (=vide), ce qui
fait que ces noms de fonctions sont formatés comme du texte courant (en noir). Néanmoins, il est possible de
changer la valeur de ce style, comme tous les autres styles, avec la commande |\SetPitonStyle|.

\medskip
Dans l'exemple suivant, on règle les styles |Name.Function| et |UserFunction| de manière à que ce, quand on clique
sur le nom d'une fonction Python précédemment définie par l'utilisateur, on soit renvoyé vers la définition
(informatique) de cette fonction. Cette programmation utilise les fonctions |\hypertarget| et |\hyperlink| de \pkg{hyperref}.

\begingroup

\NewDocumentCommand{\MyDefFunction}{m}{\hypertarget{piton:#1}{\color[HTML]{CC00FF}{#1}}}
\NewDocumentCommand{\MyUserFunction}{m}{\hyperlink{piton:#1}{#1}}

\SetPitonStyle
  {
    Name.Function = \MyDefFunction ,
    UserFunction = \MyUserFunction
  }

\medskip
\begin{Verbatim}
\NewDocumentCommand{\MyDefFunction}{m}
   {\hypertarget{piton:~#1}{\color[HTML]{CC00FF}{~#1}}}
\NewDocumentCommand{\MyUserFunction}{m}{\hyperlink{piton:~#1}{~#1}}

\SetPitonStyle{Name.Function = \MyDefFunction, ~emphase#UserFunction@ = \MyUserFunction}
\end{Verbatim}

\bigskip

\begin{Piton}
def transpose(v,i,j):
    x = v[i]
    v[i] = v[j]
    v[j] = x 

def passe(v):
    for in in range(0,len(v)-1):
        if v[i] > v[i+1]:
            transpose(v,i,i+1)
\end{Piton}

\endgroup

\PitonClearUserFunctions[Python]

\bigskip
\begin{small}
Bien sûr, la liste des noms de fonctions Python précédemment définies est gardée en mémoire de LuaLaTeX (de manière
globale, c'est-à-dire indépendamment des groupes TeX). L'extension \pkg{piton} fournit une commande qui permet de
vider cette liste : c'est la commande |\PitonClearUserFunctions|. Quand elle est utilisée sans argument, cette
commande s'applique à tous les langages informatiques utilisées par l'utilisateur mais on peut spécifier en
argument optionnel (entre crochets) une liste de langages informatiques auquels elle s'appliquera.\footnote{On
  rappelle que, dans \pkg{piton}, les noms des langages informatiques ne sont pas sensibles à la casse. }
\end{small}



\subsection{Définition de nouveaux environnements}

\label{NewPitonEnvironment}
\indexcommand{NewPitonEnvironment}

Comme l'environnement |{Piton}| a besoin d'absorber son contenu d'une manière spéciale (à peu près comme du texte
verbatim), il n'est pas possible de définir de nouveaux environnements directement au-dessus de l'environnement
|{Piton}| avec les commandes classiques |\newenvironment| (de LaTeX standard) et |\NewDocumentEnvironment| (de
LaTeX3). 

C'est pourquoi \pkg{piton} propose une commande |\NewPitonEnvironment|. Cette commande a la même syntaxe que la
commande classique |\NewDocumentEnvironment|.\footnote{Néanmoins, le spécificateur d'argument~|b|, qui sert à
  capter le corps de l'environnement comme un argument LaTeX, n'est pas autorisé.}

\bigskip
Par exemple, avec l'instruction suivante, un nouvel environnement |{Python}| sera défini avec le même comportement
que l'environnement |{Piton}|:

{\color{gray}|\NewPitonEnvironment{Python}{O{}}{\PitonOptions{#1}}{}|}

\bigskip
Si on souhaite un environnement |{Python}| qui compose le code inclus dans une boîte de \pkg{tcolorbox}, on peut
écrire (à condition, bien entendu, d'avoir chargé l'extension \pkg{tcolorbox}):

\begin{Verbatim}
\NewPitonEnvironment{Python}{}
  {\begin{tcolorbox}}
  {\end{tcolorbox}}
\end{Verbatim}

\bigskip
Avec ce nouvel environnement |{Python}|, on peut écrire : 

\begin{Verbatim}
~emphase#\begin{Python}@
def carré(x):
    """Calcule le carré d'un nombre"""
    return x*x
~emphase#\end{Python}@
\end{Verbatim}

\NewPitonEnvironment{Python}{}
  {\begin{tcolorbox}}
  {\end{tcolorbox}}

\begin{Python}
def carré(x):
    """Calcule le carré d'un nombre"""
    return x*x
\end{Python}


\section{Fonctionnalités avancées}


\subsection{Coupure des pages et des lignes}

\label{breakable}

\subsubsection{Coupure des pages}

\index{splittable}

Par défaut les listings produits par l'environnement |{Piton}| et par la commande |\PitonInputFile| sont
insécables.

Néanmoins, la commande |\PitonOptions| propose la clé \Definition{splittable} pour autoriser de telles coupures.

\begin{itemize}
\item Si la clé |splittable| est utilisée sans valeur, les listings sont sécables n'importe où.

\item Si la clé |splittable| est utilisée avec une valeur numérique $n$ (qui doit être un entier naturel non nul),
alors les listings seront sécables mais aucune coupure ne pourra avoir lieu entre les $n$~premières lignes, ni
entre les $n$~dernières. De ce fait, |splittable=1| est équivalent à |splittable|.
\end{itemize}

\medskip
\emph{Remarque}\par\nobreak

Même avec une couleur de fond (fixée avec |background-color|), les sauts de page sont possibles, à partir du moment
où la clé |splittable| est utilisée.\footnote{Avec la clé |splittable|, un environnement |{Piton}| est sécable même dans un environnement de
  \pkg{tcolorbox} (à partir du moment où la clé |breakable| de \pkg{tcolorbox} est utilisée). On précise cela parce
  que, en revanche, un environnement de \pkg{tcolorbox} inclus dans un autre environnement de \pkg{tcolorbox} n'est
  pas sécable, même quand les deux utilisent la clé |breakable|.}


\bigskip
\index{split-on-empty-lines}
\index{split-separation}
\colorbox{yellow!50}{\textbf{Nouveau 2.7}}\enskip L'extension \pkg{piton} fournit une option
\Definition{split-on-empty-lines}. Quand cette clé est active, les listings sont découpés en morceaux au niveau des
lignes vides\footnote{Les lignes considérées comme vides sont celles qui ne comportent que des espaces.} du code et
chaque morceau est traité par \pkg{piton} comme un listing autonome avant d'être envoyé à 
LaTeX. \textbf{De ce fait, LaTeX peut faire des sauts de page entre les morceaux}. Si la clé |splittable| est
utilisée, elle reste active dans chaque morceau. Évidemment, l'utilisation conjointe de |split-on-empty-lines| et
|splittable| n'a d'intérêt que si |splittable| est utilisée avec une valeur différente de $1$ (par example $4$), de
manière à privilégier les coupures de pages au niveau des lignes vides du listing d'origine.

\smallskip
La clé \Definition{split-separation} permet de spécifier une liste de tokens LaTeX qui sera insérée entre les
morceaux. Exemple : |\PitonOptions{split-speration = \hrule\goodbreak}|

\subsubsection{Coupure des lignes}

\label{line-breaks}

Par défaut, les éléments produits par \pkg{piton} ne peuvent pas être coupés par une fin de ligne. Il existe
néanmoins des clés pour autoriser de telles coupures (les points de coupure possibles sont les espaces, y compris
les espaces dans les chaînes Python).
\begin{itemize}
\item \index{break-lines!break-lines-in-piton} Avec la clé \Definition{break-lines-in-piton}, les coupures de ligne sont autorisées dans la commande
|\piton{...}| (mais pas dans la commande \verb+\piton|...|+, c'est-à-dire avec la syntaxe verbatim). 

\item \index{break-lines!break-lines-in-Piton} Avec la clé \Definition{break-lines-in-Piton}, les coupures de ligne sont autorisées dans l'environnement
|{Piton}| (d'où la lettre |P| capitale dans le nom) et les listings produits par |\PitonInputFile|.

\item \index{break-lines} La clé \Definition{break-lines} est la conjonction des deux clés précédentes.
\end{itemize}

\medskip
L'extension \pkg{piton} fournit aussi plusieurs clés pour contrôler l'apparence des coupures de ligne autorisées par |break-lines-in-Piton|.

\begin{itemize}
\item \index{indent-broken-lines} Avec la clé \Definition{indent-broken-lines}, l'indentation de la ligne coupée est respectée à chaque retour
à la ligne. 

\item \index{end-of-broken-line} La clé \Definition{end-of-broken-line} correspond au symbole placé à la fin d'une ligne coupée. Sa valeur initiale est : 
|\hspace*{0.5em}\textbackslash|.

\item \index{continuation-symbol} La clé \Definition{continuation-symbol} correspond au symbole placé à chaque retour de ligne dans la marge
gauche. Sa valeur initiale est : |+\;| (la commande |\;| insère un petit espace horizontal). 

\item \index{continuation-symbol-on-indentation} La clé \Definition{continuation-symbol-on-indentation} correspond au symbole placé à chaque retour de ligne
au niveau de l'indentation (uniquement dans le cas où la clé |indent-broken-lines| est active). Sa valeur initiale
est : |$\hookrightarrow\;$|.
\end{itemize}

\bigskip
Le code suivant a été composé avec le réglage suivant :  

\begin{Verbatim}
\PitonOptions{width=12cm,break-lines,indent-broken-lines,background-color=gray!15}
\end{Verbatim}

\begin{center}
\PitonOptions{width=12cm,break-lines,indent-broken-lines,background-color=gray!15}
\begin{Piton}
def dict_of_liste(liste):
    """Convertit une liste de subrs et de descriptions de glyphes en dictionnaire"""
    dict = {}
    for liste_lettre in liste:
        if (liste_lettre[0][0:3] == 'dup'): # si c'est un subr
            nom = liste_lettre[0][4:-3]
            print("On traite le subr de numéro " + nom)
        else:
            nom = liste_lettre[0][1:-3] # si c'est un glyphe
            print("On traite le glyphe du caractère " + nom)
        dict[nom] = [traite_ligne_Postscript(k) for k in liste_lettre[1:-1]]
    return dict
\end{Piton}
\end{center}


\bigskip
\subsection{Insertion d'une partie d'un fichier}

\label{part-of-a-file}

\indexcommand{PitonInputFile}

La commande |\PitonInputFile| permet d'insérer (avec formatage) le contenu d'un fichier. En fait, il existe des
mécanismes permettant de n'insérer qu'une partie du fichier en question.
\begin{itemize}
\item On peut spécifier la partie à insérer par les numéros de lignes (dans le fichier d'origine).
\item On peut aussi spécifier la partie à insérer par des marqueurs textuels.
\end{itemize}
Dans les deux cas, si on souhaite numéroter les lignes avec les numéros des lignes du fichier d'origine, il
convient d'utiliser la clé |line-numbers/absolute|.

\subsubsection{Avec les numéros de lignes absolus}

La commande |\PitonInputFile| propose les clés \Definition{first-line} et \Definition{last-line} pour n'insérer que
la partie du fichier comprise entre les lignes correspondantes. Ne pas confondre avec la clé |line-numbers/start|
qui demande un numérotage des lignes commençant à la valeur donnée à cette clé (en un sens |line-numbers/start|
concerne la sortie alors que |first-line| et |last-line| concernent l'entrée).


\subsubsection{Avec des marqueurs textuels}

\index{marker/beginning}
\index{marker/end}


Pour utiliser cette technique, il convient d'abord de spécifier le format des marqueurs marquant le début et la fin
de la partie du fichier à inclure. Cela se fait avec les deux clés \Definition{marker/beginning} et
\Definition{marker/end} (usuellement dans la commande |\PitonOptions|). 

\medskip
Prenons d'abord un exemple.

\medskip
Supposons que le fichier à inclure contienne des solutions à des exercices de programmation sur le modèle suivant :  

\begin{Verbatim}[formatcom=\small\color{gray}]
~#[Exercice 1] Version itérative
def fibo(n):
    if n==0: return 0 
    else:
        u=0
        v=1
        for i in range(n-1):
            w = u+v
            u = v
            v = w
        return v
~#<Exercice 1>
\end{Verbatim}

Les marqueurs de début de début et de fin sont les chaînes |#[Exercice 1]| et |#<Exercice 1>|. La chaîne
«|Exercice 1|» sera appelée le \emph{label} de l'exercice (ou de la partie du fichier à inclure).

Pour spécifier des marqueurs de cette sorte dans \pkg{piton}, on utilisera les clés |marker/beginning| et |marker/end|
de la manière suivante (le caractère |#| des commentaires de Python doit être inséré sous la forme échappée |\#|). 

\begin{Verbatim}
\PitonOptions{ ~emphase#marker/beginning@ = \~#[~#1] , ~emphase#marker/end@ = \~#<~#1> } 
\end{Verbatim}

Comme on le voit, |marker/beginning| est une expression correspondant à la fonction mathématique qui, au nom du
label (par exemple |Exercice 1|), associe le marqueur de début (dans l'exemple |#[Exercice 1]|). La chaîne |#1|
correspond aux occurrences de l'argument de cette fonction (c'est la syntaxe habituelle de TeX). De même pour
|marker/end|.


\bigskip
Pour insérer une partie marquée d'un fichier, il suffit alors d'utiliser la clé \Definition{range} de
|\PitonInputFile|. 

\smallskip
\begin{Verbatim}
\PitonInputFile[~emphase#range = Exercice 1@]{~textsl#nom_du_fichier@}
\end{Verbatim}

\medskip
\begin{Piton}
def fibo(n):
    if n==0: return 0 
    else:
        u=0
        v=1
        for i in range(n-1):
            w = u+v
            u = v
            v = w
        return v
\end{Piton}

\vspace{1cm}
\index{marker/include-line}
La clé \Definition{marker/include-line} demande que les lignes contenant les marqueurs soient également insérées.

\begin{Verbatim}
\PitonInputFile[~emphase#marker/include-lines@,range = Exercice 1]{~textsl#nom_du_fichier@}
\end{Verbatim}

\begin{Piton}
#[Exercice 1] Version itérative
def fibo(n):
    if n==0: return 0 
    else:
        u=0
        v=1
        for i in range(n-1):
            w = u+v
            u = v
            v = w
        return v
#<Exercice 1>
\end{Piton}


\bigskip
\index{begin-range}
\index{end-range}
Il existe en fait aussi les clés \Definition{begin-range} et \Definition{end-range} pour insérer plusieurs
contenus marqués simultanément. 

Par exemple, pour insérer les solutions des exercices 3 à 5, on pourra écrire (à condition que le fichier soit
structuré correctement!):

\begin{Verbatim}
\PitonInputFile[~emphase#begin-range = Exercice 3, end-range = Exercice 5@]{~textsl#nom_du_fichier@}
\end{Verbatim}




\subsection{Mise en évidence d'identificateurs}

\indexcommand{SetPitonIdentifier}
\label{SetPitonIdentifier}

\colorbox{yellow!50}{\bfseries Modification 2.4}\par\nobreak

\smallskip
La commande |\SetPitonIdentifier| permet de changer le formatage de certains identificateurs.

\smallskip
Cette commande prend trois arguments : un optionnel et deux obligatoires.

\begin{itemize}
\item L'argument optionnel (entre crochets) indique le langage (informatique) concerné ; si cet
argument est absent, les réglages faits par |\SetPitonIdentifier| s'appliqueront à tous les langages.\footnote{On rappelle que, dans \pkg{piton}, les noms des langages informatiques ne sont pas
  sensibles à la casse.}

\item Le premier argument obligatoire est une liste de noms d'identificateurs séparés par des virgules.

\item Le deuxième argument obligatoire est une liste d'instructions LaTeX de formatage du même type que pour les
styles précédemment définis (cf. \ref{styles}, p.~\pageref{styles}).


\end{itemize}

\emph{Attention} : Seuls les identificateurs peuvent voir leur formatage affecté. Les mots-clés et les noms de
fonctions prédéfinies ne seront pas affectés, même s'ils figurent dans le premier argument de
|\SetPitonIdentifier|. 

\begin{Verbatim}
~emphase#\SetPitonIdentifier{l1,l2}{\color{red}}@
\begin{Piton}
def tri(l):
    """Tri par segmentation"""
    if len(l) <= 1:
        return l
    else:
        a = l[0]
        l1 = [ x for x in l[1:] if x < a  ]
        l2 = [ x for x in l[1:] if x >= a ]
        return tri(l1) + [a] + tri(l2)
\end{Piton}
\end{Verbatim}


\bigskip

\begingroup

\SetPitonIdentifier{l1,l2}{\color{red}}

\begin{Piton}
def tri(l):
    """Tri par segmentation"""
    if len(l) <= 1:
        return l
    else:
        a = l[0]
        l1 = [ x for x in l[1:] if x < a  ]
        l2 = [ x for x in l[1:] if x >= a ]
        return tri(l1) + [a] + tri(l2)
\end{Piton}

\endgroup

\bigskip
Avec la commande |\SetPitonIdentifiers|, on peut ajouter à un langage informatique de nouvelles fonctions
prédéfinies (ou de nouveaux mots-clés, etc.) qui seront détectées par \pkg{piton}.


\begin{Verbatim}
~emphase#\SetPitonIdentifier[Python]@
  {cos, sin, tan, floor, ceil, trunc, pow, exp, ln, factorial}
  {\PitonStyle{Name.Builtin}}

\begin{Piton}
from math import *
cos(pi/2) 
factorial(5)
ceil(-2.3) 
floor(5.4) 
\end{Piton}
\end{Verbatim}

\begingroup

\SetPitonIdentifier[Python]
  {cos, sin, tan, floor, ceil, trunc, pow, exp, ln, factorial}
  {\PitonStyle{Name.Builtin}}
 
\begin{Piton}
from math import *
cos(pi/2) 
factorial(5)
ceil(-2.3) 
floor(5.4) 
\end{Piton}


\endgroup

\subsection{Les échappements vers LaTeX}

\index{echappements@échappements vers LaTeX}

L'extension \pkg{piton} propose plusieurs mécanismes d'échappement vers LaTeX :
\begin{itemize}
\item Il est possible d'avoir des commentaires entièrement composés en LaTeX.
\item Il est possible d'avoir, dans les commentaires Python, les éléments entre \texttt{\$} composés en mode
mathématique de LaTeX.
\item Il est possible de demander à \pkg{piton} de détecter directement certaines commandes LaTeX avec leur argument.
\item Il est possible d'insérer du code LaTeX à n'importe quel endroit d'un listing Python.
\end{itemize}
Ces mécanismes vont être détaillés dans les sous-parties suivantes.

\smallskip
À remarquer également que, dans le cas où \pkg{piton} est utilisée dans la classe \cls{beamer}, \pkg{piton} détecte
la plupart des commandes et environnements de Beamer : voir la sous-section \ref{beamer}, p.~\pageref{beamer}.


\subsubsection{Les «commentaires LaTeX»}

\index{comment-latex}
\index{commentaires LaTeX}

Dans ce document, on appelle «commentaire LaTeX» des commentaires qui débutent par |#>|. Tout ce qui suit ces deux 
caractères, et jusqu'à la fin de la ligne, sera composé comme du code LaTeX standard.

Il y a deux outils pour personnaliser ces commentaires.

\begin{itemize}
\item Il est possible de changer le marquage syntaxique utilisé (qui vaut initialement~|#>|). Pour ce faire, il
existe une clé |comment-latex|, \emph{disponible uniquement dans le préambule du document}, qui permet de choisir les
caractères qui (précédés par~|#|) serviront de marqueur syntaxique.

Par exemple, avec le réglage suivant (fait dans le préambule du document) :

|\PitonOptions{comment-latex = LaTeX}|

les commentaires LaTeX commenceront par~|#LaTeX|.

Si on donne la valeur nulle à la clé |comment-latex|, tous les commentaires Python (débutant par~|#|) seront en
fait des «commentaires LaTeX».

\smallskip
\item Il est possible de changer le formatage du commentaire LaTeX lui-même en changeant le style \pkg{piton}
|Comment.LaTeX|.

Par exemple, avec |\SetPitonStyle{Comment.LaTeX = \normalfont\color{blue}}|, les commentaires LaTeX seront composés
en bleu.

Si on souhaite qu'un croisillon (|#|) soit affiché en début de commentaire dans le \textsc{pdf}, on peut régler
|Comment.LaTeX| de la manière suivante :

\begin{Verbatim}
\SetPitonStyle{Comment.LaTeX = \color{gray}\~#\normalfont\space }
\end{Verbatim}

Pour d'autres exemples de personnalisation des commentaires LaTeX, voir la partie \ref{example-comments}
p.~\pageref{example-comments}. 
\end{itemize}


\bigskip 
Si l'utilisateur a demandé l'affichage des numéros de ligne avec |line-numbers|, il est possible de faire référence
à ce numéro de ligne avec la commande |\label| placée dans un commentaire LaTeX.\footnote{Cette fonctionnalité est
  implémentée en redéfinissant, dans les environnements |{Piton}|, la commande |\label|. Il peut donc y avoir des
  incompatibilités avec les extensions qui redéfinissent (globalement) cette commande |\label| (comme
  \pkg{varioref}, \pkg{refcheck}, \pkg{showlabels}, etc.)}




\subsubsection{La clé «math-comments»}

\index{math-comments}

Il est possible de demander que, dans les commentaires Python normaux, c'est-à-dire débutant par~|#| (et non par
|#>|), les éléments placés entre symboles \texttt{\$} soient composés en mode mathématique de LaTeX (le reste du
commentaire restant composé en verbatim).

La clé \Definition{math-comments} (\emph{qui ne peut être activée que dans le préambule du document}) active ce
comportement.

\bigskip
Dans l'exemple suivant, on suppose que |\PitonOptions{math-comments}| a été utilisé dans le préambule du document.

\begin{Verbatim}
\begin{Piton}
def carré(x):
    return x*x ~# renvoie $x^2$
\end{Piton}
\end{Verbatim}

\begin{Piton}
def carré(x):
    return x*x # renvoie $x^2$
\end{Piton}


\subsubsection{La clé «detected-commands»}

\index{detected-commands (key)}
\label{detected-commands}

La clé |detected-commands| de |\PitonOptions| permet de spécifier une liste de noms de commandes LaTeX qui seront
directement détectées par \pkg{piton}.

\begin{itemize}
\item Cette clé |detected-commands| ne peut être utilisée que dans le préambule du document.

\item Les noms de commandes LaTeX doivent apparaître sans la contre-oblique 
(ex. : |detected-commands = { emph , textbf }|). 

\item Ces commandes doivent être des commandes LaTeX à un seul argument obligatoire entre accolades (et ces
accolades doivent être explicites).
\end{itemize}

\medskip
Dans l'exemple suivant, qui est une programmation récursive de la factorielle, on décide de surligner en jaune
l'appel récursif. La commande |\highLight| de \pkg{lua-ul} (cette extension requiert elle-même l'extension
\pkg{luacolor}) permet de le faire avec la syntaxe |\hightLight{...}|.

\smallskip
On suppose que l'on a mis dans le préambule du document LaTeX l'instruction suivante :
\begin{Verbatim}
\PitonOptions{~emphase#detected-commands@ = highLight}
\end{Verbatim}

On peut alors écrire directement :
\begin{Verbatim}
\begin{Piton}
def fact(n):
    if n==0:
        return 1
    else:
        ~emphase#\highLight@{return n*fact(n-1)}
\end{Piton}
\end{Verbatim}

\begin{Piton}
def fact(n):
    if n==0:
        return 1
    else:
        \highLight{return n*fact(n-1)}
\end{Piton}


\subsubsection{Le mécanisme «escape»}

\index{begin-escape}
\index{end-escape}
\label{escape}

Il est aussi possible de surcharger les listings Python pour y insérer du code LaTeX à peu près n'importe où (mais
entre deux lexèmes, bien entendu). Cette fonctionnalité n'est pas activée par défaut par \pkg{piton}. Pour
l'utiliser, il faut spécifier les deux délimiteurs marquant l'échappement (le premier le commençant et le deuxième
le terminant) en utilisant les clés \Definition{begin-escape} et \Definition{end-escape} (\emph{qui ne sont accessibles
que dans le préambule du document}). Les deux délimiteurs peuvent être identiques.

\medskip
On reprend l'exemple précédent de la factorielle et on souhaite surligner en rose l'instruction qui contient l'appel
récursif. La commande |\highLight| de \pkg{lua-ul} permet de le faire avec la syntaxe |\highLight{LightPink}{...}|.
Du fait de la présence de l'argument optionnel entre crochets, on ne peut pas utiliser la clé |detected-commands|
comme précédemment mais on peut utiliser le mécanisme «escape».

\smallskip
On suppose que le préambule du document contient l'instruction :

\begin{Verbatim}
\PitonOptions{~emphase#begin-escape=!,end-escape=!@}
\end{Verbatim}

On peut alors écrire :
\begin{Verbatim}
\begin{Piton}
def fact(n):
    if n==0:
        return 1
    else:
        ~emphase#!\highLight[LightPink]{!@return n*fact(n-1)~emphase#!}!@
\end{Piton}
\end{Verbatim}

\begin{Piton}
def fact(n):
    if n==0:
        return 1
    else:
        !\highLight[LightPink]{!return n*fact(n-1)!}!
\end{Piton}



\bigskip
\emph{Attention} : L'échappement vers LaTeX permis par les clés |begin-escape| et |end-escape| n'est pas actif dans
les chaînes de caractères ni dans les commentaires (pour avoir un commentaire entièrement en échappement vers
LaTeX, c'est-à-dire ce qui est appelé dans ce document «commentaire LaTeX», il suffit de le faire débuter par
|#>|).


\subsubsection{Le mécanisme «escape-math»}

\index{escape-math}
\index{begin-escape-math}
\index{end-escape-math}

Le mécanisme «|escape-math|» est très similaire au mécanisme «|escape|» puisque la seule différence est que les
éléments en échappement LaTeX y sont composés en mode mathématique.

On active ce mécanisme avec les clés \Definition{begin-escape-math} et \Definition{end-escape-math} (\emph{qui ne sont
accessibles que dans le préambule du document}).

\medskip
Malgré la proximité technique, les usages du mécanisme «|escape-math|» sont en fait assez différents de ceux du
mécanisme «|escape|». En effet, comme le contenu en échappement est composé en mode mathématique, il est en
particulier composé dans un groupe TeX et ne pourra donc pas servir à changer le formatage d'autres unités lexicales.

\medskip
Dans les langages où le caractère |$| ne joue pas un rôle syntaxique important, on peut assez naturellement
vouloir activer le mécanisme «|escape-math|» avec le caractère |$|:
\begin{Verbatim}
\PitonOptions{~emphase#begin-escape-math=$,end-escape-math=$@}
\end{Verbatim}
Remarquer que le caractère |$| ne doit \emph{pas} être protégé par une contre-oblique.

\bigskip
Néanmoins, il est sans doute plus prudent d'utiliser |\(| et |\)|.
\begin{Verbatim}
\PitonOptions{~emphase#begin-escape-math=\(,end-escape-math=\)@}
\end{Verbatim}

\bigskip
Voici un exemple d'utilisation typique :

\medskip
\begin{Verbatim}
\begin{Piton}[line-numbers]
def arctan(x,n=10):
    if ~emphase#\(x < 0\)@ :
        return ~emphase#\(-\arctan(-x)\)@ 
    elif ~emphase#\(x > 1\)@ : 
        return ~emphase#\(\pi/2 - \arctan(1/x)\)@ 
    else: 
        s = ~emphase#\(0\)@
        for ~emphase#\(k\)@ in range(~emphase#\(n\)@): s += ~emphase#\(\smash{\frac{(-1)^k}{2k+1} x^{2k+1}}\)@
        return s
\end{Piton}
\end{Verbatim}


\bigskip

\begin{Piton}[line-numbers]
def arctan(x,n=10):
    if \(x < 0\) :
        return \(-\arctan(-x)\) 
    elif \(x > 1\) : 
        return \(\pi/2 - \arctan(1/x)\) 
    else: 
        s = \(0\)
        for \(k\) in range(\(n\)): s += \(\smash{\frac{(-1)^k}{2k+1} x^{2k+1}}\)
        return s
\end{Piton}



\subsection{Comportement dans la classe Beamer}

\label{beamer}

\index{Beamer@\cls{Beamer} (classe)}

\emph{Première remarque}\par\nobreak
Remarquons que, comme l'environnement |{Piton}| prend son argument selon un mode verbatim, il convient, ce qui
n'est pas surprenant, de l'utiliser dans des environnements |{frame}| de Beamer protégés par la clé |fragile|,
c'est-à-dire débutant par |\begin{frame}[fragile]|.\footnote{On rappelle que pour un environnement |{frame}| de Beamer qui
  utilise la clé |fragile|, l'instruction |\end{frame}| doit être seule sur une ligne (à l'exception d'éventuels
  espaces en début de ligne).}


\medskip
Quand l'extension \pkg{piton} est utilisée dans la classe \cls{beamer}\footnote{L'extension \pkg{piton} détecte la
  classe \cls{beamer} et l'extension \pkg{beamerarticle} si elle est chargée précédemment, mais il est aussi
  possible, si le besoin s'en faisait sentir, d'activer ce comportement avec la clé |beamer| au chargement de
  \pkg{piton} : |\usepackage[beamer]{piton}|}, le comportement de \pkg{piton} est légèrement modifié, comme décrit
maintenant.

\subsubsection{\{Piton\} et \textbackslash PitonInputFile sont ``overlay-aware''}

Quand \pkg{piton} est utilisé avec Beamer, l'environnement |{Piton}| et la commande |\PitonInputFile| acceptent
l'argument optionnel |<...>| de Beamer pour indiquer les «\emph{overlays}» concernés.

On peut par exemple écrire :

\begin{Verbatim}
\begin{Piton}~emphase#<2-5>@
...
\end{Piton}
\end{Verbatim}

ou aussi 

\begin{Verbatim}
\PitonInputFile~emphase#<2-5>@{mon_fichier.py}
\end{Verbatim}


\subsubsection{Commandes de Beamer reconnues dans \{Piton\} et \textbackslash PitonInputFile}

Quand \pkg{piton} est utilisé dans la classe \cls{beamer}, les commandes suivantes de \cls{beamer} (classées selon
leur nombre d'arguments obligatoires) sont directement reconnues dans les environnements |{Piton}| (ainsi que dans
les listings composés par la commande |\PitonInputFile|, même si c'est sans doute moins utile).
%
\begin{itemize}
\item aucun argument obligatoire : |\pause|\footnote{On remarquera que, bien sûr, on peut aussi utiliser |\pause|
  dans un «commentaire LaTeX», c'est-à-dire en écrivant |#> \pause|. Ainsi, si le code Python est copié, il est
  interprétable par Python.} ;
\item un argument obligatoire : |\action|, |\alert|, |\invisible|, |\only|, |\uncover| et |\visible| ;
\item deux arguments obligatoires : |\alt| ; 
\item trois arguments obligatoires : |\temporal|.
\end{itemize}

\medskip
Les accolades dans les arguments obligatoires de ces commandes doivent être équilibrées (cependant, les accolades
présentes dans des chaînes courtes\footnote{Les chaînes courtes de Python sont les chaînes (string) délimitées par
  les caractères \texttt{'} ou \texttt{"} non triplés. En Python, les chaînes de caractères courtes ne peuvent pas
  s'étendre sur plusieurs lignes de code.} de Python ne sont pas prises en compte).

\medskip
Concernant les fonctions |\alt| et |\temporal|, aucun retour à la ligne ne doit se trouver dans les arguments de ces fonctions.


\medskip
Voici un exemple complet de fichier :

\begin{Verbatim}[formatcom = \small\color{gray}]
\documentclass{beamer}
\usepackage{piton}
\begin{document}
\begin{frame}[fragile]
\begin{Piton}
def string_of_list(l):
    """Convertit une liste de nombres en chaîne"""
~emphase#    \only<2->{s = "{" + str(l[0])}@
~emphase#    \only<3->{for x in l[1:]: s = s + "," + str(x)}@
~emphase#    \only<4->{s = s + "}"}@
    return s
\end{Piton}
\end{frame}
\end{document}
\end{Verbatim}

Dans l'exemple précédent, les accolades des deux chaînes de caractères Python |"{"| et |"}"| sont correctement
interprétées (sans aucun caractère d'échappement).



\bigskip
\subsubsection{Environnements de Beamer reconnus dans \{Piton\} et \textbackslash PitonInputFile}

Quand \pkg{piton} est utilisé dans la classe \pkg{beamer}, les environnements suivants de Beamer sont directement
reconnus dans les environnements |{Piton}| (ainsi que dans les listings composés par la commande |\PitonInputFile|
même si c'est sans doute moins utile) : |{actionenv}|, |{alertenv}|, |{invisibleenv}|, |{onlyenv}|, |{uncoverenv}|
et |{visibleenv}|.


\medskip
Il y a néanmoins une restriction : ces environnements doivent englober des \emph{lignes entières de code Python}.


\medskip
On peut par exemple écrire :

\begin{Verbatim}[formatcom = \small\color{gray}]
\documentclass{beamer}
\usepackage{piton}
\begin{document}
\begin{frame}[fragile]
\begin{Piton}
def carré(x):
    """Calcule le carré de l'argument"""
    ~emphase#\begin{uncoverenv}<2>@
    return x*x
    ~emphase#\end{uncoverenv}@
\end{Piton}
\end{frame}
\end{document}
\end{Verbatim}



\vspace{1cm}
\textbf{Remarque à propos de la commande \textbackslash alert et de l'environnement \{alertenv\} de Beamer}\par\nobreak

\smallskip
Beamer propose un moyen aisé de changer la couleur utilisée par l'environnement |{alertenv}| (et par la commande
|\alert| qui s'appuie dessus). Par exemple, on peut écrire:

\begin{Verbatim}
\setbeamercolor{~emphase#alerted text@}{fg=blue} 
\end{Verbatim}

Néanmoins, dans le cas d'une utilisation à l'intérieur d'un environnement |{Piton}| un tel réglage n'est sans doute
pas pertinent, puisque, justement, \pkg{piton} va (le plus souvent) changer la couleur des élements selon leur
valeur lexicale. On préfèrera sans doute un environnement |{alertenv}| qui change la couleur de fond des
éléments à mettre en évidence.

\smallskip
Voici un code qui effectuera ce travail en mettant un fond jaune. Ce code utilise la commande |\@highLight| de
l'extension \pkg{lua-ul} (cette extension nécessite elle-même l'extension \pkg{luacolor}).

\begingroup
\fvset{commandchars=\~\#\+,formatcom=\color{gray}}
\begin{Verbatim}
\setbeamercolor{alerted text}{bg=yellow!50}
\makeatletter
\AddToHook{env/Piton/begin}
  {\renewenvironment<>{alertenv}{\only~#1{~emphase#\@highLight+[alerted text.bg]}}{}}
\makeatother
\end{Verbatim}
\endgroup

Ce code redéfinit localement l'environnement |{alertenv}| à l'intérieur de l'environnement |{Piton}| (on rappelle
que la commande |\alert| s'appuie sur cet environnement |{alertenv}|). 



\bigskip


\bigskip
\subsection{Notes de pied de page dans les environnements de piton}

\index{footnote@\pkg{footnote} (extension)}
\index{footnote (clé)}
\index{footnotehyper@\pkg{footnotehyper} (extension)}
\index{footnotehyper (clé)}

\label{footnote}


Si vous voulez mettre des notes de pied de page dans un environnement de \pkg{piton} (ou bien dans un listing
produit par |\PitonInputFile|, bien que cela paraisse moins pertinent dans ce cas-là) vous pouvez utiliser une
paire |\footnotemark|--|\footnotetext|. 

\smallskip
Néanmoins, il est également possible d'extraire les notes de pieds de page avec l'extension \pkg{footnote} ou bien
l'extension \pkg{footnotehyper}.

\smallskip
Si \pkg{piton} est chargée avec l'option |footnote| (avec |\usepackage[footnote]{piton}|) l'extension
\pkg{footnote} est chargée (si elle ne l'est pas déjà) et elle est utilisée pour extraire les notes de pied de
page.

\smallskip
Si \pkg{piton} est chargée avec l'option |footnotehyper|, l'extension \pkg{footnotehyper} est chargée (si
elle ne l'est pas déjà) et elle est utilisée pour extraire les notes de pied de page.

\smallskip
Attention : Les extensions \pkg{footnote} et \pkg{footnotehyper} sont incompatibles.
L'extension \pkg{footnotehyper} est le successeur de l'extension \pkg{footnote}
et devrait être utilisée préférentiellement. L'extension \pkg{footnote} a quelques défauts ;
en particulier, elle doit être chargée après l'extension \pkg{xcolor} et elle n'est pas parfaitement
compatible avec \pkg{hyperref}.

\medskip
Dans ce document, l'extension \pkg{piton} a été chargée avec l'option |footnotehyper| et c'est pourquoi des notes
peuvent être mises dans les environnements |{Piton}| : voir un exemple sur la première page de ce document. 

\subsection{Tabulations}

\index{tabulations}
\index{tab-size}

\smallskip
Même s'il est recommandé d'indenter les listings Python avec des espaces (cf. PEP~8), \pkg{piton} accepte les
caractères de tabulations (U+0009) en début de ligne. Chaque caractère U+0009 est remplacé par $n$ espaces. La
valeur initiale de~$n$ est~4 mais on peut la changer avec la clé |tab-size| de |\PitonOptions|.

\smallskip
Il existe aussi une clé |tabs-auto-gobble| qui détermine le nombre minimal de caractères U+0009 débutant chaque
ligne (non vide) de l'environnement |{Piton}| et applique |gobble| avec cette valeur (avant le remplacement des
caractères U+0009 par des espaces, bien entendu). Cette clé est donc similaire à la clé |auto-gobble| mais agit sur
des caractères U+0009 au lieu de caractères U+0020 (espaces).


\section{API pour les développeurs}


\index{piton.last@\texttt{piton.get\_last\_code} (fonction Lua)}
\label{API}

La variable L3 |\l_piton_language_str| contient le nom du langage courant (en minuscules).

\bigskip

\colorbox{yellow!50}{\textbf{Nouveau 2.6}}\par\nobreak

L'extension \pkg{piton} fournit une fonction Lua |piton.get_last_code| sans argument permettant de récupérer le
code contenu dans le dernier environnement de \pkg{piton}. 
\begin{itemize}
\item Les retours à la ligne (présents dans l'environnement de départ) apparaissent comme des caractères |\r|
(c'est-à-dire des caractères U+000D).

\item Le code fourni par |piton.get_last_code()| tient compte de l'éventuelle application d'une clé |gobble| (cf.
p.~\pageref{gobble}). 

\item Les surcharges du code (qui entraînent des échappements vers LaTeX) ont été retirées du code fourni par
|piton.get_last_code()|. Cela s'applique aux commandes LaTeX déclarées par la clé |detected-commands| (cf.
partie~\ref{detected-commands}) et aux éléments insérés avec le mécanisme «|escape|» (cf. partie~\ref{escape}).

\item |piton.get_last_code| est une fonction Lua et non une chaîne de caractères : les traitements présentés
précédemment sont exécutés lorsque la fonction est appelée. De ce fait, il peut être judicieux de stocker la valeur  
renvoyée par |piton.get_last_code()| dans une variable Lua si on doit l'utiliser plusieurs fois.
\end{itemize}

\medskip
Pour un exemple d'utilisation, voir la partie concernant l'utilisation (standard) de \pkg{pyluatex},
partie~\ref{pyluatex}, p.~\pageref{pyluatex}.


\section{Exemples}

\subsection{Numérotation des lignes}

\label{example-numbering}
\index{numérotation des lignes de code|emph}

On rappelle que l'on peut demander la numérotation des lignes des listings avec la clé |line-numbers|.

Par défaut, les numéros de ligne sont composés par \pkg{piton} en débordement à gauche (en utilisant en interne la commande |\llap| de LaTeX).

Si on ne veut pas de débordement, on peut utiliser l'option |left-margin=auto| qui va insérer une marge adaptée aux
numéros qui seront insérés (elle est plus large quand les numéros dépassent 10).


\begingroup
\fvset{commandchars=\~\&\@,formatcom=\small\color{gray}}
\begin{Verbatim}
~emphase&\PitonOptions{background-color=gray!10, left-margin = auto, line-numbers}@
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)        #> (appel récursif)
    elif x > 1: 
        return pi/2 - arctan(1/x) #> (autre appel récursif) 
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\end{Verbatim}
\endgroup



\begingroup
\PitonOptions{background-color=gray!10,left-margin = auto, line-numbers}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)        #> (appel récursif)
    elif x > 1: 
        return pi/2 - arctan(1/x) #> (autre appel récursif) 
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\endgroup


\bigskip

\subsection{Formatage des commentaires LaTeX}

\label{example-comments}
\index{commentaires LaTeX|emph}

On peut modifier le style |Comment.LaTeX| (avec |\SetPitonStyle|) pour faire afficher les commentaires 
LaTeX (qui débutent par |#>|) en butée à droite.

\begingroup
\fvset{commandchars=\~\&\@,formatcom=\small\color{gray}}
\begin{Verbatim}
\PitonOptions{background-color=gray!10}
~emphase&\SetPitonStyle{Comment.LaTeX = \hfill \normalfont\color{gray}}@
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)        #> appel récursif
    elif x > 1: 
        return pi/2 - arctan(1/x) #> autre appel récursif 
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\end{Verbatim}
\endgroup

\begingroup
\PitonOptions{background-color=gray!10}
\SetPitonStyle{Comment.LaTeX = \hfill \normalfont\color{gray}}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)        #> appel récursif
    elif x > 1: 
        return pi/2 - arctan(1/x) #> autre appel récursif 
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\endgroup


\vspace{1cm}
On peut aussi faire afficher les commentaires dans une deuxième colonne à droite si on limite la largeur du code
proprement dit avec la clé |width|. Dans l'exemple qui suit, on utilise la clé |width| avec la valeur
spéciale~|min|. Plusieurs compilations sont nécessaires.


\begingroup
\fvset{commandchars=\~\&\@,formatcom=\small\color{gray}}
\begin{Verbatim}
\PitonOptions{width=min, background-color=gray!10}
~emphase&\NewDocumentCommand{\MyLaTeXCommand}{m}{\hfill \normalfont\itshape\rlap{\quad #1}}@
~emphase&\SetPitonStyle{Comment.LaTeX = \MyLaTeXCommand}@
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)       #> appel récursif
    elif x > 1: 
        return pi/2 - arctan(1/x) #> autre appel récursif 
    else: 
        s = 0
        for k in range(n):
             s += (-1)**k/(2*k+1)*x**(2*k+1)
        return s 
\end{Piton}
\end{Verbatim}
\endgroup



\begingroup
\PitonOptions{width = min, background-color=gray!10}
\NewDocumentCommand{\MyLaTeXCommand}{m}{\hfill \normalfont\itshape\rlap{\quad #1}}
\SetPitonStyle{Comment.LaTeX = \MyLaTeXCommand}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)       #> appel récursif
    elif x > 1: 
        return pi/2 - arctan(1/x) #> autre appel récursif 
    else: 
        s = 0
        for k in range(n):
             s += (-1)**k/(2*k+1)*x**(2*k+1)
        return s 
\end{Piton}
\endgroup

\bigskip

\subsection{Notes dans les listings}

\index{notes dans les listings|emph}

Pour pouvoir extraire les notes (introduites par |\footnote|), l'extension |piton| doit être chargée, soit avec la
clé |footnote|, soit avec la clé |footnotehyper|, comme expliqué à la section \ref{footnote} p.~\pageref{footnote}.
Dans le présent document, l'extension \pkg{piton} a été chargée par la clé |footnotehyper|.

Bien entendu, une commande |\footnote| ne peut apparaître que dans un commentaire LaTeX (qui débute par |#>|). Un
tel commentaire peut se limiter à cette unique commande |\footnote|, comme dans l'exemple suivant.

\begingroup
\fvset{commandchars=\~\&\@,formatcom=\small\color{gray}}
\begin{Verbatim}
\PitonOptions{background-color=gray!10}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)~emphase&#>\footnote{Un premier appel récursif.}]@
    elif x > 1: 
        return pi/2 - arctan(1/x)~emphase&#>\footnote{Un deuxième appel récursif.}@
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\end{Verbatim}
\endgroup

\begingroup
\PitonOptions{background-color=gray!10}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)#>\footnote{Un premier appel récursif.}
    elif x > 1: 
        return pi/2 - arctan(1/x)#>\footnote{Un deuxième appel récursif.}
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\endgroup


\vspace{1cm}

Si on utilise l'environnement |{Piton}| dans un environnement |{minipage}| de LaTeX, les notes sont, bien entendu,
composées au bas de l'environnement |{minipage}|. Rappelons qu'une telle |{minipage}| ne peut être coupée par un
saut de page. 


\begingroup
\fvset{commandchars=\~\&\@,formatcom=\small\color{gray}}
\begin{Verbatim}
\PitonOptions{background-color=gray!10}
\emphase\begin{minipage}{\linewidth}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)~emphase&#>\footnote{Un premier appel récursif.}@
    elif x > 1: 
        return pi/2 - arctan(1/x)~emphase&#>\footnote{Un deuxième appel récursif.}@
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\end{minipage}
\end{Verbatim}
\endgroup

\begingroup
\PitonOptions{background-color=gray!10}
\begin{minipage}{\linewidth}
\begin{Piton}
def arctan(x,n=10):
    if x < 0:
        return -arctan(-x)#>\footnote{Un premier appel récursif.}
    elif x > 1: 
        return pi/2 - arctan(1/x)#>\footnote{Un deuxième appel récursif.}
    else: 
        return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) 
\end{Piton}
\end{minipage}
\endgroup


\bigskip

\subsection{Un exemple de réglage des styles}

Les styles graphiques ont été présentés à la partie \ref{styles}, p.~\pageref{styles}.

\smallskip
On présente ici un réglage de ces styles adapté pour les documents en noir et blanc. On l'utilise avec la fonte
\emph{DejaVu Sans Mono}\footnote{Voir: \url{https://dejavu-fonts.github.io}} spécifiée avec la commande
  |\setmonofont| de \pkg{fontspec}.

Ce réglage utilise la commande |\highLight| de \pkg{lua-ul} (cette extension nécessite elle-même l'extension \pkg{luacolor}).


\begin{Verbatim}
\setmonofont[Scale=0.85]{DejaVu Sans Mono}

\SetPitonStyle
  {
    Number = ,
    String = \itshape , 
    String.Doc = \color{gray} \itshape ,
    Operator = , 
    Operator.Word = \bfseries ,
    Name.Builtin = ,
    Name.Function = \bfseries \highLight[gray!20] ,
    Comment = \color{gray} ,
    Comment.LaTeX = \normalfont \color{gray},
    Keyword = \bfseries ,
    Name.Namespace = ,
    Name.Class = , 
    Name.Type = ,
    InitialValues = \color{gray}
  }
\end{Verbatim}


Dans ce réglage, de nombreuses valeurs fournies aux clés sont vides, ce qui signifie que le style correspondant
n'insèrera aucune instruction de formatage (l'élément sera composé dans la couleur standard, le plus souvent, en noir,
etc.). Ces entrées avec valeurs nulles sont néanmoins nécessaires car la valeur initiale de ces styles dans
\pkg{piton} n'est \emph{pas} vide.

\begingroup


\setmonofont[Scale=0.85]{DejaVu Sans Mono}

\SetPitonStyle
  {
    Number = ,
    String = \itshape , 
    String.Doc = \color{gray} \itshape ,
    Operator = , 
    Operator.Word = \bfseries ,
    Name.Builtin = ,
    Name.Function = \bfseries \highLight[gray!20] ,
    Comment = \color{gray} ,
    Comment.LaTeX = \normalfont \color{gray},
    Keyword = \bfseries ,
    Name.Namespace = ,
    Name.Class = , 
    Name.Type = ,
    InitialValues = \color{gray}
  }


\bigskip 

\begin{Piton}
from math import pi

def arctan(x,n=10):
    """Compute the mathematical value of arctan(x)

    n is the number of terms in the sum
    """
    if x < 0:
        return -arctan(-x) # appel récursif
    elif x > 1: 
        return pi/2 - arctan(1/x) 
        #> (on a utilisé le fait que $\arctan(x)+\arctan(1/x)=\pi/2$ pour $x>0$)
    else: 
        s = 0
        for k in range(n):
            s += (-1)**k/(2*k+1)*x**(2*k+1)
        return s 
\end{Piton}


\endgroup

\section{Utilisation avec pyluatex}

\subsection{Utilisation standard de pyluatex}

\label{pyluatex}
\index{pyluatex@{\pkg{pyluatex}} (extension)}

L'extension \pkg{pyluatex} est une extension qui permet l'exécution de code Python à partir de |lualatex| (pourvu
que Python soit installé sur la machine et que la compilation soit effectuée avec |lualatex| et |--shell-escape|).

Voici, à titre d'exemple, un environnement |{PitonExecute}| qui formate un listing Python (avec \pkg{piton}) et qui
affiche également dessous le résultat de l'exécution de ce code avec Python.


\begin{Verbatim}
\NewPitonEnvironment{~emphase#PitonExecute@}{O{}}
  {\PitonOptions{~#1}}
  {\begin{center}
   \directlua{pyluatex.execute(piton.get_last_code(), false, true, false, true)}%
   \end{center}
   \ignorespacesafterend}
\end{Verbatim}

\NewPitonEnvironment{PitonExecute}{O{}}
  {\PitonOptions{#1}}
  {\begin{center}
   \directlua{pyluatex.execute(piton.get_last_code(), false, true, false, true)}%
   \end{center}
   \ignorespacesafterend}


On a utilisé la fonction Lua |piton.get_last_code| fournie dans l'API de \pkg{piton} : cf.~partie~\ref{API},
p.~\pageref{API}. 

\bigskip
Cet environnement |{PitonExecute}| prend en argument optionnel (entre crochets) les options proposées par la
commande |\PitonOptions|.

\begin{Verbatim}
\begin{~emphase#PitonExecute@}[background-color=gray!15]
def carré(x):
    """Calcule le carré de l'argument"""
    return x*x
print(f'Le carré de 12 est {carré(12)}.')
\end{~emphase#PitonExecute@}
\end{Verbatim}


\medskip
\begin{PitonExecute}[background-color=gray!15]
def carré(x):
    """Calcule le carré de l'argument"""
    return x*x
print(f'Le carré de 12 est {carré(12)}.')
\end{PitonExecute}

\bigskip

\subsection{Utilisation de l'environnement \{pythonrepl\} de pyluatex}

\label{pythonrepl}

\index{pythonrepl@\texttt{\{pythonrepl\}} (environnement de \pkg{pyluatex})}

L'environnement |{pythonrepl}| de \pkg{pyluatex} passe son contenu à Python et renvoie ce que l'on obtient quand on
fournit ce code à une boucle \textsc{repl} (\emph{read-eval-print loop}) de Python. On obtient un entrelacement
d'instructions précédées par le prompt |>>>| de Python et des valeurs renvoyées par Python (et de ce qui a été
demandé d'être affiché avec des \piton{print} de Python).

\medskip
Il est ensuite possible de passer cela à un environnement |{Piton}| qui va faire un coloriage syntaxique 
et mettre sur fond grisé les lignes correspondant aux instructions fournies à l'interpréteur Python (grâce à la clé
|prompt-background-color| de |\PitonOptions|).


\medskip
Voici la programmation d'un environnement |{PitonREPL}| qui effectue ce travail (pour des raisons techniques, le
|!| est ici obligatoire dans la signature de l'environnement). On ne peut pas procéder comme précédemment (dans
l'utilisation «standard» de \pkg{pyluatex}) car, bien sûr, c'est le retour fait par |{pythonrepl}| qui doit être
traité par \pkg{piton}. De ce fait, il ne sera pas possible de mettre des surcharges (avec |detected-commands| ou
le mécanisme |escape|) dans le code.

\begin{Verbatim}
\ExplSyntaxOn
\NewDocumentEnvironment { PitonREPL } { ! O { } } % le ! est obligatoire
 { 
   \PitonOptions
     { 
       background-color=white,
       ~emphase#prompt-background-color = gray!10@,
       ~#1
     }
   \PyLTVerbatimEnv
   \begin{pythonrepl}
 }
 {
   \end{pythonrepl}
   \lua_now:n
     {
       tex.print("\\begin{Piton}")
       tex.print(pyluatex.get_last_output())
       tex.print("\\end{Piton}")
       tex.print("") 
     } 
   \ignorespacesafterend
 }
\ExplSyntaxOff
\end{Verbatim}

\medskip
Voici un exemple d'utilisation de ce nouvel environnement |{PitonREPL}|.

\medskip
\begin{Verbatim}
~emphase#\begin{PitonREPL}@
    def valeur_absolue(x):
        "Renvoie la valeur absolue de x"
        if x > 0:
           return x
        else:
           return -x

    valeur_absolue(-3)
    valeur_absolue(0)
    valeur_absolue(5)
~emphase#\end{PitonREPL}@
\end{Verbatim}

\bigskip

\ExplSyntaxOn
\NewDocumentEnvironment { PitonREPL } { }
 { 
   \PitonOptions{background-color=white,prompt-background-color = gray!10}
   \PyLTVerbatimEnv
   \begin{pythonrepl}
 }
 {
   \end{pythonrepl}
   \lua_now:n
     {
       tex.print("\\begin{Piton}")
       tex.print(pyluatex.get_last_output())
       tex.print("\\end{Piton}")
       tex.print("") 
     }
   \ignorespacesafterend
 }
\ExplSyntaxOff
 
\begin{PitonREPL}
    def valeur_absolue(x):
        "Renvoie la valeur absolue de x"
        if x > 0:
           return x
        else:
           return -x

    valeur_absolue(-3)
    valeur_absolue(0)
    valeur_absolue(5)
\end{PitonREPL}


\bigskip
En fait, il est possible de ne pas faire afficher les prompts eux-mêmes (c'est-à-dire les chaînes de caractères
|>>>| et |...|). En effet, \pkg{piton} propose un style pour ces éléments, qui est appelé |Prompt|. Par défaut, la
valeur de ce style est vide, ce qui fait qu'aucune action n'est exécutée sur ces éléments qui sont donc affichés
tels quels. En fournissant comme valeur une fonction qui se contente de gober son argument, on peut demander à ce
qu'ils ne soient pas affichés.

\bigskip
\begin{savenotes}
\begin{Verbatim}
\NewDocumentCommand{\Gobe}{m}{}#~color#black@~footnote#On a défini ici une fonction ~texttt#~string~Gobe@ mais, en fait, elle existe déjà en L3 sous le nom ~texttt#~string~use~_none:n@.@@
\SetPitonStyle{ ~emphase#Prompt = \Gobe@ }
\end{Verbatim}
\end{savenotes}




\NewDocumentCommand{\Gobe}{m}{}
\ExplSyntaxOn
\SetPitonStyle{ Prompt = \use_none:n }
\ExplSyntaxOff

\bigskip
L'exemple précédent donne alors :

\medskip
\begin{Verbatim}
~emphase#\begin{PitonREPL}@
    def valeur_absolue(x):
        "Renvoie la valeur absolue de x"
        if x > 0:
           return x
        else:
           return -x

    valeur_absolue(-3)
    valeur_absolue(0)
    valeur_absolue(5)
~emphase#\end{PitonREPL}@
\end{Verbatim}



\begin{PitonREPL}
    def valeur_absolue(x):
        "Renvoie la valeur absolue de x"
        if x > 0:
           return x
        else:
           return -x

    valeur_absolue(-3)
    valeur_absolue(0)
    valeur_absolue(5)
\end{PitonREPL}

\clearpage

\section{Les styles pour les différents langages informatiques}

\label{Semantic}


\subsection{Le langage Python}

Le langage par défaut de l'extension \pkg{piton} est Python. Si besoin est, on peut revenir au langage Python avec
|\PitonOptions{language=Python}|. 

\bigskip

Les réglages initiaux effectués par \pkg{piton} dans |piton.sty| sont inspirés par le style \pkg{manni} de Pygments
tel qu'il est appliqué au langage Python par Pygments.\footnote{Voir \url{https://pygments.org/styles/}. À
  remarquer que, par défaut, Pygments propose pour le style \pkg{manni} un fond coloré dont la couleur est la
  couleur HTML |#F0F3F3|. Il est possible d'avoir la même couleur dans |{Piton}| avec l'instruction :
  |\PitonOptions{background-color = [HTML]{F0F3F3}}|}

\vspace{1cm}


\begin{center}
\begin{tabularx}{0.9\textwidth}{@{}>{\ttfamily}l>{\raggedright\arraybackslash}X@{}}
  \toprule
  \normalfont Style  & Usage \\
  \midrule
  Number & les nombres \\
  String.Short & les chaînes de caractères courtes (entre \texttt{'} ou \texttt{"}) \\
  String.Long & les chaînes de caractères longues (entre \texttt{'''} ou \texttt{"""}) sauf les chaînes de
                documentation (qui sont gérées par |String.Doc|)\\
  String & cette clé fixe à la fois |String.Short| et |String.Long| \\
  String.Doc & les chaînes de documentation (seulement entre |"""| suivant PEP~257) \\
  String.Interpol & les éléments syntaxiques des champs des f-strings (c'est-à-dire les caractères \texttt{\{} et
                    \texttt{\}}) ; ce style hérite des styles |String.Short| et |String.Long| (suivant la chaîne où
                    apparaît l'interpolation)\\
  Interpol.Inside & le contenu des interpolations dans les f-strings (c'est-à-dire les éléments qui se trouvent entre
                    \texttt{\{} et~\texttt{\}} ; si l'utilisateur n'a pas fixé ce style, ces éléments sont analysés et formatés par \pkg{piton}
                    au même titre que le reste du code. \\
                    Operator & les opérateurs suivants : \texttt{!= == << >> - \~{} + / * \% = < > \& .} \verb+|+ |@| \\
  Operator.Word & les opérateurs suivants : |in|, |is|, |and|, |or| et |not| \\
  Name.Builtin & la plupart des fonctions prédéfinies par Python \\
  Name.Decorator & les décorateurs (instructions débutant par \verb|@|) \\
  Name.Namespace & le nom des modules (= bibliothèques extérieures) \\
  Name.Class & le nom des classes au moment de leur définition, c'est-à-dire après le mot-clé \verb|class| \\
  Name.Function & le nom des fonctions définies par l'utilisateur \emph{au moment de leur définition} (après le
                  mot-clé |def|) \\
  UserFunction & le nom des fonctions précédemment définies par l'utilisateur (la valeur initiale de ce paramètre est
                 vide et ces éléments sont affichés en noir --- ou plutôt dans la couleur courante) \\
  Exception & les exceptions prédéfinies (ex.: \texttt{SyntaxError}) \\
  InitialValues & les valeurs initiales (et le symbole |=| qui précède) des arguments optionnels dans les définitions
                  de fonctions ; si l'utilisateur n'a pas fixé ce style, ces éléments sont analysés et formatés par \pkg{piton}
                  au même titre que le reste du code.\\
  Comment & les commentaires commençant par \texttt{\#} \\
  Comment.LaTeX & les commentaires commençant par \texttt{\#>} qui sont composés par \pkg{piton} comme du code LaTeX (et
                  appelés simplement «commentaires LaTeX» dans ce document) \\
  Keyword.Constant & |True|, |False| et |None| \\
  Keyword & les mots-clés suivants :
            \ttfamily assert, break, case, continue, del,
            elif, else, except, exec, finally, for, from, 
            global, if, import, lambda, non local,
            pass, raise, return, try, while,
            with, yield et yield from.\\
  \bottomrule
\end{tabularx}
\end{center}


\newpage

\subsection{Le langage OCaml}

On peut basculer vers le langage |OCaml| avec |\PitonOptions{language = OCaml}|

\bigskip
On peut aussi choisir le langage |OCaml| pour un environnement |{Piton}| individuel :
%
\begin{Verbatim}
\begin{Piton}~emphase#[language=OCaml]@
...
\end{Piton}
\end{Verbatim}


\bigskip
L'option est aussi disponible pour |\PitonInputFile| : |\PitonInputFile[language=OCaml]{...}|


\vspace{1cm}


\begin{center}
\begin{tabularx}{0.9\textwidth}{@{}>{\ttfamily}l>{\raggedright\arraybackslash}X@{}}
  \toprule
  \normalfont Style  & Usage \\
  \midrule
  Number & les nombres \\
  String.Short & les caractères (entre \texttt{'}) \\
  String.Long & les chaînes de caractères, entre |"| mais aussi les \emph{quoted-strings} \\
  String & cette clé fixe à la fois |String.Short| et |String.Long| \\
  Operator & les opérateurs, en particulier |+|, |-|, |/|, |*|, |@|, |!=|, |==|, |&&| \\
  Operator.Word & les opérateurs suivants : |and|, |asr|, |land|, |lor|, |lsl|, |lxor|, |mod| et |or| \\
  Name.Builtin & les fonctions |not|, |incr|, |decr|, |fst| et |snd| \\
  Name.Type & le nom des types OCaml \\
  Name.Field & le nom d'un champ de module \\
  Name.Constructor & le nom des constructeurs de types (qui débutent par une majuscule) \\
  Name.Module & le nom des modules \\
  Name.Function & le nom des fonctions définies par l'utilisateur \emph{au moment de leur définition} (après le
                  mot-clé |let|) \\
  UserFunction & le nom des fonctions précédemment définies par l'utilisateur 
                 (la valeur initiale de ce paramètre est
                 vide et ces éléments sont affichés en noir --- ou plutôt dans la couleur courante) \\
  Exception & les exceptions prédéfinies (ex. : |End_of_File|) \\
  TypeParameter & les paramétreurs de type \\
  Comment & les commentaires, entre |(*| et |*)| ; ces commentaires peuvent être imbriqués \\
  Keyword.Constant & |true| et |false| \\
  Keyword & les mots-clés suivants :
            |assert|, |as|, |begin|, |class|, |constraint|, |done|,
            |downto|, |do|, |else|, |end|, |exception|, |external|,
            |for|, |function|, |functor|, |fun| , |if| 
            |include|, |inherit|, |initializer|, |in| , |lazy|, |let|,
            |match|, |method|, |module|, |mutable|, |new|, |object|,
            |of|, |open|, |private|, |raise|, |rec|, |sig|,
            |struct|, |then|, |to|, |try|, |type|, 
            |value|, |val|, |virtual|, |when|, |while| et |with| \\
  \bottomrule
\end{tabularx}
\end{center}

\newpage

\subsection[Le langage C (et C++)]{Le langage C (et \CC)}


On peut basculer vers le langage |C| avec |\PitonOptions{language = C}|

\bigskip
On peut aussi choisir le langage |C| pour un environnement |{Piton}| individuel :
%
\begin{Verbatim}
\begin{Piton}~emphase#[language=C]@
...
\end{Piton}
\end{Verbatim}

\bigskip
L'option est aussi disponible pour |\PitonInputFile| : |\PitonInputFile[language=C]{...}|

\vspace{1cm}

\begin{center}
\begin{tabularx}{0.9\textwidth}{@{}>{\ttfamily}l>{\raggedright\arraybackslash}X@{}}
\toprule
\normalfont Style  & Usage \\
\midrule
Number & les nombres \\
String.Long & les chaînes de caractères (entre \texttt{"}) \\
String.Interpol &  les éléments \texttt{\%d}, \texttt{\%i}, \texttt{\%f}, \texttt{\%c}, etc. dans les chaînes de
                  caractères ; ce style hérite du style |String.Long| \\
Operator & les opérateurs suivants : \texttt{!= == << >> - \~{} + / * \% = < > \& .} \verb+|+ |@| \\
Name.Type & les types prédéfinis suivants :
  |bool|, |char|, |char16_t|, |char32_t|, |double|, |float|, |int|, |int8_t|, |int16_t|, |int32_t|, 
  |int64_t|, |long|, |short|, |signed|, |unsigned|, |void| et |wchar_t| \\ 
Name.Builtin & les fonctions prédéfinies suivantes : |printf|, |scanf|, |malloc|, |sizeof| et  |alignof|  \\
  Name.Class & le nom des classes au moment de leur définition, c'est-à-dire après le mot-clé |class| \\
Name.Function & le nom des fonctions définies par l'utilisateur \emph{au moment de leur définition} \\
UserFunction & le nom des fonctions précédemment définies par l'utilisateur (la valeur initiale de ce paramètre est
               vide et ces éléments sont affichés en noir --- ou plutôt dans la couleur courante) \\
Preproc & les instructions du préprocesseur (commençant par |#|) \\
Comment & les commentaires (commençant par \texttt{//} ou entre |/*| et |*/|) \\
Comment.LaTeX & les commentaires commençant par \texttt{//>} qui sont composés par \pkg{piton} comme du code LaTeX (et
                appelés simplement «commentaires LaTeX» dans ce document) \\
Keyword.Constant & |default|, |false|, |NULL|, |nullptr| et |true| \\
Keyword & les mots-clés suivants :
|alignas|, |asm|, |auto|, |break|, |case|, |catch|, |class|, 
|constexpr|, |const|, |continue|, |decltype|, |do|, |else|, |enum|,
|extern|, |for|, |goto|, |if|, |nexcept|, |private|, |public|, |register|, |restricted|, |try|, 
|return|, |static|, |static_assert|, |struct|, |switch|, |thread_local|, |throw|, 
|typedef|, |union|, |using|, |virtual|, |volatile| et |while|
\\
\bottomrule
\end{tabularx}
\end{center}


\newpage

\subsection{Le langage SQL}

On peut basculer vers le langage |SQL| avec |\PitonOptions{language = SQL}|

\bigskip
On peut aussi choisir le langage |SQL| pour un environnement |{Piton}| individuel :
%
\begin{Verbatim}
\begin{Piton}~emphase#[language=SQL]@
...
\end{Piton}
\end{Verbatim}

\bigskip
L'option est aussi disponible pour |\PitonInputFile| : |\PitonInputFile[language=SQL]{...}|


\vspace{1cm}

\begin{center}
\begin{tabularx}{0.9\textwidth}{@{}>{\ttfamily}l>{\raggedright\arraybackslash}X@{}}
\toprule
\normalfont Style  & Usage \\
\midrule
Number & les nombres \\
String.Long & les chaînes de caractères (entre \texttt{'} et non entre \texttt{"} car les éléments entre \texttt{"}
              sont des noms de champs et formatés avec |Name.Field|) \\
Operator & les opérateurs suivants : 
\texttt{= != <> >= > < <= * + / } \\
Name.Table & les noms des tables \\
Name.Field & les noms des champs des tables \\
Name.Builtin & les fonctions prédéfinies suivantes (leur nom n'est \emph{pas} sensible à la casse) : 
   |avg|, |count|, |char_lenght|, |concat|, |curdate|, |current_date|,
   |date_format|, |day|, |lower|, |ltrim|, |max|, |min|, |month|, |now|,
   |rank|, |round|, |rtrim|, |substring|, |sum|, |upper| et |year|. \\
Comment & les commentaires (débutant par |--| ou bien entre |/*| et |*/|) \\
Comment.LaTeX & les commentaires commençant par \texttt{-->} qui sont composés par \pkg{piton} comme du code LaTeX (et
                appelés simplement «commentaires LaTeX» dans ce document) \\
Keyword & les mots-clés suivants (leur nom n'est \emph{pas} sensible à la casse) :
   |add|, |after|, |all|, |alter|, |and|, |as|, |asc|, |between|, |by|,
   |change|, |column|, |create|, |cross join|, |delete|, |desc|, |distinct|, 
   |drop|, |from|, |group|, |having|, |in|, |inner|, |insert|, |into|, |is|, 
   |join|, |left|, |like|, |limit|, |merge|, |not|, |null|, |on|, |or|, 
   |order|, |over|, |right|, |select|, |set|, |table|, |then|, |truncate|, 
   |union|, |update|, |values|, |when|, |where| et |with|. \\
\bottomrule
\end{tabularx}
\end{center}

\bigskip
Si on souhaite que les mots-clés soient capitalisés automatiquement, on peut modifier le style |Keywords|
localement pour le langage SQL avec l'instruction :
\begin{Verbatim}
\SetPitonStyle~emphase#[SQL]@{Keywords = \bfseries \MakeUppercase}
\end{Verbatim}



\newpage

\subsection{Le langage «minimal»}


\label{minimal}
\index{minimal (langage «minimal»)}

On peut basculer vers le langage «|minimal|» avec |\PitonOptions{language = minimal}|

\bigskip
On peut aussi choisir le langage «|minimal|» pour un environnement |{Piton}| individuel :
%
\begin{Verbatim}
\begin{Piton}~emphase#[language=minimal]@
...
\end{Piton}
\end{Verbatim}

\bigskip
L'option est aussi disponible pour |\PitonInputFile| : |\PitonInputFile[language=minimal]{...}|


\vspace{1cm}

\begin{center}
\begin{tabularx}{0.9\textwidth}{@{}>{\ttfamily}l>{\raggedright\arraybackslash}X@{}}
\toprule
\normalfont Style  & Usage \\
\midrule
Number & les nombres \\
String & les chaînes de caractères (qui sont entre \texttt{"}) \\
Comment & les commentaires (qui débutent par |#|) \\
Comment.LaTeX & les commentaires commençant par \texttt{\#>} qui sont composés par \pkg{piton} comme du code LaTeX (et
                appelés simplement «commentaires LaTeX» dans ce document) \\
\bottomrule
\end{tabularx}
\end{center}

\bigskip
Ce langage «|minimal|» est proposé par \pkg{piton} à l'utilisateur final pour qu'il puisse y ajouter des
formatages de mots-clés avec la commande |\SetPitonIdentifier| (cf. \ref{SetPitonIdentifier},
p.~\pageref{SetPitonIdentifier}) et créer par exemple un langage pour pseudo-code.


\newpage

\phantomsection
\addcontentsline{toc}{section}{Index}

\printindex


\section*{Autre documentation}

Le document |piton.pdf| (fourni avec l'extension \pkg{piton}) contient une traduction anglaise de la
documentation ici présente, ainsi que le code source commenté et un historique des versions. 


\medskip
Les versions successives du fichier |piton.sty| fournies par
TeXLive sont disponibles sur le serveur \textsc{svn} de TeXLive :

\smallskip
{
\small
\nolinkurl{https://tug.org/svn/texlive/trunk/Master/texmf-dist/tex/lualatex/piton/piton.sty}
}

\medskip
Le développement de l'extension \pkg{piton} se fait sur le dépôt GitHub suivant :

\smallskip
\verb|https://github.com/fpantigny/piton|

\tableofcontents



\end{document}