Flask【模板总结】

 

模板

在前面的示例中，视图函数的主要作用是生成请求的响应，这是最简单的请求。实际上，视图函数有两个作用：处理业务逻辑和返回响应内容。在大型应用中，把业务逻辑和表现内容放在一起，会增加代码的复杂度和维护成本。本节学到的模板，它的作用即是承担视图函数的另一个作用，即返回响应内容。 模板其实是一个包含响应文本的文件，其中用占位符（变量）表示动态部分，告诉模板引擎其具体值需要从使用的数据中获取。使用真实值替换变量，再返回最终得到的字符串，这个过程称为“渲染”。Flask使用Jinja2这个模板引擎来渲染模板。Jinja2能识别所有类型的变量，包括{}。 Jinja2模板引擎，Flask提供的render_template函数封装了该模板引擎，render_template函数的第一个参数是模板的文件名，后面的参数都是键值对，表示模板中变量对应的真实值。

Jinja2官方文档（http://docs.jinkan.org/docs/jinja2/）

flask框架会自动创建一个static文件夹,与应用的文件同目录

模板的基本语法：

<p>{% for i in name %}</p>
<p>{{i}}</p>
<p>{% endfor %}</p>

模板的简单使用：

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

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

变量

在模板中{{ variable }}结构表示变量，是一种特殊的占位符，告诉模板引擎这个位置的值，从渲染模板时使用的数据中获取；Jinja2除了能识别基本类型的变量，还能识别{}；

<p>{% for i in user_list %}</p>
<!--循环列表-->
<p>{{i}}</p> 
<p>{% endfor %}</p>
<hr>


<p>{% for i in user_dict %}</p>
<!--循环字典，循环到的元素为键-->
<p>{{user_dict[i]}}</p>
<p>{% endfor %}</p>

<!--获取下表元素-->
{{user_list[1]}}　

反向路由：

Flask提供了url_for()辅助函数，可以使用程序URL映射中保存的信息生成URL；url_for()接收视图函数名作为参数，返回对应的URL；

如调用url_for('index',_external=True)返回的是绝对地址，

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

@app.route('/user/')
def redirect():
    return url_for('index',_external=True)

自定义错误页面：

from flask import Flask,render_template

@app.errorhandler(404)
def page_not_found(e):
    return render_template('404.html'), 404　

 过滤器：

过滤器的本质就是函数。有时候我们不仅仅只是需要输出变量的值，我们还需要修改变量的显示，甚至格式化、运算等等，这就用到了过滤器。 过滤器的使用方式为：变量名 | 过滤器。 过滤器名写在变量名后面，中间用 | 分隔。如：{{variable | capitalize}}，这个过滤器的作用：把变量variable的值的首字母转换为大写，其他字母转换为小写。 其他常用过滤器如下：

safe：禁用转义；

  <p>{{ '<em>hello</em>' | safe }}</p>

capitalize：把变量值的首字母转成大写，其余字母转小写；

  <p>{{ 'hello' | capitalize }}</p>

lower：把值转成小写；

  <p>{{ 'HELLO' | lower }}</p>

upper：把值转成大写；

  <p>{{ 'hello' | upper }}</p>

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

  <p>{{ 'hello' | title }}</p>

trim：把值的首尾空格去掉；

  <p>{{ ' hello world ' | trim }}</p>

reverse:字符串反转；

  <p>{{ 'olleh' | reverse }}</p>

format:格式化输出；

  <p>{{ '%s is %d' | format('name',17) }}</p>

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

  <p>{{ '<em>hello</em>' | striptags }}</p>

语句块过滤(不常用)：

  {% filter upper %}
    this is a Flask Jinja2 introduction
  {% endfilter %}

自定义过滤器：

通过Flask应用对象的add_template_filter方法，可以注册自己的过滤器。该函数的第一个参数是过滤器函数，第二个参数是过滤器名称。然后，在模板中就可以使用自定义的过滤器。

def filter_double_sort(ls):
    return ls[::2]
app.add_template_filter(filter_double_sort,'double_2')

Web表单：

web表单是web应用程序的基本功能。

它是HTML页面中负责数据采集的部件。表单有三个部分组成：表单标签、表单域、表单按钮。表单允许用户输入数据，负责HTML页面数据采集，通过表单将用户输入的数据提交给服务器。

在Flask中，为了处理web表单，我们一般使用Flask-WTF扩展，它封装了WTForms，并且它有验证表单数据的功能。

WTForms支持的HTML标准字段

 

WTForms常用验证函数

验证函数	说明
DataRequired	确保字段中有数据
EqualTo	比较两个字段的值，常用于比较两次密码输入
Length	验证输入的字符串长度
NumberRange	验证输入的值在数字范围内
URL	验证URL
AnyOf	验证输入值在可选列表中
NoneOf	验证输入值不在可选列表中

使用Flask-WTF需要配置参数SECRET_KEY。

CSRF_ENABLED是为了CSRF（跨站请求伪造）保护。 SECRET_KEY用来生成加密令牌，当CSRF激活的时候，该设置会根据设置的密匙生成加密令牌。

 代码实现

视图函数

# coding:utf-8
from flask import Flask, render_template, request

# 导入wtf扩展
from flask_wtf import FlaskForm
# 导入表单的类型,文本/密码/按钮
from wtforms import SubmitField, StringField, PasswordField
# 导入验证器
from wtforms.validators import DataRequired, EqualTo
# 自定义表单类,需集成FlaskForm
class Form(FlaskForm):
    name = StringField(label='用户:', validators=[DataRequired()])
    pwd1 = PasswordField(label='密码:', validators=[DataRequired(), EqualTo('pwd2')])
    pwd2 = PasswordField(label='密码确认', validators=[DataRequired()])
    sub = SubmitField(u'提交')

# 使用wtf扩展的流程：
    # 导入wtf的FlaskForm类，导入表单字段类型，验证器
    # 自定义表单类
    # 在视图函数中创建表单对象
    # 使用表单验证方法表单对象


app = Flask(__name__)

# 设置csrf防御
app.config['SECRET_KEY'] = 'hello kay'


@app.route('/login/', methods=['GET', 'POST'])
def register():
    # 创建表单对象
    form = Form()
    # 调用表单验证器,它的执行过程是依次调用表单类中的验证器
    # 验证输入数据是否符合要求，符合要求返回值为True，否则False
    print form.validate_on_submit()
    if form.validate_on_submit():
        us = form.name.data
        ps1 = form.pwd1.data
        ps2 = form.pwd2.data
        print us, ps1, ps2
    return render_template('login.html', form=form)
if __name__ == '__main__':
    app.run(debug=True)

模板代码

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>login</title>
</head>
<body>

<form method="post">
    <p>{{ form.csrf_token() }}</p>
    <p>{{form.name}}</p>
    <p>{{form.pwd1}}</p>
    <p>{{form.pwd2}}</p>
    <p>{{form.sub}}</p>
</form>

</body>
</html>

在没有使用wtf表单时，发起post请求后，服务器端的获取参数的方法

# POST请求时：从请求对象中获取请求数据的方法
@app.route('/login/', methods=["GET", "POST"])
def register():
    if request.method == 'POST':
        user_name = request.form['username']
        password = request.form['password']
        print user_name, password
    return render_template('login.html')

宏、继承、包含

宏

定义宏

{% macro input() %}
<input type="text" name="username" value="User" size="30">
{% endmacro %}

调用宏

{{ input() }}

定义带参数的宏

<!--带有参数的宏-->

{% macro args_input(name, value='', type='text', size=30) %}
<input type="{{ type }}" name="{{ name }}" value="{{ value }}" size="{{ size }}">
{% endmacro %}


{{ args_input(name='password',value='Pwsd',type='password',size=60) }}

将宏抽取出来

{% macro base_macro() %}
<input type="submit">
{% endmacro %}

其他文件使用宏

# 导入
{% import 'baseMacro.html' as fun %}
# 使用
{{ fun.base_macro() }}

包含

Jinja2模板中，除了宏和继承，还支持一种代码重用的功能，叫包含(Include)。它的功能是将另一个模板整个加载到当前模板中，并直接渲染。

 

包含在使用时，如果包含的模板文件不存在时，程序会抛出TemplateNotFound异常，可以加上ignore missing关键字。如果包含的模板文件不存在，会忽略这条include语句。

include的使用：

{% include '404.html' %}

include的使用加上关键字ignore missing：

{% include '40f4.html' ignore missing%}

宏、继承、包含：

• 宏(Macro)、继承(Block)、包含(include)均能实现代码的复用。
• 继承(Block)的本质是代码替换，一般用来实现多个页面中重复不变的区域。
• 宏(Macro)的功能类似函数，可以传入参数，需要定义、调用。
• 包含(include)是直接将目标模板文件整个渲染出来。

Flask中的特殊变量和方法：

在Flask中，有一些特殊的变量和方法是可以在模板文件中直接访问的。

config 对象:

config 对象就是Flask的config对象，也就是 app.config 对象。

{{ config.SQLALCHEMY_DATABASE_URI }}

request 对象:

就是 Flask 中表示当前请求的 request 对象，request对象中保存了一次HTTP请求的一切信息。

request常用的属性如下：

 

属性	说明	类型
data	记录请求的数据，并转换为字符串	*
form	记录请求中的表单数据	MultiDict
args	记录请求中的查询参数	MultiDict
cookies	记录请求中的cookie信息	Dict
headers	记录请求中的报文头	EnvironHeaders
method	记录请求使用的HTTP方法	GET/POST
url	记录请求的URL地址	string
files	记录请求上传的文件	*

url_for 方法:

url_for() 会返回传入的路由函数对应的URL，所谓路由函数就是被 app.route() 路由装饰器装饰的函数。如果我们定义的路由函数是带有参数的，则可以将这些参数作为命名参数传入。

{{ url_for('index') }}

{{ url_for('post', post_id=1024) }}