Jinja2 是一个强大的 Python 模板引擎,广泛用于生成 HTML、XML 或其他基于文本的格式。它的语法灵活且易于使用,支持变量插值、控制结构、过滤器、自定义函数等功能。以下是 Jinja2 语法的详细介绍:
1. 变量插值
使用双大括号 {{ }}
来插入变量的值。
<p>Hello, {{ name }}!</p>
2. 控制结构
条件语句
使用 {% if %}
、{% elif %}
和 {% else %}
来进行条件判断。
{% if user.is_authenticated %}
<p>Welcome, {{ user.name }}!</p>
{% else %}
<p>Please log in.</p>
{% endif %}
循环语句
使用 {% for %}
来进行循环。
<ul>
{% for item in items %}
<li>{{ item }}</li>
{% endfor %}
</ul>
3. 过滤器
过滤器用于修改变量的输出,使用管道符 |
。
<p>{{ name | upper }}</p> <!-- 将 name 转换为大写 -->
<p>{{ price | round(2) }}</p> <!-- 将 price 四舍五入到两位小数 -->
常用过滤器包括:
length
:返回序列的长度lower
:将字符串转换为小写upper
:将字符串转换为大写default
:如果变量未定义,则使用默认值join
:将列表连接成字符串
4. 宏
宏类似于函数,可以在模板中定义和调用。
{% macro render_item(item) %}
<li>{{ item }}</li>
{% endmacro %}
<ul>
{% for item in items %}
{{ render_item(item) }}
{% endfor %}
</ul>
5. 模板继承
模板继承允许你创建一个基础模板,并在子模板中扩展或覆盖其内容。
基础模板 (base.html
)
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>{% block title %}Default Title{% endblock %}</title>
</head>
<body>
<header>{% block header %}{% endblock %}</header>
<main>{% block content %}{% endblock %}</main>
<footer>{% block footer %}{% endblock %}</footer>
</body>
</html>
子模板 (child.html
)
{% extends "base.html" %}
{% block title %}Page Title{% endblock %}
{% block header %}<h1>Welcome</h1>{% endblock %}
{% block content %}
<p>This is the content of the page.</p>
{% endblock %}
6. 包含模板
使用 {% include %}
来包含其他模板文件。
{% include "header.html" %}
<p>Main content here.</p>
{% include "footer.html" %}
7. 注释
使用 {# #}
来添加注释,这些注释不会出现在渲染后的输出中。
{# This is a comment #}
<p>Hello, {{ name }}!</p>
8. 设置变量
使用 {% set %}
来设置变量。
{% set total = price * quantity %}
<p>Total: {{ total }}</p>
9. 原始内容
使用 {% raw %}
和 {% endraw %}
来包含原始内容,不进行模板渲染。
{% raw %}
{{ This will not be rendered }}
{% endraw %}
10. 自定义过滤器和全局函数
你可以在 Python 代码中定义自定义过滤器和全局函数,并将它们注册到 Jinja2 环境中。
自定义过滤器
from jinja2 import Environment, FileSystemLoader
def reverse_string(s):
return s[::-1]
env = Environment(loader=FileSystemLoader('templates'))
env.filters['reverse'] = reverse_string
template = env.get_template('example_template.html')
rendered = template.render(name="Jinja2")
print(rendered)
自定义全局函数
def greet(name):
return f"Hello, {name}!"
env.globals['greet'] = greet
template = env.get_template('example_template.html')
rendered = template