模板
Flask 使用 Jinja2 作为默认模板引擎。你完全可以使用其它模板引擎。但是不管你使用哪种模板引擎,都必须安装 Jinja2 。因为使用 Jinja2 可以让 Flask 使用更多依赖于这个模板引擎的扩展。
本文只是简单介绍如何在 Flask 中使用 Jinja2 。如果要详细了解这个模板引擎的语法,请查阅 Jinja2 模板官方文档 (opens new window) 。
# 1.6.1 Jinja设置
在 Flask 中,Jinja2 默认配置如下:
- 当使用
render_template()时,扩展名为.html、.htm、.xml和.xhtml的模板中开启自动转义。 - 当使用
render_template_string()时,字符串开启自动转义。 - 在模板中可以使用
{% autoescape %}来手动设置是否转义。 Flask在Jinja2环境中加入一些全局函数和辅助对象,以增强模板的功能。
# 1.6.2 标准环境
缺省情况下,以下全局变量可以在 Jinja2 模板中使用:
- config 当前配置对象(flask.Flask.config ) Changed in version 0.10: 这个变量总是可用,甚至是在被导入的模板中。 New in version 0.6.
- request 当前请求对象(flask.request )。在没有活动请求环境情况下渲染模板时,这个变量不可用。
- session 当前会话对象(flask.session )。在没有活动请求环境情况下渲染模板时,这个变量不可用。
- g 请求绑定的全局变量(flask.g )。在没有活动请求环境情况下渲染模板时,这个变量不可用。
- url_for() flask.url_for() 函数。
- get_flashed_messages() flask.get_flashed_messages() 函数。
Jinja 环境行为
这些添加到环境中的变量不是全局变量。与真正的全局变量不同的是这些变量在已导入的模板的环境中是不 可见的。这样做是基于性能的原因,同时也考虑让代码更有条理。
那么意义何在?假设你需要导入一个宏,这个宏需要访问请求对象,那么你有两个选择:
- 显式地把请求或都该请求有用的属性作为参数传递给宏。
- 导入
“with context ”宏。 导入方式如下:
{% from '_helpers.html' import my_macro with context %}
# 1.6.3 控制自动转义
自动转义是指自动对特殊字符进行转义。特殊字符是指 HTML(或 XML 和 XHTML )中的 & 、> 、< 、" 和 ' 。因为这些特殊字符代表了特殊的意思,所以如果要在文本中使用它们就必须把它们替换为“实体”。如果 不转义,那么用户就无法使用这些字符,而且还会带来安全问题。(参见跨站脚本攻击(XSS ) )
有时候,如需要直接把 HTML 植入页面的时候,可能会需要在模板中关闭自动转义功能。这个可以直接植入 的 HTML 一般来自安全的来源,例如一个把标记语言转换为 HTML 的转换器。
有三种方法可以控制自动转义:
- 在
Python代码中,可以在把HTML字符串传递给模板之前,用Markup对象封装。一般情况下推荐使 用这个方法。 - 在模板中,使用
|safe过滤器显式把一个字符串标记为安全的HTML(例如:)。 - 临时关闭整个系统的自动转义。
在模板中关闭自动转义系统可以使用 {% autoescape %} 块:
{% autoescape false %}
<p>autoescaping is disabled here
<p>{{ will_not_be_escaped }}
{% endautoescape %}
2
3
4
在这样做的时候,要非常小心块中的变量的安全性。
# 1.6.4 注册过滤器
有两种方法可以在 Jinja2 中注册你自己的过滤器。要么手动把它们放入应用的jinja_env 中,要么使 用template_filter() 装饰器。
下面两个例子功能相同,都是倒序一个对象:
@app.template_filter('reverse')
def reverse_filter(s):
return s[::-1]
def reverse_filter(s):
return s[::-1]
app.jinja_env.filters['reverse'] = reverse_filter
2
3
4
5
6
7
装饰器的参数是可选的,如果不给出就使用函数名作为过滤器名。一旦注册完成后,你就可以在模板中像 Jinja2 的内建过滤器一样使用过滤器了。例如,假设在环境中你有一个名为 mylist 的 Pyhton 列表:
{% for x in mylist | reverse %}
{% endfor %}
2
# 1.6.5 环境处理器
环境处理器的作用是把新的变量自动引入模板环境中。环境处理器在模板被渲染前运行,因此可以把新的变 量自动引入模板环境中。它是一个函数,返回值是一个字典。在应用的所有模板中,这个字典将与模板环境 合并:
@app.context_processor
def inject_user():
return dict(user=g.user)
2
3
上例中的环境处理器创建了一个值为 g.user 的 user 变量,并把这个变量加入了模板环境中。这个例子只是用 于说明工作原理,不是非常有用,因为在模板中,g 总是存在的。
传递值不仅仅局限于变量,还可以传递函数(Python 提供传递函数的功能):
@app.context_processor
def utility_processor():
def format_price(amount, currency="€"):
return f"{amount:.2f}{currency}"
return dict(format_price=format_price)
2
3
4
5
上例中的环境处理器把 format_price 函数传递给了所有模板:
{{ format_price(0.33) }}
你还可以把 format_price 创建为一个模板过滤器(参见注册过滤器 ),这里只是演示如何在一个环境处理器中 传递函数。