编写html时继承模板报错编码,第3章 模板

要想开发出易于维护的程序，关键在于编写形式简洁且结构良好的代码。带目前为止，看到的示例都太简单，无法说明这一点，但Flask视图函数的两个完全独立的作用却被融合在了一起。这就产生了一个问题。

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

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

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

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

3.1 Jinja2模板引擎

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

3-1 templates/index.html ：Jinja2模板

Hello World

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

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

Hello,{{name}}!

3.1.1 渲染模板

默认情况下，Flask在程序文件夹中的templates子文件夹中寻找模板。在下一个hello.py版本中，要把前面定义的模板保存在templates文件夹中，并分贝命名为index.html和user.html。

程序中的视图函数需要修改一下，以便渲染这些模板，修改方法参见示例。

from flask import Flask

app = Flask(__name__)

from flask import Flask,render_template

#...

@app.route('/')

def index():

return render_template('index.html')

@app.route('/user/')

def user(name):

return render_template('user.html',name=name)

if __name__ =='__main__':

#app.run(debug=True)

app.run(debug=True)

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

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

如果你从GitHub上克隆了这个程序的git仓库，那么可以执行git checkout 3a 签出程序的这个版本。

3.1.2 变量

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

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

A value from a dictionary:{{mydict['key']}}.

A value from a list:{{mylist[3]}}.

A value from a list,with a varbale index:{{mylist[myuntval]}}.

A value from an object`s method:{{myobj.somemethod()}}.

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

hello，{{name|capitalize}}

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

表3-1 Jinja2变量过滤器

过滤名

说明

safe

渲染值时不转义

capitalize

把值得首字母转换成大写，其他字母转换成小写

lower

把值转换成小写形式

upper

把值转换成大写形式

title

把值中每个单词的首字母都转换成大写

trim

把值得首尾空格去掉

striptags

渲染之前把值中所有的HTML标签都删掉

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

hello

',Jinja2会将其渲染成'

Hello

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

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

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

3.1.3 控制结构

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

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

{% if user %}

Hello, {{ name }}!

{% else %}

hello,Stranger!

{% endif %}

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

{% for comment in comments %}

{{ comment }}

{% endfor %}

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

{% macro render_comment(comment) %}

{{ comment }}

{% endmacro %}

{% for comment in comments %}

{{ render_comment(comment) }}

{% endfor %}

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

{% import 'macros.html' as macros %}

{% for comment in comments %}

{{ macros.render_comment(comment) }}

{% endfor %}

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

{% include 'common.html' %}

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

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

{% extends "base.html" %}

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

{% block head %}

{{ super() }}

{% endblock %}

{% block body %}

Hello, World!

{% endblock %}

extends指令声明这个模板衍生自base.html。在extends指令之后，基模板中的3个块被重新定义，模板引擎会将其插入适当的位置，注意新定义的head块，在基模板中其内容不是空的，所以使用super()获取原来的内容。

稍后会展示这些控制结构的具体用法，让你了解一下他们的工作原理。

3.2使用flask-Bootstrap继承Twitter Bootstrap

bootstrap是twitter开发的一个开源框架，它提佛那个的用户界面组件可用于创建整洁且具有吸引力的网页，而且这些网页还能兼容所有现代Web浏览器。

Bootstrap是客户端框架，因此不会直接涉及服务器，服务器需要做的只是提供引用了bootstrap层叠样式表css和JavaScript文件的html响应，并在html、css和JavaScript代码中实例化所需组件，这些操作最理想的执行场所就是模板。

要想在程序中集成bootstrap，显然要对模板做所有有必要的改动，不过，更简单的方法是使用一个名为flask-Bootstrap的flask扩展，简化集成的过程，Flask-Bootstrap使用pip安装：

(venv) pip install flask-bootstrap

Flask扩展一般都在创建程序实例时初始化，示例3-4是flask-Bootstrap的初始化方法。

示例3-4 hello.py 初始化Flask-BootStrap

from flask.ext.bootstrap import Bootstrap

#...

bootstrap = Bootstrap(app)

flask.ext.bootstrap这个代码会报错 改为 flask_bootstrap

初始化flask-bootstrap之后，就可以在程序中使用一个包含所有BootStrap文件的基模板。这个模板利用Jinja2的模板继承机制，让程序扩展一个具有基本页面结构的及模板，其中就有用来引入Bootstrap的元素，示例3-5就是吧user.html改写为衍生模板后的新版本。

示例3-5 templates/user.html：使用 Flask-Bootstrap 的模板

{% extends "bootstrap/base.html" %}

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

{% block navbar %}

data-toggle="collapse" data-target=".navbar-collapse">

Toggle navigation

Flasky

• Home

{% endblock %}

{% block content %}

Hello, {{ name }}!

{% endblock %}

样式

Jinja2 中的 extends 指令从 Flask-Bootstrap 中导入bootstrap/base.html，从而实现模板继承。Flask-Bootstrap 中的基模板提供了一个网页框架，引入了 Bootstrap 中的所有 CSS 和JavaScript 文件。

基模板中定义了可在衍生模板中重定义的块。block 和endblock 指令定义的块中的内容可添加到基模板中。

上面这个 user.html 模板定义了 3 个块，分别名为 title、navbar 和 content。这些块都是基模板提供的，可在衍生模板中重新定义。title 块的作用很明显，其中的内容会出现在渲染后的 HTML 文档头部，放在

标签中。navbar 和 content 这两个块分别表示页面中的导航条和主体内容。

在这个模板中，navbar块使用BootStrap组件定义了一个简单的导航条，content块中有个

容器，起哄包含一个页面头部。之前版本的模板中欢迎信息，现在就放在这个页面头部。改动之后的程序如图3-1所示。

如果你从github上克隆了这个程序的git仓库，那么可以执行git checkout 3b签出程序的这个版本。Bootstrap官方文档是很好的学习资源，由很多可以直接复制黏贴的示例。

Twitter Bootstrap模板

Flask-Bootstrap的base.html模板还定义了很多其他块，都可在衍生模板中使用，表3-2列出了所有可用的块。

表3-2 Flask-BootStrap基模板中定义的块

块名

说明

doc

整个html文档

html_attribs

标签的属性

html

标签中的内容

head

title

标签中的内容

metas

一组标签

styles

层叠样式表定义

body_attribs

标签的属性

body

navbar

用户定义的导航条

content

用户定义的页面内容

scripts

文档底部的JavaScript声明

表3-2中的很多块都是Flask-Bootstrap自用的，如果直接重定义可能会导致一些问题。例如，Bootstrap所需的文件在styles和scripts块中声明。如果程序需要向已经有内容的块中的添加新内容，必须使用Jinja2提供的super()函数，例如，如果要在衍生模板中添加的新的javascript文件，需要这么定义scripts块：

{% block scripts %}

{{ super() }}

{% endblock %}

3.3自定义错误页面

如果你在浏览器的地址栏中输入不可用的路由，那么会显示一个状态码为404的错误页面，现在这个错误页面太简陋、平庸，而且样式和使用了Bootstrap的页面不一致。

像常规路由一样，Flask允许程序使用基于模板的自定义错误页面。最常见的错误代码有两个：404,客户端请求未知页面或路由时显示；500，有未处理的异常时显示。为这两个错误代码指定自定义处理程序的方式如示例3-6所示。

示例3-6 hello.py 自定义错误页面

@app.errorhandler(404)

def page_not_found(e):

return render_template('404.html'),404

@app.errorhandler(500)

def internal_server_error(e):

return render_template('500.html'),500

和视图函数一样，错误处理程序也会返回响应，他们还返回与该错误对应的数字状态码。

错误处理程序中引用的模板也需要编写。这些模板应该和常规页面使用相同的布局，因此要有一个导航条和显示错误消息的页面头部。

编写这些模板最直观的方法是复制templates/user.html，分别创建templates/404.html和templates/500.html，然后把这两个文件中的页面头部元素改为相应的错误消息，但这种方法会带来很多重复劳动。

Jinja2的模板继承机制可以帮助我们解决这一问题，Flask-bootstrap提供了一个具有页面基本布局的基模板，同样，程序可以定义一个具有完整页面布局的基模板，其中包含导航条，而页面内容则可留到衍生模板中定义，示例3-7展示了templates/base.html的内容，这是一个继承自Bootstrap/base.html的新模板，其中定义了导航条。这个模板本身也可作为其他模板的基模板，例如templates/user.html、templates/404.html和templates/500.html

示例3-7 templates/base.html：包含导航条的程序基模板

{% extends "bootstrap/base.html" %}

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

{% block navbar %}

data-toggle="collapse" data-target=".navbar-collapse">

Toggle navigation

Flasky

• Home

{% endblock %}

{% block content %}

{% block page_content %}{% endblock %}

{% endblock %}

这个模板的content块中只有一个

容器，其中包含了一个名为page_content的新的空块，块中的内容由衍生模板定义。

现在，程序使用的模板继承自这个模板，而不直接继承自Flask-Bootstrap的基模板。通过继承templates/base.html模板编写编写自定义的404错误页面很简单，如示例3-8所示。

示例3-8 templates/404.html：使用模板继承机制自定义404错误页面

{% extends 'base.html' %}

{% block title %}Flasy - page Not Found{% endblock %}

{% block page_content %}

Not Found

{% endblock %}

404页面

templates/user.html现在可以通过继承这个基模板简化内容，如示例3-9所示。

示例3-9 templates/user.html使用模板继承机制简化页面模板

3.4 链接

任何具有多个路由的程序都需要可以链接不同页面的链接，例如导航条

在模板中知己编写简单路由的URL链接不难，但对于包含可变部分动态路由，在模板中构建正确的URL就很困难，而且，直接编写URL会对代码中定义的路由产生不必要的依赖关系。如果重新定义路由，模板中的链接可能会失效。

为了避免这些问题，Flask提供了url_for()辅助函数，它可以使用程序URL映射保存的信息生成URL。

url_for()函数最简单的用法是以视图函数名(或者 app.add_url_route()定义路由时使用的端点名)作为参数，返回对应的URL。例如在当前版本的hello.py程序中调用url_for('index')得到的结果是/。调用url_for('index',_external=True)返回的则是绝对地址，在这个示例中是http://localhost:5000/。

生成链接程序内不同路由的连接时，使用相对地址就足够了。如果要生成在浏览器之外使用的链接，则必须使用绝对地址，例如在电子邮件中发送的链接。

使用url_for()生成动态地址时，将动态部分作为关键字参数传入，例如，url_for('user',name='john',_external=True)的返回结果就是http://localhost:5000/user/jhon

传入url_for()的关键字参数不仅限于动态路由中的参数，函数能将任何额外参数添加到查询字符串中，例如url_for(‘index’，page=2)的返回结果是/?page=2.

3.5 静态文件

web程序不是仅由Python代码和模板组成，大多数程序还会使用静态文件，例如HTML代码中引用的图片、JavaScript源码文件和CSS。

你可能还记得在第2章检查hello.py程序和URL映射时，其中有一个static路由。这是因为对静态文件的引用被当成一个特殊的路由，即/static/。例如，调用url_for('static',filename='css/style.css',_external=True)得到的结果是http://localhost:5000/static/css/styles.css。

默认设置下，Flask在程序根目录中名为static的子目录中寻找静态文件，如果需要，可在static文件夹中使用子文件夹存放文件，服务器搜到前面那个URL后，会生成一个响应，包含文件系统中static/css/style.css文件的内容。

示例3-10展示了如何在程序的基模板中放置favicon.ico图标。这个图标会显示在浏览器的地址栏中。

示例3-10 templates/base.html定义收藏夹图标：

{%block head%}

{{super()}}

type="image/x-icon">

{% endblock %}

这里的static表示在根目录下static的文件夹下面

图标的声明会插入head块的末尾，注意如何使用super()保留基模板中定义的块的原始内容。

3.6 使用Flask-Moment本地化日期和时间

如果Web程序的用户来自世界各地，那么处理日期和时间可不是一个简单的任务。服务器需要统一时间单位，这和用户所在的地理位置无关，所有一般使用协调时间时，不过用户看到UTC格式的时间会感到困惑，他们更希望看到当地时间，而且采用当地惯用的格式。

要想在服务器上只使用UTC时间，一个优雅的解决方案是，把时间单位发送给Web浏览器，转换成当地时间，然后渲染。Web浏览器可以更好地完成这一任务。因为它能获取用户电脑中的时区和区域设置。

有一个使用JavaScript开发的优秀客户端开源代码库，名为moment.js(http://momentjs.com)它可以在浏览器中渲染日期和时间，flask-Moment是一个Flask程序扩展，能把moment.js继承到Jinja2模板中，Flask-Moment可以使用pip安装：

(venv) pip install flask-moment

这个扩展初始化方法如示例3-11所示。

示例3-11 hello.py初始化Flask-Moment

from flask_moment import Moment

moment = Moment(app)

除了moment.js，Flask-Moment还依赖jquery.js。要在html文档的某个地方引入这两个库，可以直接引入。这样可以选择使用哪个版本，也可使用扩展提供的辅助函数，从内容分发网络中引入通过测试的版本。Bootstrap已经引入了jquery.js，因此只需引入moment.js即可。示例3-12展示了如何在基模板的scripts块中引入这个库。

#示例3-12 templates/base.html: 引入moment.js

{% block script %}

{{suer()}}

{{moment.include_moment()}}

{%endblock%}

为了处理时间戳，Flask-Moment向模板开放了moment类。示例3-13中的代码把变量current_time传入模板进行渲染。

示例3-13 hello.py 加入一个datetime变量

from datetime import datetime

@app.route('/')

def index():

return render_template('index.html',current_time= datetime.utcnow())

接下来的代码展示如何渲染current_time

代码3-14 templates/index.html：使用 Flask-Moment 渲染时间戳

The local date and time is {{ moment(current_time).format('LLL') }}.

That was {{ moment(current_time).fromNow(refresh=True) }}

format('LLL')根据客户端电脑中的时区和区域设置渲染日期和时间。参数决定了渲染的方式，'L'到'LLL'分别对应不同的复杂度。format()函数还可接收自定义的格式说明符。

第二行中的fromNow()渲染相对时间戳，而且会随着时间的推移自动刷新显示时间。这个时间戳最开始显示未 a few seconds ago 但制定refresh参数后，其内容会随着时间的推移而更新。如果一直待在这个页面，几分钟后，会看到显示的文本变成 a minute ago ‘ 2 minutes ago’等。

Flask-Moment实现了moment.js中的format()、fromNow()、fromTime()、calendar()、valueOf()和unix()方法。可查阅资料学习moment.js提供的全部格式选项。

Flask-Moment渲染的时间戳可实现多种语言的本地化，语言可在模板中选择，把语言代码传给lang()函数即可：

{{moment.lang('es')}}

使用本章介绍的技术，应该能为程序编写出现代话且用户友好的网页，下一章介绍本章么有涉及的一个模板功能，即如何通过Web表单和用户交互。