Jinja2

Jinja

原作者	Armin Ronacher
首次发布	2008年7月17日​（2008-07-17）
当前版本	3.1.6（2025年3月5日；穩定版本）
源代码库	github.com/pallets/jinja
编程语言	Python
类型	模板引擎
许可协议	BSD许可证
网站	palletsprojects.com/p/jinja/

Jinja2是为Python提供的一个功能齐全的模板引擎。Jinja2提供了对Unicode的完全支持，以及一个可选的集成沙盒运行环境。它使用BSD许可证。

Jinja模板引擎允许对标签、过滤器（用来格式化或变换值）、测试（用来评估条件）和全局变量。不像Django模板引擎，Jinja允许模板设计者在对象上调用具有参数的函数。Jinja是Flask还有Home Assistant自动化的缺省模板引擎。它还被用于Ansible、Trac和Salt。它也用于制作SQL宏，例如dbt。

主要特征：

• 沙盒执行。
• 防止跨站脚本攻击的自动HTML转义。
• 模板继承。
• 即时编译至优化的python代码。
• 可选的提前模板编译。
• 易于调试。
• 可配置的语法。

Jinja就像Smarty，还备有类似Unix管道的易用的过滤系统。

语法

打印输出的语法使用双花括号，例如{{ Hello, World! }}。

设置变量的语句或没有输出的语句可以包装在{% and %}之中，例如{% set foo = 42 %}，这里使用了set关键字，它设置叫做foo的变量具有值42。

注释可以可以包装在{# and #}之中，例如{# helpful comment #}。

建立过滤器的语法是竖线（|），例如{{ variable|filter }}。一个变量可以有多个过滤器，例如{{ variable|filter|filter }}。

建立测试的语法是关键字is，以及评估一个测试有效性的条件，例如{% if variable is divisibleby 10 %}do something{% endif %}。

可以使用For循环来迭代于序列之上，同时保持它们的对象属性。下面的例子展示迭代于一个列表users之上，它具有username和password字段。

{% for user in users %}
    {{ user.username }}
    {{ user.password }}
{% endfor %}

尽管break和continue不允许出现在循环中，序列是可以过滤的。

例子

下面的小例子是一个模板文件example.html.jinja：

<!DOCTYPE html>
<html>
  <head>
    <title>{{ variable|escape }}</title>
  </head>
  <body>
  {% for item in item_list -%}
    {{ item }}{% if not loop.last %}, {% endif %}
  {%- endfor %}
  </body>
</html>

和一个模板代码：

from jinja2 import Template
with open("example.html.jinja") as f:
    tmpl = Template(f.read())
print(tmpl.render(
    variable = "Value with <unsafe> data",
    item_list = [1, 2, 3, 4, 5, 6]
))

它产生HTML字符串：

<!DOCTYPE html>
<html>
  <head>
    <title>Value with &lt;unsafe&gt; data</title>
  </head>
  <body>
  1, 2, 3, 4, 5, 6
  </body>
</html>

注意如果向一个块（比如这里的for标签）、注释或变量表达式的开头或结尾增加一个减号（-)，则在这个块前面或后面的空白都会删除。

外部链接

• 官方网站