1
# -*- coding: utf-8 -*-
3
jinja2.testsuite.filters
4
~~~~~~~~~~~~~~~~~~~~~~~~
6
Tests for the jinja filters.
8
:copyright: (c) 2010 by the Jinja Team.
9
:license: BSD, see LICENSE for more details.
12
from jinja2.testsuite import JinjaTestCase
14
from jinja2 import Markup, Environment
15
from jinja2._compat import text_type, implements_to_string
20
class FilterTestCase(JinjaTestCase):
22
def test_filter_calling(self):
23
rv = env.call_filter('sum', [1, 2, 3])
24
self.assert_equal(rv, 6)
26
def test_capitalize(self):
27
tmpl = env.from_string('{{ "foo bar"|capitalize }}')
28
assert tmpl.render() == 'Foo bar'
30
def test_center(self):
31
tmpl = env.from_string('{{ "foo"|center(9) }}')
32
assert tmpl.render() == ' foo '
34
def test_default(self):
35
tmpl = env.from_string(
36
"{{ missing|default('no') }}|{{ false|default('no') }}|"
37
"{{ false|default('no', true) }}|{{ given|default('no') }}"
39
assert tmpl.render(given='yes') == 'no|False|no|yes'
41
def test_dictsort(self):
42
tmpl = env.from_string(
44
'{{ foo|dictsort(true) }}|'
45
'{{ foo|dictsort(false, "value") }}'
47
out = tmpl.render(foo={"aa": 0, "b": 1, "c": 2, "AB": 3})
48
assert out == ("[('aa', 0), ('AB', 3), ('b', 1), ('c', 2)]|"
49
"[('AB', 3), ('aa', 0), ('b', 1), ('c', 2)]|"
50
"[('aa', 0), ('b', 1), ('c', 2), ('AB', 3)]")
53
tmpl = env.from_string("{{ foo|batch(3)|list }}|"
54
"{{ foo|batch(3, 'X')|list }}")
55
out = tmpl.render(foo=list(range(10)))
56
assert out == ("[[0, 1, 2], [3, 4, 5], [6, 7, 8], [9]]|"
57
"[[0, 1, 2], [3, 4, 5], [6, 7, 8], [9, 'X', 'X']]")
60
tmpl = env.from_string('{{ foo|slice(3)|list }}|'
61
'{{ foo|slice(3, "X")|list }}')
62
out = tmpl.render(foo=list(range(10)))
63
assert out == ("[[0, 1, 2, 3], [4, 5, 6], [7, 8, 9]]|"
64
"[[0, 1, 2, 3], [4, 5, 6, 'X'], [7, 8, 9, 'X']]")
66
def test_escape(self):
67
tmpl = env.from_string('''{{ '<">&'|escape }}''')
69
assert out == '<">&'
71
def test_striptags(self):
72
tmpl = env.from_string('''{{ foo|striptags }}''')
73
out = tmpl.render(foo=' <p>just a small \n <a href="#">'
74
'example</a> link</p>\n<p>to a webpage</p> '
75
'<!-- <p>and some commented stuff</p> -->')
76
assert out == 'just a small example link to a webpage'
78
def test_filesizeformat(self):
79
tmpl = env.from_string(
80
'{{ 100|filesizeformat }}|'
81
'{{ 1000|filesizeformat }}|'
82
'{{ 1000000|filesizeformat }}|'
83
'{{ 1000000000|filesizeformat }}|'
84
'{{ 1000000000000|filesizeformat }}|'
85
'{{ 100|filesizeformat(true) }}|'
86
'{{ 1000|filesizeformat(true) }}|'
87
'{{ 1000000|filesizeformat(true) }}|'
88
'{{ 1000000000|filesizeformat(true) }}|'
89
'{{ 1000000000000|filesizeformat(true) }}'
92
self.assert_equal(out, (
93
'100 Bytes|1.0 kB|1.0 MB|1.0 GB|1.0 TB|100 Bytes|'
94
'1000 Bytes|976.6 KiB|953.7 MiB|931.3 GiB'
97
def test_filesizeformat_issue59(self):
98
tmpl = env.from_string(
99
'{{ 300|filesizeformat }}|'
100
'{{ 3000|filesizeformat }}|'
101
'{{ 3000000|filesizeformat }}|'
102
'{{ 3000000000|filesizeformat }}|'
103
'{{ 3000000000000|filesizeformat }}|'
104
'{{ 300|filesizeformat(true) }}|'
105
'{{ 3000|filesizeformat(true) }}|'
106
'{{ 3000000|filesizeformat(true) }}'
109
self.assert_equal(out, (
110
'300 Bytes|3.0 kB|3.0 MB|3.0 GB|3.0 TB|300 Bytes|'
115
def test_first(self):
116
tmpl = env.from_string('{{ foo|first }}')
117
out = tmpl.render(foo=list(range(10)))
120
def test_float(self):
121
tmpl = env.from_string('{{ "42"|float }}|'
122
'{{ "ajsghasjgd"|float }}|'
123
'{{ "32.32"|float }}')
125
assert out == '42.0|0.0|32.32'
127
def test_format(self):
128
tmpl = env.from_string('''{{ "%s|%s"|format("a", "b") }}''')
132
def test_indent(self):
133
tmpl = env.from_string('{{ foo|indent(2) }}|{{ foo|indent(2, true) }}')
134
text = '\n'.join([' '.join(['foo', 'bar'] * 2)] * 2)
135
out = tmpl.render(foo=text)
136
assert out == ('foo bar foo bar\n foo bar foo bar| '
137
'foo bar foo bar\n foo bar foo bar')
140
tmpl = env.from_string('{{ "42"|int }}|{{ "ajsghasjgd"|int }}|'
143
assert out == '42|0|32'
146
tmpl = env.from_string('{{ [1, 2, 3]|join("|") }}')
148
assert out == '1|2|3'
150
env2 = Environment(autoescape=True)
151
tmpl = env2.from_string('{{ ["<foo>", "<span>foo</span>"|safe]|join }}')
152
assert tmpl.render() == '<foo><span>foo</span>'
154
def test_join_attribute(self):
156
def __init__(self, username):
157
self.username = username
158
tmpl = env.from_string('''{{ users|join(', ', 'username') }}''')
159
assert tmpl.render(users=map(User, ['foo', 'bar'])) == 'foo, bar'
162
tmpl = env.from_string('''{{ foo|last }}''')
163
out = tmpl.render(foo=list(range(10)))
166
def test_length(self):
167
tmpl = env.from_string('''{{ "hello world"|length }}''')
171
def test_lower(self):
172
tmpl = env.from_string('''{{ "FOO"|lower }}''')
176
def test_pprint(self):
177
from pprint import pformat
178
tmpl = env.from_string('''{{ data|pprint }}''')
179
data = list(range(1000))
180
assert tmpl.render(data=data) == pformat(data)
182
def test_random(self):
183
tmpl = env.from_string('''{{ seq|random }}''')
184
seq = list(range(100))
186
assert int(tmpl.render(seq=seq)) in seq
188
def test_reverse(self):
189
tmpl = env.from_string('{{ "foobar"|reverse|join }}|'
190
'{{ [1, 2, 3]|reverse|list }}')
191
assert tmpl.render() == 'raboof|[3, 2, 1]'
193
def test_string(self):
195
tmpl = env.from_string('''{{ obj|string }}''')
196
assert tmpl.render(obj=x) == text_type(x)
198
def test_title(self):
199
tmpl = env.from_string('''{{ "foo bar"|title }}''')
200
assert tmpl.render() == "Foo Bar"
201
tmpl = env.from_string('''{{ "foo's bar"|title }}''')
202
assert tmpl.render() == "Foo's Bar"
203
tmpl = env.from_string('''{{ "foo bar"|title }}''')
204
assert tmpl.render() == "Foo Bar"
205
tmpl = env.from_string('''{{ "f bar f"|title }}''')
206
assert tmpl.render() == "F Bar F"
207
tmpl = env.from_string('''{{ "foo-bar"|title }}''')
208
assert tmpl.render() == "Foo-Bar"
209
tmpl = env.from_string('''{{ "foo\tbar"|title }}''')
210
assert tmpl.render() == "Foo\tBar"
211
tmpl = env.from_string('''{{ "FOO\tBAR"|title }}''')
212
assert tmpl.render() == "Foo\tBar"
214
def test_truncate(self):
215
tmpl = env.from_string(
216
'{{ data|truncate(15, true, ">>>") }}|'
217
'{{ data|truncate(15, false, ">>>") }}|'
218
'{{ smalldata|truncate(15) }}'
220
out = tmpl.render(data='foobar baz bar' * 1000,
221
smalldata='foobar baz bar')
222
assert out == 'foobar baz barf>>>|foobar baz >>>|foobar baz bar'
224
def test_upper(self):
225
tmpl = env.from_string('{{ "foo"|upper }}')
226
assert tmpl.render() == 'FOO'
228
def test_urlize(self):
229
tmpl = env.from_string('{{ "foo http://www.example.com/ bar"|urlize }}')
230
assert tmpl.render() == 'foo <a href="http://www.example.com/">'\
231
'http://www.example.com/</a> bar'
233
def test_wordcount(self):
234
tmpl = env.from_string('{{ "foo bar baz"|wordcount }}')
235
assert tmpl.render() == '3'
237
def test_block(self):
238
tmpl = env.from_string('{% filter lower|escape %}<HEHE>{% endfilter %}')
239
assert tmpl.render() == '<hehe>'
241
def test_chaining(self):
242
tmpl = env.from_string('''{{ ['<foo>', '<bar>']|first|upper|escape }}''')
243
assert tmpl.render() == '<FOO>'
246
tmpl = env.from_string('''{{ [1, 2, 3, 4, 5, 6]|sum }}''')
247
assert tmpl.render() == '21'
249
def test_sum_attributes(self):
250
tmpl = env.from_string('''{{ values|sum('value') }}''')
251
assert tmpl.render(values=[
257
def test_sum_attributes_nested(self):
258
tmpl = env.from_string('''{{ values|sum('real.value') }}''')
259
assert tmpl.render(values=[
260
{'real': {'value': 23}},
261
{'real': {'value': 1}},
262
{'real': {'value': 18}},
265
def test_sum_attributes_tuple(self):
266
tmpl = env.from_string('''{{ values.items()|sum('1') }}''')
267
assert tmpl.render(values={
274
tmpl = env.from_string('''{{ -1|abs }}|{{ 1|abs }}''')
275
assert tmpl.render() == '1|1', tmpl.render()
277
def test_round_positive(self):
278
tmpl = env.from_string('{{ 2.7|round }}|{{ 2.1|round }}|'
279
"{{ 2.1234|round(3, 'floor') }}|"
280
"{{ 2.1|round(0, 'ceil') }}")
281
assert tmpl.render() == '3.0|2.0|2.123|3.0', tmpl.render()
283
def test_round_negative(self):
284
tmpl = env.from_string('{{ 21.3|round(-1)}}|'
285
"{{ 21.3|round(-1, 'ceil')}}|"
286
"{{ 21.3|round(-1, 'floor')}}")
287
assert tmpl.render() == '20.0|30.0|20.0',tmpl.render()
289
def test_xmlattr(self):
290
tmpl = env.from_string("{{ {'foo': 42, 'bar': 23, 'fish': none, "
291
"'spam': missing, 'blub:blub': '<?>'}|xmlattr }}")
292
out = tmpl.render().split()
294
assert 'foo="42"' in out
295
assert 'bar="23"' in out
296
assert 'blub:blub="<?>"' in out
298
def test_sort1(self):
299
tmpl = env.from_string('{{ [2, 3, 1]|sort }}|{{ [2, 3, 1]|sort(true) }}')
300
assert tmpl.render() == '[1, 2, 3]|[3, 2, 1]'
302
def test_sort2(self):
303
tmpl = env.from_string('{{ "".join(["c", "A", "b", "D"]|sort) }}')
304
assert tmpl.render() == 'AbcD'
306
def test_sort3(self):
307
tmpl = env.from_string('''{{ ['foo', 'Bar', 'blah']|sort }}''')
308
assert tmpl.render() == "['Bar', 'blah', 'foo']"
310
def test_sort4(self):
311
@implements_to_string
313
def __init__(self, value):
316
return text_type(self.value)
317
tmpl = env.from_string('''{{ items|sort(attribute='value')|join }}''')
318
assert tmpl.render(items=map(Magic, [3, 2, 4, 1])) == '1234'
320
def test_groupby(self):
321
tmpl = env.from_string('''
322
{%- for grouper, list in [{'foo': 1, 'bar': 2},
323
{'foo': 2, 'bar': 3},
324
{'foo': 1, 'bar': 1},
325
{'foo': 3, 'bar': 4}]|groupby('foo') -%}
326
{{ grouper }}{% for x in list %}: {{ x.foo }}, {{ x.bar }}{% endfor %}|
328
assert tmpl.render().split('|') == [
335
def test_groupby_tuple_index(self):
336
tmpl = env.from_string('''
337
{%- for grouper, list in [('a', 1), ('a', 2), ('b', 1)]|groupby(0) -%}
338
{{ grouper }}{% for x in list %}:{{ x.1 }}{% endfor %}|
340
assert tmpl.render() == 'a:1:2|b:1|'
342
def test_groupby_multidot(self):
344
def __init__(self, day, month, year):
348
class Article(object):
349
def __init__(self, title, *date):
350
self.date = Date(*date)
353
Article('aha', 1, 1, 1970),
354
Article('interesting', 2, 1, 1970),
355
Article('really?', 3, 1, 1970),
356
Article('totally not', 1, 1, 1971)
358
tmpl = env.from_string('''
359
{%- for year, list in articles|groupby('date.year') -%}
360
{{ year }}{% for x in list %}[{{ x.title }}]{% endfor %}|
362
assert tmpl.render(articles=articles).split('|') == [
363
'1970[aha][interesting][really?]',
368
def test_filtertag(self):
369
tmpl = env.from_string("{% filter upper|replace('FOO', 'foo') %}"
370
"foobar{% endfilter %}")
371
assert tmpl.render() == 'fooBAR'
373
def test_replace(self):
375
tmpl = env.from_string('{{ string|replace("o", 42) }}')
376
assert tmpl.render(string='<foo>') == '<f4242>'
377
env = Environment(autoescape=True)
378
tmpl = env.from_string('{{ string|replace("o", 42) }}')
379
assert tmpl.render(string='<foo>') == '<f4242>'
380
tmpl = env.from_string('{{ string|replace("<", 42) }}')
381
assert tmpl.render(string='<foo>') == '42foo>'
382
tmpl = env.from_string('{{ string|replace("o", ">x<") }}')
383
assert tmpl.render(string=Markup('foo')) == 'f>x<>x<'
385
def test_forceescape(self):
386
tmpl = env.from_string('{{ x|forceescape }}')
387
assert tmpl.render(x=Markup('<div />')) == u'<div />'
390
env = Environment(autoescape=True)
391
tmpl = env.from_string('{{ "<div>foo</div>"|safe }}')
392
assert tmpl.render() == '<div>foo</div>'
393
tmpl = env.from_string('{{ "<div>foo</div>" }}')
394
assert tmpl.render() == '<div>foo</div>'
396
def test_urlencode(self):
397
env = Environment(autoescape=True)
398
tmpl = env.from_string('{{ "Hello, world!"|urlencode }}')
399
assert tmpl.render() == 'Hello%2C%20world%21'
400
tmpl = env.from_string('{{ o|urlencode }}')
401
assert tmpl.render(o=u"Hello, world\u203d") == "Hello%2C%20world%E2%80%BD"
402
assert tmpl.render(o=(("f", 1),)) == "f=1"
403
assert tmpl.render(o=(('f', 1), ("z", 2))) == "f=1&z=2"
404
assert tmpl.render(o=((u"\u203d", 1),)) == "%E2%80%BD=1"
405
assert tmpl.render(o={u"\u203d": 1}) == "%E2%80%BD=1"
406
assert tmpl.render(o={0: 1}) == "0=1"
408
def test_simple_map(self):
410
tmpl = env.from_string('{{ ["1", "2", "3"]|map("int")|sum }}')
411
self.assertEqual(tmpl.render(), '6')
413
def test_attribute_map(self):
415
def __init__(self, name):
423
tmpl = env.from_string('{{ users|map(attribute="name")|join("|") }}')
424
self.assertEqual(tmpl.render(users=users), 'john|jane|mike')
426
def test_empty_map(self):
428
tmpl = env.from_string('{{ none|map("upper")|list }}')
429
self.assertEqual(tmpl.render(), '[]')
431
def test_simple_select(self):
433
tmpl = env.from_string('{{ [1, 2, 3, 4, 5]|select("odd")|join("|") }}')
434
self.assertEqual(tmpl.render(), '1|3|5')
436
def test_bool_select(self):
438
tmpl = env.from_string('{{ [none, false, 0, 1, 2, 3, 4, 5]|select|join("|") }}')
439
self.assertEqual(tmpl.render(), '1|2|3|4|5')
441
def test_simple_reject(self):
443
tmpl = env.from_string('{{ [1, 2, 3, 4, 5]|reject("odd")|join("|") }}')
444
self.assertEqual(tmpl.render(), '2|4')
446
def test_bool_reject(self):
448
tmpl = env.from_string('{{ [none, false, 0, 1, 2, 3, 4, 5]|reject|join("|") }}')
449
self.assertEqual(tmpl.render(), 'None|False|0')
451
def test_simple_select_attr(self):
453
def __init__(self, name, is_active):
455
self.is_active = is_active
462
tmpl = env.from_string('{{ users|selectattr("is_active")|'
463
'map(attribute="name")|join("|") }}')
464
self.assertEqual(tmpl.render(users=users), 'john|jane')
466
def test_simple_reject_attr(self):
468
def __init__(self, name, is_active):
470
self.is_active = is_active
477
tmpl = env.from_string('{{ users|rejectattr("is_active")|'
478
'map(attribute="name")|join("|") }}')
479
self.assertEqual(tmpl.render(users=users), 'mike')
481
def test_func_select_attr(self):
483
def __init__(self, id, name):
492
tmpl = env.from_string('{{ users|selectattr("id", "odd")|'
493
'map(attribute="name")|join("|") }}')
494
self.assertEqual(tmpl.render(users=users), 'john|mike')
496
def test_func_reject_attr(self):
498
def __init__(self, id, name):
507
tmpl = env.from_string('{{ users|rejectattr("id", "odd")|'
508
'map(attribute="name")|join("|") }}')
509
self.assertEqual(tmpl.render(users=users), 'jane')
513
suite = unittest.TestSuite()
514
suite.addTest(unittest.makeSuite(FilterTestCase))