Flask 模板:使用 Jinja2 渲染 HTML

zhezhongyun 2024-12-22 21:56 56 浏览

Flask 是一个轻量级且灵活的 Python Web 框架。其主要功能之一是能够使用强大的模板引擎 Jinja2 呈现 HTML 模板。本博客将引导您了解 Flask 模板的基础知识，并演示如何使用 Jinja2 渲染动态 HTML 内容。

什么是模板？

Flask 中的模板是包含静态 HTML 以及用于插入动态内容的特殊语法的文件。这些模板通常存储在 Flask 项目目录中名为“templates”的文件夹中。 Flask 使用 Jinja2 作为默认模板引擎，允许您在 HTML 文件中嵌入类似 Python 的表达式和逻辑。

使用 Jinja2 设置 Flask

首先，确保您的 Python 环境中安装了 Flask。您可以使用 pip 安装它：

pip install Flask

接下来，创建一个基本的 Flask 应用程序结构：

flask_app/
│
├── app.py
├── templates/
│   └── index.html
└── static/

创建一个简单的 Flask 应用程序

让我们从一个简单的 Flask 应用程序开始。创建一个名为“app.py”的文件：

from flask import Flask, render_template


app = Flask(__name__)


@app.route('/')
def home():
    return render_template('index.html', title="Home Page", message="Welcome to Flask with Jinja2!")


if __name__ == '__main__':
    app.run(debug=True)

在此示例中，“render_template”函数呈现“index.html”模板，并传入标题和消息作为变量。

创建您的第一个模板

在项目目录中创建一个名为“templates”的文件夹，并在该文件夹中创建一个名为“index.html”的文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{{ title }}</title>
</head>
<body>
    <h1>{{ message }}</h1>
    <p>This is a simple Flask application demonstrating Jinja2 templates.</p>
</body>
</html>

在此模板中，“{{ title }}”和“{{ message }}”是占位符，将被从 Flask 路由传递的值替换。

向模板添加逻辑

Jinja2 允许您添加控制结构，例如循环和条件。让我们更新我们的模板来演示这些功能：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{{ title }}</title>
</head>
<body>
    <h1>{{ message }}</h1>
    <p>This is a simple Flask application demonstrating Jinja2 templates.</p>
    
    <h2>Fruits List:</h2>
    <ul>
        {% for fruit in fruits %}
        <li>{{ fruit }}</li>
        {% endfor %}
    </ul>


    {% if show_greeting %}
    <p>Have a great day!</p>
    {% else %}
    <p>Goodbye!</p>
    {% endif %}
</body>
</html>

更新“app.py”以将水果列表和布尔变量传递给模板：

@app.route('/')
def home():
    fruits = ["Apple", "Banana", "Cherry", "Date", "Elderberry"]
    show_greeting = True
    return render_template('index.html', title="Home Page", message="Welcome to Flask with Jinja2!", fruits=fruits, show_greeting=show_greeting)

使用模板继承

模板继承允许您创建具有公共元素（例如页眉和页脚）的基本模板，并在其他模板中扩展它。在“templates”文件夹中创建一个基本模板“base.html”：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}Default Title{% endblock %}</title>
</head>
<body>
    <header>
        <h1>My Website</h1>
    </header>
    
    <main>
        {% block content %}{% endblock %}
    </main>
    
    <footer>
        <p>? 2024 My Website</p>
    </footer>
</body>
</html>

现在，更新“index.html”以扩展“base.html”：

{% extends "base.html" %}


{% block title %}{{ title }}{% endblock %}


{% block content %}
    <h1>{{ message }}</h1>
    <p>This is a simple Flask application demonstrating Jinja2 templates.</p>
    
    <h2>Fruits List:</h2>
    <ul>
        {% for fruit in fruits %}
        <li>{{ fruit }}</li>
        {% endfor %}
    </ul>


    {% if show_greeting %}
    <p>Have a great day!</p>
    {% else %}
    <p>Goodbye!</p>
    {% endif %}
{% endblock %}

模板过滤器

Jinja2 允许您使用过滤器在渲染变量之前修改它的值。让我们添加一个自定义过滤器来将列表中的所有项目大写。

在“app.py”中创建自定义过滤器：

from flask import Flask, render_template


app = Flask(__name__)


# Custom filter
def capitalize_list(items):
    return [item.capitalize() for item in items]


app.jinja_env.filters['capitalize'] = capitalize_list


@app.route('/')
def home():
    fruits = ["apple", "banana", "cherry", "date", "elderberry"]
    return render_template('index.html', title="Home Page", message="Welcome to Flask with Jinja2!", fruits=fruits)


if __name__ == '__main__':
    app.run(debug=True)

在“index.html”中，将自定义过滤器应用于水果列表：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{{ title }}</title>
</head>
<body>
    <h1>{{ message }}</h1>
    <p>This is a simple Flask application demonstrating Jinja2 templates.</p>
    
    <h2>Fruits List (Capitalized):</h2>
    <ul>
        {% for fruit in fruits|capitalize %}
        <li>{{ fruit }}</li>
        {% endfor %}
    </ul>
</body>
</html>

宏

Jinja2 中的宏类似于 Python 中的函数。它们允许您在模板中重复使用代码片段。

在“templates”文件夹中创建一个“macros.html”文件：

{% macro render_fruit_list(fruits) %}
<ul>
    {% for fruit in fruits %}
    <li>{{ fruit }}</li>
    {% endfor %}
</ul>
{% endmacro %}

更新 `index.html` 以使用宏：

{% extends "base.html" %}
{% import "macros.html" as macros %}


{% block title %}{{ title }}{% endblock %}


{% block content %}
    <h1>{{ message }}</h1>
    <p>This is a simple Flask application demonstrating Jinja2 templates.</p>
    
    <h2>Fruits List (Using Macros):</h2>
    {{ macros.render_fruit_list(fruits) }}
{% endblock %}

多级模板继承

通过添加另一级别的模板扩展来创建更复杂的模板继承示例。

在“templates”文件夹中创建“layout.html”：

{% extends "base.html" %}


{% block content %}
<div class="container">
    {% block body %}{% endblock %}
</div>
{% endblock %}

更新 `index.html` 以扩展 `layout.html`：

{% extends "layout.html" %}


{% block title %}{{ title }}{% endblock %}


{% block body %}
    <h1>{{ message }}</h1>
    <p>This is a simple Flask application demonstrating Jinja2 templates with multiple levels of inheritance.</p>
    
    <h2>Fruits List:</h2>
    <ul>
        {% for fruit in fruits %}
        <li>{{ fruit }}</li>
        {% endfor %}
    </ul>


    {% if show_greeting %}
    <p>Have a great day!</p>
    {% else %}
    <p>Goodbye!</p>
    {% endif %}
{% endblock %}

静态文件

Flask 允许您从“static”目录提供静态文件，例如 CSS、JavaScript 和图像。让我们创建一个简单的样式表并将其包含在我们的模板中。

在项目目录中创建一个名为“static”的文件夹，并添加一个名为“styles.css”的文件：

body {
    font-family: Arial, sans-serif;
}


header {
    background-color: #f8f9fa;
    padding: 20px;
    text-align: center;
}


footer {
    background-color: #f8f9fa;
    padding: 10px;
    text-align: center;
    position: fixed;
    bottom: 0;
    width: 100%;
}

更新 `base.html` 以包含样式表：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}Default Title{% endblock %}</title>
    <link rel="stylesheet" href="{{ url_for('static', filename='styles.css') }}">
</head>
<body>
    <header>
        <h1>My Website</h1>
    </header>
    
    <main>
        {% block content %}{% endblock %}
    </main>
    
    <footer>
        <p>? 2024 My Website</p>
    </footer>
</body>
</html>

包含其他模板

有时，您可能希望将模板分解为更小的、可重复使用的部分。 Jinja2 允许您在其他模板中包含模板。

在“templates”文件夹中创建一个“header.html”文件：

<header>
    <h1>{{ header_title }}</h1>
</header>

更新 `base.html` 以包含 `header.html`：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}Default Title{% endblock %}</title>
    <link rel="stylesheet" href="{{ url_for('static', filename='styles.css') }}">
</head>
<body>
    {% include 'header.html' %}
    
    <main>
        {% block content %}{% endblock %}
    </main>
    
    <footer>
        <p>? 2024 My Website</p>
    </footer>
</body>
</html>

更新 `app.py` 以传递参数作为头标题

@app.route('/')
def home():
    fruits = ["apple", "banana", "cherry", "date", "elderberry"]
    return render_template('index.html', title="Home Page", message="Welcome to Flask with Jinja2!", fruits=fruits, header_title="Welcome to My Website")


if __name__ == '__main__':
    app.run(debug=True)

在本博客中，我们介绍了使用 Jinja2 在 Flask 中渲染 HTML 模板的基础知识。我们创建了一个简单的 Flask 应用程序，构建了动态模板，并利用模板继承来更好地组织。 Flask 和 Jinja2 为开发动态且可维护的 Web 应用程序提供了强大的组合。

通过利用这些工具，您可以使用干净且可重用的代码创建强大且可扩展的 Web 应用程序。祝您快乐编码，关注收藏或者转发给其他小伙伴吧，谢谢！

HTML 拓展阅读

上一篇：DOM - 根据ID访问HTML元素根据id获取元素的jquery方法
下一篇：chrome系列-扩展程序开发学习-从无到有

Flask 模板:使用 Jinja2 渲染 HTML

相关推荐

b端详情页:各种信息聚集地，设计师要如何规划这一亩三分地呢

漏洞系列一一看我一招征服漏洞 SSRF

接口测试遇到500报错?别慌，你的头部可能有点问题

Web前端需要学什么?Web前端开发需要学习哪些?

前端Flex布局可视化布局工具介绍，vue和html5快速设计利器

「资讯」为强迫用户使用Edge浏览器，微软又出新招数

HTML 简介（html简介及优缺点）

HBuilderX，uni-app创建HTML5项目，同时支持浏览器和移动端

关于HTML5被简称做H5，你怎么看?（html5缩写）

现在页面实时聊天都使用Websocket技术实现吗?