从其他模板引擎迁移到Jinja的指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00167/article/details/148415033

从其他模板引擎迁移到Jinja的指南

jinja A very fast and expressive template engine. 项目地址: https://gitcode.com/gh_mirrors/ji/jinja

Jinja作为Python生态中广泛使用的模板引擎，与Django模板、Mako等其他模板引擎有着相似之处但也存在重要差异。本文将为开发者详细解析这些差异，帮助您顺利从其他模板引擎迁移到Jinja。

从Django模板迁移

Django模板用户会发现Jinja非常熟悉，但需要注意以下几个关键区别：

方法调用语法

在Django中，方法调用可以省略括号：

{% for page in user.get_created_pages %}
    ...
{% endfor %}

而在Jinja中，必须使用Python风格的括号调用方法：

{% for page in user.get_created_pages() %}
    ...
{% endfor %}

这种显式调用方式不仅更符合Python习惯，还允许传递参数给方法。

过滤器参数传递

Django只支持通过冒号传递单个字面量参数：

{{ items|join:", " }}

Jinja则支持完整的函数调用语法，可以传递多个参数（包括变量）：

{{ items|join(", ") }}

测试运算符

Jinja特有的is测试运算符（不同于Python的is）：

{% if user.user_id is odd %}
    {{ user.username|e }} is odd
{% else %}
    hmm. {{ user.username|e }} looks pretty normal
{% endif %}

循环控制

Django使用forloop变量和empty块：

{% for item in items %}
    {{ forloop.counter }}. {{ item }}
{% empty %}
    No items!
{% endfor %}

Jinja使用loop变量和else块：

{% for item in items %}
    {{ loop.index }}. {{ item }}
{% else %}
    No items!
{% endfor %}

循环交替样式

Django使用单独的cycle标签：

{% for user in users %}
    <li class="{% cycle 'odd' 'even' %}">{{ user }}</li>
{% endfor %}

Jinja通过loop变量的cycle方法实现：

{% for user in users %}
    <li class="{{ loop.cycle('odd', 'even') }}">{{ user }}</li>
{% endfor %}

从Mako迁移

Jinja可以通过配置来模拟Mako的部分语法：

env = Environment(
    block_start_string="<%",
    block_end_string="%>",
    variable_start_string="${",
    variable_end_string="}",
    comment_start_string="<%doc>",
    commend_end_string="</%doc>",
    line_statement_prefix="%",
    line_comment_prefix="##",
)

主要差异

嵌入式Python代码：Jinja不支持在模板中直接嵌入Python代码，需要将业务逻辑移到模板外处理
宏定义：Mako的def在Jinja中称为macro
模板继承：语法结构有所不同

模板转换示例

Mako模板：

<%inherit file="layout.html" />
<%def name="title()">Page Title</%def>
<ul>
% for item in list:
    <li>${item}</li>
% endfor
</ul>

转换后的Jinja模板：

<% extends "layout.html" %>
<% block title %>Page Title<% endblock %>
<% block body %>
<ul>
% for item in list:
    <li>${item}</li>
% endfor
</ul>
<% endblock %>