| 1 |
import functools |
| 2 |
import unittest |
| 3 |
|
| 4 |
from django.template import Library |
| 5 |
from django.template.base import Node |
| 6 |
from django.test import SimpleTestCase |
| 7 |
from django.utils.version import PY314 |
| 8 |
|
| 9 |
|
| 10 |
class FilterRegistrationTests(SimpleTestCase): |
| 11 |
def setUp(self): |
| 12 |
self.library = Library() |
| 13 |
|
| 14 |
def test_filter(self): |
| 15 |
@self.library.filter |
| 16 |
def func(): |
| 17 |
return "" |
| 18 |
|
| 19 |
self.assertEqual(self.library.filters["func"], func) |
| 20 |
|
| 21 |
def test_filter_parens(self): |
| 22 |
@self.library.filter() |
| 23 |
def func(): |
| 24 |
return "" |
| 25 |
|
| 26 |
self.assertEqual(self.library.filters["func"], func) |
| 27 |
|
| 28 |
def test_filter_name_arg(self): |
| 29 |
@self.library.filter("name") |
| 30 |
def func(): |
| 31 |
return "" |
| 32 |
|
| 33 |
self.assertEqual(self.library.filters["name"], func) |
| 34 |
|
| 35 |
def test_filter_name_kwarg(self): |
| 36 |
@self.library.filter(name="name") |
| 37 |
def func(): |
| 38 |
return "" |
| 39 |
|
| 40 |
self.assertEqual(self.library.filters["name"], func) |
| 41 |
|
| 42 |
def test_filter_call(self): |
| 43 |
def func(): |
| 44 |
return "" |
| 45 |
|
| 46 |
self.library.filter("name", func) |
| 47 |
self.assertEqual(self.library.filters["name"], func) |
| 48 |
|
| 49 |
def test_filter_invalid(self): |
| 50 |
msg = "Unsupported arguments to Library.filter: (None, '')" |
| 51 |
with self.assertRaisesMessage(ValueError, msg): |
| 52 |
self.library.filter(None, "") |
| 53 |
|
| 54 |
|
| 55 |
class InclusionTagRegistrationTests(SimpleTestCase): |
| 56 |
def setUp(self): |
| 57 |
self.library = Library() |
| 58 |
|
| 59 |
def test_inclusion_tag(self): |
| 60 |
@self.library.inclusion_tag("template.html") |
| 61 |
def func(): |
| 62 |
return "" |
| 63 |
|
| 64 |
self.assertIn("func", self.library.tags) |
| 65 |
|
| 66 |
def test_inclusion_tag_name(self): |
| 67 |
@self.library.inclusion_tag("template.html", name="name") |
| 68 |
def func(): |
| 69 |
return "" |
| 70 |
|
| 71 |
self.assertIn("name", self.library.tags) |
| 72 |
|
| 73 |
def test_inclusion_tag_wrapped(self): |
| 74 |
@self.library.inclusion_tag("template.html") |
| 75 |
@functools.lru_cache(maxsize=32) |
| 76 |
def func(): |
| 77 |
return "" |
| 78 |
|
| 79 |
func_wrapped = self.library.tags["func"].__wrapped__ |
| 80 |
self.assertIs(func_wrapped, func) |
| 81 |
self.assertTrue(hasattr(func_wrapped, "cache_info")) |
| 82 |
|
| 83 |
@unittest.skipUnless(PY314, "Deferred annotations are Python 3.14+ only") |
| 84 |
def test_inclusion_tag_deferred_annotation(self): |
| 85 |
@self.library.inclusion_tag("template.html") |
| 86 |
def func(arg: SomeType): # NOQA: F821 |
| 87 |
return "" |
| 88 |
|
| 89 |
self.assertIn("func", self.library.tags) |
| 90 |
|
| 91 |
|
| 92 |
class SimpleTagRegistrationTests(SimpleTestCase): |
| 93 |
def setUp(self): |
| 94 |
self.library = Library() |
| 95 |
|
| 96 |
def test_simple_tag(self): |
| 97 |
@self.library.simple_tag |
| 98 |
def func(): |
| 99 |
return "" |
| 100 |
|
| 101 |
self.assertIn("func", self.library.tags) |
| 102 |
|
| 103 |
def test_simple_tag_parens(self): |
| 104 |
@self.library.simple_tag() |
| 105 |
def func(): |
| 106 |
return "" |
| 107 |
|
| 108 |
self.assertIn("func", self.library.tags) |
| 109 |
|
| 110 |
def test_simple_tag_name_kwarg(self): |
| 111 |
@self.library.simple_tag(name="name") |
| 112 |
def func(): |
| 113 |
return "" |
| 114 |
|
| 115 |
self.assertIn("name", self.library.tags) |
| 116 |
|
| 117 |
@unittest.skipUnless(PY314, "Deferred annotations are Python 3.14+ only") |
| 118 |
def test_tag_deferred_annotation(self): |
| 119 |
@self.library.simple_tag |
| 120 |
def func(parser, token: SomeType): # NOQA: F821 |
| 121 |
return Node() |
| 122 |
|
| 123 |
self.assertIn("func", self.library.tags) |
| 124 |
|
| 125 |
def test_simple_tag_invalid(self): |
| 126 |
msg = "Invalid arguments provided to simple_tag" |
| 127 |
with self.assertRaisesMessage(ValueError, msg): |
| 128 |
self.library.simple_tag("invalid") |
| 129 |
|
| 130 |
def test_simple_tag_wrapped(self): |
| 131 |
@self.library.simple_tag |
| 132 |
@functools.lru_cache(maxsize=32) |
| 133 |
def func(): |
| 134 |
return "" |
| 135 |
|
| 136 |
func_wrapped = self.library.tags["func"].__wrapped__ |
| 137 |
self.assertIs(func_wrapped, func) |
| 138 |
self.assertTrue(hasattr(func_wrapped, "cache_info")) |
| 139 |
|
| 140 |
|
| 141 |
class SimpleBlockTagRegistrationTests(SimpleTestCase): |
| 142 |
def setUp(self): |
| 143 |
self.library = Library() |
| 144 |
|
| 145 |
def test_simple_block_tag(self): |
| 146 |
@self.library.simple_block_tag |
| 147 |
def func(content): |
| 148 |
return content |
| 149 |
|
| 150 |
self.assertIn("func", self.library.tags) |
| 151 |
|
| 152 |
def test_simple_block_tag_parens(self): |
| 153 |
@self.library.simple_block_tag() |
| 154 |
def func(content): |
| 155 |
return content |
| 156 |
|
| 157 |
self.assertIn("func", self.library.tags) |
| 158 |
|
| 159 |
def test_simple_block_tag_name_kwarg(self): |
| 160 |
@self.library.simple_block_tag(name="name") |
| 161 |
def func(content): |
| 162 |
return content |
| 163 |
|
| 164 |
self.assertIn("name", self.library.tags) |
| 165 |
|
| 166 |
@unittest.skipUnless(PY314, "Deferred annotations are Python 3.14+ only") |
| 167 |
def test_simple_block_tag_deferred_annotation(self): |
| 168 |
@self.library.simple_block_tag |
| 169 |
def func(content: SomeType): # NOQA: F821 |
| 170 |
return content |
| 171 |
|
| 172 |
self.assertIn("func", self.library.tags) |
| 173 |
|
| 174 |
def test_simple_block_tag_invalid(self): |
| 175 |
msg = "Invalid arguments provided to simple_block_tag" |
| 176 |
with self.assertRaisesMessage(ValueError, msg): |
| 177 |
self.library.simple_block_tag("invalid") |
| 178 |
|
| 179 |
def test_simple_tag_wrapped(self): |
| 180 |
@self.library.simple_block_tag |
| 181 |
@functools.lru_cache(maxsize=32) |
| 182 |
def func(content): |
| 183 |
return content |
| 184 |
|
| 185 |
func_wrapped = self.library.tags["func"].__wrapped__ |
| 186 |
self.assertIs(func_wrapped, func) |
| 187 |
self.assertTrue(hasattr(func_wrapped, "cache_info")) |
| 188 |
|
| 189 |
|
| 190 |
class TagRegistrationTests(SimpleTestCase): |
| 191 |
def setUp(self): |
| 192 |
self.library = Library() |
| 193 |
|
| 194 |
def test_tag(self): |
| 195 |
@self.library.tag |
| 196 |
def func(parser, token): |
| 197 |
return Node() |
| 198 |
|
| 199 |
self.assertEqual(self.library.tags["func"], func) |
| 200 |
|
| 201 |
def test_tag_parens(self): |
| 202 |
@self.library.tag() |
| 203 |
def func(parser, token): |
| 204 |
return Node() |
| 205 |
|
| 206 |
self.assertEqual(self.library.tags["func"], func) |
| 207 |
|
| 208 |
def test_tag_name_arg(self): |
| 209 |
@self.library.tag("name") |
| 210 |
def func(parser, token): |
| 211 |
return Node() |
| 212 |
|
| 213 |
self.assertEqual(self.library.tags["name"], func) |
| 214 |
|
| 215 |
def test_tag_name_kwarg(self): |
| 216 |
@self.library.tag(name="name") |
| 217 |
def func(parser, token): |
| 218 |
return Node() |
| 219 |
|
| 220 |
self.assertEqual(self.library.tags["name"], func) |
| 221 |
|
| 222 |
def test_tag_call(self): |
| 223 |
def func(parser, token): |
| 224 |
return Node() |
| 225 |
|
| 226 |
self.library.tag("name", func) |
| 227 |
self.assertEqual(self.library.tags["name"], func) |
| 228 |
|
| 229 |
def test_tag_invalid(self): |
| 230 |
msg = "Unsupported arguments to Library.tag: (None, '')" |
| 231 |
with self.assertRaisesMessage(ValueError, msg): |
| 232 |
self.library.tag(None, "") |