Flask、Django Web框架都使用模板语言引擎进行web页面的渲染,Flask使用Jinja2作为其模板引擎,Jinja2是一个快速、表达力强、可扩展的模板引擎,它使用了类似于Python语法的特殊占位符,可以将模板和数据结合起来渲染出最终的文档。Jinja2是基于Python的,可以安装在任何支持Python的平台上。Jinja2还提供了一个可选的沙箱模板执行环境,可以保证模板的安全性。
Jinja2的使用不必依附于Web框架,它完全可以独立使用,相信很多人都有写各种报告文档的经历,如果某类型的文档要反复地写的话,可以考虑使用Jinja2来自动生成报告,事先准备好漂亮的模板文件,每次只要更新数据就可以自动生成漂亮的报告文档了。由于本文重点介绍Jinja2的基本使用方法,仅使用最简单的html模板进行说明,读者完全可以自己设计或下载满意的html页面作为模板使用。
Jinja2的基本用法是这样的:
- 首先,需要导入jinja2模块,并创建一个Environment对象,这个对象可以配置模板的加载方式、过滤器、变量等。
- 然后,需要加载一个模板文件,这个文件可以是一个本地的文件,也可以是一个字符串,或者是一个从其他地方获取的对象。
- 最后,需要调用模板的render方法,传入一些数据,这些数据可以是字典、列表、对象等,模板会根据这些数据生成最终的文档。
下面是一个简单的例子,演示了如何使用jinja2渲染一个HTML页面:
# 导入jinja2模块
import jinja2
# 创建一个Environment对象,指定模板的加载方式为文件系统
env = jinja2.Environment(loader=jinja2.FileSystemLoader('./templates'))
# 加载一个模板文件,这个文件的内容是一个HTML页面,其中有一些占位符
template = env.get_template('template.html')
# 定义一些数据,这些数据会替换模板中的占位符
data = {
'title': 'Hello Jinja2',
'name': 'Jinja2',
'items': ['Python', 'Jinja2', 'Flask']
}
# 调用模板的render方法,传入数据,得到最终的文档
document = template.render(data)
# 打印或保存文档
print(document)
with open("report.html", 'w', encoding='utf-8') as f:
f.write(document)
这个模板文件template.html的内容是这样的:
{{ title }}
Hello {{ name }}!
{% for item in items %}
{% if item == "Jinja2" %}
- {{loop.index}} {{ item }}
{% else %}
- {{loop.index}} {{ item|upper }}
{% endif %}
{% endfor %}
这个模板文件中,使用了两种占位符:
- {{ … }} 表示一个变量,它会被传入的数据中对应的值替换,变量可以使用upper这样的过滤器进行修改,以|分割,前一个作为后一个的输入。
- {% … %} 表示一个控制结构,它可以实现一些逻辑,比如循环、判断、继承等。
渲染后的文档是这样的:
Hello Jinja2
Hello Jinja2!
- 1 PYTHON
- 2 Jinja2
- 3 FLASK
可以看到,模板中的占位符被数据中的值替换了,生成了一个简单的HTML页面。
参考文献
[1]. Jinja2内置过滤器清单模板设计者文档 — Jinja2 中文手册 2.8 documentation (pythontab.com);