【Chapter 3】模板
模板是一个包含响应文本的文件，其中个包含用站位变量表示的动态部分，其具体值只在请求的上下文中才能知道。
渲染是一个使用真实值替换变量，在返回最终得到的响应字符串的过程。
Jinja2 是一个强大模板引擎用来渲染模板。
3.1 Jinja2 模板引擎
3.1.1 渲染模板
默认情况下，Flask 在程序文件夹中的 templates 子文件夹中寻找模板。在下一个 hello.py 版本中，要把前面定义的模板保存在 templates 文件夹中，并分别命名为 index.html 和 user.html。
templates\index.html
<h1>
Hello World
</h1>
templates\user.html
{# {{ name }} 表示一种变量，模板中的占位符 #}
<h1>Hello,{{ name }}!</h1>
hello.py：渲染模板
from flask import Flask,render_template
# 1.初始化 Flask 对象
app = Flask(__name__)
# manager = Manager(app)
# 2. 设置路由和视图函数
@app.route('/')
def index():
# return '<h1>Hello World!<h1>'
return render_template('index.html')
@app.route('/user/<name>')
def user(name):
# return '<h1>Hello,%s!<h1>' % name
return render_template('user.html',name=name)
# 3.启动服务
if __name__ == '__main__':
app.run(debug=True)
# manager.run()
Flask 提供的 render_template 函数吧 Jinja2 模板引擎集成到了程序中。render_template 函数的第一个参数是模板的文件名，随后的参数都是键值对，表示模板中变量对应的真实值。在这段代码中，第二个参数收到一个名为 name 的变量。
3.1.2 变量
Jinja2 能识别所有类型的变量,甚至是一些复杂的类型,例如列表、字典和对象。
Jinja2 可以使用过滤器修改变量，过滤器名添加在变量名之后，中间使用竖线分割。
例如，下述模板以首字母大写形式显示变量 name 的值：
Hello,{{ name|capitalize }}
Jinja2 变量过滤器
safe 过滤器，默认情况下，出于安全考虑，Jinja2 会转义所有变量。
例 如，如果一个变量的值为 '<h1>Hello</h1>'，Jinja2 会将其渲染成 '<h1>Hello</ h1>'，浏览器能显示这个 h1 元素，但不会进行解释。很多情况下需要显示变量中存储 的 HTML 代码，这时就可使用 safe 过滤器。
3.1.3 控制结构
在模板中使用条件控制语句：
{% 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>{{ render_comment(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 'comment.html' %}
另一种重复使用代码的强大方式是模板继承，它类似于 Python 代码中的类继承。首先，创 \建一个名为 base.html 的基模板：
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<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() 获取原来的内容。
3.2 使用 Flask-Bootstrap 集成 Twiitter Bootstrap
Bootstrap 是 Twitter 开发的一个开源框架，它提供的用户界面组 件可用于创建整洁且具有吸引力的网页，而且这些网页还能兼容所有现代 Web 浏览器。
要想在程序中集成 Bootstrap，显然要对模板做所有必要的改动。不过，更简单的方法是使用一个名为 Flask-Bootstrap 的 Flask 扩展，简化集成的过程。Flask-Bootstrap 使用 pip 安装：
(venv) C:\Users\76152\Desktop\PyProjects\flask\flasky>pip install flask-bootstrap
hello.py 初始化 Flask-Bootstrap
from flask_bootstrap import Bootstrap
#...
#初始化 Flask-Bootstrap
bootstrap = Bootstrap(app)
初始化 Flask-Bootstrap 之后，就可以在程序中使用一个包含所有 Bootstrap 文件的基模板。 这个模板利用 Jinja2 的模板继承机制，让程序扩展一个具有基本页面结构的基模板，其中就有用来引入 Bootstrap 的元素。
templates/user.html：使用 Flask-Bootstrap 的模板
{% extends "bootstrap/base.html" %}
{% block title %}Flasky{% endblock %}
{% block navbar %}
<div class="navbar navbar-inverse" role="navigation">
<div class="container">
<div class="nav-header">
<button type="button" class="navbar-toggle"
data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">Flasky</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="/">Home</a></li>
</ul>
</div>
</div>
</div>
{% endblock %}
{% block conntent %}
<div class="container">
<div class="page-header">
<h1>Hello,{{ name|capitalize }}!</h1>
</div>
</div>
{% endblock %}
Jinja2 中的 extends 指令从Flask-Bootstrap 中导入bootstrap/base.html，从而实现模板继承。Flask-Bootstrap 中的基模板提供了一个网页框架，引入了 Bootstrap 中的所有 CSS 和 JavaScript 文件。
基模板中定义了可在衍生模板中重定义的块。block 和 endblock 指令定义的块中的内容可 添加到基模板中。
上面这个 user.html 模板定义了3 个块，分别名为 title、navbar 和 content。这些块都是基模板提供的，可在衍生模板中重新定义。title 块的作用很明显，其中的内容会出现在渲染后的 HTML 文档头部，放在 <title> 标签中。navbar 和 content 这两个块分别表示页面中的导航条和主体内容。
在这个模板中，navbar 块使用 Bootstrap 组件定义了一个简单的导航条。content 块中有个 <div> 容器，其中包含一个页面头部。之前版本的模板中的欢迎信息，现在就放在这个页面头部。改动之后效果如下：
Flask-Bootstrap 的 base.html 模板还定义了很多其他块，都可在衍生模板中使用。
Flask-Bootstrap基模板中定义的块
表中的很多块都是 Flask-Bootstrap 自用的，如果直接重定义可能会导致一些问题。例 如，Bootstrap 所需的文件在 styles 和 scripts 块中声明。如果程序需要向已经有内容的块 中添加新内容，必须使用 Jinja2 提供的 super() 函数。例如，如果要在衍生模板中添加新 的 JavaScript 文件，需要这么定义 scripts 块：
{% block scripts %}
{{ super() }}
<script type="text/javascript" src="my-script.js"></script>
{% endblock %}
3.3 自定义错误页面
如果你在浏览器的地址栏中输入了不可用的路由，那么会显示一个状态码为 404 的错误页 面。现在这个错误页面太简陋、平庸，而且样式和使用了 Bootstrap 的页面不一致。
最常见的错误代码有 两个：404，客户端请求未知页面或路由时显示；500，有未处理的异常时显示。
hello.py：自定义错误页面
@app.errorhandler(404)
def page_not_found(e):
return render_template('404.html'),404
@app.errorhandler(500)
def page_not_found(e):
return render_template('500.html'),500
和视图函数一样，错误处理程序也会返回响应。它们还返回与该错误对应的数字状态码。
错误处理程序中引用的模板也需要编写。这些模板应该和常规页面使用相同的布局，因此 要有一个导航条和显示错误消息的页面头部。
编写这些模板最直观的方法是复制 templates/user.html，分别创建 templates/404.html 和 templates/500.html，然后把这两个文件中的页面头部元素改为相应的错误消息。
templates/base.html：包含导航条的程序基模板
{% extends "bootstrap/base.html" %}
{% block title %}Flasky{% endblock %}
{% block navbar %}
<div class="navbar navbar-inverse" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">Flasky</a></div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="/">Home</a></li>
</ul>
</div>
</div>
</div> {% endblock %}
{% block content %}
<div class="container">
{% block page_content %}{% endblock %}
</div>
{% endblock %}
这个模板的 content 块中只有一个 <div> 容器，其中包含了一个名为 page_content 的新的 空块，块中的内容由衍生模板定义。
现在，程序使用的模板继承自这个模板，而不直接继承自 Flask-Bootstrap 的基模板。通过 继承 templates/base.html 模板编写自定义的 404 错误页面很简单。
404.html
{% extends "base.html" %}
{% block title %}Flasky - Page Not Found{% endblock %}
{% block page_content %}
<div class="page-header">
<h1>Not Found</h1>
</div>
{% endblock %}
继承 base.html 简化后的 user.html
{% extends "base.html" %}
{% block title %}Flasky{% endblock %}
{% block page_content %}
<div class="page-header">
<h1>Hello,{{ name|capitalize }}!</h1>
</div>
{% endblock %}
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/john。
传入 url_for() 的关键字参数不仅限于动态路由中的参数。函数能将任何额外参数添加到 查询字符串中。例如，url_for('index', page=2) 的返回结果是 /?page=2。
3.5 静态文件
Web 程序不是仅由 Python 代码和模板组成。大多数程序还会使用静态文件，例如 HTML 代码中引用的图片、JavaScript 源码文件和 CSS。
默认设置下，Flask 在程序根目录中名为 static 的子目录中寻找静态文件。如果需要，可在 static 文件夹中使用子文件夹存放文件。服务器收到前面那个 URL 后，会生成一个响应，包含文件系统中 static/css/styles.css 文件的内容。
{% block head %}
{{ super() }}
<link rel="shortcut icon" href="{{ url_for('static',filename='favicon.ico') }}" type="image/x-icon">
<link rel="icon" href="{{ url_for('static',filename='favicon.ico') }}" type="image/x-icon">
{% endblock %}
3.6 使用 Flask-Moment 本地化日期和时间
服务器需要统一时间单位，这和用户所在的地理位置无关，所以一般使用协调世界时 （Coordinated Universal Time，UTC）。不过用户看到 UTC 格式的时间会感到困惑，他们更希望看到当地时间，而且采用当地惯用的格式。
要想在服务器上只使用 UTC 时间，一个优雅的解决方案是，把时间单位发送给 Web 浏览 器，转换成当地时间，然后渲染。Web 浏览器可以更好地完成这一任务，因为它能获取用 户电脑中的时区和区域设置。
有一个使用JavaScript 开发的优秀客户端开源代码库，名为 [moment.js](http://momentjs. com/)，它可以在浏览器中渲染日期和时间。Flask-Moment 是一个Flask 程序扩展，能把 moment.js 集成到 Jinja2 模板中。
(venv) C:\Users\76152\Desktop\PyProjects\flask\Myflasky>pip install flask-moment
hello.py 初始化 Flask-Moment
from flask_moment import Moment
#初始化 Flask-Moment
moment = Moment(app)
base.html 引入 moment.js 库
{% block scripts %}
{{ super() }}
{{ moment.include_moment() }}
{% endblock %}
hello.py 加入一个 datetime 变量
from datetime import datetime
def index():
# return '<h1>Hello World!<h1>'
return render_template('index.html',
current_time = datetime.utcnow())
修改 index.html: 使用 Flask-Moment 渲染时间戳
{% extends "base.html" %}
{% block title %}Flasky{% endblock %}
{% block page_content %}
<div class="page-header">
<h1>Hello World!</h1>
</div>
<p>The local date and time is {{ moment(current_time).format('LLL') }}.</p>
<p>That was {{ moment(current_time).fromNow(refresh=True) }}.</p>
{% endblock %}
format('LLL') 根据客户端电脑中的时区和区域设置渲染日期和时间。参数决定了渲染的方式，'L' 到 'LLLL' 分别对应不同的复杂度。format() 函数还可接受自定义的格式说明符。
第二行中的 fromNow() 渲染相对时间戳，而且会随着时间的推移自动刷新显示的时间。这 个时间戳最开始显示为“a few seconds ago”，但指定 refresh 参数后，其内容会随着时间的推移而更新。如果一直待在这个页面，几分钟后，会看到显示的文本变成“a minute ago”“ 2 minutes ago”等。
最终效果:
几分钟后
网友评论