Python 中的模板
Python 中的模板是 Web 开发中使用的一种技术,它使用模板和数据动态生成静态 HTML 页面。
在本教程中,我们将探索 Python 模板化的基础知识,包括安装、创建模板和使用数据渲染模板,重点是 Jinja2 模板引擎。
Python 中的字符串模板
Python 中的字符串模板是执行字符串替换的一种简单方法。Python 的 string 模块包括 Template 类,该类提供了一种将字符串中的占位符替换为实际值的简单方法。
模板字符串使用 $ 符号进行替换,后跟遵循形成有效 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)
它将产生以下输出 -
示例:使用字典
在以下示例中,我们使用 dictionary 对象来映射模板字符串中的替换标识符 -
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)
以下是上述代码的输出 -
示例:缺少参数会引发 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)
以下是产生的错误 -
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)
它将产生以下输出 -
安装 Jinja2
要在 Python 中使用 Jinja2 进行模板化,您首先需要安装该库。Jinja2 是一个强大的模板引擎,广泛用于 Web 开发以呈现 HTML。它可以使用 Python 的包安装程序 pip 轻松安装 -
创建和呈现 Jinja2 模板
Jinja2 是一个强大的 Python 模板引擎,允许您通过将静态模板文件与数据混合来创建动态内容。本节探讨如何创建 Jinja2 模板并使用数据呈现它们。
创建 Jinja2 模板
要创建 Jinja2 模板,请定义模板字符串或从文件中加载它。模板使用双花括号 {{ ... }} 作为占位符,并支持控制结构,如“循环”和“条件”,带有 {% ... %}。
例
以下是存储在文件 “template.html” 中的简单 Jinja2 模板的示例 -
<!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
# Loading a template from a file (template.html)
file_loader = FileSystemLoader('.')
env = Environment(loader=file_loader)
template = env.get_template('template.html')
# Rendering the template with data
output = template.render(name='Alice')
# Output the rendered template
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 %}”,这些块可以在派生模板中覆盖,以分别自定义页面的标题和主要内容 -
<!-- base.html -->
<!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”模板,覆盖标题块以将其设置为“子页面”,并覆盖内容块以包含带有文本“子页面内容”的 <h1> 标题。
<!-- child.html -->
{% 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 %})用于根据条件控制模板的流程。下面是一个示例,其中 “Jinja2” 检查用户是否存在,如果为 true,则显示个性化问候语;否则,它会提示登录 -
{% if user %}
<p>Welcome, {{ user }}!</p>
{% else %}
<p>Please log in.</p>
{% endif %}
自定义过滤器
Jinja2 中的自定义筛选器用于定义您自己的筛选器,以便在模板中显示数据之前对其进行操作。
在以下示例中,在 Jinja2 中定义了自定义筛选器反向,以反转字符串“hello”,从而在模板中应用时生成“olleh” -
# Define a custom filter function
def reverse_string(s):
return s[::-1]
# Register the filter with the Jinja2 environment
env.filters['reverse'] = reverse_string
然后,您可以在模板中将 “reverse” 过滤器应用于任何字符串 -
{{ "hello" | reverse }}
以下是获得的输出 -