Python 中的模板技术是在 Web 开发中使用模板和数据动态生成静态 HTML 页面的一种技术。
在本教程中,我们将探索 Python 中模板技术的基础知识,包括安装、创建模板以及渲染带有数据的模板,重点放在 Jinja2 模板引擎上。
Python 中的字符串模板
Python 中的字符串模板是一种简单的字符串替换方式。Python 的 string 模块包含了 Template 类,提供了轻松替换字符串中占位符的实际值的方法。
string 模块中的 Template 类在 PEP 292 中描述了一种通过替换技术动态形成字符串对象的方式。其更简单的语法和功能使得它在国际化方面相比 Python 中其他的内置字符串格式化设施更容易翻译。
模板字符串使用 $ 符号进行替换,紧跟着的是符合 Python 标识符规则的标识符。
创建模板
为了创建模板,你需要使用包含以 $ 开头的占位符的字符串来实例化 Template 类,如下所示:
from string import Template
template = Template("Hello, $name!")
替换值
你可以使用 substitute()
方法来替换模板中的值,该方法接受键值对的字典。
substitute()
方法将模板中的占位符(标识符)替换成实际的值。你可以使用关键字参数或者字典来提供这些值。该方法返回一个新的字符串,其中占位符已经被填充。
示例:使用关键字参数
下面的代码使用关键字参数来替换模板字符串中的标识符:
from string import Template
tempStr = Template('Hello. My name is $name and my age is $age')
newStr = tempStr.substitute(name='Pushpa', age=26)
print(newStr)
它会产生以下输出:
Hello. My name is Pushpa and my age is 26
示例:使用字典
在下面的例子中,我们使用字典对象来映射模板字符串中的替换标识符:
from string import Template
tempStr = Template('Hello. My name is $name and my age is $age')
dct = {'name': 'Pushpalata', 'age': 25}
newStr = tempStr.substitute(dct)
print(newStr)
以上代码的输出如下:
Hello. My name is Pushpalata and my age is 25
示例:缺少参数会引发 KeyError
如果 substitute()
方法没有提供足够的参数来匹配模板字符串中的标识符,Python 会抛出 KeyError:
from string import Template
tempStr = Template('Hello. My name is $name and my age is $age')
dct = {'name': 'Pushpalata'}
newStr = tempStr.substitute(dct)
print(newStr)
产生的错误信息如下:
Traceback (most recent call last):
File "/home/cg/root/667e441d9ebd5/main.py", line 5, in <module>
newStr = tempStr.substitute(dct)
File "/usr/lib/python3.10/string.py", line 121, in substitute
return self.pattern.sub(convert, self.template)
File "/usr/lib/python3.10/string.py", line 114, in convert
return str(mapping[named])
KeyError: 'age'
使用 safe_substitute() 方法替换值
safe_substitute()
方法的行为类似于 substitute()
方法,唯一的区别是如果提供的键不足或不匹配时,它不会抛出错误。相反,原始的占位符会保留在结果字符串中不变。
示例
在下面的例子中,我们使用 safe_substitue()
方法来替换值:
from string import Template
tempStr = Template('Hello. My name is $name and my age is $age')
dct = {'name': 'Pushpalata'}
newStr = tempStr.safe_substitute(dct)
print(newStr)
它会产生以下输出:
Hello. My name is Pushpalata and my age is $age
安装 Jinja2
为了在 Python 中使用 Jinja2 进行模板化,首先需要安装该库。Jinja2 是一个强大的模板引擎,在 Web 开发中广泛用于渲染 HTML。使用 pip,Python 的包管理器,可以轻松安装它:
pip install jinja2
创建和渲染 Jinja2 模板
Jinja2 是一个功能强大的 Python 模板引擎,允许你通过混合静态模板文件与数据来创建动态内容。此部分探讨如何创建 Jinja2 模板并渲染它们。
创建 Jinja2 模板
为了创建 Jinja2 模板,你需要定义一个模板字符串或从文件中加载它。模板使用双花括号 {{ ... }} 作为占位符,并支持使用 {% ... %} 的控制结构,如循环和条件语句。
示例
以下是一个简单的 Jinja2 模板,存储在名为 "template.html" 的文件中:
<!DOCTYPE html>
<html>
<head>
<title>Hello, {{ name }}!</title>
</head>
<body>
<h1>Hello, {{ name }}!</h1>
<p>Welcome to our site.</p>
</body>
</html>
渲染 Jinja2 模板
为了渲染一个 Jinja2 模板,遵循以下步骤:
-
-
创建模板对象 —— 使用
jinja2.Template
创建模板对象。
-
渲染 —— 使用模板对象上的
render()
方法,传入作为参数或字典的数据。
示例
在这里,我们正在渲染 Jinja2 模板:
from jinja2 import Template, FileSystemLoader, Environment
file_loader = FileSystemLoader('.')
env = Environment(loader=file_loader)
template = env.get_template('template.html')
output = template.render(name='Alice')
print(output)
渲染后的 Jinja2 模板的输出将是一个 HTML 文档,其中模板中的占位符被渲染时传入的实际数据替换:
<!DOCTYPE html>
<html>
<head>
<title>Hello, Alice!</title>
</head>
<body>
<h1>Hello, Alice!</h1>
<p>Welcome to our site.</p>
</body>
</html>
高级 Jinja2 功能
Jinja2 支持各种高级特性,如循环、条件判断和自定义过滤器,使其成为创建复杂模板的强大工具。
模板继承
Jinja2 支持模板继承,允许你在基础模板中定义常见元素(比如头部、尾部、导航栏),并在子模板中扩展或覆盖特定的区块。这促进了大型项目中的代码复用和维护性。
示例
这个命名为 "base.html" 的 HTML 模板文件使用 Jinja2 模板语法定义了一个网页的基本结构。
它包含可以被派生模板覆盖的区块 "{% block title %}" 和 "{% block content %}",分别用来定制页面的标题和主要内容:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>{% block title %}Default Title{% endblock %}</title>
</head>
<body>
{% block content %}{% endblock %}
</body>
</html>
下面这个 Jinja2 模板文件 "child.html" 继承了 "base.html" 模板,并覆盖了标题区块,将其设置为 "Child Page",同时覆盖了内容区块,包含了带有文本 "Child Page Content" 的 <h1>
标签:
{% extends "base.html" %}
{% block title %}Child Page{% endblock %}
{% block content %}
<h1>Child Page Content</h1>
{% endblock %}
循环
Jinja2 允许你使用 {% for %}
循环遍历列表或其他可迭代对象。以下是一个示例,展示了如何使用循环生成 HTML 中的无序列表(<ul>
):
<ul>
{% for item in items %}
<li>{{ item }}</li>
{% endfor %}
</ul>
条件判断
Jinja2 中的条件语句({% if %}
和 {% else %}
)用于根据条件控制模板的流程。以下是一个示例,其中检查用户是否存在,并在存在时显示个性化问候,否则提示登录:
{% if user %}
<p>Welcome, {{ user }}!</p>
{% else %}
<p>Please log in.</p>
{% endif %}
自定义过滤器
Jinja2 中的自定义过滤器用于定义你自己的过滤器来在显示前处理数据。
在下面的例子中,定义了一个名为 reverse
的自定义过滤器来反转字符串 "hello",在模板中应用时结果为 "olleh":
def reverse_string(s):
return s[::-1]
env.filters['reverse'] = reverse_string
在模板中,你可以将 reverse
过滤器应用到任何字符串上:
{{ "hello" | reverse }}
产生的输出如下:
olleh