Repository navigation
Commit a162c9c
committed
Report template location for compile time warnings
Warnings raised by Python while a template is compiled, in practice
SyntaxWarning, were reported against the generated module, giving a line
number that has no relation to the template source; the same warning was
additionally reported twice, once from parsing the individual
expression, where the location is the meaningless "<unknown>", line 1,
and again from compiling the module as a whole.
The warnings display hook is now replaced while the template is
compiled. Warnings raised for the generated module are shown against
the template's filename, with the line translated through the same line
map that RichTraceback uses to report the location of an exception.
This is applied both to templates compiled in memory and to those
compiled to a module file, where the compilation is performed by the
import system and the warning would otherwise be reported against the
generated module file. Warnings from the parsing of individual
expressions are dropped, as the same warning is always raised again when
the module is compiled, where a usable location is available; the hook
that does so is in place only while the expressions are parsed, so that
a warning raised by a module imported from a <%! %> block is shown
unchanged even if it carries the same filename.
Replacing the display hook is preferred to recording the warnings and
raising them a second time, as the latter passes each warning through
the filters twice. A filter with a stateful action, notably "once",
suppresses the second occurrence, so the warning would be lost
altogether. For the same reason the occurrence that is dropped, which
the filters see first, has its entry removed from the "once" registry,
else it would suppress the occurrence that can be translated.
The module level code of a <%! %> block is executed within the same
block, as the import system compiles and executes a module file as one
step and the two paths would otherwise disagree on where a warning
raised by such code is reported.
Warnings raised while a template renders are unchanged, and continue to
report a location within the generated module. The warnings module
takes the location from the executing frame, so translating these would
require replacing the display hook for the life of the process, which is
not something a library should do on import.
A module file that carries no usable metadata, having been written by
some other means or damaged, would raise from the attempt to read its
line map, from inside the display hook and therefore out of an unrelated
compile() call; such a warning is now shown untranslated instead. A
line that cannot be translated likewise retains its own filename, rather
than being given the template's filename with the module's line.
Fixes: #430
Change-Id: Ie7e942d5b0a753788de1ea012d83193be03dbe2a1 parent 67df138 commit a162c9c
4 files changed
Lines changed: 450 additions & 20 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
23 | 28 | | |
24 | 29 | | |
25 | 30 | | |
26 | 31 | | |
27 | 32 | | |
28 | | - | |
| 33 | + | |
29 | 34 | | |
30 | 35 | | |
31 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
10 | 11 | | |
11 | 12 | | |
12 | 13 | | |
| |||
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
| 20 | + | |
19 | 21 | | |
20 | 22 | | |
21 | 23 | | |
22 | 24 | | |
23 | 25 | | |
24 | 26 | | |
| 27 | + | |
25 | 28 | | |
26 | 29 | | |
27 | 30 | | |
| |||
365 | 368 | | |
366 | 369 | | |
367 | 370 | | |
368 | | - | |
369 | | - | |
370 | | - | |
| 371 | + | |
| 372 | + | |
371 | 373 | | |
372 | | - | |
373 | | - | |
374 | | - | |
375 | | - | |
376 | | - | |
377 | | - | |
378 | | - | |
379 | | - | |
380 | | - | |
381 | | - | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
382 | 383 | | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
383 | 392 | | |
384 | 393 | | |
385 | 394 | | |
| |||
688 | 697 | | |
689 | 698 | | |
690 | 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 | + | |
691 | 801 | | |
692 | 802 | | |
693 | | - | |
694 | | - | |
695 | | - | |
696 | 803 | | |
697 | 804 | | |
698 | 805 | | |
| 806 | + | |
| 807 | + | |
| 808 | + | |
| 809 | + | |
| 810 | + | |
| 811 | + | |
699 | 812 | | |
700 | 813 | | |
701 | 814 | | |
702 | | - | |
703 | 815 | | |
704 | | - | |
705 | | - | |
| 816 | + | |
| 817 | + | |
| 818 | + | |
| 819 | + | |
| 820 | + | |
| 821 | + | |
| 822 | + | |
| 823 | + | |
| 824 | + | |
| 825 | + | |
| 826 | + | |
| 827 | + | |
706 | 828 | | |
707 | 829 | | |
708 | 830 | | |
| |||
0 commit comments