自定義過濾器只是常規的 Python 函數,過濾器左邊作為第一個參數,其余的參數作 為額外的參數或關鍵字參數傳遞到過濾器。
例如在過濾器?{{?42|myfilter(23)?}}?中,函數被以?myfilter(42,?23)?調 用。這里給出一個簡單的過濾器示例,可以應用到 datetime 對象來格式化它們:
~~~
def datetimeformat(value, format='%H:%M / %d-%m-%Y'):
return value.strftime(format)
~~~
你可以更新環境上的?[filters](http://docs.jinkan.org/docs/jinja2/api.html#jinja2.Environment.filters "jinja2.Environment.filters")?字典來把它注冊到模板環境上:
~~~
environment.filters['datetimeformat'] = datetimeformat
~~~
在模板中使用如下:
~~~
written on: {{ article.pub_date|datetimeformat }}
publication date: {{ article.pub_date|datetimeformat('%d-%m-%Y') }}
~~~
也可以傳給過濾器當前模板上下文或環境。當過濾器要返回一個未定義值或檢查當前的autoescape?設置時很有用。為此,有三個裝飾器:?[environmentfilter()](http://docs.jinkan.org/docs/jinja2/api.html#jinja2.environmentfilter "jinja2.environmentfilter")?、?[contextfilter()](http://docs.jinkan.org/docs/jinja2/api.html#jinja2.contextfilter "jinja2.contextfilter")和?[evalcontextfilter()](http://docs.jinkan.org/docs/jinja2/api.html#jinja2.evalcontextfilter "jinja2.evalcontextfilter")?。
這里是一個小例子,過濾器把一個文本在 HTML 中換行或分段,并標記返回值為安全 的 HTML 字符串,因為自動轉義是啟用的:
~~~
import re
from jinja2 import evalcontextfilter, Markup, escape
_paragraph_re = re.compile(r'(?:\r\n|\r|\n){2,}')
@evalcontextfilter
def nl2br(eval_ctx, value):
result = u'\n\n'.join(u'<p>%s</p>' % p.replace('\n', '<br>\n')
for p in _paragraph_re.split(escape(value)))
if eval_ctx.autoescape:
result = Markup(result)
return result
~~~
上下文過濾器工作方式相同,只是第一個參數是當前活動的?Context?而 不是環境。
- 介紹
- 預備知識
- 安裝
- 基本 API 使用
- 實驗性的 Python 3 支持
- API
- 基礎
- Unicode
- 高層 API
- 自動轉義
- 標識符的說明
- 未定義類型
- 上下文
- 加載器
- 字節碼緩存
- 實用工具
- 異常
- 自定義過濾器
- 求值上下文
- 自定義測試
- 全局命名空間
- 低層 API
- 元 API
- 沙箱
- API
- 運算符攔截
- 模板設計者文檔
- 概要
- 變量
- 過濾器
- 測試
- 注釋
- 空白控制
- 轉義
- 行語句
- 模板繼承
- HTML 轉義
- 控制結構清單
- 導入上下文行為
- 表達式
- 內置過濾器清單
- 內置測試清單
- 全局函數清單
- 擴展
- 自動轉義擴展
- 擴展
- 添加擴展
- i18n 擴展
- 表達式語句
- 循環控制
- With 語句
- 自動轉義擴展
- 編寫擴展
- 集成
- Babel 集成
- Pylons
- TextMate
- Vim
- 從其它的模板引擎切換
- Jinja1
- Django
- Mako
- 提示和技巧
- Null-Master 退回
- 交替的行
- 高亮活動菜單項
- 訪問父級循環