一起学FLask -第二章,模板

要想开发出易于维护的程序,关键在于编写形式简洁且结构良好的代码。

视图函数的作用很明确,即生成请求的响应,如第 1 章中的示例所示。对最简单的请求来说, 这就足够了,但一般而言,请求会改变程序的状态,而这种变化也会在视图函数中产生。

例如,用户在网站中注册了一个新账户。用户在表单中输入电子邮件地址和密码,然后点 击提交按钮。服务器接收到包含用户输入数据的请求,然后 Flask 把请求分发到处理注册 请求的视图函数。这个视图函数需要访问数据库,添加新用户,然后生成响应回送浏览 器。这两个过程分别称为业务逻辑和表现逻辑。

把业务逻辑和表现逻辑混在一起会导致代码难以理解和维护。假设要为一个大型表格构建 HTML 代码,表格中的数据由数据库中读取的数据以及必要的 HTML 字符串连接在一起。 把表现逻辑移到模板中能够提升程序的可维护性。

模板是一个包含响应文本的文件,其中包含用占位变量表示的动态部分,其具体值只在请 求的上下文中才能知道。使用真实值替换变量,再返回最终得到的响应字符串,这一过程 称为渲染。为了渲染模板,Flask 使用了一个名为 Jinja2 的强大模板引擎。

2.1 Jinja2模板引擎

形式最简单的 Jinja2 模板就是一个包含响应文本的文件。示例 2-1 是一个 Jinja2 模板,它 和示例 1-1 中 index() 视图函数的响应一样。

示例 3-1 templates/index.html:Jinja2 模板

<h1>Hello World!</h1>

 示例 1-2 中,视图函数 user() 返回的响应中包含一个使用变量表示的动态部分。示例 2-2 实现了这个响应。

示例 3-2 templates/user.html:Jinja2 模板

<h1>Hello, {{ name }}!</h1>

1.1.1 渲染模板 默认情况下,Flask 在程序文件夹中的 templates 子文件夹中寻找模板。在下一个 hello.py 版本中,要把前面定义的模板保存在 templates 文件夹中,并分别命名为 index.html 和 user. html。 程序中的视图函数需要修改一下,以便渲染这些模板。修改方法参见示例 1-3。

示例 1-3 hello.py:渲染模板

from flask import Flask,render_template
app = Flask(__name__)

@app.route('/')
def index():
    return render_template('index.html')

@app.route('/user/<name>')
def user(name):
    return render_template('user.html',name=name)


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

Flask 提供的 render_template 函数把 Jinja2 模板引擎集成到了程序中。render_template 函 数的第一个参数是模板的文件名。随后的参数都是键值对,表示模板中变量对应的真实 值。在这段代码中,第二个模板收到一个名为 name 的变量。

前例中的 name=name 是关键字参数,这类关键字参数很常见,但如果你不熟悉它们的话, 可能会觉得迷惑且难以理解。左边的“name”表示参数名,就是模板中使用的占位符;右 边的“name”是当前作用域中的变量,表示同名参数的值。

2.1.2 变量

示例 2-2 在模板中使用的 {{ name }} 结构表示一个变量,它是一种特殊的占位符,告诉模 板引擎这个位置的值从渲染模板时使用的数据中获取。

Jinja2 能识别所有类型的变量,甚至是一些复杂的类型,例如列表、字典和对象。在模板 中使用变量的一些示例如下:

<p>A value from a dictionary: {{ mydict['key'] }}.</p>
<p>A value from a list: {{ mylist[3] }}.</p>
<p>A value from a list, with a variable index: {{ mylist[myintvar] }}.</p>
<p>A value from an object's method: {{ myobj.somemethod() }}.</p>

可以使用过滤器修改变量,过滤器名添加在变量名之后,中间使用竖线分隔。例如,下述 模板以首字母大写形式显示变量 name 的值:

Hello, {{ name|capitalize }}

表 2-1 列出了 Jinja2 提供的部分常用过滤器。

表2-1 Jinja2变量过滤器

过滤器名 说明
safe  渲染值时不转义
capitalize  把值的首字母转换成大写,其他字母转换成小写
lower  把值转换成小写形式
upper  把值转换成大写形式
title  把值中每个单词的首字母都转换成大写
trim  把值的首尾空格去掉
striptags  渲染之前把值中所有的 HTML 标签都删掉

safe 过滤器值得特别说明一下。默认情况下,出于安全考虑,Jinja2 会转义所有变量。例 如,如果一个变量的值为

'<h1>Hello</h1>'

Jinja2 会将其渲染成

'&lt;h1&gt;Hello&lt;/h1&gt;'

浏览器能显示这个 h1 元素,但不会进行解释。很多情况下需要显示变量中存储 的 HTML 代码,这时就可使用 safe 过滤器。

千万别在不可信的值上使用 safe 过滤器,例如用户在表单中输入的文本。

完整的过滤器列表可在 Jinja2 文档(http://jinja.pocoo.org/docs/templates/#builtin-filters)中 查看。

2.1.3 控制结构

Jinja2 提供了多种控制结构,可用来改变模板的渲染流程。本节使用简单的例子介绍其中 最有用的控制结构。

下面这个例子展示了如何在模板中使用条件控制语句:

{% if user %}
    Hello, {{ user }}!
{% else %}
    Hello, Stranger!
{% endif %}

另一种常见需求是在模板中渲染一组元素。下例展示了如何使用 for 循环实现这一需求:

<ul>
    {% for comment in comments %}
        <li>{{ comment }}</li>
    {% endfor %}
</ul>

Jinja2 还支持宏。宏类似于 Python 代码中的函数。例如:

{% macro render_comment(comment) %}
    <li>{{ comment }}</li>
{% endmacro %}

<ul>
    {% for comment in comments %}
        {{ render_comment(comment) }}
    {% endfor %}
</ul>

为了重复使用宏,我们可以将其保存在单独的文件中,然后在需要使用的模板中导入:

{% import 'macros.html' as macros %}
<ul>
     {% for comment in comments %}
         {{ macros.render_comment(comment) }}
     {% endfor %}
</ul>

需要在多处重复使用的模板代码片段可以写入单独的文件,再包含在所有模板中,以避免 重复:

{% include 'common.html' %}

另一种重复使用代码的强大方式是模板继承,它类似于 Python 代码中的类继承。首先,创 建一个名为 base.html 的基模板:

<html>
<head>
    {% block head %}
    <title>{% block title %}{% endblock %} - My Application</title>
    {% endblock %}
</head>
<body>
    {% block body %}
    {% endblock %}
</body>
</html>

block 标签定义的元素可在衍生模板中修改。在本例中,我们定义了名为 head、title 和 body 的块。注意,title 包含在 head 中。下面这个示例是基模板的衍生模板:

{% extends "base.html" %}
{% block title %}Index{% endblock %}
{% block head %}
     {{ super() }}
     <style>
     </style>
{% endblock %}
{% block body %}
<h1>Hello, World!</h1>
{% endblock %}

extends 指令声明这个模板衍生自 base.html。在 extends 指令之后,基模板中的 3 个块被 重新定义,模板引擎会将其插入适当的位置。注意新定义的 head 块,在基模板中其内容不 是空的,所以使用 super() 获取原来的内容。 稍后会展示这些控制结构的具体用法,让你了解一下它们的工作原理。

猜你喜欢

转载自blog.csdn.net/qq_39208536/article/details/83113506