Пользовательские фильтры для шаблонов jinja2
представляют собой обычные функции Python, которые принимают левую часть фильтра в качестве первого аргумента, а аргументы, передаваемые в сам фильтр служат дополнительными позиционными или ключевыми аргументами.
Например, в выражении шаблона {{ 42| myfilter(23) }}
функция фильтра будет вызываться как myfilter(42, 23)
. Смотрим пример простого фильтра, который можно применить к объектам datetime
для их форматирования:
def datetimeformat(value, format='%H:%M / %d-%m-%Y'): return value.strftime(format)
Созданный фильтр можно зарегистрировать в среде шаблонов Environment
, обновив Environment.filters
:
environment.filters['datetimeformat'] = datetimeformat
Затем внутри шаблона его можно использовать следующим образом:
Дата создания: {{ article.pub_date|datetimeformat }} Дата публикации: {{ article.pub_date|datetimeformat('%d-%m-%Y') }}
Фильтры также могут передавать текущий контекст шаблона или среду. Это полезно, если фильтр хочет вернуть неопределенное значение или проверить текущую настройку автоэкранирования. Для этого существует три декоратора: environmentfilter()
, contextfilter()
и evalcontextfilter()
.
Вот небольшой пример фильтра, который разбивает текст на разрывы строк и абзацы HTML и помечает возвращаемое значение как безопасную строку HTML, если включено автоэкранирование:
import re from jinja2 import evalcontextfilter, Markup, escape _paragraph_re = re.compile(r'(?:\r\n|\r(?!\n)|\n){2,}') @evalcontextfilter def nl2br(eval_ctx, value): result = u'\n\n'.join(u'<p>%s</p>' % p.replace('\n', Markup('<br>\n')) for p in _paragraph_re.split(escape(value))) if eval_ctx.autoescape: result = Markup(result) return result
Контекстные фильтры работают так же, только первый аргумент - это текущий активный контекст, а не среда.