Python Jinja

最后修改于 2024 年 1 月 29 日

Jinja 教程演示了如何使用 Jinja 模块在 Python 中创建模板。

Python Jinja 模块

Jinja 是 Python 的一个模板引擎。它类似于 Django 的模板引擎。

模板引擎或模板处理器是一种旨在将模板与数据模型相结合以生成文档的库。模板引擎通常用于生成大量电子邮件、在源代码预处理中，或生成动态 HTML 页面。

我们创建一个模板引擎，在其中定义静态部分和动态部分。动态部分稍后将被数据替换。渲染函数随后会将模板与数据结合起来。

Jinja 安装

$ sudo pip3 install jinja2

我们使用 pip3 工具来安装 Jinja。

Jinja 分隔符

Jinja 在模板字符串中使用各种分隔符。

{% %} - 语句
{{ }} - 要打印到模板输出的表达式
{# #} - 不包含在模板输出中的注释
# ## - 行语句

Jinja 简单示例

在第一个示例中，我们创建了一个非常简单的模板。

simple.py

#!/usr/bin/python

from jinja2 import Template

name = input("Enter your name: ")

tm = Template("Hello {{ name }}")
msg = tm.render(name=name)

print(msg)

该示例要求输入用户名并生成一条消息字符串，然后打印给用户。模板引擎类似于 Python 的 format 方法；但模板引擎更强大，拥有更多功能。

from jinja2 import Template

我们从 jinja2 模块导入 Template 对象。Template 是核心模板对象。它代表一个已编译的模板，并用于对其进行求值。

tm = Template("Hello {{ name }}")

在我们的模板中，我们使用了 {{ }} 语法，它用于打印变量。变量通过 render 方法传递。

msg = tm.render(name=name)

使用 render 方法，我们生成最终输出。该方法将模板字符串与作为参数传递的数据连接起来。传递给 render 方法的变量称为上下文变量。

$ ./simple.py
Enter your name: Paul
Hello Paul

在下一个示例中，我们使用了两个变量。

simple2.py

#!/usr/bin/python

from jinja2 import Template

name = 'Peter'
age = 34

tm = Template("My name is {{ name }} and I am {{ age }}")
msg = tm.render(name=name, age=age)

print(msg)

模板字符串渲染了两个变量：name 和 age。这次变量是硬编码的。

$ ./simple2.py 
My name is Peter and I am 34

Jinja 对象

我们可以在模板字符串中使用对象。

objects.py

#!/usr/bin/python

from jinja2 import Template

class Person:

    def __init__(self, name, age):

        self.name = name
        self.age = age

    def getAge(self):
        return self.age

    def getName(self):
        return self.name    


person = Person('Peter', 34)

tm = Template("My name is {{ per.getName() }} and I am {{ per.getAge() }}")
msg = tm.render(per=person)

print(msg)

在示例中，我们定义了一个 Person 对象。我们通过两个 getter 获取 name 和 age。

字典

Jinja 允许使用方便的点表示法来访问 Python 字典中的数据。

dicts.py

#!/usr/bin/python

from jinja2 import Template

person = { 'name': 'Person', 'age': 34 }

tm = Template("My name is {{ per.name }} and I am {{ per.age }}")
# tm = Template("My name is {{ per['name'] }} and I am {{ per['age'] }}")
msg = tm.render(per=person)

print(msg)

我们有一个 person 字典。我们使用点运算符访问字典键。

tm = Template("My name is {{ per.name }} and I am {{ per.age }}")
# tm = Template("My name is {{ per['name'] }} and I am {{ per['age'] }}")

活动方式和注释方式都是有效的。点表示法更方便。

Jinja 原始数据

我们可以使用 raw、endraw 标记来转义 Jinja 分隔符。

raw_data.py

#!/usr/bin/python

from jinja2 import Template

data = '''
{% raw %}
His name is {{ name }}
{% endraw %}
'''

tm = Template(data)
msg = tm.render(name='Peter')

print(msg)

通过使用 raw、endraw 块，我们转义了 Jinja 的 {{ }} 语法。它会以其字面含义打印出来。

Jinja 转义数据

要转义 < 或 > 等字符，我们可以使用过滤器或 escape 函数。

escape_data.py

#!/usr/bin/python

from jinja2 import Template, escape

data = '<a>Today is a sunny day</a>'

tm = Template("{{ data | e}}")
msg = tm.render(data=data)

print(msg)
print(escape(data))

该示例转义了 < 和 > 字符。

tm = Template("{{ data | e}}")

使用 e 过滤器，数据会被转义。过滤器使用 | 字符应用。

print(escape(data))

escape 函数执行相同的操作。

Jinja for 表达式

for 表达式用于在模板中迭代数据集合。

现在我们不再使用简单的字符串模板了。我们使用文本文件，并通过 FileSystemLoader 加载它。

for_expr.py

#!/usr/bin/python

from jinja2 import Environment, FileSystemLoader

persons = [
    {'name': 'Andrej', 'age': 34}, 
    {'name': 'Mark', 'age': 17}, 
    {'name': 'Thomas', 'age': 44}, 
    {'name': 'Lucy', 'age': 14}, 
    {'name': 'Robert', 'age': 23}, 
    {'name': 'Dragomir', 'age': 54}
]

file_loader = FileSystemLoader('templates')
env = Environment(loader=file_loader)

template = env.get_template('showpersons.txt')

output = template.render(persons=persons)
print(output)

在此示例中，模板是 showpersons.txt 文件。该文件位于 templates 目录中。

persons = [
    {'name': 'Andrej', 'age': 34}, 
    {'name': 'Mark', 'age': 17}, 
    {'name': 'Thomas', 'age': 44}, 
    {'name': 'Lucy', 'age': 14}, 
    {'name': 'Robert', 'age': 23}, 
    {'name': 'Dragomir', 'age': 54}
]

数据是字典列表。

file_loader = FileSystemLoader('templates')
env = Environment(loader=file_loader)

我们定义了一个 FileSystemLoader。模板是从 templates 目录中检索的。

template = env.get_template('showpersons.txt')

我们使用 get_template 方法获取模板。

templates/showpersons.txt

{% for person in persons -%}
    {{ person.name }} {{ person.age }}
{% endfor %}

在模板文件中，我们使用 for 表达式迭代集合。我们显示了人的姓名和年龄。百分号字符旁边的连字符用于控制空白。

Jinja 条件语句

条件语句是在满足特定条件时进行评估的表达式。

conditionals.py

#!/usr/bin/python

from jinja2 import Environment, FileSystemLoader

persons = [
    {'name': 'Andrej', 'age': 34}, 
    {'name': 'Mark', 'age': 17}, 
    {'name': 'Thomas', 'age': 44}, 
    {'name': 'Lucy', 'age': 14}, 
    {'name': 'Robert', 'age': 23}, 
    {'name': 'Dragomir', 'age': 54}, 
]

file_loader = FileSystemLoader('templates')
env = Environment(loader=file_loader)
env.trim_blocks = True
env.lstrip_blocks = True
env.rstrip_blocks = True

template = env.get_template('showminors.txt')

output = template.render(persons=persons)
print(output)

该示例仅打印未成年人；未成年人是指未满 18 岁的人。

env.trim_blocks = True
env.lstrip_blocks = True
env.rstrip_blocks = True

输出中的空白可以通过环境属性来控制。

templates/showminors.txt

{% for person in persons %}
    {% if person.age < 18 %}
        {{- person.name }}
    {% endif %}    
{%- endfor %}

在模板中，我们使用 if 表达式仅输出未满 18 岁的人。

$ ./conditionals.py
Mark
Lucy

Jinja sum 过滤器

过滤器可以应用于数据以修改它们。例如，sum 过滤器可以对数据求和，escape 过滤器可以转义数据，sort 过滤器可以对数据排序。

sum_filter.py

#!/usr/bin/python

from jinja2 import Environment, FileSystemLoader

cars = [
    {'name': 'Audi', 'price': 23000}, 
    {'name': 'Skoda', 'price': 17300}, 
    {'name': 'Volvo', 'price': 44300}, 
    {'name': 'Volkswagen', 'price': 21300}
]

file_loader = FileSystemLoader('templates')
env = Environment(loader=file_loader)

template = env.get_template('sumprices.txt')

output = template.render(cars=cars)
print(output)

在示例中，我们使用 sum 过滤器计算所有汽车价格的总和。

cars = [
    {'name': 'Audi', 'price': 23000}, 
    {'name': 'Skoda', 'price': 17300}, 
    {'name': 'Volvo', 'price': 44300}, 
    {'name': 'Volkswagen', 'price': 21300}
]

我们有一个汽车字典列表。每个字典都有一个 price 键。它将用于计算总和。

templates/sumprices.txt

The sum of car prices is {{ cars | sum(attribute='price') }}

在模板文件中，我们将过滤器应用于 cars 集合对象。总和是从 price 属性计算的。

$ ./sum_filter.py 
The sum of car prices is 105900

Jinja 模板继承

模板继承是一项强大的功能，可减少代码重复并改善代码组织。我们定义一个基础模板，并在其他模板文件中继承它。这些模板文件会覆盖基础模板文件中的特定块。

inheritance.py

#!/usr/bin/python

from jinja2 import Environment, FileSystemLoader

content = 'This is about page'

file_loader = FileSystemLoader('templates')
env = Environment(loader=file_loader)

template = env.get_template('about.html')

output = template.render(content=content)
print(output)

我们渲染 about.html 文件。它继承自 base.html 文件。

base.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>{% block title %}{% endblock %}</title>
</head>
<body>
    {% block content%}
    
    {% endblock %}
</body>
</html>

在 base.html 文件中，我们声明了两个块：title 和 content。这些块将在子模板中用特定的标签和文本填充。

about.html

{% extends 'base.html' %}

{% block title%}About page{% endblock %}

{% block content %}
<h1>About page</h1>
<p>
    This is about page
</p>
{% endblock %}

about.html 模板文件继承自 base.html。它添加了此页面特有的数据。我们避免了代码重复；我们没有重复两个页面都相同的标签，例如 body、html 和 meta 标签。

{% extends 'base.html' %}

继承通过 extends 指令完成。

{% block title%}About page{% endblock %}

我们定义了一个 title。

{% block content %}
<h1>About page</h1>
<p>
    This is about page
</p>
{% endblock %}

然后我们定义了 content。

Jinja Flask 示例

在下一个示例中，我们创建一个使用 Jinja 的简单 Flask 应用程序。

app.py

#!/usr/bin/python

from flask import Flask, render_template, request
app = Flask(__name__)

@app.route("/greet")
def greet():
    username = request.args.get('name')
    return render_template('index.html', name=username)

if __name__ == "__main__":
    app.run()

在此 Flask 应用程序中，我们获取用户的姓名，并将其作为参数传递给 render_template 方法。greet 函数响应 /greet 路径。

templates/index.html

<!doctype html>

<html lang="en">

<head>
    <meta charset="utf-8">
    <title>Greeting</title>
</head>

<body>
    <p>
        Hello {{ name }}
    </p>
</body>

</html>

这是模板文件，位于 templates 目录中。我们使用 {{ name }} 语法将用户姓名添加到模板文件中。

$ python3 app.py 
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

我们启动服务器。

$ curl http://127.0.0.1:5000/greet?name=Peter
<!doctype html>

<html lang="en">

<head>
    <meta charset="utf-8">
    <title>Greeting</title>
</head>

<body>
    <p>
        Hello Peter
    </p>
</body>

</html>

我们使用 curl 工具连接到应用程序。我们添加了一个 name 参数。

来源

Python Jinja 文档

在本文中，我们介绍了 Python Jinja 模块。

作者

我叫 Jan Bodnar，我是一名热情的程序员，拥有丰富的编程经验。我自 2007 年以来一直在撰写编程文章。迄今为止，我已撰写了 1400 多篇文章和 8 本电子书。我在教学编程方面拥有十多年的经验。

列出所有 Python 教程。