| 1 |
""" |
| 2 |
Testing some internals of the template processing. |
| 3 |
These are *not* examples to be copied in user code. |
| 4 |
""" |
| 5 |
|
| 6 |
import unittest |
| 7 |
|
| 8 |
from django.template import Library, TemplateSyntaxError |
| 9 |
from django.template.base import ( |
| 10 |
FilterExpression, |
| 11 |
Lexer, |
| 12 |
Parser, |
| 13 |
Token, |
| 14 |
TokenType, |
| 15 |
Variable, |
| 16 |
) |
| 17 |
from django.template.defaultfilters import register as filter_library |
| 18 |
from django.test import SimpleTestCase |
| 19 |
from django.utils.version import PY314 |
| 20 |
|
| 21 |
|
| 22 |
class ParserTests(SimpleTestCase): |
| 23 |
def test_token_smart_split(self): |
| 24 |
""" |
| 25 |
#7027 -- _() syntax should work with spaces |
| 26 |
""" |
| 27 |
token = Token( |
| 28 |
TokenType.BLOCK, 'sometag _("Page not found") value|yesno:_("yes,no")' |
| 29 |
) |
| 30 |
split = token.split_contents() |
| 31 |
self.assertEqual( |
| 32 |
split, ["sometag", '_("Page not found")', 'value|yesno:_("yes,no")'] |
| 33 |
) |
| 34 |
|
| 35 |
def test_repr(self): |
| 36 |
token = Token(TokenType.BLOCK, "some text") |
| 37 |
self.assertEqual(repr(token), '<Block token: "some text...">') |
| 38 |
parser = Parser([token], builtins=[filter_library]) |
| 39 |
self.assertEqual( |
| 40 |
repr(parser), |
| 41 |
'<Parser tokens=[<Block token: "some text...">]>', |
| 42 |
) |
| 43 |
filter_expression = FilterExpression("news|upper", parser) |
| 44 |
self.assertEqual(repr(filter_expression), "<FilterExpression 'news|upper'>") |
| 45 |
lexer = Lexer("{% for i in 1 %}{{ a }}\n{% endfor %}") |
| 46 |
self.assertEqual( |
| 47 |
repr(lexer), |
| 48 |
'<Lexer template_string="{% for i in 1 %}{{ a...", verbatim=False>', |
| 49 |
) |
| 50 |
|
| 51 |
def test_filter_parsing(self): |
| 52 |
c = {"article": {"section": "News"}} |
| 53 |
p = Parser("", builtins=[filter_library]) |
| 54 |
|
| 55 |
def fe_test(s, val): |
| 56 |
self.assertEqual(FilterExpression(s, p).resolve(c), val) |
| 57 |
|
| 58 |
fe_test("article.section", "News") |
| 59 |
fe_test("article.section|upper", "NEWS") |
| 60 |
fe_test('"News"', "News") |
| 61 |
fe_test("'News'", "News") |
| 62 |
fe_test(r'"Some \"Good\" News"', 'Some "Good" News') |
| 63 |
fe_test(r'"Some \"Good\" News"', 'Some "Good" News') |
| 64 |
fe_test(r"'Some \'Bad\' News'", "Some 'Bad' News") |
| 65 |
|
| 66 |
fe = FilterExpression(r'"Some \"Good\" News"', p) |
| 67 |
self.assertEqual(fe.filters, []) |
| 68 |
self.assertEqual(fe.var, 'Some "Good" News') |
| 69 |
|
| 70 |
# Filtered variables should reject access of attributes beginning with |
| 71 |
# underscores. |
| 72 |
msg = ( |
| 73 |
"Variables and attributes may not begin with underscores: 'article._hidden'" |
| 74 |
) |
| 75 |
with self.assertRaisesMessage(TemplateSyntaxError, msg): |
| 76 |
FilterExpression("article._hidden|upper", p) |
| 77 |
|
| 78 |
def test_variable_parsing(self): |
| 79 |
c = {"article": {"section": "News"}} |
| 80 |
self.assertEqual(Variable("article.section").resolve(c), "News") |
| 81 |
self.assertEqual(Variable('"News"').resolve(c), "News") |
| 82 |
self.assertEqual(Variable("'News'").resolve(c), "News") |
| 83 |
|
| 84 |
# Translated strings are handled correctly. |
| 85 |
self.assertEqual(Variable("_(article.section)").resolve(c), "News") |
| 86 |
self.assertEqual(Variable('_("Good News")').resolve(c), "Good News") |
| 87 |
self.assertEqual(Variable("_('Better News')").resolve(c), "Better News") |
| 88 |
|
| 89 |
# Escaped quotes work correctly as well. |
| 90 |
self.assertEqual( |
| 91 |
Variable(r'"Some \"Good\" News"').resolve(c), 'Some "Good" News' |
| 92 |
) |
| 93 |
self.assertEqual( |
| 94 |
Variable(r"'Some \'Better\' News'").resolve(c), "Some 'Better' News" |
| 95 |
) |
| 96 |
|
| 97 |
# Variables should reject access of attributes and variables beginning |
| 98 |
# with underscores. |
| 99 |
for name in ["article._hidden", "_article"]: |
| 100 |
msg = f"Variables and attributes may not begin with underscores: '{name}'" |
| 101 |
with self.assertRaisesMessage(TemplateSyntaxError, msg): |
| 102 |
Variable(name) |
| 103 |
|
| 104 |
# Variables should raise on non string type |
| 105 |
with self.assertRaisesMessage( |
| 106 |
TypeError, "Variable must be a string or number, got <class 'dict'>" |
| 107 |
): |
| 108 |
Variable({}) |
| 109 |
|
| 110 |
def test_filter_args_count(self): |
| 111 |
parser = Parser("") |
| 112 |
register = Library() |
| 113 |
|
| 114 |
@register.filter |
| 115 |
def no_arguments(value): |
| 116 |
pass |
| 117 |
|
| 118 |
@register.filter |
| 119 |
def one_argument(value, arg): |
| 120 |
pass |
| 121 |
|
| 122 |
@register.filter |
| 123 |
def one_opt_argument(value, arg=False): |
| 124 |
pass |
| 125 |
|
| 126 |
@register.filter |
| 127 |
def two_arguments(value, arg, arg2): |
| 128 |
pass |
| 129 |
|
| 130 |
@register.filter |
| 131 |
def two_one_opt_arg(value, arg, arg2=False): |
| 132 |
pass |
| 133 |
|
| 134 |
parser.add_library(register) |
| 135 |
for expr in ( |
| 136 |
'1|no_arguments:"1"', |
| 137 |
"1|two_arguments", |
| 138 |
'1|two_arguments:"1"', |
| 139 |
"1|two_one_opt_arg", |
| 140 |
): |
| 141 |
with self.assertRaises(TemplateSyntaxError): |
| 142 |
FilterExpression(expr, parser) |
| 143 |
for expr in ( |
| 144 |
# Correct number of arguments |
| 145 |
"1|no_arguments", |
| 146 |
'1|one_argument:"1"', |
| 147 |
# One optional |
| 148 |
"1|one_opt_argument", |
| 149 |
'1|one_opt_argument:"1"', |
| 150 |
# Not supplying all |
| 151 |
'1|two_one_opt_arg:"1"', |
| 152 |
): |
| 153 |
FilterExpression(expr, parser) |
| 154 |
|
| 155 |
@unittest.skipUnless(PY314, "Deferred annotations are Python 3.14+ only") |
| 156 |
def test_filter_deferred_annotation(self): |
| 157 |
register = Library() |
| 158 |
|
| 159 |
@register.filter("example") |
| 160 |
def example_filter(value: str, arg: SomeType): # NOQA: F821 |
| 161 |
return f"{value}_{arg}" |
| 162 |
|
| 163 |
result = FilterExpression.args_check( |
| 164 |
"example", example_filter, ["extra_example"] |
| 165 |
) |
| 166 |
|
| 167 |
self.assertIs(result, True) |