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
|
"""
Testing some internals of the template processing.
These are *not* examples to be copied in user code.
"""
from django.template import Library, TemplateSyntaxError
from django.template.base import (
FilterExpression,
Lexer,
Parser,
Token,
TokenType,
Variable,
VariableDoesNotExist,
)
from django.template.defaultfilters import register as filter_library
from django.test import SimpleTestCase
class ParserTests(SimpleTestCase):
def test_token_smart_split(self):
"""
#7027 -- _() syntax should work with spaces
"""
token = Token(
TokenType.BLOCK, 'sometag _("Page not found") value|yesno:_("yes,no")'
)
split = token.split_contents()
self.assertEqual(
split, ["sometag", '_("Page not found")', 'value|yesno:_("yes,no")']
)
def test_repr(self):
token = Token(TokenType.BLOCK, "some text")
self.assertEqual(repr(token), '<Block token: "some text...">')
parser = Parser([token], builtins=[filter_library])
self.assertEqual(
repr(parser),
'<Parser tokens=[<Block token: "some text...">]>',
)
filter_expression = FilterExpression("news|upper", parser)
self.assertEqual(repr(filter_expression), "<FilterExpression 'news|upper'>")
lexer = Lexer("{% for i in 1 %}{{ a }}\n{% endfor %}")
self.assertEqual(
repr(lexer),
'<Lexer template_string="{% for i in 1 %}{{ a...", verbatim=False>',
)
def test_filter_parsing(self):
c = {"article": {"section": "News"}}
p = Parser("", builtins=[filter_library])
def fe_test(s, val):
self.assertEqual(FilterExpression(s, p).resolve(c), val)
fe_test("article.section", "News")
fe_test("article.section|upper", "NEWS")
fe_test('"News"', "News")
fe_test("'News'", "News")
fe_test(r'"Some \"Good\" News"', 'Some "Good" News')
fe_test(r'"Some \"Good\" News"', 'Some "Good" News')
fe_test(r"'Some \'Bad\' News'", "Some 'Bad' News")
fe = FilterExpression(r'"Some \"Good\" News"', p)
self.assertEqual(fe.filters, [])
self.assertEqual(fe.var, 'Some "Good" News')
# Filtered variables should reject access of attributes beginning with
# underscores.
msg = (
"Variables and attributes may not begin with underscores: 'article._hidden'"
)
with self.assertRaisesMessage(TemplateSyntaxError, msg):
FilterExpression("article._hidden|upper", p)
def test_cannot_parse_characters(self):
p = Parser("", builtins=[filter_library])
for filter_expression, characters in [
('<>|default:"Default"|upper', '|<>||default:"Default"|upper'),
("test|<>|upper", "test||<>||upper"),
]:
with self.subTest(filter_expression=filter_expression):
with self.assertRaisesMessage(
TemplateSyntaxError,
f"Could not parse some characters: {characters}",
):
FilterExpression(filter_expression, p)
def test_cannot_find_variable(self):
p = Parser("", builtins=[filter_library])
with self.assertRaisesMessage(
TemplateSyntaxError,
'Could not find variable at start of |default:"Default"',
):
FilterExpression('|default:"Default"', p)
def test_variable_parsing(self):
c = {"article": {"section": "News"}}
self.assertEqual(Variable("article.section").resolve(c), "News")
self.assertEqual(Variable('"News"').resolve(c), "News")
self.assertEqual(Variable("'News'").resolve(c), "News")
# Translated strings are handled correctly.
self.assertEqual(Variable("_(article.section)").resolve(c), "News")
self.assertEqual(Variable('_("Good News")').resolve(c), "Good News")
self.assertEqual(Variable("_('Better News')").resolve(c), "Better News")
# Escaped quotes work correctly as well.
self.assertEqual(
Variable(r'"Some \"Good\" News"').resolve(c), 'Some "Good" News'
)
self.assertEqual(
Variable(r"'Some \'Better\' News'").resolve(c), "Some 'Better' News"
)
# Variables should reject access of attributes and variables beginning
# with underscores.
for name in ["article._hidden", "_article"]:
msg = f"Variables and attributes may not begin with underscores: '{name}'"
with self.assertRaisesMessage(TemplateSyntaxError, msg):
Variable(name)
# Variables should raise on non string type
with self.assertRaisesMessage(
TypeError, "Variable must be a string or number, got <class 'dict'>"
):
Variable({})
# Variables should raise when invalid characters in name.
for c in ["+", "-"]:
with self.subTest(invalid_character=c):
variable_name = f"variable{c}name"
with self.assertRaisesMessage(
TemplateSyntaxError,
f"Invalid character ('{c}') in variable name: '{variable_name}'",
):
Variable(variable_name)
def test_filter_args_count(self):
parser = Parser("")
register = Library()
@register.filter
def no_arguments(value):
pass
@register.filter
def one_argument(value, arg):
pass
@register.filter
def one_opt_argument(value, arg=False):
pass
@register.filter
def two_arguments(value, arg, arg2):
pass
@register.filter
def two_one_opt_arg(value, arg, arg2=False):
pass
parser.add_library(register)
for expr in (
'1|no_arguments:"1"',
"1|two_arguments",
'1|two_arguments:"1"',
"1|two_one_opt_arg",
):
with self.assertRaises(TemplateSyntaxError):
FilterExpression(expr, parser)
for expr in (
# Correct number of arguments
"1|no_arguments",
'1|one_argument:"1"',
# One optional
"1|one_opt_argument",
'1|one_opt_argument:"1"',
# Not supplying all
'1|two_one_opt_arg:"1"',
):
FilterExpression(expr, parser)
def test_filter_numeric_argument_parsing(self):
p = Parser("", builtins=[filter_library])
# Values that resolve to a numeric literal.
cases = {
"5": 5,
"-5": -5,
"5.2": 5.2,
".4": 0.4,
"5.2e3": 5200.0, # 5.2 × 10³ = 5200.0.
"5.2E3": 5200.0, # Case-insensitive.
"5.2e-3": 0.0052, # Negative exponent.
"-1.5E4": -15000.0,
"+3.0e2": 300.0,
".5e2": 50.0, # 0.5 × 10² = 50.0
}
for num, expected in cases.items():
with self.subTest(num=num):
self.assertEqual(FilterExpression(num, p).resolve({}), expected)
self.assertEqual(
FilterExpression(f"0|default:{num}", p).resolve({}), expected
)
# Values that are interpreted as names of variables that do not exist.
invalid_numbers = [
"abc123",
"123abc",
"foo",
"error",
"1e",
"e400",
"1e.2",
"1e2.",
"1e2.0",
"1e2a",
"1e2e3",
]
for num in invalid_numbers:
with self.subTest(num=num):
self.assertIsNone(
FilterExpression(num, p).resolve({}, ignore_failures=True)
)
with self.assertRaises(VariableDoesNotExist):
FilterExpression(f"0|default:{num}", p).resolve({})
# Values that are interpreted as an invalid variable name.
invalid_numbers_and_var_names = [
"1e-",
"1e-a",
"1+1",
"1-1",
]
for num in invalid_numbers_and_var_names:
with self.subTest(num=num):
with self.assertRaises(TemplateSyntaxError):
FilterExpression(num, p).resolve({})
with self.assertRaises(TemplateSyntaxError):
FilterExpression(f"0|default:{num}", p).resolve({})
|
