自定义过滤器

自定义过滤器只是常规的 Python 函数，过滤器左边作为第一个参数，其余的参数作为额外的参数或关键字参数传递到过滤器。

例如在过滤器 {{42|myfilter(23)}} 中，函数被以 myfilter(42,23) 调用。这里给出一个简单的过滤器示例，可以应用到 datetime 对象来格式化它们:

  1. def datetimeformat(value, format='%H:%M / %d-%m-%Y'):
  2.     return value.strftime(format)

你可以更新环境上的 filters 字典来把它注册到模板环境上:

  1. environment.filters['datetimeformat'] = datetimeformat

在模板中使用如下:

  1. written on: {{ article.pub_date|datetimeformat }}
  2. publication date: {{ article.pub_date|datetimeformat('%d-%m-%Y') }}

也可以传给过滤器当前模板上下文或环境。当过滤器要返回一个未定义值或检查当前的autoescape 设置时很有用。为此，有三个装饰器：environmentfilter() 、 contextfilter() 和evalcontextfilter() 。

这里是一个小例子，过滤器把一个文本在 HTML 中换行或分段，并标记返回值为安全的 HTML 字符串，因为自动转义是启用的:

  1. import re
  2. from jinja2 import evalcontextfilter, Markup, escape
  4. _paragraph_re = re.compile(r'(?:\r\n|\r|\n){2,}')
  6. @evalcontextfilter
  7. def nl2br(eval_ctx, value):
  8.     result = u'\n\n'.join(u'<p>%s</p>' % p.replace('\n', '<br>\n')
  9.                           for p in _paragraph_re.split(escape(value)))
  10.     if eval_ctx.autoescape:
  11.         result = Markup(result)
  12.     return result

上下文过滤器工作方式相同，只是第一个参数是当前活动的 Context 而不是环境。