【Python系列】Jinja2 模板引擎
CSDN 2024-09-18 12:35:01 阅读 66
💝💝💝欢迎来到我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。
推荐:kwan 的首页,持续学习,不断总结,共同进步,活到老学到老导航
檀越剑指大厂系列:全面总结 java 核心技术,jvm,并发编程 redis,kafka,Spring,微服务等常用开发工具系列:常用的开发工具,IDEA,Mac,Alfred,Git,typora 等数据库系列:详细总结了常用数据库 mysql 技术点,以及工作中遇到的 mysql 问题等新空间代码工作室:提供各种软件服务,承接各种毕业设计,毕业论文等懒人运维系列:总结好用的命令,解放双手不香吗?能用一个命令完成绝不用两个操作数据结构与算法系列:总结数据结构和算法,不同类型针对性训练,提升编程思维,剑指大厂
非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。💝💝💝 ✨✨ 欢迎订阅本专栏 ✨✨
博客目录
一.基本介绍1.Jinja2 简介2.安装 Jinja23.基本用法4.创建模板5.渲染模板6.高级特性
二.需求实现1.需求描述2.代码实现
一.基本介绍
在现代软件开发中，模板引擎扮演着至关重要的角色，尤其是在 Web 开发领域。它们允许开发者将逻辑代码与用户界面分离，使得代码更加清晰、易于维护。在 Python 社区中，Jinja2 是一个广泛使用的模板引擎，它提供了强大的功能来处理模板渲染。
1.Jinja2 简介
Jinja2 是一个用 Python 编写的模板引擎，它继承了 Django 模板语言的许多特性，同时加入了一些独特的功能。Jinja2 支持继承、包含、宏等高级功能，使得模板的创建和管理变得更加灵活和强大。
2.安装 Jinja2
安装 Jinja2 非常简单，你可以通过 pip 命令轻松安装：
<code>pip install Jinja2
安装完成后，你就可以在 Python 代码中使用 Jinja2 了。
3.基本用法
Jinja2 的基本用法涉及到模板的创建和渲染。首先，你需要创建一个模板文件，然后在 Python 代码中加载并渲染这个模板。
4.创建模板
假设你有一个名为 template.html 的模板文件，内容如下：
<!DOCTYPE html>
<html lang="en">code>
<head>
<meta charset="UTF-8" />code>
<title>{ -- -->{ title }}</title>
</head>
<body>
<h1>{ { header }}</h1>
<p>{ { content }}</p>
</body>
</html>
在这个模板中，{ { title }}、{ { header }} 和 { { content }} 是变量占位符，它们将在渲染时被实际的数据替换。
5.渲染模板
接下来，你可以使用 Jinja2 的 Template 类来渲染这个模板。以下是如何在 Python 代码中完成这个过程的示例：
from jinja2 import Template
# 定义模板字符串
template_str = """
<!DOCTYPE html>
<html lang="en">code>
<head>
<meta charset="UTF-8">code>
<title>{ -- -->{ title }}</title>
</head>
<body>
<h1>{ { header }}</h1>
<p>{ { content }}</p>
</body>
</html>
"""
# 创建模板对象
template = Template(template_str)
# 定义上下文字典，包含要渲染的数据
context = {
'title': 'Hello Jinja2',
'header': 'Welcome to Jinja2',
'content': 'This is a simple example of using Jinja2.'
}
# 渲染模板
rendered_template = template.render(context)
# 打印渲染后的 HTML
print(rendered_template)
在这个例子中，我们首先定义了一个模板字符串 template_str，然后创建了一个 Template 对象。接着，我们定义了一个包含数据的字典 context，并将其传递给 render 方法。最后，我们打印出渲染后的 HTML 内容。
6.高级特性
Jinja2 提供了许多高级特性，如继承、包含和宏，这些特性可以帮助你创建更复杂的模板。
继承
继承允许你创建一个基础模板，然后让其他模板继承这个基础模板。这在创建具有一致布局的 Web 应用时非常有用。
<!-- base.html -->
<!DOCTYPE html>
<html lang="en">code>
<head>
<meta charset="UTF-8" />code>
<title>{% block title %}My Website{% endblock %}</title>
</head>
<body>
{% block content %}{% endblock %}
</body>
</html>
在这个基础模板中，我们定义了 title 和 content 两个块，其他模板可以通过继承这个模板并覆盖这些块来定义自己的内容。
包含
包含功能允许你在一个模板中包含另一个模板。这在创建重复的 HTML 结构时非常有用。
<!-- header.html -->
<header>
<h1>Welcome to My Website</h1>
</header>
你可以在其他模板中包含这个 header.html：
{% include 'header.html' %}
宏
宏允许你定义可重用的模板代码块。这在创建复杂的模板时非常有用。
{% macro input(name, value='', type='text', size=20) %}code>
<input
type="{ { type }}"code>
name="{ { name }}"code>
value="{ { value|e }}"code>
size="{ { size }}"code>
/>
{% endmacro %}
你可以在其他模板中调用这个宏：
{ -- -->{ input('username') }}
二.需求实现
1.需求描述
如何将 config.yaml 中的内容变为赋值后的内容
config.yaml
llm:
api_key: { { api_key } }
api_base: { { api_base } }
type: openai_chat
model: { { llm_model } }
model_supports_json: true
赋值后的结果
llm:
api_base: your_api_base
api_key: your_api_key
model: your_llm_model
model_supports_json: true
type: openai_chat
2.代码实现
读取 yaml 文件并将占位符改为指定字符,并写入新文件
<code>import yaml
from jinja2 import Template
# 读取YAML文件
def read_yaml_as_str(file_path):
with open(file_path, 'r') as file:
return file.read()
file_path = 'config.yaml'
yaml_data = read_yaml_as_str(file_path)
data = { -- -->
'api_key': 'your_api_key',
'api_base': 'your_api_base',
'llm_model': 'your_llm_model'
}
t = Template(yaml_data)
filled_template = t.render(data)
print(filled_template)
def write_yaml(data, file_path):
with open(file_path, 'w', encoding='utf-8') as file:code>
yaml.safe_dump(data, file)
write_yaml(yaml.safe_load(filled_template), 'config-template.yaml')
觉得有用的话点个赞
👍🏻呗。
❤️❤️❤️本人水平有限，如有纰漏，欢迎各位大佬评论批评指正！😄😄😄
💘💘💘如果觉得这篇文对你有帮助的话，也请给个点赞、收藏下吧，非常感谢!👍 👍 👍
🔥🔥🔥Stay Hungry Stay Foolish 道阻且长,行则将至,让我们一起加油吧！🌙🌙🌙
声明
本文内容仅代表作者观点，或转载于其他网站，本站不以此文作为商业用途
如有涉及侵权，请联系本站进行删除
转载本站原创文章，请注明来源及作者。