Jinja2解析器（Parser）中的模板继承和块覆盖的实现方式

发布时间：2023-12-28 06:14:33

Jinja2是一个用于Python的流行的模板引擎，它提供了丰富的功能，包括模板继承和块覆盖。

模板继承允许你创建一个基础模板，并在其他模板中扩展和重写基础模板的内容。这对于创建具有共同结构的网页非常有用，例如网站的布局或导航菜单。

下面是一个简单的例子，演示了如何使用模板继承。首先，我们创建一个基础模板（base.html），其中定义了一个基本网页结构：

<!DOCTYPE html>
<html>
<head>
    <title>{% block title %}{% endblock %}</title>
</head>
<body>
    <header>
        {% block header %}{% endblock %}
    </header>
    
    <nav>
        {% block nav %}
            <ul>
                <li><a href="#">Home</a></li>
                <li><a href="#">About</a></li>
                <li><a href="#">Contact</a></li>
            </ul>
        {% endblock %}
    </nav>
    
    <section>
        {% block content %}
            <h1>Welcome to my website!</h1>
        {% endblock %}
    </section>
    
    <footer>
        {% block footer %}{% endblock %}
    </footer>
</body>
</html>

在基础模板中，我们使用了Jinja2的block标记来定义可以被其他模板覆盖的内容块。每个内容块都包含在{% block %}和{% endblock %}之间。

现在，我们可以创建一个扩展基础模板的子模板（child.html），并重写其中的内容块。

{% extends "base.html" %}

{% block title %}
    Child Template
{% endblock %}

{% block header %}
    <h1>Welcome to my website</h1>
{% endblock %}

{% block nav %}
    <ul>
        <li><a href="#">Home</a></li>
        <li><a href="#">Gallery</a></li>
        <li><a href="#">Contact</a></li>
    </ul>
{% endblock %}

{% block content %}
    <h2>About Me</h2>
    <p>I am a web developer.</p>
{% endblock %}

{% block footer %}
    <p>? 2021 My Website. All rights reserved.</p>
{% endblock %}

在子模板中，我们使用{% extends "base.html" %}指令来继承基础模板，并通过{% block %}指令重写了标题、头部、导航、内容和页脚的内容。

当我们渲染子模板时，Jinja2会自动将基础模板和子模板的内容合并在一起，最终生成完整的HTML页面。

from jinja2 import Template, Environment, FileSystemLoader

loader = FileSystemLoader(searchpath="./")
env = Environment(loader=loader)

template = env.get_template("child.html")
output = template.render()

print(output)

输出结果为：

<!DOCTYPE html>
<html>
<head>
    <title>Child Template</title>
</head>
<body>
    <header>
        <h1>Welcome to my website</h1>
    </header>
    
    <nav>
        <ul>
            <li><a href="#">Home</a></li>
            <li><a href="#">Gallery</a></li>
            <li><a href="#">Contact</a></li>
        </ul>
    </nav>
    
    <section>
        <h2>About Me</h2>
        <p>I am a web developer.</p>
    </section>
    
    <footer>
        <p>? 2021 My Website. All rights reserved.</p>
    </footer>
</body>
</html>

通过模板继承，我们可以轻松地修改和扩展基础模板的内容，同时保持页面结构的一致性。

Jinja2还提供了块覆盖的功能，允许您在基础模板中定义一个可替换的内容块，并在子模板中重写该内容块。

下面是一个使用块覆盖的例子。在基础模板中，我们定义了一个名为content的块。

<!DOCTYPE html>
<html>
<head>
    <title>Block Override Example</title>
</head>
<body>
    <h1>My Website</h1>
    {% block content %}{% endblock %}
</body>
</html>

在子模板中，我们重写了content块并添加了自己的内容：

{% extends "base.html" %}

{% block content %}
    <p>Welcome to my homepage!</p>
    <p>This is some example content.</p>
{% endblock %}

当我们渲染子模板时，Jinja2会将子模板中定义的内容块替换基础模板中的对应内容：

from jinja2 import Template, Environment, FileSystemLoader

loader = FileSystemLoader(searchpath="./")
env = Environment(loader=loader)

template = env.get_template("child.html")
output = template.render()

print(output)

输出结果为：

<!DOCTYPE html>
<html>
<head>
    <title>Block Override Example</title>
</head>
<body>
    <h1>My Website</h1>
    <p>Welcome to my homepage!</p>
    <p>This is some example content.</p>
</body>
</html>

通过块覆盖，我们可以在子模板中灵活地自定义基础模板的内容，以满足特定页面的需求。

总之，Jinja2的模板继承和块覆盖提供了一种灵活和强大的方式来创建可重用的模板和定制化的内容。通过使用这些功能，我们可以减少模板重复的工作，并提高开发效率。