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
|
=========
Changelog
=========
1.2
===
.. changelog::
:version: 1.2
:include_notes_from: unreleased
1.1
===
.. changelog::
:version: 1.1.5
:released: Fri Aug 20 2021
.. change::
:tags: bug, tests
:tickets: 338
Fixed some issues with running the test suite which would be revealed by
running tests in random order.
.. changelog::
:version: 1.1.4
:released: Thu Jan 14 2021
.. change::
:tags: bug, py3k
:tickets: 328
Fixed Python deprecation issues related to module importing, as well as
file access within the Lingua plugin, for deprecated APIs that began to
emit warnings under Python 3.10. Pull request courtesy Petr Viktorin.
.. changelog::
:version: 1.1.3
:released: Fri May 29 2020
.. change::
:tags: bug, templates
:tickets: 267
The default template encoding is now utf-8. Previously, the encoding was
"ascii", which was standard throughout Python 2. This allows that
"magic encoding comment" for utf-8 templates is no longer required.
.. changelog::
:version: 1.1.2
:released: Sun Mar 1 2020
.. change::
:tags: feature, commands
:tickets: 283
Added --output-file argument to the Mako command line runner, which allows
a specific output file to be selected. Pull request courtesy Björn
Dahlgren.
.. changelog::
:version: 1.1.1
:released: Mon Jan 20 2020
.. change::
:tags: bug, py3k
:tickets: 310
Replaced usage of the long-superseded "parser.suite" module in the
mako.util package for parsing the python magic encoding comment with the
"ast.parse" function introduced many years ago in Python 2.5, as
"parser.suite" is emitting deprecation warnings in Python 3.9.
.. change::
:tags: bug, ext
:tickets: 304
Added "babel" and "lingua" dependency entries to the setuptools entrypoints
for the babel and lingua extensions, so that pkg_resources can check that
these extra dependencies are available, raising an informative
exception if not. Pull request courtesy sinoroc.
.. changelog::
:version: 1.1.0
:released: Thu Aug 1 2019
.. change::
:tags: bug, py3k, windows
:tickets: 301
Replaced usage of time.clock() on windows as well as time.time() elsewhere
for microsecond timestamps with timeit.default_timer(), as time.clock() is
being removed in Python 3.8. Pull request courtesy Christoph Reiter.
.. change::
:tags: bug, py3k
:tickets: 295
Replaced usage of ``inspect.getfullargspec()`` with the vendored version
used by SQLAlchemy, Alembic to avoid future deprecation warnings. Also
cleans up an additional version of the same function that's apparently
been floating around for some time.
.. change::
:tags: changed, setup
:tickets: 303
Removed the "python setup.py test" feature in favor of a straight run of
"tox". Per Pypa / pytest developers, "setup.py" commands are in general
headed towards deprecation in favor of tox. The tox.ini script has been
updated such that running "tox" with no arguments will perform a single run
of the test suite against the default installed Python interpreter.
.. seealso::
https://github.com/pypa/setuptools/issues/1684
https://github.com/pytest-dev/pytest/issues/5534
.. change::
:tags: changed, py3k, installer
:tickets: 249
Mako 1.1 now supports Python versions:
* 2.7
* 3.4 and higher
This includes that setup.py no longer includes any conditionals, allowing
for a pure Python wheel build, however this is not necessarily part of the
Pypi release process as of yet. The test suite also raises for Python
deprecation warnings.
1.0
===
.. changelog::
:version: 1.0.14
:released: Sat Jul 20 2019
.. change::
:tags: feature, template
The ``n`` filter is now supported in the ``<%page>`` tag. This allows a
template to omit the default expression filters throughout a whole
template, for those cases where a template-wide filter needs to have
default filtering disabled. Pull request courtesy Martin von Gagern.
.. seealso::
:ref:`expression_filtering_nfilter`
.. change::
:tags: bug, exceptions
Fixed issue where the correct file URI would not be shown in the
template-formatted exception traceback if the template filename were not
known. Additionally fixes an issue where stale filenames would be
displayed if a stack trace alternated between different templates. Pull
request courtesy Martin von Gagern.
.. changelog::
:version: 1.0.13
:released: Mon Jul 1 2019
.. change::
:tags: bug, exceptions
Improved the line-number tracking for source lines inside of Python ``<%
... %>`` blocks, such that text- and HTML-formatted exception traces such
as that of :func:`.html_error_template` now report the correct source line
inside the block, rather than the first line of the block itself.
Exceptions in ``<%! ... %>`` blocks which get raised while loading the
module are still not reported correctly, as these are handled before the
Mako code is generated. Pull request courtesy Martin von Gagern.
.. changelog::
:version: 1.0.12
:released: Wed Jun 5 2019
.. change::
:tags: bug, py3k
:tickets: 296
Fixed regression where import refactors in Mako 1.0.11 caused broken
imports on Python 3.8.
.. changelog::
:version: 1.0.11
:released: Fri May 31 2019
.. change::
:tags: changed
Updated for additional project metadata in setup.py. Additionally,
the code has been reformatted using Black and zimports.
.. changelog::
:version: 1.0.10
:released: Fri May 10 2019
.. change::
:tags: bug, py3k
:tickets: 293
Added a default encoding of "utf-8" when the :class:`.RichTraceback`
object retrieves Python source lines from a Python traceback; as these
are bytes in Python 3 they need to be decoded so that they can be
formatted in the template.
.. changelog::
:version: 1.0.9
:released: Mon Apr 15 2019
.. change::
:tags: bug
:tickets: 287
Further corrected the previous fix for :ticket:`287` as it relied upon
an attribute that is monkeypatched by Python's ``ast`` module for some
reason, which fails if ``ast`` hasn't been imported; the correct
attribute ``Constant.value`` is now used. Also note the issue
was mis-numbered in the previous changelog note.
.. changelog::
:version: 1.0.8
:released: Wed Mar 20 2019
:released: Wed Mar 20 2019
.. change::
:tags: bug
:tickets: 287
Fixed an element in the AST Python generator which changed
for Python 3.8, causing expression generation to fail.
.. change::
:tags: feature
:tickets: 271
Added ``--output-encoding`` flag to the mako-render script.
Pull request courtesy lacsaP.
.. change::
:tags: bug
Removed unnecessary "usage" prefix from mako-render script.
Pull request courtesy Hugo.
.. changelog::
:version: 1.0.7
:released: Thu Jul 13 2017
.. change::
:tags: bug
Changed the "print" in the mako-render command to
sys.stdout.write(), avoiding the extra newline at the end
of the template output. Pull request courtesy
Yves Chevallier.
.. changelog::
:version: 1.0.6
:released: Wed Nov 9 2016
.. change::
:tags: feature
Added new parameter :paramref:`.Template.include_error_handler` .
This works like :paramref:`.Template.error_handler` but indicates the
handler should take place when this template is included within another
template via the ``<%include>`` tag. Pull request courtesy
Huayi Zhang.
.. changelog::
:version: 1.0.5
:released: Wed Nov 2 2016
.. change::
:tags: bug
Updated the Sphinx documentation builder to work with recent
versions of Sphinx.
.. changelog::
:version: 1.0.4
:released: Thu Mar 10 2016
.. change::
:tags: feature, test
The default test runner is now py.test. Running "python setup.py test"
will make use of py.test instead of nose. nose still works as a test
runner as well, however.
.. change::
:tags: bug, lexer
:pullreq: github:19
Major improvements to lexing of intricate Python sections which may
contain complex backslash sequences, as well as support for the bitwise
operator (e.g. pipe symbol) inside of expression sections distinct
from the Mako "filter" operator, provided the operator is enclosed
within parentheses or brackets. Pull request courtesy Daniel Martin.
.. change::
:tags: feature
Added new method :meth:`.Template.list_defs`. Pull request courtesy
Jonathan Vanasco.
.. changelog::
:version: 1.0.3
:released: Tue Oct 27 2015
.. change::
:tags: bug, babel
Fixed an issue where the Babel plugin would not handle a translation
symbol that contained non-ascii characters. Pull request courtesy
Roman Imankulov.
.. changelog::
:version: 1.0.2
:released: Wed Aug 26 2015
.. change::
:tags: bug, installation
:tickets: 249
The "universal wheel" marker is removed from setup.cfg, because
our setup.py currently makes use of conditional dependencies.
In :ticket:`249`, the discussion is ongoing on how to correct our
setup.cfg / setup.py fully so that we can handle the per-version
dependency changes while still maintaining optimal wheel settings,
so this issue is not yet fully resolved.
.. change::
:tags: bug, py3k
:tickets: 250
Repair some calls within the ast module that no longer work on Python3.5;
additionally replace the use of ``inspect.getargspec()`` under
Python 3 (seems to be called from the TG plugin) to avoid deprecation
warnings.
.. change::
:tags: bug
Update the Lingua translation extraction plugin to correctly
handle templates mixing Python control statements (such as if,
for and while) with template fragments. Pull request courtesy
Laurent Daverio.
.. change::
:tags: feature
:tickets: 236
Added ``STOP_RENDERING`` keyword for returning/exiting from a
template early, which is a synonym for an empty string ``""``.
Previously, the docs suggested a bare
``return``, but this could cause ``None`` to appear in the
rendered template result.
.. seealso::
:ref:`syntax_exiting_early`
.. changelog::
:version: 1.0.1
:released: Thu Jan 22 2015
.. change::
:tags: feature
Added support for Lingua, a translation extraction system as an
alternative to Babel. Pull request courtesy Wichert Akkerman.
.. change::
:tags: bug, py3k
Modernized the examples/wsgi/run_wsgi.py file for Py3k.
Pull requset courtesy Cody Taylor.
.. changelog::
:version: 1.0.0
:released: Sun Jun 8 2014
.. change::
:tags: bug, py2k
Improved the error re-raise operation when a custom
:paramref:`.Template.error_handler` is used that does not handle
the exception; the original stack trace etc. is now preserved.
Pull request courtesy Manfred Haltner.
.. change::
:tags: bug, py2k, filters
Added an html_escape filter that works in "non unicode" mode.
Previously, when using ``disable_unicode=True``, the ``u`` filter
would fail to handle non-ASCII bytes properly. Pull request
courtesy George Xie.
.. change::
:tags: general
Compatibility changes; in order to modernize the codebase, Mako
is now dropping support for Python 2.4 and Python 2.5 altogether.
The source base is now targeted at Python 2.6 and forwards.
.. change::
:tags: feature
Template modules now generate a JSON "metadata" structure at the bottom
of the source file which includes parseable information about the
templates' source file, encoding etc. as well as a mapping of module
source lines to template lines, thus replacing the "# SOURCE LINE"
markers throughout the source code. The structure also indicates those
lines that are explicitly not part of the template's source; the goal
here is to allow better integration with coverage and other tools.
.. change::
:tags: bug, py3k
Fixed bug in ``decode.<encoding>`` filter where a non-string object
would not be correctly interpreted in Python 3.
.. change::
:tags: bug, py3k
:tickets: 227
Fixed bug in Python parsing logic which would fail on Python 3
when a "try/except" targeted a tuple of exception types, rather
than a single exception.
.. change::
:tags: feature
mako-render is now implemented as a setuptools entrypoint script;
a standalone mako.cmd.cmdline() callable is now available, and the
system also uses argparse now instead of optparse. Pull request
courtesy Derek Harland.
.. change::
:tags: feature
The mako-render script will now catch exceptions and run them
into the text error handler, and exit with a non-zero exit code.
Pull request courtesy Derek Harland.
.. change::
:tags: bug
A rework of the mako-render script allows the script to run
correctly when given a file pathname that is outside of the current
directory, e.g. ``mako-render ../some_template.mako``. In this case,
the "template root" defaults to the directory in which the template
is located, instead of ".". The script also accepts a new argument
``--template-dir`` which can be specified multiple times to establish
template lookup directories. Standard input for templates also works
now too. Pull request courtesy Derek Harland.
.. change::
:tags: feature, py3k
:pullreq: github:7
Support is added for Python 3 "keyword only" arguments, as used in
defs. Pull request courtesy Eevee.
0.9
===
.. changelog::
:version: 0.9.1
:released: Thu Dec 26 2013
.. change::
:tags: bug
:tickets: 225
Fixed bug in Babel plugin where translator comments
would be lost if intervening text nodes were encountered.
Fix courtesy Ned Batchelder.
.. change::
:tags: bug
:tickets:
Fixed TGPlugin.render method to support unicode template
names in Py2K - courtesy Vladimir Magamedov.
.. change::
:tags: bug
:tickets:
Fixed an AST issue that was preventing correct operation
under alpha versions of Python 3.4. Pullreq courtesy Zer0-.
.. change::
:tags: bug
:tickets:
Changed the format of the "source encoding" header output
by the code generator to use the format ``# -*- coding:%s -*-``
instead of ``# -*- encoding:%s -*-``; the former is more common
and compatible with emacs. Courtesy Martin Geisler.
.. change::
:tags: bug
:tickets: 224
Fixed issue where an old lexer rule prevented a template line
which looked like "#*" from being correctly parsed.
.. changelog::
:version: 0.9.0
:released: Tue Aug 27 2013
.. change::
:tags: bug
:tickets: 219
The Context.locals_() method becomes a private underscored
method, as this method has a specific internal use. The purpose
of Context.kwargs has been clarified, in that it only delivers
top level keyword arguments originally passed to template.render().
.. change::
:tags: bug
:tickets:
Fixed the babel plugin to properly interpret ${} sections
inside of a "call" tag, i.e. <%self:some_tag attr="${_('foo')}"/>.
Code that's subject to babel escapes in here needs to be
specified as a Python expression, not a literal. This change
is backwards incompatible vs. code that is relying upon a _('')
translation to be working within a call tag.
.. change::
:tags: bug
:tickets: 187
The Babel plugin has been repaired to work on Python 3.
.. change::
:tags: bug
:tickets: 207
Using <%namespace import="*" module="somemodule"/> now
skips over module elements that are not explcitly callable,
avoiding TypeError when trying to produce partials.
.. change::
:tags: bug
:tickets: 190
Fixed Py3K bug where a "lambda" expression was not
interpreted correctly within a template tag; also
fixed in Py2.4.
0.8
===
.. changelog::
:version: 0.8.1
:released: Fri May 24 2013
.. change::
:tags: bug
:tickets: 216
Changed setup.py to skip installing markupsafe
if Python version is < 2.6 or is between 3.0 and
less than 3.3, as Markupsafe now only supports 2.6->2.X,
3.3->3.X.
.. change::
:tags: bug
:tickets: 214
Fixed regression where "entity" filter wasn't
converted for py3k properly (added tests.)
.. change::
:tags: bug
:tickets: 212
Fixed bug where mako-render script wasn't
compatible with Py3k.
.. change::
:tags: bug
:tickets: 213
Cleaned up all the various deprecation/
file warnings when running the tests under
various Pythons with warnings turned on.
.. changelog::
:version: 0.8.0
:released: Wed Apr 10 2013
.. change::
:tags: feature
:tickets:
Performance improvement to the
"legacy" HTML escape feature, used for XML
escaping and when markupsafe isn't present,
courtesy George Xie.
.. change::
:tags: bug
:tickets: 209
Fixed bug whereby an exception in Python 3
against a module compiled to the filesystem would
fail trying to produce a RichTraceback due to the
content being in bytes.
.. change::
:tags: bug
:tickets: 208
Change default for compile()->reserved_names
from tuple to frozenset, as this is expected to be
a set by default.
.. change::
:tags: feature
:tickets:
Code has been reworked to support Python 2.4->
Python 3.xx in place. 2to3 no longer needed.
.. change::
:tags: feature
:tickets:
Added lexer_cls argument to Template,
TemplateLookup, allows alternate Lexer classes
to be used.
.. change::
:tags: feature
:tickets:
Added future_imports parameter to Template
and TemplateLookup, renders the __future__ header
with desired capabilities at the top of the generated
template module. Courtesy Ben Trofatter.
0.7
===
.. changelog::
:version: 0.7.3
:released: Wed Nov 7 2012
.. change::
:tags: bug
:tickets:
legacy_html_escape function, used when
Markupsafe isn't installed, was using an inline-compiled
regexp which causes major slowdowns on Python 3.3;
is now precompiled.
.. change::
:tags: bug
:tickets: 201
AST supporting now supports tuple-packed
function arguments inside pure-python def
or lambda expressions.
.. change::
:tags: bug
:tickets:
Fixed Py3K bug in the Babel extension.
.. change::
:tags: bug
:tickets:
Fixed the "filter" attribute of the
<%text> tag so that it pulls locally specified
identifiers from the context the same
way as that of <%block> and <%filter>.
.. change::
:tags: bug
:tickets:
Fixed bug in plugin loader to correctly
raise exception when non-existent plugin
is specified.
.. changelog::
:version: 0.7.2
:released: Fri Jul 20 2012
.. change::
:tags: bug
:tickets: 193
Fixed regression in 0.7.1 where AST
parsing for Py2.4 was broken.
.. changelog::
:version: 0.7.1
:released: Sun Jul 8 2012
.. change::
:tags: feature
:tickets: 146
Control lines with no bodies will
now succeed, as "pass" is added for these
when no statements are otherwise present.
Courtesy Ben Trofatter
.. change::
:tags: bug
:tickets: 192
Fixed some long-broken scoping behavior
involving variables declared in defs and such,
which only became apparent when
the strict_undefined flag was turned on.
.. change::
:tags: bug
:tickets: 191
Can now use strict_undefined at the
same time args passed to def() are used
by other elements of the <%def> tag.
.. changelog::
:version: 0.7.0
:released: Fri Mar 30 2012
.. change::
:tags: feature
:tickets: 125
Added new "loop" variable to templates,
is provided within a % for block to provide
info about the loop such as index, first/last,
odd/even, etc. A migration path is also provided
for legacy templates via the "enable_loop" argument
available on Template, TemplateLookup, and <%page>.
Thanks to Ben Trofatter for all
the work on this
.. change::
:tags: feature
:tickets:
Added a real check for "reserved"
names, that is names which are never pulled
from the context and cannot be passed to
the template.render() method. Current names
are "context", "loop", "UNDEFINED".
.. change::
:tags: feature
:tickets: 95
The html_error_template() will now
apply Pygments highlighting to the source
code displayed in the traceback, if Pygments
if available. Courtesy Ben Trofatter
.. change::
:tags: feature
:tickets: 147
Added support for context managers,
i.e. "% with x as e:/ % endwith" support.
Courtesy Ben Trofatter
.. change::
:tags: feature
:tickets: 185
Added class-level flag to CacheImpl
"pass_context"; when True, the keyword argument
'context' will be passed to get_or_create()
containing the Mako Context object.
.. change::
:tags: bug
:tickets: 182
Fixed some Py3K resource warnings due
to filehandles being implicitly closed.
.. change::
:tags: bug
:tickets: 186
Fixed endless recursion bug when
nesting multiple def-calls with content.
Thanks to Jeff Dairiki.
.. change::
:tags: feature
:tickets:
Added Jinja2 to the example
benchmark suite, courtesy Vincent Férotin
Older Versions
==============
.. changelog::
:version: 0.6.2
:released: Thu Feb 2 2012
.. change::
:tags: bug
:tickets: 86, 20
The ${{"foo":"bar"}} parsing issue is fixed!!
The legendary Eevee has slain the dragon!. Also fixes quoting issue
at.
.. changelog::
:version: 0.6.1
:released: Sat Jan 28 2012
.. change::
:tags: bug
:tickets:
Added special compatibility for the 0.5.0
Cache() constructor, which was preventing file
version checks and not allowing Mako 0.6 to
recompile the module files.
.. changelog::
:version: 0.6.0
:released: Sat Jan 21 2012
.. change::
:tags: feature
:tickets:
Template caching has been converted into a plugin
system, whereby the usage of Beaker is just the
default plugin. Template and TemplateLookup
now accept a string "cache_impl" parameter which
refers to the name of a cache plugin, defaulting
to the name 'beaker'. New plugins can be
registered as pkg_resources entrypoints under
the group "mako.cache", or registered directly
using mako.cache.register_plugin(). The
core plugin is the mako.cache.CacheImpl
class.
.. change::
:tags: feature
:tickets:
Added support for Beaker cache regions
in templates. Usage of regions should be considered
as superseding the very obsolete idea of passing in
backend options, timeouts, etc. within templates.
.. change::
:tags: feature
:tickets:
The 'put' method on Cache is now
'set'. 'put' is there for backwards compatibility.
.. change::
:tags: feature
:tickets:
The <%def>, <%block> and <%page> tags now accept
any argument named "cache_*", and the key
minus the "cache_" prefix will be passed as keyword
arguments to the CacheImpl methods.
.. change::
:tags: feature
:tickets:
Template and TemplateLookup now accept an argument
cache_args, which refers to a dictionary containing
cache parameters. The cache_dir, cache_url, cache_type,
cache_timeout arguments are deprecated (will probably
never be removed, however) and can be passed
now as cache_args={'url':<some url>, 'type':'memcached',
'timeout':50, 'dir':'/path/to/some/directory'}
.. change::
:tags: feature/bug
:tickets: 180
Can now refer to context variables
within extra arguments to <%block>, <%def>, i.e.
<%block name="foo" cache_key="${somekey}">.
Filters can also be used in this way, i.e.
<%def name="foo()" filter="myfilter">
then template.render(myfilter=some_callable)
.. change::
:tags: feature
:tickets: 178
Added "--var name=value" option to the mako-render
script, allows passing of kw to the template from
the command line.
.. change::
:tags: feature
:tickets: 181
Added module_writer argument to Template,
TemplateLookup, allows a callable to be passed which
takes over the writing of the template's module source
file, so that special environment-specific steps
can be taken.
.. change::
:tags: bug
:tickets: 142
The exception message in the html_error_template
is now escaped with the HTML filter.
.. change::
:tags: bug
:tickets: 173
Added "white-space:pre" style to html_error_template()
for code blocks so that indentation is preserved
.. change::
:tags: bug
:tickets: 175
The "benchmark" example is now Python 3 compatible
(even though several of those old template libs aren't
available on Py3K, so YMMV)
.. changelog::
:version: 0.5.0
:released: Wed Sep 28 2011
.. change::
:tags:
:tickets: 174
A Template is explicitly disallowed
from having a url that normalizes to relative outside
of the root. That is, if the Lookup is based
at /home/mytemplates, an include that would place
the ultimate template at
/home/mytemplates/../some_other_directory,
i.e. outside of /home/mytemplates,
is disallowed. This usage was never intended
despite the lack of an explicit check.
The main issue this causes
is that module files can be written outside
of the module root (or raise an error, if file perms aren't
set up), and can also lead to the same template being
cached in the lookup under multiple, relative roots.
TemplateLookup instead has always supported multiple
file roots for this purpose.
.. changelog::
:version: 0.4.2
:released: Fri Aug 5 2011
.. change::
:tags:
:tickets: 170
Fixed bug regarding <%call>/def calls w/ content
whereby the identity of the "caller" callable
inside the <%def> would be corrupted by the
presence of another <%call> in the same block.
.. change::
:tags:
:tickets: 169
Fixed the babel plugin to accommodate <%block>
.. changelog::
:version: 0.4.1
:released: Wed Apr 6 2011
.. change::
:tags:
:tickets: 164
New tag: <%block>. A variant on <%def> that
evaluates its contents in-place.
Can be named or anonymous,
the named version is intended for inheritance
layouts where any given section can be
surrounded by the <%block> tag in order for
it to become overrideable by inheriting
templates, without the need to specify a
top-level <%def> plus explicit call.
Modified scoping and argument rules as well as a
more strictly enforced usage scheme make it ideal
for this purpose without at all replacing most
other things that defs are still good for.
Lots of new docs.
.. change::
:tags:
:tickets: 165
a slight adjustment to the "highlight" logic
for generating template bound stacktraces.
Will stick to known template source lines
without any extra guessing.
.. changelog::
:version: 0.4.0
:released: Sun Mar 6 2011
.. change::
:tags:
:tickets:
A 20% speedup for a basic two-page
inheritance setup rendering
a table of escaped data
(see http://techspot.zzzeek.org/2010/11/19/quick-mako-vs.-jinja-speed-test/).
A few configurational changes which
affect those in the I-don't-do-unicode
camp should be noted below.
.. change::
:tags:
:tickets:
The FastEncodingBuffer is now used
by default instead of cStringIO or StringIO,
regardless of whether output_encoding
is set to None or not. FEB is faster than
both. Only StringIO allows bytestrings
of unknown encoding to pass right
through, however - while it is of course
not recommended to send bytestrings of unknown
encoding to the output stream, this
mode of usage can be re-enabled by
setting the flag bytestring_passthrough
to True.
.. change::
:tags:
:tickets:
disable_unicode mode requires that
output_encoding be set to None - it also
forces the bytestring_passthrough flag
to True.
.. change::
:tags:
:tickets: 156
the <%namespace> tag raises an error
if the 'template' and 'module' attributes
are specified at the same time in
one tag. A different class is used
for each case which allows a reduction in
runtime conditional logic and function
call overhead.
.. change::
:tags:
:tickets: 159
the keys() in the Context, as well as
it's internal _data dictionary, now
include just what was specified to
render() as well as Mako builtins
'caller', 'capture'. The contents
of __builtin__ are no longer copied.
Thanks to Daniel Lopez for pointing
this out.
.. changelog::
:version: 0.3.6
:released: Sat Nov 13 2010
.. change::
:tags:
:tickets: 126
Documentation is on Sphinx.
.. change::
:tags:
:tickets: 154
Beaker is now part of "extras" in
setup.py instead of "install_requires".
This to produce a lighter weight install
for those who don't use the caching
as well as to conform to Pyramid
deployment practices.
.. change::
:tags:
:tickets: 153
The Beaker import (or attempt thereof)
is delayed until actually needed;
this to remove the performance penalty
from startup, particularly for
"single execution" environments
such as shell scripts.
.. change::
:tags:
:tickets: 155
Patch to lexer to not generate an empty
'' write in the case of backslash-ended
lines.
.. change::
:tags:
:tickets: 148
Fixed missing \**extra collection in
setup.py which prevented setup.py
from running 2to3 on install.
.. change::
:tags:
:tickets:
New flag on Template, TemplateLookup -
strict_undefined=True, will cause
variables not found in the context to
raise a NameError immediately, instead of
defaulting to the UNDEFINED value.
.. change::
:tags:
:tickets:
The range of Python identifiers that
are considered "undefined", meaning they
are pulled from the context, has been
trimmed back to not include variables
declared inside of expressions (i.e. from
list comprehensions), as well as
in the argument list of lambdas. This
to better support the strict_undefined
feature. The change should be
fully backwards-compatible but involved
a little bit of tinkering in the AST code,
which hadn't really been touched for
a couple of years, just FYI.
.. changelog::
:version: 0.3.5
:released: Sun Oct 24 2010
.. change::
:tags:
:tickets: 141
The <%namespace> tag allows expressions
for the `file` argument, i.e. with ${}.
The `context` variable, if needed,
must be referenced explicitly.
.. change::
:tags:
:tickets:
${} expressions embedded in tags,
such as <%foo:bar x="${...}">, now
allow multiline Python expressions.
.. change::
:tags:
:tickets:
Fixed previously non-covered regular
expression, such that using a ${} expression
inside of a tag element that doesn't allow
them raises a CompileException instead of
silently failing.
.. change::
:tags:
:tickets: 151
Added a try/except around "import markupsafe".
This to support GAE which can't run markupsafe. No idea whatsoever if the
install_requires in setup.py also breaks GAE,
couldn't get an answer on this.
.. changelog::
:version: 0.3.4
:released: Tue Jun 22 2010
.. change::
:tags:
:tickets:
Now using MarkupSafe for HTML escaping,
i.e. in place of cgi.escape(). Faster
C-based implementation and also escapes
single quotes for additional security.
Supports the __html__ attribute for
the given expression as well.
When using "disable_unicode" mode,
a pure Python HTML escaper function
is used which also quotes single quotes.
Note that Pylons by default doesn't
use Mako's filter - check your
environment.py file.
.. change::
:tags:
:tickets: 137
Fixed call to "unicode.strip" in
exceptions.text_error_template which
is not Py3k compatible.
.. changelog::
:version: 0.3.3
:released: Mon May 31 2010
.. change::
:tags:
:tickets: 135
Added conditional to RichTraceback
such that if no traceback is passed
and sys.exc_info() has been reset,
the formatter just returns blank
for the "traceback" portion.
.. change::
:tags:
:tickets: 131
Fixed sometimes incorrect usage of
exc.__class__.__name__
in html/text error templates when using
Python 2.4
.. change::
:tags:
:tickets:
Fixed broken @property decorator on
template.last_modified
.. change::
:tags:
:tickets: 132
Fixed error formatting when a stacktrace
line contains no line number, as in when
inside an eval/exec-generated function.
.. change::
:tags:
:tickets:
When a .py is being created, the tempfile
where the source is stored temporarily is
now made in the same directory as that of
the .py file. This ensures that the two
files share the same filesystem, thus
avoiding cross-filesystem synchronization
issues. Thanks to Charles Cazabon.
.. changelog::
:version: 0.3.2
:released: Thu Mar 11 2010
.. change::
:tags:
:tickets: 116
Calling a def from the top, via
template.get_def(...).render() now checks the
argument signature the same way as it did in
0.2.5, so that TypeError is not raised.
reopen of
.. changelog::
:version: 0.3.1
:released: Sun Mar 7 2010
.. change::
:tags:
:tickets: 129
Fixed incorrect dir name in setup.py
.. changelog::
:version: 0.3.0
:released: Fri Mar 5 2010
.. change::
:tags:
:tickets: 123
Python 2.3 support is dropped.
.. change::
:tags:
:tickets: 119
Python 3 support is added ! See README.py3k
for installation and testing notes.
.. change::
:tags:
:tickets: 127
Unit tests now run with nose.
.. change::
:tags:
:tickets: 99
Source code escaping has been simplified.
In particular, module source files are now
generated with the Python "magic encoding
comment", and source code is passed through
mostly unescaped, except for that code which
is regenerated from parsed Python source.
This fixes usage of unicode in
<%namespace:defname> tags.
.. change::
:tags:
:tickets: 122
RichTraceback(), html_error_template().render(),
text_error_template().render() now accept "error"
and "traceback" as optional arguments, and
these are now actually used.
.. change::
:tags:
:tickets:
The exception output generated when
format_exceptions=True will now be as a Python
unicode if it occurred during render_unicode(),
or an encoded string if during render().
.. change::
:tags:
:tickets: 112
A percent sign can be emitted as the first
non-whitespace character on a line by escaping
it as in "%%".
.. change::
:tags:
:tickets: 94
Template accepts empty control structure, i.e.
% if: %endif, etc.
.. change::
:tags:
:tickets: 116
The <%page args> tag can now be used in a base
inheriting template - the full set of render()
arguments are passed down through the inherits
chain. Undeclared arguments go into \**pageargs
as usual.
.. change::
:tags:
:tickets: 109
defs declared within a <%namespace> section, an
uncommon feature, have been improved. The defs
no longer get doubly-rendered in the body() scope,
and now allow local variable assignment without
breakage.
.. change::
:tags:
:tickets: 128
Windows paths are handled correctly if a Template
is passed only an absolute filename (i.e. with c:
drive etc.) and no URI - the URI is converted
to a forward-slash path and module_directory
is treated as a windows path.
.. change::
:tags:
:tickets: 73
TemplateLookup raises TopLevelLookupException for
a given path that is a directory, not a filename,
instead of passing through to the template to
generate IOError.
.. changelog::
:version: 0.2.6
:released:
.. change::
:tags:
:tickets:
Fix mako function decorators to preserve the
original function's name in all cases. Patch
from Scott Torborg.
.. change::
:tags:
:tickets: 118
Support the <%namespacename:defname> syntax in
the babel extractor.
.. change::
:tags:
:tickets: 88
Further fixes to unicode handling of .py files with the
html_error_template.
.. changelog::
:version: 0.2.5
:released: Mon Sep 7 2009
.. change::
:tags:
:tickets:
Added a "decorator" kw argument to <%def>,
allows custom decoration functions to wrap
rendering callables. Mainly intended for
custom caching algorithms, not sure what
other uses there may be (but there may be).
Examples are in the "filtering" docs.
.. change::
:tags:
:tickets: 101
When Mako creates subdirectories in which
to store templates, it uses the more
permissive mode of 0775 instead of 0750,
helping out with certain multi-process
scenarios. Note that the mode is always
subject to the restrictions of the existing
umask.
.. change::
:tags:
:tickets: 104
Fixed namespace.__getattr__() to raise
AttributeError on attribute not found
instead of RuntimeError.
.. change::
:tags:
:tickets: 97
Added last_modified accessor to Template,
returns the time.time() when the module
was created.
.. change::
:tags:
:tickets: 102
Fixed lexing support for whitespace
around '=' sign in defs.
.. change::
:tags:
:tickets: 108
Removed errant "lower()" in the lexer which
was causing tags to compile with
case-insensitive names, thus messing up
custom <%call> names.
.. change::
:tags:
:tickets: 110
added "mako.__version__" attribute to
the base module.
.. changelog::
:version: 0.2.4
:released: Tue Dec 23 2008
.. change::
:tags:
:tickets:
Fixed compatibility with Jython 2.5b1.
.. changelog::
:version: 0.2.3
:released: Sun Nov 23 2008
.. change::
:tags:
:tickets:
the <%namespacename:defname> syntax described at
http://techspot.zzzeek.org/?p=28 has now
been added as a built in syntax, and is recommended
as a more modern syntax versus <%call expr="expression">.
The %call tag itself will always remain,
with <%namespacename:defname> presenting a more HTML-like
alternative to calling defs, both plain and
nested. Many examples of the new syntax are in the
"Calling a def with embedded content" section
of the docs.
.. change::
:tags:
:tickets:
added support for Jython 2.5.
.. change::
:tags:
:tickets:
cache module now uses Beaker's CacheManager
object directly, so that all cache types are included.
memcached is available as both "ext:memcached" and
"memcached", the latter for backwards compatibility.
.. change::
:tags:
:tickets:
added "cache" accessor to Template, Namespace.
e.g. ${local.cache.get('somekey')} or
template.cache.invalidate_body()
.. change::
:tags:
:tickets:
added "cache_enabled=True" flag to Template,
TemplateLookup. Setting this to False causes cache
operations to "pass through" and execute every time;
this flag should be integrated in Pylons with its own
cache_enabled configuration setting.
.. change::
:tags:
:tickets: 92
the Cache object now supports invalidate_def(name),
invalidate_body(), invalidate_closure(name),
invalidate(key), which will remove the given key
from the cache, if it exists. The cache arguments
(i.e. storage type) are derived from whatever has
been already persisted for that template.
.. change::
:tags:
:tickets:
For cache changes to work fully, Beaker 1.1 is required.
1.0.1 and up will work as well with the exception of
cache expiry. Note that Beaker 1.1 is **required**
for applications which use dynamically generated keys,
since previous versions will permanently store state in memory
for each individual key, thus consuming all available
memory for an arbitrarily large number of distinct
keys.
.. change::
:tags:
:tickets: 93
fixed bug whereby an <%included> template with
<%page> args named the same as a __builtin__ would not
honor the default value specified in <%page>
.. change::
:tags:
:tickets: 88
fixed the html_error_template not handling tracebacks from
normal .py files with a magic encoding comment
.. change::
:tags:
:tickets:
RichTraceback() now accepts an optional traceback object
to be used in place of sys.exc_info()[2]. html_error_template()
and text_error_template() accept an optional
render()-time argument "traceback" which is passed to the
RichTraceback object.
.. change::
:tags:
:tickets:
added ModuleTemplate class, which allows the construction
of a Template given a Python module generated by a previous
Template. This allows Python modules alone to be used
as templates with no compilation step. Source code
and template source are optional but allow error reporting
to work correctly.
.. change::
:tags:
:tickets: 90
fixed Python 2.3 compat. in mako.pyparser
.. change::
:tags:
:tickets:
fix Babel 0.9.3 compatibility; stripping comment tags is now
optional (and enabled by default).
.. changelog::
:version: 0.2.2
:released: Mon Jun 23 2008
.. change::
:tags:
:tickets: 87
cached blocks now use the current context when rendering
an expired section, instead of the original context
passed in
.. change::
:tags:
:tickets:
fixed a critical issue regarding caching, whereby
a cached block would raise an error when called within a
cache-refresh operation that was initiated after the
initiating template had completed rendering.
.. changelog::
:version: 0.2.1
:released: Mon Jun 16 2008
.. change::
:tags:
:tickets:
fixed bug where 'output_encoding' parameter would prevent
render_unicode() from returning a unicode object.
.. change::
:tags:
:tickets:
bumped magic number, which forces template recompile for
this version (fixes incompatible compile symbols from 0.1
series).
.. change::
:tags:
:tickets:
added a few docs for cache options, specifically those that
help with memcached.
.. changelog::
:version: 0.2.0
:released: Tue Jun 3 2008
.. change::
:tags:
:tickets:
Speed improvements (as though we needed them, but people
contributed and there you go):
.. change::
:tags:
:tickets: 77
added "bytestring passthru" mode, via
`disable_unicode=True` argument passed to Template or
TemplateLookup. All unicode-awareness and filtering is
turned off, and template modules are generated with
the appropriate magic encoding comment. In this mode,
template expressions can only receive raw bytestrings
or Unicode objects which represent straight ASCII, and
render_unicode() may not be used if multibyte
characters are present. When enabled, speed
improvement around 10-20%. (courtesy
anonymous guest)
.. change::
:tags:
:tickets: 76
inlined the "write" function of Context into a local
template variable. This affords a 12-30% speedup in
template render time. (idea courtesy same anonymous
guest)
.. change::
:tags:
:tickets:
New Features, API changes:
.. change::
:tags:
:tickets: 62
added "attr" accessor to namespaces. Returns
attributes configured as module level attributes, i.e.
within <%! %> sections. i.e.::
# somefile.html
<%!
foo = 27
%>
# some other template
<%namespace name="myns" file="somefile.html"/>
${myns.attr.foo}
The slight backwards incompatibility here is, you
can't have namespace defs named "attr" since the
"attr" descriptor will occlude it.
.. change::
:tags:
:tickets: 78
cache_key argument can now render arguments passed
directly to the %page or %def, i.e. <%def
name="foo(x)" cached="True" cache_key="${x}"/>
.. change::
:tags:
:tickets:
some functions on Context are now private:
_push_buffer(), _pop_buffer(),
caller_stack._push_frame(), caller_stack._pop_frame().
.. change::
:tags:
:tickets: 56, 81
added a runner script "mako-render" which renders
standard input as a template to stdout
.. change::
:tags: bugfixes
:tickets: 83, 84
can now use most names from __builtins__ as variable
names without explicit declaration (i.e. 'id',
'exception', 'range', etc.)
.. change::
:tags: bugfixes
:tickets: 84
can also use builtin names as local variable names
(i.e. dict, locals) (came from fix for)
.. change::
:tags: bugfixes
:tickets: 68
fixed bug in python generation when variable names are
used with identifiers like "else", "finally", etc.
inside them
.. change::
:tags: bugfixes
:tickets: 69
fixed codegen bug which occurred when using <%page>
level caching, combined with an expression-based
cache_key, combined with the usage of <%namespace
import="*"/> - fixed lexer exceptions not cleaning up
temporary files, which could lead to a maximum number
of file descriptors used in the process
.. change::
:tags: bugfixes
:tickets: 71
fixed issue with inline format_exceptions that was
producing blank exception pages when an inheriting
template is present
.. change::
:tags: bugfixes
:tickets:
format_exceptions will apply the encoding options of
html_error_template() to the buffered output
.. change::
:tags: bugfixes
:tickets: 75
rewrote the "whitespace adjuster" function to work
with more elaborate combinations of quotes and
comments
.. changelog::
:version: 0.1.10
:released:
.. change::
:tags:
:tickets:
fixed propagation of 'caller' such that nested %def calls
within a <%call> tag's argument list propigates 'caller'
to the %call function itself (propigates to the inner
calls too, this is a slight side effect which previously
existed anyway)
.. change::
:tags:
:tickets:
fixed bug where local.get_namespace() could put an
incorrect "self" in the current context
.. change::
:tags:
:tickets:
fixed another namespace bug where the namespace functions
did not have access to the correct context containing
their 'self' and 'parent'
.. changelog::
:version: 0.1.9
:released:
.. change::
:tags:
:tickets: 47
filters.Decode filter can also accept a non-basestring
object and will call str() + unicode() on it
.. change::
:tags:
:tickets: 53
comments can be placed at the end of control lines,
i.e. if foo: # a comment,, thanks to
Paul Colomiets
.. change::
:tags:
:tickets: 16
fixed expressions and page tag arguments and with embedded
newlines in CRLF templates, follow up to, thanks
Eric Woroshow
.. change::
:tags:
:tickets: 51
added an IOError catch for source file not found in RichTraceback
exception reporter
.. changelog::
:version: 0.1.8
:released: Tue Jun 26 2007
.. change::
:tags:
:tickets:
variable names declared in render methods by internal
codegen prefixed by "__M_" to prevent name collisions
with user code
.. change::
:tags:
:tickets: 45
added a Babel (http://babel.edgewall.org/) extractor entry
point, allowing extraction of gettext messages directly from
mako templates via Babel
.. change::
:tags:
:tickets:
fix to turbogears plugin to work with dot-separated names
(i.e. load_template('foo.bar')). also takes file extension
as a keyword argument (default is 'mak').
.. change::
:tags:
:tickets: 35
more tg fix: fixed, allowing string-based
templates with tgplugin even if non-compatible args were sent
.. changelog::
:version: 0.1.7
:released: Wed Jun 13 2007
.. change::
:tags:
:tickets:
one small fix to the unit tests to support python 2.3
.. change::
:tags:
:tickets:
a slight hack to how cache.py detects Beaker's memcached,
works around unexplained import behavior observed on some
python 2.3 installations
.. changelog::
:version: 0.1.6
:released: Fri May 18 2007
.. change::
:tags:
:tickets:
caching is now supplied directly by Beaker, which has
all of MyghtyUtils merged into it now. The latest Beaker
(0.7.1) also fixes a bug related to how Mako was using the
cache API.
.. change::
:tags:
:tickets: 34
fix to module_directory path generation when the path is "./"
.. change::
:tags:
:tickets: 35
TGPlugin passes options to string-based templates
.. change::
:tags:
:tickets: 28
added an explicit stack frame step to template runtime, which
allows much simpler and hopefully bug-free tracking of 'caller',
fixes
.. change::
:tags:
:tickets:
if plain Python defs are used with <%call>, a decorator
@runtime.supports_callable exists to ensure that the "caller"
stack is properly handled for the def.
.. change::
:tags:
:tickets: 37
fix to RichTraceback and exception reporting to get template
source code as a unicode object
.. change::
:tags:
:tickets: 39
html_error_template includes options "full=True", "css=True"
which control generation of HTML tags, CSS
.. change::
:tags:
:tickets: 40
added the 'encoding_errors' parameter to Template/TemplateLookup
for specifying the error handler associated with encoding to
'output_encoding'
.. change::
:tags:
:tickets: 37
the Template returned by html_error_template now defaults to
output_encoding=sys.getdefaultencoding(),
encoding_errors='htmlentityreplace'
.. change::
:tags:
:tickets:
control lines, i.e. % lines, support backslashes to continue long
lines (#32)
.. change::
:tags:
:tickets:
fixed codegen bug when defining <%def> within <%call> within <%call>
.. change::
:tags:
:tickets:
leading utf-8 BOM in template files is honored according to pep-0263
.. changelog::
:version: 0.1.5
:released: Sat Mar 31 2007
.. change::
:tags:
:tickets: 26
AST expression generation - added in just about everything
expression-wise from the AST module
.. change::
:tags:
:tickets: 27
AST parsing, properly detects imports of the form "import foo.bar"
.. change::
:tags:
:tickets:
fix to lexing of <%docs> tag nested in other tags
.. change::
:tags:
:tickets: 29
fix to context-arguments inside of <%include> tag which broke
during 0.1.4
.. change::
:tags:
:tickets:
added "n" filter, disables *all* filters normally applied to an expression
via <%page> or default_filters (but not those within the filter)
.. change::
:tags:
:tickets:
added buffer_filters argument, defines filters applied to the return value
of buffered/cached/filtered %defs, after all filters defined with the %def
itself have been applied. allows the creation of default expression filters
that let the output of return-valued %defs "opt out" of that filtering
via passing special attributes or objects.
.. changelog::
:version: 0.1.4
:released: Sat Mar 10 2007
.. change::
:tags:
:tickets:
got defs-within-defs to be cacheable
.. change::
:tags:
:tickets: 23
fixes to code parsing/whitespace adjusting where plain python comments
may contain quote characters
.. change::
:tags:
:tickets:
fix to variable scoping for identifiers only referenced within
functions
.. change::
:tags:
:tickets:
added a path normalization step to lookup so URIs like
"/foo/bar/../etc/../foo" pre-process the ".." tokens before checking
the filesystem
.. change::
:tags:
:tickets:
fixed/improved "caller" semantics so that undefined caller is
"UNDEFINED", propigates __nonzero__ method so it evaulates to False if
not present, True otherwise. this way you can say % if caller:\n
${caller.body()}\n% endif
.. change::
:tags:
:tickets:
<%include> has an "args" attribute that can pass arguments to the
called template (keyword arguments only, must be declared in that
page's <%page> tag.)
.. change::
:tags:
:tickets:
<%include> plus arguments is also programmatically available via
self.include_file(<filename>, \**kwargs)
.. change::
:tags:
:tickets: 24
further escaping added for multibyte expressions in %def, %call
attributes
.. changelog::
:version: 0.1.3
:released: Wed Feb 21 2007
.. change::
:tags:
:tickets:
***Small Syntax Change*** - the single line comment character is now
*two* hash signs, i.e. "## this is a comment". This avoids a common
collection with CSS selectors.
.. change::
:tags:
:tickets:
the magic "coding" comment (i.e. # coding:utf-8) will still work with
either one "#" sign or two for now; two is preferred going forward, i.e.
## coding:<someencoding>.
.. change::
:tags:
:tickets:
new multiline comment form: "<%doc> a comment </%doc>"
.. change::
:tags:
:tickets:
UNDEFINED evaluates to False
.. change::
:tags:
:tickets:
improvement to scoping of "caller" variable when using <%call> tag
.. change::
:tags:
:tickets:
added lexer error for unclosed control-line (%) line
.. change::
:tags:
:tickets:
added "preprocessor" argument to Template, TemplateLookup - is a single
callable or list of callables which will be applied to the template text
before lexing. given the text as an argument, returns the new text.
.. change::
:tags:
:tickets:
added mako.ext.preprocessors package, contains one preprocessor so far:
'convert_comments', which will convert single # comments to the new ##
format
.. changelog::
:version: 0.1.2
:released: Thu Feb 1 2007
.. change::
:tags:
:tickets: 11
fix to parsing of code/expression blocks to insure that non-ascii
characters, combined with a template that indicates a non-standard
encoding, are expanded into backslash-escaped glyphs before being AST
parsed
.. change::
:tags:
:tickets:
all template lexing converts the template to unicode first, to
immediately catch any encoding issues and ensure internal unicode
representation.
.. change::
:tags:
:tickets:
added module_filename argument to Template to allow specification of a
specific module file
.. change::
:tags:
:tickets: 14
added modulename_callable to TemplateLookup to allow a function to
determine module filenames (takes filename, uri arguments). used for
.. change::
:tags:
:tickets:
added optional input_encoding flag to Template, to allow sending a
unicode() object with no magic encoding comment
.. change::
:tags:
:tickets:
"expression_filter" argument in <%page> applies only to expressions
.. change::
:tags: "unicode"
:tickets:
added "default_filters" argument to Template, TemplateLookup. applies only
to expressions, gets prepended to "expression_filter" arg from <%page>.
defaults to, so that all expressions get stringified into u''
by default (this is what Mako already does). By setting to [], expressions
are passed through raw.
.. change::
:tags:
:tickets:
added "imports" argument to Template, TemplateLookup. so you can predefine
a list of import statements at the top of the template. can be used in
conjunction with default_filters.
.. change::
:tags:
:tickets: 16
support for CRLF templates...whoops ! welcome to all the windows users.
.. change::
:tags:
:tickets:
small fix to local variable propigation for locals that are conditionally
declared
.. change::
:tags:
:tickets:
got "top level" def calls to work, i.e. template.get_def("somedef").render()
.. changelog::
:version: 0.1.1
:released: Sun Jan 14 2007
.. change::
:tags:
:tickets: 8
buffet plugin supports string-based templates, allows ToscaWidgets to work
.. change::
:tags:
:tickets:
AST parsing fixes: fixed TryExcept identifier parsing
.. change::
:tags:
:tickets:
removed textmate tmbundle from contrib and into separate SVN location;
windows users cant handle those files, setuptools not very good at
"pruning" certain directories
.. change::
:tags:
:tickets:
fix so that "cache_timeout" parameter is propigated
.. change::
:tags:
:tickets:
fix to expression filters so that string conversion (actually unicode)
properly occurs before filtering
.. change::
:tags:
:tickets:
better error message when a lookup is attempted with a template that has no
lookup
.. change::
:tags:
:tickets:
implemented "module" attribute for namespace
.. change::
:tags:
:tickets:
fix to code generation to correctly track multiple defs with the same name
.. change::
:tags:
:tickets: 9
"directories" can be passed to TemplateLookup as a scalar in which case it
gets converted to a list
|