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標籤）、註釋或變量表達式的開頭或結尾增加一個減號（-)，則在這個塊前面或後面的空白都會刪除。

外部連結

• 官方網站