okstra 0.31.0 → 0.32.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/package.json +1 -1
  2. package/runtime/BUILD.json +2 -2
  3. package/runtime/agents/SKILL.md +3 -3
  4. package/runtime/agents/workers/report-writer-worker.md +45 -67
  5. package/runtime/bin/okstra-render-final-report.py +101 -0
  6. package/runtime/bin/okstra-render-report-views.py +17 -10
  7. package/runtime/bin/okstra-token-usage.py +3 -1
  8. package/runtime/python/okstra_ctl/final_report_schema.py +253 -0
  9. package/runtime/python/okstra_ctl/render_final_report.py +201 -0
  10. package/runtime/python/okstra_ctl/report_views.py +108 -305
  11. package/runtime/python/okstra_ctl/wizard.py +16 -5
  12. package/runtime/python/okstra_token_usage/__init__.py +5 -1
  13. package/runtime/python/okstra_token_usage/cli.py +66 -36
  14. package/runtime/python/okstra_token_usage/report.py +148 -65
  15. package/runtime/python/okstra_vendor/__init__.py +37 -0
  16. package/runtime/python/okstra_vendor/jinja2/__init__.py +38 -0
  17. package/runtime/python/okstra_vendor/jinja2/_identifier.py +6 -0
  18. package/runtime/python/okstra_vendor/jinja2/async_utils.py +99 -0
  19. package/runtime/python/okstra_vendor/jinja2/bccache.py +408 -0
  20. package/runtime/python/okstra_vendor/jinja2/compiler.py +1998 -0
  21. package/runtime/python/okstra_vendor/jinja2/constants.py +20 -0
  22. package/runtime/python/okstra_vendor/jinja2/debug.py +191 -0
  23. package/runtime/python/okstra_vendor/jinja2/defaults.py +48 -0
  24. package/runtime/python/okstra_vendor/jinja2/environment.py +1672 -0
  25. package/runtime/python/okstra_vendor/jinja2/exceptions.py +166 -0
  26. package/runtime/python/okstra_vendor/jinja2/ext.py +870 -0
  27. package/runtime/python/okstra_vendor/jinja2/filters.py +1873 -0
  28. package/runtime/python/okstra_vendor/jinja2/idtracking.py +318 -0
  29. package/runtime/python/okstra_vendor/jinja2/lexer.py +868 -0
  30. package/runtime/python/okstra_vendor/jinja2/loaders.py +693 -0
  31. package/runtime/python/okstra_vendor/jinja2/meta.py +112 -0
  32. package/runtime/python/okstra_vendor/jinja2/nativetypes.py +130 -0
  33. package/runtime/python/okstra_vendor/jinja2/nodes.py +1206 -0
  34. package/runtime/python/okstra_vendor/jinja2/optimizer.py +48 -0
  35. package/runtime/python/okstra_vendor/jinja2/parser.py +1049 -0
  36. package/runtime/python/okstra_vendor/jinja2/py.typed +0 -0
  37. package/runtime/python/okstra_vendor/jinja2/runtime.py +1062 -0
  38. package/runtime/python/okstra_vendor/jinja2/sandbox.py +436 -0
  39. package/runtime/python/okstra_vendor/jinja2/tests.py +256 -0
  40. package/runtime/python/okstra_vendor/jinja2/utils.py +766 -0
  41. package/runtime/python/okstra_vendor/jinja2/visitor.py +92 -0
  42. package/runtime/python/okstra_vendor/markupsafe/__init__.py +396 -0
  43. package/runtime/python/okstra_vendor/markupsafe/_native.py +8 -0
  44. package/runtime/python/okstra_vendor/markupsafe/py.typed +0 -0
  45. package/runtime/schemas/final-report-v1.0.schema.json +1391 -0
  46. package/runtime/skills/okstra-report-writer/SKILL.md +29 -28
  47. package/runtime/templates/reports/final-report.template.md +370 -411
  48. package/runtime/templates/reports/report.css +12 -6
  49. package/runtime/validators/lib/fixtures.sh +7 -7
  50. package/runtime/validators/validate-report-views.py +24 -153
  51. package/runtime/validators/validate-run.py +102 -19
  52. package/src/install.mjs +20 -1
@@ -0,0 +1,1873 @@
1
+ """Built-in template filters used with the ``|`` operator."""
2
+
3
+ import math
4
+ import random
5
+ import re
6
+ import typing
7
+ import typing as t
8
+ from collections import abc
9
+ from inspect import getattr_static
10
+ from itertools import chain
11
+ from itertools import groupby
12
+
13
+ from markupsafe import escape
14
+ from markupsafe import Markup
15
+ from markupsafe import soft_str
16
+
17
+ from .async_utils import async_variant
18
+ from .async_utils import auto_aiter
19
+ from .async_utils import auto_await
20
+ from .async_utils import auto_to_list
21
+ from .exceptions import FilterArgumentError
22
+ from .runtime import Undefined
23
+ from .utils import htmlsafe_json_dumps
24
+ from .utils import pass_context
25
+ from .utils import pass_environment
26
+ from .utils import pass_eval_context
27
+ from .utils import pformat
28
+ from .utils import url_quote
29
+ from .utils import urlize
30
+
31
+ if t.TYPE_CHECKING:
32
+ import typing_extensions as te
33
+
34
+ from .environment import Environment
35
+ from .nodes import EvalContext
36
+ from .runtime import Context
37
+ from .sandbox import SandboxedEnvironment # noqa: F401
38
+
39
+ class HasHTML(te.Protocol):
40
+ def __html__(self) -> str:
41
+ pass
42
+
43
+
44
+ F = t.TypeVar("F", bound=t.Callable[..., t.Any])
45
+ K = t.TypeVar("K")
46
+ V = t.TypeVar("V")
47
+
48
+
49
+ def ignore_case(value: V) -> V:
50
+ """For use as a postprocessor for :func:`make_attrgetter`. Converts strings
51
+ to lowercase and returns other types as-is."""
52
+ if isinstance(value, str):
53
+ return t.cast(V, value.lower())
54
+
55
+ return value
56
+
57
+
58
+ def make_attrgetter(
59
+ environment: "Environment",
60
+ attribute: t.Optional[t.Union[str, int]],
61
+ postprocess: t.Optional[t.Callable[[t.Any], t.Any]] = None,
62
+ default: t.Optional[t.Any] = None,
63
+ ) -> t.Callable[[t.Any], t.Any]:
64
+ """Returns a callable that looks up the given attribute from a
65
+ passed object with the rules of the environment. Dots are allowed
66
+ to access attributes of attributes. Integer parts in paths are
67
+ looked up as integers.
68
+ """
69
+ parts = _prepare_attribute_parts(attribute)
70
+
71
+ def attrgetter(item: t.Any) -> t.Any:
72
+ for part in parts:
73
+ item = environment.getitem(item, part)
74
+
75
+ if default is not None and isinstance(item, Undefined):
76
+ item = default
77
+
78
+ if postprocess is not None:
79
+ item = postprocess(item)
80
+
81
+ return item
82
+
83
+ return attrgetter
84
+
85
+
86
+ def make_multi_attrgetter(
87
+ environment: "Environment",
88
+ attribute: t.Optional[t.Union[str, int]],
89
+ postprocess: t.Optional[t.Callable[[t.Any], t.Any]] = None,
90
+ ) -> t.Callable[[t.Any], t.List[t.Any]]:
91
+ """Returns a callable that looks up the given comma separated
92
+ attributes from a passed object with the rules of the environment.
93
+ Dots are allowed to access attributes of each attribute. Integer
94
+ parts in paths are looked up as integers.
95
+
96
+ The value returned by the returned callable is a list of extracted
97
+ attribute values.
98
+
99
+ Examples of attribute: "attr1,attr2", "attr1.inner1.0,attr2.inner2.0", etc.
100
+ """
101
+ if isinstance(attribute, str):
102
+ split: t.Sequence[t.Union[str, int, None]] = attribute.split(",")
103
+ else:
104
+ split = [attribute]
105
+
106
+ parts = [_prepare_attribute_parts(item) for item in split]
107
+
108
+ def attrgetter(item: t.Any) -> t.List[t.Any]:
109
+ items = [None] * len(parts)
110
+
111
+ for i, attribute_part in enumerate(parts):
112
+ item_i = item
113
+
114
+ for part in attribute_part:
115
+ item_i = environment.getitem(item_i, part)
116
+
117
+ if postprocess is not None:
118
+ item_i = postprocess(item_i)
119
+
120
+ items[i] = item_i
121
+
122
+ return items
123
+
124
+ return attrgetter
125
+
126
+
127
+ def _prepare_attribute_parts(
128
+ attr: t.Optional[t.Union[str, int]],
129
+ ) -> t.List[t.Union[str, int]]:
130
+ if attr is None:
131
+ return []
132
+
133
+ if isinstance(attr, str):
134
+ return [int(x) if x.isdigit() else x for x in attr.split(".")]
135
+
136
+ return [attr]
137
+
138
+
139
+ def do_forceescape(value: "t.Union[str, HasHTML]") -> Markup:
140
+ """Enforce HTML escaping. This will probably double escape variables."""
141
+ if hasattr(value, "__html__"):
142
+ value = t.cast("HasHTML", value).__html__()
143
+
144
+ return escape(str(value))
145
+
146
+
147
+ def do_urlencode(
148
+ value: t.Union[str, t.Mapping[str, t.Any], t.Iterable[t.Tuple[str, t.Any]]],
149
+ ) -> str:
150
+ """Quote data for use in a URL path or query using UTF-8.
151
+
152
+ Basic wrapper around :func:`urllib.parse.quote` when given a
153
+ string, or :func:`urllib.parse.urlencode` for a dict or iterable.
154
+
155
+ :param value: Data to quote. A string will be quoted directly. A
156
+ dict or iterable of ``(key, value)`` pairs will be joined as a
157
+ query string.
158
+
159
+ When given a string, "/" is not quoted. HTTP servers treat "/" and
160
+ "%2F" equivalently in paths. If you need quoted slashes, use the
161
+ ``|replace("/", "%2F")`` filter.
162
+
163
+ .. versionadded:: 2.7
164
+ """
165
+ if isinstance(value, str) or not isinstance(value, abc.Iterable):
166
+ return url_quote(value)
167
+
168
+ if isinstance(value, dict):
169
+ items: t.Iterable[t.Tuple[str, t.Any]] = value.items()
170
+ else:
171
+ items = value # type: ignore
172
+
173
+ return "&".join(
174
+ f"{url_quote(k, for_qs=True)}={url_quote(v, for_qs=True)}" for k, v in items
175
+ )
176
+
177
+
178
+ @pass_eval_context
179
+ def do_replace(
180
+ eval_ctx: "EvalContext", s: str, old: str, new: str, count: t.Optional[int] = None
181
+ ) -> str:
182
+ """Return a copy of the value with all occurrences of a substring
183
+ replaced with a new one. The first argument is the substring
184
+ that should be replaced, the second is the replacement string.
185
+ If the optional third argument ``count`` is given, only the first
186
+ ``count`` occurrences are replaced:
187
+
188
+ .. sourcecode:: jinja
189
+
190
+ {{ "Hello World"|replace("Hello", "Goodbye") }}
191
+ -> Goodbye World
192
+
193
+ {{ "aaaaargh"|replace("a", "d'oh, ", 2) }}
194
+ -> d'oh, d'oh, aaargh
195
+ """
196
+ if count is None:
197
+ count = -1
198
+
199
+ if not eval_ctx.autoescape:
200
+ return str(s).replace(str(old), str(new), count)
201
+
202
+ if (
203
+ hasattr(old, "__html__")
204
+ or hasattr(new, "__html__")
205
+ and not hasattr(s, "__html__")
206
+ ):
207
+ s = escape(s)
208
+ else:
209
+ s = soft_str(s)
210
+
211
+ return s.replace(soft_str(old), soft_str(new), count)
212
+
213
+
214
+ def do_upper(s: str) -> str:
215
+ """Convert a value to uppercase."""
216
+ return soft_str(s).upper()
217
+
218
+
219
+ def do_lower(s: str) -> str:
220
+ """Convert a value to lowercase."""
221
+ return soft_str(s).lower()
222
+
223
+
224
+ def do_items(value: t.Union[t.Mapping[K, V], Undefined]) -> t.Iterator[t.Tuple[K, V]]:
225
+ """Return an iterator over the ``(key, value)`` items of a mapping.
226
+
227
+ ``x|items`` is the same as ``x.items()``, except if ``x`` is
228
+ undefined an empty iterator is returned.
229
+
230
+ This filter is useful if you expect the template to be rendered with
231
+ an implementation of Jinja in another programming language that does
232
+ not have a ``.items()`` method on its mapping type.
233
+
234
+ .. code-block:: html+jinja
235
+
236
+ <dl>
237
+ {% for key, value in my_dict|items %}
238
+ <dt>{{ key }}
239
+ <dd>{{ value }}
240
+ {% endfor %}
241
+ </dl>
242
+
243
+ .. versionadded:: 3.1
244
+ """
245
+ if isinstance(value, Undefined):
246
+ return
247
+
248
+ if not isinstance(value, abc.Mapping):
249
+ raise TypeError("Can only get item pairs from a mapping.")
250
+
251
+ yield from value.items()
252
+
253
+
254
+ # Check for characters that would move the parser state from key to value.
255
+ # https://html.spec.whatwg.org/#attribute-name-state
256
+ _attr_key_re = re.compile(r"[\s/>=]", flags=re.ASCII)
257
+
258
+
259
+ @pass_eval_context
260
+ def do_xmlattr(
261
+ eval_ctx: "EvalContext", d: t.Mapping[str, t.Any], autospace: bool = True
262
+ ) -> str:
263
+ """Create an SGML/XML attribute string based on the items in a dict.
264
+
265
+ **Values** that are neither ``none`` nor ``undefined`` are automatically
266
+ escaped, safely allowing untrusted user input.
267
+
268
+ User input should not be used as **keys** to this filter. If any key
269
+ contains a space, ``/`` solidus, ``>`` greater-than sign, or ``=`` equals
270
+ sign, this fails with a ``ValueError``. Regardless of this, user input
271
+ should never be used as keys to this filter, or must be separately validated
272
+ first.
273
+
274
+ .. sourcecode:: html+jinja
275
+
276
+ <ul{{ {'class': 'my_list', 'missing': none,
277
+ 'id': 'list-%d'|format(variable)}|xmlattr }}>
278
+ ...
279
+ </ul>
280
+
281
+ Results in something like this:
282
+
283
+ .. sourcecode:: html
284
+
285
+ <ul class="my_list" id="list-42">
286
+ ...
287
+ </ul>
288
+
289
+ As you can see it automatically prepends a space in front of the item
290
+ if the filter returned something unless the second parameter is false.
291
+
292
+ .. versionchanged:: 3.1.4
293
+ Keys with ``/`` solidus, ``>`` greater-than sign, or ``=`` equals sign
294
+ are not allowed.
295
+
296
+ .. versionchanged:: 3.1.3
297
+ Keys with spaces are not allowed.
298
+ """
299
+ items = []
300
+
301
+ for key, value in d.items():
302
+ if value is None or isinstance(value, Undefined):
303
+ continue
304
+
305
+ if _attr_key_re.search(key) is not None:
306
+ raise ValueError(f"Invalid character in attribute name: {key!r}")
307
+
308
+ items.append(f'{escape(key)}="{escape(value)}"')
309
+
310
+ rv = " ".join(items)
311
+
312
+ if autospace and rv:
313
+ rv = " " + rv
314
+
315
+ if eval_ctx.autoescape:
316
+ rv = Markup(rv)
317
+
318
+ return rv
319
+
320
+
321
+ def do_capitalize(s: str) -> str:
322
+ """Capitalize a value. The first character will be uppercase, all others
323
+ lowercase.
324
+ """
325
+ return soft_str(s).capitalize()
326
+
327
+
328
+ _word_beginning_split_re = re.compile(r"([-\s({\[<]+)")
329
+
330
+
331
+ def do_title(s: str) -> str:
332
+ """Return a titlecased version of the value. I.e. words will start with
333
+ uppercase letters, all remaining characters are lowercase.
334
+ """
335
+ return "".join(
336
+ [
337
+ item[0].upper() + item[1:].lower()
338
+ for item in _word_beginning_split_re.split(soft_str(s))
339
+ if item
340
+ ]
341
+ )
342
+
343
+
344
+ def do_dictsort(
345
+ value: t.Mapping[K, V],
346
+ case_sensitive: bool = False,
347
+ by: 'te.Literal["key", "value"]' = "key",
348
+ reverse: bool = False,
349
+ ) -> t.List[t.Tuple[K, V]]:
350
+ """Sort a dict and yield (key, value) pairs. Python dicts may not
351
+ be in the order you want to display them in, so sort them first.
352
+
353
+ .. sourcecode:: jinja
354
+
355
+ {% for key, value in mydict|dictsort %}
356
+ sort the dict by key, case insensitive
357
+
358
+ {% for key, value in mydict|dictsort(reverse=true) %}
359
+ sort the dict by key, case insensitive, reverse order
360
+
361
+ {% for key, value in mydict|dictsort(true) %}
362
+ sort the dict by key, case sensitive
363
+
364
+ {% for key, value in mydict|dictsort(false, 'value') %}
365
+ sort the dict by value, case insensitive
366
+ """
367
+ if by == "key":
368
+ pos = 0
369
+ elif by == "value":
370
+ pos = 1
371
+ else:
372
+ raise FilterArgumentError('You can only sort by either "key" or "value"')
373
+
374
+ def sort_func(item: t.Tuple[t.Any, t.Any]) -> t.Any:
375
+ value = item[pos]
376
+
377
+ if not case_sensitive:
378
+ value = ignore_case(value)
379
+
380
+ return value
381
+
382
+ return sorted(value.items(), key=sort_func, reverse=reverse)
383
+
384
+
385
+ @pass_environment
386
+ def do_sort(
387
+ environment: "Environment",
388
+ value: "t.Iterable[V]",
389
+ reverse: bool = False,
390
+ case_sensitive: bool = False,
391
+ attribute: t.Optional[t.Union[str, int]] = None,
392
+ ) -> "t.List[V]":
393
+ """Sort an iterable using Python's :func:`sorted`.
394
+
395
+ .. sourcecode:: jinja
396
+
397
+ {% for city in cities|sort %}
398
+ ...
399
+ {% endfor %}
400
+
401
+ :param reverse: Sort descending instead of ascending.
402
+ :param case_sensitive: When sorting strings, sort upper and lower
403
+ case separately.
404
+ :param attribute: When sorting objects or dicts, an attribute or
405
+ key to sort by. Can use dot notation like ``"address.city"``.
406
+ Can be a list of attributes like ``"age,name"``.
407
+
408
+ The sort is stable, it does not change the relative order of
409
+ elements that compare equal. This makes it is possible to chain
410
+ sorts on different attributes and ordering.
411
+
412
+ .. sourcecode:: jinja
413
+
414
+ {% for user in users|sort(attribute="name")
415
+ |sort(reverse=true, attribute="age") %}
416
+ ...
417
+ {% endfor %}
418
+
419
+ As a shortcut to chaining when the direction is the same for all
420
+ attributes, pass a comma separate list of attributes.
421
+
422
+ .. sourcecode:: jinja
423
+
424
+ {% for user in users|sort(attribute="age,name") %}
425
+ ...
426
+ {% endfor %}
427
+
428
+ .. versionchanged:: 2.11.0
429
+ The ``attribute`` parameter can be a comma separated list of
430
+ attributes, e.g. ``"age,name"``.
431
+
432
+ .. versionchanged:: 2.6
433
+ The ``attribute`` parameter was added.
434
+ """
435
+ key_func = make_multi_attrgetter(
436
+ environment, attribute, postprocess=ignore_case if not case_sensitive else None
437
+ )
438
+ return sorted(value, key=key_func, reverse=reverse)
439
+
440
+
441
+ @pass_environment
442
+ def sync_do_unique(
443
+ environment: "Environment",
444
+ value: "t.Iterable[V]",
445
+ case_sensitive: bool = False,
446
+ attribute: t.Optional[t.Union[str, int]] = None,
447
+ ) -> "t.Iterator[V]":
448
+ """Returns a list of unique items from the given iterable.
449
+
450
+ .. sourcecode:: jinja
451
+
452
+ {{ ['foo', 'bar', 'foobar', 'FooBar']|unique|list }}
453
+ -> ['foo', 'bar', 'foobar']
454
+
455
+ The unique items are yielded in the same order as their first occurrence in
456
+ the iterable passed to the filter.
457
+
458
+ :param case_sensitive: Treat upper and lower case strings as distinct.
459
+ :param attribute: Filter objects with unique values for this attribute.
460
+ """
461
+ getter = make_attrgetter(
462
+ environment, attribute, postprocess=ignore_case if not case_sensitive else None
463
+ )
464
+ seen = set()
465
+
466
+ for item in value:
467
+ key = getter(item)
468
+
469
+ if key not in seen:
470
+ seen.add(key)
471
+ yield item
472
+
473
+
474
+ @async_variant(sync_do_unique) # type: ignore
475
+ async def do_unique(
476
+ environment: "Environment",
477
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
478
+ case_sensitive: bool = False,
479
+ attribute: t.Optional[t.Union[str, int]] = None,
480
+ ) -> "t.Iterator[V]":
481
+ return sync_do_unique(
482
+ environment, await auto_to_list(value), case_sensitive, attribute
483
+ )
484
+
485
+
486
+ def _min_or_max(
487
+ environment: "Environment",
488
+ value: "t.Iterable[V]",
489
+ func: "t.Callable[..., V]",
490
+ case_sensitive: bool,
491
+ attribute: t.Optional[t.Union[str, int]],
492
+ ) -> "t.Union[V, Undefined]":
493
+ it = iter(value)
494
+
495
+ try:
496
+ first = next(it)
497
+ except StopIteration:
498
+ return environment.undefined("No aggregated item, sequence was empty.")
499
+
500
+ key_func = make_attrgetter(
501
+ environment, attribute, postprocess=ignore_case if not case_sensitive else None
502
+ )
503
+ return func(chain([first], it), key=key_func)
504
+
505
+
506
+ @pass_environment
507
+ def do_min(
508
+ environment: "Environment",
509
+ value: "t.Iterable[V]",
510
+ case_sensitive: bool = False,
511
+ attribute: t.Optional[t.Union[str, int]] = None,
512
+ ) -> "t.Union[V, Undefined]":
513
+ """Return the smallest item from the sequence.
514
+
515
+ .. sourcecode:: jinja
516
+
517
+ {{ [1, 2, 3]|min }}
518
+ -> 1
519
+
520
+ :param case_sensitive: Treat upper and lower case strings as distinct.
521
+ :param attribute: Get the object with the min value of this attribute.
522
+ """
523
+ return _min_or_max(environment, value, min, case_sensitive, attribute)
524
+
525
+
526
+ @pass_environment
527
+ def do_max(
528
+ environment: "Environment",
529
+ value: "t.Iterable[V]",
530
+ case_sensitive: bool = False,
531
+ attribute: t.Optional[t.Union[str, int]] = None,
532
+ ) -> "t.Union[V, Undefined]":
533
+ """Return the largest item from the sequence.
534
+
535
+ .. sourcecode:: jinja
536
+
537
+ {{ [1, 2, 3]|max }}
538
+ -> 3
539
+
540
+ :param case_sensitive: Treat upper and lower case strings as distinct.
541
+ :param attribute: Get the object with the max value of this attribute.
542
+ """
543
+ return _min_or_max(environment, value, max, case_sensitive, attribute)
544
+
545
+
546
+ def do_default(
547
+ value: V,
548
+ default_value: V = "", # type: ignore
549
+ boolean: bool = False,
550
+ ) -> V:
551
+ """If the value is undefined it will return the passed default value,
552
+ otherwise the value of the variable:
553
+
554
+ .. sourcecode:: jinja
555
+
556
+ {{ my_variable|default('my_variable is not defined') }}
557
+
558
+ This will output the value of ``my_variable`` if the variable was
559
+ defined, otherwise ``'my_variable is not defined'``. If you want
560
+ to use default with variables that evaluate to false you have to
561
+ set the second parameter to `true`:
562
+
563
+ .. sourcecode:: jinja
564
+
565
+ {{ ''|default('the string was empty', true) }}
566
+
567
+ .. versionchanged:: 2.11
568
+ It's now possible to configure the :class:`~jinja2.Environment` with
569
+ :class:`~jinja2.ChainableUndefined` to make the `default` filter work
570
+ on nested elements and attributes that may contain undefined values
571
+ in the chain without getting an :exc:`~jinja2.UndefinedError`.
572
+ """
573
+ if isinstance(value, Undefined) or (boolean and not value):
574
+ return default_value
575
+
576
+ return value
577
+
578
+
579
+ @pass_eval_context
580
+ def sync_do_join(
581
+ eval_ctx: "EvalContext",
582
+ value: t.Iterable[t.Any],
583
+ d: str = "",
584
+ attribute: t.Optional[t.Union[str, int]] = None,
585
+ ) -> str:
586
+ """Return a string which is the concatenation of the strings in the
587
+ sequence. The separator between elements is an empty string per
588
+ default, you can define it with the optional parameter:
589
+
590
+ .. sourcecode:: jinja
591
+
592
+ {{ [1, 2, 3]|join('|') }}
593
+ -> 1|2|3
594
+
595
+ {{ [1, 2, 3]|join }}
596
+ -> 123
597
+
598
+ It is also possible to join certain attributes of an object:
599
+
600
+ .. sourcecode:: jinja
601
+
602
+ {{ users|join(', ', attribute='username') }}
603
+
604
+ .. versionadded:: 2.6
605
+ The `attribute` parameter was added.
606
+ """
607
+ if attribute is not None:
608
+ value = map(make_attrgetter(eval_ctx.environment, attribute), value)
609
+
610
+ # no automatic escaping? joining is a lot easier then
611
+ if not eval_ctx.autoescape:
612
+ return str(d).join(map(str, value))
613
+
614
+ # if the delimiter doesn't have an html representation we check
615
+ # if any of the items has. If yes we do a coercion to Markup
616
+ if not hasattr(d, "__html__"):
617
+ value = list(value)
618
+ do_escape = False
619
+
620
+ for idx, item in enumerate(value):
621
+ if hasattr(item, "__html__"):
622
+ do_escape = True
623
+ else:
624
+ value[idx] = str(item)
625
+
626
+ if do_escape:
627
+ d = escape(d)
628
+ else:
629
+ d = str(d)
630
+
631
+ return d.join(value)
632
+
633
+ # no html involved, to normal joining
634
+ return soft_str(d).join(map(soft_str, value))
635
+
636
+
637
+ @async_variant(sync_do_join) # type: ignore
638
+ async def do_join(
639
+ eval_ctx: "EvalContext",
640
+ value: t.Union[t.AsyncIterable[t.Any], t.Iterable[t.Any]],
641
+ d: str = "",
642
+ attribute: t.Optional[t.Union[str, int]] = None,
643
+ ) -> str:
644
+ return sync_do_join(eval_ctx, await auto_to_list(value), d, attribute)
645
+
646
+
647
+ def do_center(value: str, width: int = 80) -> str:
648
+ """Centers the value in a field of a given width."""
649
+ return soft_str(value).center(width)
650
+
651
+
652
+ @pass_environment
653
+ def sync_do_first(
654
+ environment: "Environment", seq: "t.Iterable[V]"
655
+ ) -> "t.Union[V, Undefined]":
656
+ """Return the first item of a sequence."""
657
+ try:
658
+ return next(iter(seq))
659
+ except StopIteration:
660
+ return environment.undefined("No first item, sequence was empty.")
661
+
662
+
663
+ @async_variant(sync_do_first) # type: ignore
664
+ async def do_first(
665
+ environment: "Environment", seq: "t.Union[t.AsyncIterable[V], t.Iterable[V]]"
666
+ ) -> "t.Union[V, Undefined]":
667
+ try:
668
+ return await auto_aiter(seq).__anext__()
669
+ except StopAsyncIteration:
670
+ return environment.undefined("No first item, sequence was empty.")
671
+
672
+
673
+ @pass_environment
674
+ def do_last(
675
+ environment: "Environment", seq: "t.Reversible[V]"
676
+ ) -> "t.Union[V, Undefined]":
677
+ """Return the last item of a sequence.
678
+
679
+ Note: Does not work with generators. You may want to explicitly
680
+ convert it to a list:
681
+
682
+ .. sourcecode:: jinja
683
+
684
+ {{ data | selectattr('name', '==', 'Jinja') | list | last }}
685
+ """
686
+ try:
687
+ return next(iter(reversed(seq)))
688
+ except StopIteration:
689
+ return environment.undefined("No last item, sequence was empty.")
690
+
691
+
692
+ # No async do_last, it may not be safe in async mode.
693
+
694
+
695
+ @pass_context
696
+ def do_random(context: "Context", seq: "t.Sequence[V]") -> "t.Union[V, Undefined]":
697
+ """Return a random item from the sequence."""
698
+ try:
699
+ return random.choice(seq)
700
+ except IndexError:
701
+ return context.environment.undefined("No random item, sequence was empty.")
702
+
703
+
704
+ def do_filesizeformat(value: t.Union[str, float, int], binary: bool = False) -> str:
705
+ """Format the value like a 'human-readable' file size (i.e. 13 kB,
706
+ 4.1 MB, 102 Bytes, etc). Per default decimal prefixes are used (Mega,
707
+ Giga, etc.), if the second parameter is set to `True` the binary
708
+ prefixes are used (Mebi, Gibi).
709
+ """
710
+ bytes = float(value)
711
+ base = 1024 if binary else 1000
712
+ prefixes = [
713
+ ("KiB" if binary else "kB"),
714
+ ("MiB" if binary else "MB"),
715
+ ("GiB" if binary else "GB"),
716
+ ("TiB" if binary else "TB"),
717
+ ("PiB" if binary else "PB"),
718
+ ("EiB" if binary else "EB"),
719
+ ("ZiB" if binary else "ZB"),
720
+ ("YiB" if binary else "YB"),
721
+ ]
722
+
723
+ if bytes == 1:
724
+ return "1 Byte"
725
+ elif bytes < base:
726
+ return f"{int(bytes)} Bytes"
727
+ else:
728
+ for i, prefix in enumerate(prefixes):
729
+ unit = base ** (i + 2)
730
+
731
+ if bytes < unit:
732
+ return f"{base * bytes / unit:.1f} {prefix}"
733
+
734
+ return f"{base * bytes / unit:.1f} {prefix}"
735
+
736
+
737
+ def do_pprint(value: t.Any) -> str:
738
+ """Pretty print a variable. Useful for debugging."""
739
+ return pformat(value)
740
+
741
+
742
+ _uri_scheme_re = re.compile(r"^([\w.+-]{2,}:(/){0,2})$")
743
+
744
+
745
+ @pass_eval_context
746
+ def do_urlize(
747
+ eval_ctx: "EvalContext",
748
+ value: str,
749
+ trim_url_limit: t.Optional[int] = None,
750
+ nofollow: bool = False,
751
+ target: t.Optional[str] = None,
752
+ rel: t.Optional[str] = None,
753
+ extra_schemes: t.Optional[t.Iterable[str]] = None,
754
+ ) -> str:
755
+ """Convert URLs in text into clickable links.
756
+
757
+ This may not recognize links in some situations. Usually, a more
758
+ comprehensive formatter, such as a Markdown library, is a better
759
+ choice.
760
+
761
+ Works on ``http://``, ``https://``, ``www.``, ``mailto:``, and email
762
+ addresses. Links with trailing punctuation (periods, commas, closing
763
+ parentheses) and leading punctuation (opening parentheses) are
764
+ recognized excluding the punctuation. Email addresses that include
765
+ header fields are not recognized (for example,
766
+ ``mailto:address@example.com?cc=copy@example.com``).
767
+
768
+ :param value: Original text containing URLs to link.
769
+ :param trim_url_limit: Shorten displayed URL values to this length.
770
+ :param nofollow: Add the ``rel=nofollow`` attribute to links.
771
+ :param target: Add the ``target`` attribute to links.
772
+ :param rel: Add the ``rel`` attribute to links.
773
+ :param extra_schemes: Recognize URLs that start with these schemes
774
+ in addition to the default behavior. Defaults to
775
+ ``env.policies["urlize.extra_schemes"]``, which defaults to no
776
+ extra schemes.
777
+
778
+ .. versionchanged:: 3.0
779
+ The ``extra_schemes`` parameter was added.
780
+
781
+ .. versionchanged:: 3.0
782
+ Generate ``https://`` links for URLs without a scheme.
783
+
784
+ .. versionchanged:: 3.0
785
+ The parsing rules were updated. Recognize email addresses with
786
+ or without the ``mailto:`` scheme. Validate IP addresses. Ignore
787
+ parentheses and brackets in more cases.
788
+
789
+ .. versionchanged:: 2.8
790
+ The ``target`` parameter was added.
791
+ """
792
+ policies = eval_ctx.environment.policies
793
+ rel_parts = set((rel or "").split())
794
+
795
+ if nofollow:
796
+ rel_parts.add("nofollow")
797
+
798
+ rel_parts.update((policies["urlize.rel"] or "").split())
799
+ rel = " ".join(sorted(rel_parts)) or None
800
+
801
+ if target is None:
802
+ target = policies["urlize.target"]
803
+
804
+ if extra_schemes is None:
805
+ extra_schemes = policies["urlize.extra_schemes"] or ()
806
+
807
+ for scheme in extra_schemes:
808
+ if _uri_scheme_re.fullmatch(scheme) is None:
809
+ raise FilterArgumentError(f"{scheme!r} is not a valid URI scheme prefix.")
810
+
811
+ rv = urlize(
812
+ value,
813
+ trim_url_limit=trim_url_limit,
814
+ rel=rel,
815
+ target=target,
816
+ extra_schemes=extra_schemes,
817
+ )
818
+
819
+ if eval_ctx.autoescape:
820
+ rv = Markup(rv)
821
+
822
+ return rv
823
+
824
+
825
+ def do_indent(
826
+ s: str, width: t.Union[int, str] = 4, first: bool = False, blank: bool = False
827
+ ) -> str:
828
+ """Return a copy of the string with each line indented by 4 spaces. The
829
+ first line and blank lines are not indented by default.
830
+
831
+ :param width: Number of spaces, or a string, to indent by.
832
+ :param first: Don't skip indenting the first line.
833
+ :param blank: Don't skip indenting empty lines.
834
+
835
+ .. versionchanged:: 3.0
836
+ ``width`` can be a string.
837
+
838
+ .. versionchanged:: 2.10
839
+ Blank lines are not indented by default.
840
+
841
+ Rename the ``indentfirst`` argument to ``first``.
842
+ """
843
+ if isinstance(width, str):
844
+ indention = width
845
+ else:
846
+ indention = " " * width
847
+
848
+ newline = "\n"
849
+
850
+ if isinstance(s, Markup):
851
+ indention = Markup(indention)
852
+ newline = Markup(newline)
853
+
854
+ s += newline # this quirk is necessary for splitlines method
855
+
856
+ if blank:
857
+ rv = (newline + indention).join(s.splitlines())
858
+ else:
859
+ lines = s.splitlines()
860
+ rv = lines.pop(0)
861
+
862
+ if lines:
863
+ rv += newline + newline.join(
864
+ indention + line if line else line for line in lines
865
+ )
866
+
867
+ if first:
868
+ rv = indention + rv
869
+
870
+ return rv
871
+
872
+
873
+ @pass_environment
874
+ def do_truncate(
875
+ env: "Environment",
876
+ s: str,
877
+ length: int = 255,
878
+ killwords: bool = False,
879
+ end: str = "...",
880
+ leeway: t.Optional[int] = None,
881
+ ) -> str:
882
+ """Return a truncated copy of the string. The length is specified
883
+ with the first parameter which defaults to ``255``. If the second
884
+ parameter is ``true`` the filter will cut the text at length. Otherwise
885
+ it will discard the last word. If the text was in fact
886
+ truncated it will append an ellipsis sign (``"..."``). If you want a
887
+ different ellipsis sign than ``"..."`` you can specify it using the
888
+ third parameter. Strings that only exceed the length by the tolerance
889
+ margin given in the fourth parameter will not be truncated.
890
+
891
+ .. sourcecode:: jinja
892
+
893
+ {{ "foo bar baz qux"|truncate(9) }}
894
+ -> "foo..."
895
+ {{ "foo bar baz qux"|truncate(9, True) }}
896
+ -> "foo ba..."
897
+ {{ "foo bar baz qux"|truncate(11) }}
898
+ -> "foo bar baz qux"
899
+ {{ "foo bar baz qux"|truncate(11, False, '...', 0) }}
900
+ -> "foo bar..."
901
+
902
+ The default leeway on newer Jinja versions is 5 and was 0 before but
903
+ can be reconfigured globally.
904
+ """
905
+ if leeway is None:
906
+ leeway = env.policies["truncate.leeway"]
907
+
908
+ assert length >= len(end), f"expected length >= {len(end)}, got {length}"
909
+ assert leeway >= 0, f"expected leeway >= 0, got {leeway}"
910
+
911
+ if len(s) <= length + leeway:
912
+ return s
913
+
914
+ if killwords:
915
+ return s[: length - len(end)] + end
916
+
917
+ result = s[: length - len(end)].rsplit(" ", 1)[0]
918
+ return result + end
919
+
920
+
921
+ @pass_environment
922
+ def do_wordwrap(
923
+ environment: "Environment",
924
+ s: str,
925
+ width: int = 79,
926
+ break_long_words: bool = True,
927
+ wrapstring: t.Optional[str] = None,
928
+ break_on_hyphens: bool = True,
929
+ ) -> str:
930
+ """Wrap a string to the given width. Existing newlines are treated
931
+ as paragraphs to be wrapped separately.
932
+
933
+ :param s: Original text to wrap.
934
+ :param width: Maximum length of wrapped lines.
935
+ :param break_long_words: If a word is longer than ``width``, break
936
+ it across lines.
937
+ :param break_on_hyphens: If a word contains hyphens, it may be split
938
+ across lines.
939
+ :param wrapstring: String to join each wrapped line. Defaults to
940
+ :attr:`Environment.newline_sequence`.
941
+
942
+ .. versionchanged:: 2.11
943
+ Existing newlines are treated as paragraphs wrapped separately.
944
+
945
+ .. versionchanged:: 2.11
946
+ Added the ``break_on_hyphens`` parameter.
947
+
948
+ .. versionchanged:: 2.7
949
+ Added the ``wrapstring`` parameter.
950
+ """
951
+ import textwrap
952
+
953
+ if wrapstring is None:
954
+ wrapstring = environment.newline_sequence
955
+
956
+ # textwrap.wrap doesn't consider existing newlines when wrapping.
957
+ # If the string has a newline before width, wrap will still insert
958
+ # a newline at width, resulting in a short line. Instead, split and
959
+ # wrap each paragraph individually.
960
+ return wrapstring.join(
961
+ [
962
+ wrapstring.join(
963
+ textwrap.wrap(
964
+ line,
965
+ width=width,
966
+ expand_tabs=False,
967
+ replace_whitespace=False,
968
+ break_long_words=break_long_words,
969
+ break_on_hyphens=break_on_hyphens,
970
+ )
971
+ )
972
+ for line in s.splitlines()
973
+ ]
974
+ )
975
+
976
+
977
+ _word_re = re.compile(r"\w+")
978
+
979
+
980
+ def do_wordcount(s: str) -> int:
981
+ """Count the words in that string."""
982
+ return len(_word_re.findall(soft_str(s)))
983
+
984
+
985
+ def do_int(value: t.Any, default: int = 0, base: int = 10) -> int:
986
+ """Convert the value into an integer. If the
987
+ conversion doesn't work it will return ``0``. You can
988
+ override this default using the first parameter. You
989
+ can also override the default base (10) in the second
990
+ parameter, which handles input with prefixes such as
991
+ 0b, 0o and 0x for bases 2, 8 and 16 respectively.
992
+ The base is ignored for decimal numbers and non-string values.
993
+ """
994
+ try:
995
+ if isinstance(value, str):
996
+ return int(value, base)
997
+
998
+ return int(value)
999
+ except (TypeError, ValueError):
1000
+ # this quirk is necessary so that "42.23"|int gives 42.
1001
+ try:
1002
+ return int(float(value))
1003
+ except (TypeError, ValueError, OverflowError):
1004
+ return default
1005
+
1006
+
1007
+ def do_float(value: t.Any, default: float = 0.0) -> float:
1008
+ """Convert the value into a floating point number. If the
1009
+ conversion doesn't work it will return ``0.0``. You can
1010
+ override this default using the first parameter.
1011
+ """
1012
+ try:
1013
+ return float(value)
1014
+ except (TypeError, ValueError):
1015
+ return default
1016
+
1017
+
1018
+ def do_format(value: str, *args: t.Any, **kwargs: t.Any) -> str:
1019
+ """Apply the given values to a `printf-style`_ format string, like
1020
+ ``string % values``.
1021
+
1022
+ .. sourcecode:: jinja
1023
+
1024
+ {{ "%s, %s!"|format(greeting, name) }}
1025
+ Hello, World!
1026
+
1027
+ In most cases it should be more convenient and efficient to use the
1028
+ ``%`` operator or :meth:`str.format`.
1029
+
1030
+ .. code-block:: text
1031
+
1032
+ {{ "%s, %s!" % (greeting, name) }}
1033
+ {{ "{}, {}!".format(greeting, name) }}
1034
+
1035
+ .. _printf-style: https://docs.python.org/library/stdtypes.html
1036
+ #printf-style-string-formatting
1037
+ """
1038
+ if args and kwargs:
1039
+ raise FilterArgumentError(
1040
+ "can't handle positional and keyword arguments at the same time"
1041
+ )
1042
+
1043
+ return soft_str(value) % (kwargs or args)
1044
+
1045
+
1046
+ def do_trim(value: str, chars: t.Optional[str] = None) -> str:
1047
+ """Strip leading and trailing characters, by default whitespace."""
1048
+ return soft_str(value).strip(chars)
1049
+
1050
+
1051
+ def do_striptags(value: "t.Union[str, HasHTML]") -> str:
1052
+ """Strip SGML/XML tags and replace adjacent whitespace by one space."""
1053
+ if hasattr(value, "__html__"):
1054
+ value = t.cast("HasHTML", value).__html__()
1055
+
1056
+ return Markup(str(value)).striptags()
1057
+
1058
+
1059
+ def sync_do_slice(
1060
+ value: "t.Collection[V]", slices: int, fill_with: "t.Optional[V]" = None
1061
+ ) -> "t.Iterator[t.List[V]]":
1062
+ """Slice an iterator and return a list of lists containing
1063
+ those items. Useful if you want to create a div containing
1064
+ three ul tags that represent columns:
1065
+
1066
+ .. sourcecode:: html+jinja
1067
+
1068
+ <div class="columnwrapper">
1069
+ {%- for column in items|slice(3) %}
1070
+ <ul class="column-{{ loop.index }}">
1071
+ {%- for item in column %}
1072
+ <li>{{ item }}</li>
1073
+ {%- endfor %}
1074
+ </ul>
1075
+ {%- endfor %}
1076
+ </div>
1077
+
1078
+ If you pass it a second argument it's used to fill missing
1079
+ values on the last iteration.
1080
+ """
1081
+ seq = list(value)
1082
+ length = len(seq)
1083
+ items_per_slice = length // slices
1084
+ slices_with_extra = length % slices
1085
+ offset = 0
1086
+
1087
+ for slice_number in range(slices):
1088
+ start = offset + slice_number * items_per_slice
1089
+
1090
+ if slice_number < slices_with_extra:
1091
+ offset += 1
1092
+
1093
+ end = offset + (slice_number + 1) * items_per_slice
1094
+ tmp = seq[start:end]
1095
+
1096
+ if fill_with is not None and slice_number >= slices_with_extra:
1097
+ tmp.append(fill_with)
1098
+
1099
+ yield tmp
1100
+
1101
+
1102
+ @async_variant(sync_do_slice) # type: ignore
1103
+ async def do_slice(
1104
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1105
+ slices: int,
1106
+ fill_with: t.Optional[t.Any] = None,
1107
+ ) -> "t.Iterator[t.List[V]]":
1108
+ return sync_do_slice(await auto_to_list(value), slices, fill_with)
1109
+
1110
+
1111
+ def do_batch(
1112
+ value: "t.Iterable[V]", linecount: int, fill_with: "t.Optional[V]" = None
1113
+ ) -> "t.Iterator[t.List[V]]":
1114
+ """
1115
+ A filter that batches items. It works pretty much like `slice`
1116
+ just the other way round. It returns a list of lists with the
1117
+ given number of items. If you provide a second parameter this
1118
+ is used to fill up missing items. See this example:
1119
+
1120
+ .. sourcecode:: html+jinja
1121
+
1122
+ <table>
1123
+ {%- for row in items|batch(3, '&nbsp;') %}
1124
+ <tr>
1125
+ {%- for column in row %}
1126
+ <td>{{ column }}</td>
1127
+ {%- endfor %}
1128
+ </tr>
1129
+ {%- endfor %}
1130
+ </table>
1131
+ """
1132
+ tmp: t.List[V] = []
1133
+
1134
+ for item in value:
1135
+ if len(tmp) == linecount:
1136
+ yield tmp
1137
+ tmp = []
1138
+
1139
+ tmp.append(item)
1140
+
1141
+ if tmp:
1142
+ if fill_with is not None and len(tmp) < linecount:
1143
+ tmp += [fill_with] * (linecount - len(tmp))
1144
+
1145
+ yield tmp
1146
+
1147
+
1148
+ def do_round(
1149
+ value: float,
1150
+ precision: int = 0,
1151
+ method: 'te.Literal["common", "ceil", "floor"]' = "common",
1152
+ ) -> float:
1153
+ """Round the number to a given precision. The first
1154
+ parameter specifies the precision (default is ``0``), the
1155
+ second the rounding method:
1156
+
1157
+ - ``'common'`` rounds either up or down
1158
+ - ``'ceil'`` always rounds up
1159
+ - ``'floor'`` always rounds down
1160
+
1161
+ If you don't specify a method ``'common'`` is used.
1162
+
1163
+ .. sourcecode:: jinja
1164
+
1165
+ {{ 42.55|round }}
1166
+ -> 43.0
1167
+ {{ 42.55|round(1, 'floor') }}
1168
+ -> 42.5
1169
+
1170
+ Note that even if rounded to 0 precision, a float is returned. If
1171
+ you need a real integer, pipe it through `int`:
1172
+
1173
+ .. sourcecode:: jinja
1174
+
1175
+ {{ 42.55|round|int }}
1176
+ -> 43
1177
+ """
1178
+ if method not in {"common", "ceil", "floor"}:
1179
+ raise FilterArgumentError("method must be common, ceil or floor")
1180
+
1181
+ if method == "common":
1182
+ return round(value, precision)
1183
+
1184
+ func = getattr(math, method)
1185
+ return t.cast(float, func(value * (10**precision)) / (10**precision))
1186
+
1187
+
1188
+ class _GroupTuple(t.NamedTuple):
1189
+ grouper: t.Any
1190
+ list: t.List[t.Any]
1191
+
1192
+ # Use the regular tuple repr to hide this subclass if users print
1193
+ # out the value during debugging.
1194
+ def __repr__(self) -> str:
1195
+ return tuple.__repr__(self)
1196
+
1197
+ def __str__(self) -> str:
1198
+ return tuple.__str__(self)
1199
+
1200
+
1201
+ @pass_environment
1202
+ def sync_do_groupby(
1203
+ environment: "Environment",
1204
+ value: "t.Iterable[V]",
1205
+ attribute: t.Union[str, int],
1206
+ default: t.Optional[t.Any] = None,
1207
+ case_sensitive: bool = False,
1208
+ ) -> "t.List[_GroupTuple]":
1209
+ """Group a sequence of objects by an attribute using Python's
1210
+ :func:`itertools.groupby`. The attribute can use dot notation for
1211
+ nested access, like ``"address.city"``. Unlike Python's ``groupby``,
1212
+ the values are sorted first so only one group is returned for each
1213
+ unique value.
1214
+
1215
+ For example, a list of ``User`` objects with a ``city`` attribute
1216
+ can be rendered in groups. In this example, ``grouper`` refers to
1217
+ the ``city`` value of the group.
1218
+
1219
+ .. sourcecode:: html+jinja
1220
+
1221
+ <ul>{% for city, items in users|groupby("city") %}
1222
+ <li>{{ city }}
1223
+ <ul>{% for user in items %}
1224
+ <li>{{ user.name }}
1225
+ {% endfor %}</ul>
1226
+ </li>
1227
+ {% endfor %}</ul>
1228
+
1229
+ ``groupby`` yields namedtuples of ``(grouper, list)``, which
1230
+ can be used instead of the tuple unpacking above. ``grouper`` is the
1231
+ value of the attribute, and ``list`` is the items with that value.
1232
+
1233
+ .. sourcecode:: html+jinja
1234
+
1235
+ <ul>{% for group in users|groupby("city") %}
1236
+ <li>{{ group.grouper }}: {{ group.list|join(", ") }}
1237
+ {% endfor %}</ul>
1238
+
1239
+ You can specify a ``default`` value to use if an object in the list
1240
+ does not have the given attribute.
1241
+
1242
+ .. sourcecode:: jinja
1243
+
1244
+ <ul>{% for city, items in users|groupby("city", default="NY") %}
1245
+ <li>{{ city }}: {{ items|map(attribute="name")|join(", ") }}</li>
1246
+ {% endfor %}</ul>
1247
+
1248
+ Like the :func:`~jinja-filters.sort` filter, sorting and grouping is
1249
+ case-insensitive by default. The ``key`` for each group will have
1250
+ the case of the first item in that group of values. For example, if
1251
+ a list of users has cities ``["CA", "NY", "ca"]``, the "CA" group
1252
+ will have two values. This can be disabled by passing
1253
+ ``case_sensitive=True``.
1254
+
1255
+ .. versionchanged:: 3.1
1256
+ Added the ``case_sensitive`` parameter. Sorting and grouping is
1257
+ case-insensitive by default, matching other filters that do
1258
+ comparisons.
1259
+
1260
+ .. versionchanged:: 3.0
1261
+ Added the ``default`` parameter.
1262
+
1263
+ .. versionchanged:: 2.6
1264
+ The attribute supports dot notation for nested access.
1265
+ """
1266
+ expr = make_attrgetter(
1267
+ environment,
1268
+ attribute,
1269
+ postprocess=ignore_case if not case_sensitive else None,
1270
+ default=default,
1271
+ )
1272
+ out = [
1273
+ _GroupTuple(key, list(values))
1274
+ for key, values in groupby(sorted(value, key=expr), expr)
1275
+ ]
1276
+
1277
+ if not case_sensitive:
1278
+ # Return the real key from the first value instead of the lowercase key.
1279
+ output_expr = make_attrgetter(environment, attribute, default=default)
1280
+ out = [_GroupTuple(output_expr(values[0]), values) for _, values in out]
1281
+
1282
+ return out
1283
+
1284
+
1285
+ @async_variant(sync_do_groupby) # type: ignore
1286
+ async def do_groupby(
1287
+ environment: "Environment",
1288
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1289
+ attribute: t.Union[str, int],
1290
+ default: t.Optional[t.Any] = None,
1291
+ case_sensitive: bool = False,
1292
+ ) -> "t.List[_GroupTuple]":
1293
+ expr = make_attrgetter(
1294
+ environment,
1295
+ attribute,
1296
+ postprocess=ignore_case if not case_sensitive else None,
1297
+ default=default,
1298
+ )
1299
+ out = [
1300
+ _GroupTuple(key, await auto_to_list(values))
1301
+ for key, values in groupby(sorted(await auto_to_list(value), key=expr), expr)
1302
+ ]
1303
+
1304
+ if not case_sensitive:
1305
+ # Return the real key from the first value instead of the lowercase key.
1306
+ output_expr = make_attrgetter(environment, attribute, default=default)
1307
+ out = [_GroupTuple(output_expr(values[0]), values) for _, values in out]
1308
+
1309
+ return out
1310
+
1311
+
1312
+ @pass_environment
1313
+ def sync_do_sum(
1314
+ environment: "Environment",
1315
+ iterable: "t.Iterable[V]",
1316
+ attribute: t.Optional[t.Union[str, int]] = None,
1317
+ start: V = 0, # type: ignore
1318
+ ) -> V:
1319
+ """Returns the sum of a sequence of numbers plus the value of parameter
1320
+ 'start' (which defaults to 0). When the sequence is empty it returns
1321
+ start.
1322
+
1323
+ It is also possible to sum up only certain attributes:
1324
+
1325
+ .. sourcecode:: jinja
1326
+
1327
+ Total: {{ items|sum(attribute='price') }}
1328
+
1329
+ .. versionchanged:: 2.6
1330
+ The ``attribute`` parameter was added to allow summing up over
1331
+ attributes. Also the ``start`` parameter was moved on to the right.
1332
+ """
1333
+ if attribute is not None:
1334
+ iterable = map(make_attrgetter(environment, attribute), iterable)
1335
+
1336
+ return sum(iterable, start) # type: ignore[no-any-return, call-overload]
1337
+
1338
+
1339
+ @async_variant(sync_do_sum) # type: ignore
1340
+ async def do_sum(
1341
+ environment: "Environment",
1342
+ iterable: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1343
+ attribute: t.Optional[t.Union[str, int]] = None,
1344
+ start: V = 0, # type: ignore
1345
+ ) -> V:
1346
+ rv = start
1347
+
1348
+ if attribute is not None:
1349
+ func = make_attrgetter(environment, attribute)
1350
+ else:
1351
+
1352
+ def func(x: V) -> V:
1353
+ return x
1354
+
1355
+ async for item in auto_aiter(iterable):
1356
+ rv += func(item)
1357
+
1358
+ return rv
1359
+
1360
+
1361
+ def sync_do_list(value: "t.Iterable[V]") -> "t.List[V]":
1362
+ """Convert the value into a list. If it was a string the returned list
1363
+ will be a list of characters.
1364
+ """
1365
+ return list(value)
1366
+
1367
+
1368
+ @async_variant(sync_do_list) # type: ignore
1369
+ async def do_list(value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]") -> "t.List[V]":
1370
+ return await auto_to_list(value)
1371
+
1372
+
1373
+ def do_mark_safe(value: str) -> Markup:
1374
+ """Mark the value as safe which means that in an environment with automatic
1375
+ escaping enabled this variable will not be escaped.
1376
+ """
1377
+ return Markup(value)
1378
+
1379
+
1380
+ def do_mark_unsafe(value: str) -> str:
1381
+ """Mark a value as unsafe. This is the reverse operation for :func:`safe`."""
1382
+ return str(value)
1383
+
1384
+
1385
+ @typing.overload
1386
+ def do_reverse(value: str) -> str: ...
1387
+
1388
+
1389
+ @typing.overload
1390
+ def do_reverse(value: "t.Iterable[V]") -> "t.Iterable[V]": ...
1391
+
1392
+
1393
+ def do_reverse(value: t.Union[str, t.Iterable[V]]) -> t.Union[str, t.Iterable[V]]:
1394
+ """Reverse the object or return an iterator that iterates over it the other
1395
+ way round.
1396
+ """
1397
+ if isinstance(value, str):
1398
+ return value[::-1]
1399
+
1400
+ try:
1401
+ return reversed(value) # type: ignore
1402
+ except TypeError:
1403
+ try:
1404
+ rv = list(value)
1405
+ rv.reverse()
1406
+ return rv
1407
+ except TypeError as e:
1408
+ raise FilterArgumentError("argument must be iterable") from e
1409
+
1410
+
1411
+ @pass_environment
1412
+ def do_attr(
1413
+ environment: "Environment", obj: t.Any, name: str
1414
+ ) -> t.Union[Undefined, t.Any]:
1415
+ """Get an attribute of an object. ``foo|attr("bar")`` works like
1416
+ ``foo.bar``, but returns undefined instead of falling back to ``foo["bar"]``
1417
+ if the attribute doesn't exist.
1418
+
1419
+ See :ref:`Notes on subscriptions <notes-on-subscriptions>` for more details.
1420
+ """
1421
+ # Environment.getattr will fall back to obj[name] if obj.name doesn't exist.
1422
+ # But we want to call env.getattr to get behavior such as sandboxing.
1423
+ # Determine if the attr exists first, so we know the fallback won't trigger.
1424
+ try:
1425
+ # This avoids executing properties/descriptors, but misses __getattr__
1426
+ # and __getattribute__ dynamic attrs.
1427
+ getattr_static(obj, name)
1428
+ except AttributeError:
1429
+ # This finds dynamic attrs, and we know it's not a descriptor at this point.
1430
+ if not hasattr(obj, name):
1431
+ return environment.undefined(obj=obj, name=name)
1432
+
1433
+ return environment.getattr(obj, name)
1434
+
1435
+
1436
+ @typing.overload
1437
+ def sync_do_map(
1438
+ context: "Context",
1439
+ value: t.Iterable[t.Any],
1440
+ name: str,
1441
+ *args: t.Any,
1442
+ **kwargs: t.Any,
1443
+ ) -> t.Iterable[t.Any]: ...
1444
+
1445
+
1446
+ @typing.overload
1447
+ def sync_do_map(
1448
+ context: "Context",
1449
+ value: t.Iterable[t.Any],
1450
+ *,
1451
+ attribute: str = ...,
1452
+ default: t.Optional[t.Any] = None,
1453
+ ) -> t.Iterable[t.Any]: ...
1454
+
1455
+
1456
+ @pass_context
1457
+ def sync_do_map(
1458
+ context: "Context", value: t.Iterable[t.Any], *args: t.Any, **kwargs: t.Any
1459
+ ) -> t.Iterable[t.Any]:
1460
+ """Applies a filter on a sequence of objects or looks up an attribute.
1461
+ This is useful when dealing with lists of objects but you are really
1462
+ only interested in a certain value of it.
1463
+
1464
+ The basic usage is mapping on an attribute. Imagine you have a list
1465
+ of users but you are only interested in a list of usernames:
1466
+
1467
+ .. sourcecode:: jinja
1468
+
1469
+ Users on this page: {{ users|map(attribute='username')|join(', ') }}
1470
+
1471
+ You can specify a ``default`` value to use if an object in the list
1472
+ does not have the given attribute.
1473
+
1474
+ .. sourcecode:: jinja
1475
+
1476
+ {{ users|map(attribute="username", default="Anonymous")|join(", ") }}
1477
+
1478
+ Alternatively you can let it invoke a filter by passing the name of the
1479
+ filter and the arguments afterwards. A good example would be applying a
1480
+ text conversion filter on a sequence:
1481
+
1482
+ .. sourcecode:: jinja
1483
+
1484
+ Users on this page: {{ titles|map('lower')|join(', ') }}
1485
+
1486
+ Similar to a generator comprehension such as:
1487
+
1488
+ .. code-block:: python
1489
+
1490
+ (u.username for u in users)
1491
+ (getattr(u, "username", "Anonymous") for u in users)
1492
+ (do_lower(x) for x in titles)
1493
+
1494
+ .. versionchanged:: 2.11.0
1495
+ Added the ``default`` parameter.
1496
+
1497
+ .. versionadded:: 2.7
1498
+ """
1499
+ if value:
1500
+ func = prepare_map(context, args, kwargs)
1501
+
1502
+ for item in value:
1503
+ yield func(item)
1504
+
1505
+
1506
+ @typing.overload
1507
+ def do_map(
1508
+ context: "Context",
1509
+ value: t.Union[t.AsyncIterable[t.Any], t.Iterable[t.Any]],
1510
+ name: str,
1511
+ *args: t.Any,
1512
+ **kwargs: t.Any,
1513
+ ) -> t.Iterable[t.Any]: ...
1514
+
1515
+
1516
+ @typing.overload
1517
+ def do_map(
1518
+ context: "Context",
1519
+ value: t.Union[t.AsyncIterable[t.Any], t.Iterable[t.Any]],
1520
+ *,
1521
+ attribute: str = ...,
1522
+ default: t.Optional[t.Any] = None,
1523
+ ) -> t.Iterable[t.Any]: ...
1524
+
1525
+
1526
+ @async_variant(sync_do_map) # type: ignore
1527
+ async def do_map(
1528
+ context: "Context",
1529
+ value: t.Union[t.AsyncIterable[t.Any], t.Iterable[t.Any]],
1530
+ *args: t.Any,
1531
+ **kwargs: t.Any,
1532
+ ) -> t.AsyncIterable[t.Any]:
1533
+ if value:
1534
+ func = prepare_map(context, args, kwargs)
1535
+
1536
+ async for item in auto_aiter(value):
1537
+ yield await auto_await(func(item))
1538
+
1539
+
1540
+ @pass_context
1541
+ def sync_do_select(
1542
+ context: "Context", value: "t.Iterable[V]", *args: t.Any, **kwargs: t.Any
1543
+ ) -> "t.Iterator[V]":
1544
+ """Filters a sequence of objects by applying a test to each object,
1545
+ and only selecting the objects with the test succeeding.
1546
+
1547
+ If no test is specified, each object will be evaluated as a boolean.
1548
+
1549
+ Example usage:
1550
+
1551
+ .. sourcecode:: jinja
1552
+
1553
+ {{ numbers|select("odd") }}
1554
+ {{ numbers|select("odd") }}
1555
+ {{ numbers|select("divisibleby", 3) }}
1556
+ {{ numbers|select("lessthan", 42) }}
1557
+ {{ strings|select("equalto", "mystring") }}
1558
+
1559
+ Similar to a generator comprehension such as:
1560
+
1561
+ .. code-block:: python
1562
+
1563
+ (n for n in numbers if test_odd(n))
1564
+ (n for n in numbers if test_divisibleby(n, 3))
1565
+
1566
+ .. versionadded:: 2.7
1567
+ """
1568
+ return select_or_reject(context, value, args, kwargs, lambda x: x, False)
1569
+
1570
+
1571
+ @async_variant(sync_do_select) # type: ignore
1572
+ async def do_select(
1573
+ context: "Context",
1574
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1575
+ *args: t.Any,
1576
+ **kwargs: t.Any,
1577
+ ) -> "t.AsyncIterator[V]":
1578
+ return async_select_or_reject(context, value, args, kwargs, lambda x: x, False)
1579
+
1580
+
1581
+ @pass_context
1582
+ def sync_do_reject(
1583
+ context: "Context", value: "t.Iterable[V]", *args: t.Any, **kwargs: t.Any
1584
+ ) -> "t.Iterator[V]":
1585
+ """Filters a sequence of objects by applying a test to each object,
1586
+ and rejecting the objects with the test succeeding.
1587
+
1588
+ If no test is specified, each object will be evaluated as a boolean.
1589
+
1590
+ Example usage:
1591
+
1592
+ .. sourcecode:: jinja
1593
+
1594
+ {{ numbers|reject("odd") }}
1595
+
1596
+ Similar to a generator comprehension such as:
1597
+
1598
+ .. code-block:: python
1599
+
1600
+ (n for n in numbers if not test_odd(n))
1601
+
1602
+ .. versionadded:: 2.7
1603
+ """
1604
+ return select_or_reject(context, value, args, kwargs, lambda x: not x, False)
1605
+
1606
+
1607
+ @async_variant(sync_do_reject) # type: ignore
1608
+ async def do_reject(
1609
+ context: "Context",
1610
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1611
+ *args: t.Any,
1612
+ **kwargs: t.Any,
1613
+ ) -> "t.AsyncIterator[V]":
1614
+ return async_select_or_reject(context, value, args, kwargs, lambda x: not x, False)
1615
+
1616
+
1617
+ @pass_context
1618
+ def sync_do_selectattr(
1619
+ context: "Context", value: "t.Iterable[V]", *args: t.Any, **kwargs: t.Any
1620
+ ) -> "t.Iterator[V]":
1621
+ """Filters a sequence of objects by applying a test to the specified
1622
+ attribute of each object, and only selecting the objects with the
1623
+ test succeeding.
1624
+
1625
+ If no test is specified, the attribute's value will be evaluated as
1626
+ a boolean.
1627
+
1628
+ Example usage:
1629
+
1630
+ .. sourcecode:: jinja
1631
+
1632
+ {{ users|selectattr("is_active") }}
1633
+ {{ users|selectattr("email", "none") }}
1634
+
1635
+ Similar to a generator comprehension such as:
1636
+
1637
+ .. code-block:: python
1638
+
1639
+ (user for user in users if user.is_active)
1640
+ (user for user in users if test_none(user.email))
1641
+
1642
+ .. versionadded:: 2.7
1643
+ """
1644
+ return select_or_reject(context, value, args, kwargs, lambda x: x, True)
1645
+
1646
+
1647
+ @async_variant(sync_do_selectattr) # type: ignore
1648
+ async def do_selectattr(
1649
+ context: "Context",
1650
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1651
+ *args: t.Any,
1652
+ **kwargs: t.Any,
1653
+ ) -> "t.AsyncIterator[V]":
1654
+ return async_select_or_reject(context, value, args, kwargs, lambda x: x, True)
1655
+
1656
+
1657
+ @pass_context
1658
+ def sync_do_rejectattr(
1659
+ context: "Context", value: "t.Iterable[V]", *args: t.Any, **kwargs: t.Any
1660
+ ) -> "t.Iterator[V]":
1661
+ """Filters a sequence of objects by applying a test to the specified
1662
+ attribute of each object, and rejecting the objects with the test
1663
+ succeeding.
1664
+
1665
+ If no test is specified, the attribute's value will be evaluated as
1666
+ a boolean.
1667
+
1668
+ .. sourcecode:: jinja
1669
+
1670
+ {{ users|rejectattr("is_active") }}
1671
+ {{ users|rejectattr("email", "none") }}
1672
+
1673
+ Similar to a generator comprehension such as:
1674
+
1675
+ .. code-block:: python
1676
+
1677
+ (user for user in users if not user.is_active)
1678
+ (user for user in users if not test_none(user.email))
1679
+
1680
+ .. versionadded:: 2.7
1681
+ """
1682
+ return select_or_reject(context, value, args, kwargs, lambda x: not x, True)
1683
+
1684
+
1685
+ @async_variant(sync_do_rejectattr) # type: ignore
1686
+ async def do_rejectattr(
1687
+ context: "Context",
1688
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1689
+ *args: t.Any,
1690
+ **kwargs: t.Any,
1691
+ ) -> "t.AsyncIterator[V]":
1692
+ return async_select_or_reject(context, value, args, kwargs, lambda x: not x, True)
1693
+
1694
+
1695
+ @pass_eval_context
1696
+ def do_tojson(
1697
+ eval_ctx: "EvalContext", value: t.Any, indent: t.Optional[int] = None
1698
+ ) -> Markup:
1699
+ """Serialize an object to a string of JSON, and mark it safe to
1700
+ render in HTML. This filter is only for use in HTML documents.
1701
+
1702
+ The returned string is safe to render in HTML documents and
1703
+ ``<script>`` tags. The exception is in HTML attributes that are
1704
+ double quoted; either use single quotes or the ``|forceescape``
1705
+ filter.
1706
+
1707
+ :param value: The object to serialize to JSON.
1708
+ :param indent: The ``indent`` parameter passed to ``dumps``, for
1709
+ pretty-printing the value.
1710
+
1711
+ .. versionadded:: 2.9
1712
+ """
1713
+ policies = eval_ctx.environment.policies
1714
+ dumps = policies["json.dumps_function"]
1715
+ kwargs = policies["json.dumps_kwargs"]
1716
+
1717
+ if indent is not None:
1718
+ kwargs = kwargs.copy()
1719
+ kwargs["indent"] = indent
1720
+
1721
+ return htmlsafe_json_dumps(value, dumps=dumps, **kwargs)
1722
+
1723
+
1724
+ def prepare_map(
1725
+ context: "Context", args: t.Tuple[t.Any, ...], kwargs: t.Dict[str, t.Any]
1726
+ ) -> t.Callable[[t.Any], t.Any]:
1727
+ if not args and "attribute" in kwargs:
1728
+ attribute = kwargs.pop("attribute")
1729
+ default = kwargs.pop("default", None)
1730
+
1731
+ if kwargs:
1732
+ raise FilterArgumentError(
1733
+ f"Unexpected keyword argument {next(iter(kwargs))!r}"
1734
+ )
1735
+
1736
+ func = make_attrgetter(context.environment, attribute, default=default)
1737
+ else:
1738
+ try:
1739
+ name = args[0]
1740
+ args = args[1:]
1741
+ except LookupError:
1742
+ raise FilterArgumentError("map requires a filter argument") from None
1743
+
1744
+ def func(item: t.Any) -> t.Any:
1745
+ return context.environment.call_filter(
1746
+ name, item, args, kwargs, context=context
1747
+ )
1748
+
1749
+ return func
1750
+
1751
+
1752
+ def prepare_select_or_reject(
1753
+ context: "Context",
1754
+ args: t.Tuple[t.Any, ...],
1755
+ kwargs: t.Dict[str, t.Any],
1756
+ modfunc: t.Callable[[t.Any], t.Any],
1757
+ lookup_attr: bool,
1758
+ ) -> t.Callable[[t.Any], t.Any]:
1759
+ if lookup_attr:
1760
+ try:
1761
+ attr = args[0]
1762
+ except LookupError:
1763
+ raise FilterArgumentError("Missing parameter for attribute name") from None
1764
+
1765
+ transfunc = make_attrgetter(context.environment, attr)
1766
+ off = 1
1767
+ else:
1768
+ off = 0
1769
+
1770
+ def transfunc(x: V) -> V:
1771
+ return x
1772
+
1773
+ try:
1774
+ name = args[off]
1775
+ args = args[1 + off :]
1776
+
1777
+ def func(item: t.Any) -> t.Any:
1778
+ return context.environment.call_test(name, item, args, kwargs, context)
1779
+
1780
+ except LookupError:
1781
+ func = bool # type: ignore
1782
+
1783
+ return lambda item: modfunc(func(transfunc(item)))
1784
+
1785
+
1786
+ def select_or_reject(
1787
+ context: "Context",
1788
+ value: "t.Iterable[V]",
1789
+ args: t.Tuple[t.Any, ...],
1790
+ kwargs: t.Dict[str, t.Any],
1791
+ modfunc: t.Callable[[t.Any], t.Any],
1792
+ lookup_attr: bool,
1793
+ ) -> "t.Iterator[V]":
1794
+ if value:
1795
+ func = prepare_select_or_reject(context, args, kwargs, modfunc, lookup_attr)
1796
+
1797
+ for item in value:
1798
+ if func(item):
1799
+ yield item
1800
+
1801
+
1802
+ async def async_select_or_reject(
1803
+ context: "Context",
1804
+ value: "t.Union[t.AsyncIterable[V], t.Iterable[V]]",
1805
+ args: t.Tuple[t.Any, ...],
1806
+ kwargs: t.Dict[str, t.Any],
1807
+ modfunc: t.Callable[[t.Any], t.Any],
1808
+ lookup_attr: bool,
1809
+ ) -> "t.AsyncIterator[V]":
1810
+ if value:
1811
+ func = prepare_select_or_reject(context, args, kwargs, modfunc, lookup_attr)
1812
+
1813
+ async for item in auto_aiter(value):
1814
+ if func(item):
1815
+ yield item
1816
+
1817
+
1818
+ FILTERS = {
1819
+ "abs": abs,
1820
+ "attr": do_attr,
1821
+ "batch": do_batch,
1822
+ "capitalize": do_capitalize,
1823
+ "center": do_center,
1824
+ "count": len,
1825
+ "d": do_default,
1826
+ "default": do_default,
1827
+ "dictsort": do_dictsort,
1828
+ "e": escape,
1829
+ "escape": escape,
1830
+ "filesizeformat": do_filesizeformat,
1831
+ "first": do_first,
1832
+ "float": do_float,
1833
+ "forceescape": do_forceescape,
1834
+ "format": do_format,
1835
+ "groupby": do_groupby,
1836
+ "indent": do_indent,
1837
+ "int": do_int,
1838
+ "join": do_join,
1839
+ "last": do_last,
1840
+ "length": len,
1841
+ "list": do_list,
1842
+ "lower": do_lower,
1843
+ "items": do_items,
1844
+ "map": do_map,
1845
+ "min": do_min,
1846
+ "max": do_max,
1847
+ "pprint": do_pprint,
1848
+ "random": do_random,
1849
+ "reject": do_reject,
1850
+ "rejectattr": do_rejectattr,
1851
+ "replace": do_replace,
1852
+ "reverse": do_reverse,
1853
+ "round": do_round,
1854
+ "safe": do_mark_safe,
1855
+ "select": do_select,
1856
+ "selectattr": do_selectattr,
1857
+ "slice": do_slice,
1858
+ "sort": do_sort,
1859
+ "string": soft_str,
1860
+ "striptags": do_striptags,
1861
+ "sum": do_sum,
1862
+ "title": do_title,
1863
+ "trim": do_trim,
1864
+ "truncate": do_truncate,
1865
+ "unique": do_unique,
1866
+ "upper": do_upper,
1867
+ "urlencode": do_urlencode,
1868
+ "urlize": do_urlize,
1869
+ "wordcount": do_wordcount,
1870
+ "wordwrap": do_wordwrap,
1871
+ "xmlattr": do_xmlattr,
1872
+ "tojson": do_tojson,
1873
+ }