Python---Flask--02--模板

时间 2019-12-13

原文原文链接

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

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

Flask 默认的模板文件存放在templates目录下面。html

建立模板

建立teamplates/index.html模板java

<h1>Hello Flask</h1>

建立teamplate/user.html模板python

<h1>{{ name }}</h1>

渲染模板

from flask import Flask, render_template

app = Flask(__name__)

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

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


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

模板变量

在模板中使用的 {{ 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 的值：flask

Hello, {{ name|capitalize }}

列出了 Jinja2 提供的部分经常使用过滤器。
Jinja2变量过滤器bootstrap

过滤器名	说　　明
safe	渲染值时不转义
capitalize	把值的首字母转换成大写，其余字母转换成小写
lower	把值转换成小写形式
upper	把值转换成大写形式
title	把值中每一个单词的首字母都转换成大写
trim	把值的首尾空格去掉
striptags	渲染以前把值中全部的 HTML 标签都删掉
safe	过滤器值得特别说明一下。默认状况下，出于安全考虑，Jinja2 会转义全部变量。例

如，若是一个变量的值为 '<h1>Hello</h1>'，Jinja2 会将其渲染成 '<h1>Hello</
h1>'，浏览器能显示这个 h1 元素，但不会进行解释。不少状况下须要显示变量中存储
的 HTML 代码，这时就可以使用 safe 过滤器。api

控制结构

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() 获取原来的内容。稍后会展现这些控制结构的具体用法，让你了解一下它们的工做原理。

使用Flask_bootstrap 扩展

Bootstrap（http://getbootstrap.com/）是 Twitter 开发的一个开源框架，它提供的用户界面组件可用于建立整洁且具备吸引力的网页，并且这些网页还能兼容全部现代 Web 浏览器。
Bootstrap 是客户端框架，所以不会直接涉及服务器。服务器须要作的只是提供引用了Bootstrap 层叠样式表（CSS）和 JavaScript 文件的 HTML 响应，并在 HTML、CSS 和JavaScript 代码中实例化所需组件。这些操做最理想的执行场所就是模板。
要想在程序中集成 Bootstrap，显然要对模板作全部必要的改动。不过，更简单的方法是使用一个名为 Flask-Bootstrap 的 Flask 扩展，简化集成的过程。

安装

pip install flask_bootstrap

使用

初始化Flask_bootstrap

from flask import Flask
from flask_bootstrap import Bootstrap

app = Flask(__name__)
bootstarp = Bootstrap(app)

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="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">
 <div class="page-header">
 <h1>Hello, {{ name }}!</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 文档头部，放在标签中。navbar 和 content 这两个块分别表示页
面中的导航条和主体内容。
在这个模板中，navbar 块使用 Bootstrap 组件定义了一个简单的导航条。content 块中有个

容器，其中包含一个页面头部。以前版本的模板中的欢迎信息，如今就放在这个页面头部。

Flask-Bootstrap 的 base.html 模板还定义了不少其余块，均可在衍生模板中使用。表 3-2 列
出了全部可用的快。
Flask-Bootstrap基模板中定义的块
|块　　名| 说　　明|
|---|---|
|doc| 整个 HTML 文档|
|html_attribs| 标签的属性|
|html| 标签中的内容|
|head | 标签中的内容|
|title | 标签中的内容|
|metas| 一组标签|
|styles |层叠样式表定义|
|body_attribs| 标签的属性|
|body | 标签中的内容|
|navbar| 用户定义的导航条|
|content |用户定义的页面内容|
|scripts| 文档底部的 JavaScript 声明|
表中的不少块都是 Flask-Bootstrap 自用的，若是直接重定义可能会致使一些问题。例如，Bootstrap 所需的文件在 styles 和 scripts 块中声明。若是程序须要向已经有内容的块中添加新内容，必须使用 Jinja2 提供的 super() 函数。例如，若是要在衍生模板中添加新的 JavaScript 文件，须要这么定义 scripts 块：

{% block scripts %}
{{ super() }}
<script type="text/javascript" src="my-script.js"></script>

模板中的连接

任何具备多个路由的程序都须要能够链接不一样页面的连接，例如导航条。

在模板中直接编写简单路由的 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。

静态文件

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

这是由于对静态文件的引用被当成一个特殊的路由，即 /static/ 。例如，调用url_for('static', filename='css/styles.css', _external=True) 得到的结果是 http://localhost:5000/static/css/styles.css。

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

如何在程序的基模板中放置 favicon.ico 图标。这个图标会显示在浏览器的
地址栏中。
templates/base.html：定义收藏夹图标

{% 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 %}

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