使用Flask-WTF处理表单

WTForms 是一个使用 Python 编写的表单库， 它使得表单的定义、验证（服务器端） 和处理变得非常轻松。Flask-WTF 集成了 WTForms，使用它可以在 Flask 中更方便地使用 WTForms。Flask-WTF 集成了表单数据解析、CSRF保护、文件上传等功能。

1. 安装

	pip install flask-wtf
1

Flask-WTF使用程序密钥来对CSRF令牌进行签名，所以需要为程序设置密钥：

	app.secret key =’secret string’ 
1

2. 创建表单类

from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField, SubmitField
from wtforms.validators import DataRequired, Length

class LoginForm(FlaskForm):
    username = StringField('Username', validators=[DataRequired()], render_kw={"placeholder":"hello"})
    password = PasswordField('Password', validators=[DataRequired(), Length(8,128)])
    submit = SubmitField('Login')
1
2
3
4
5
6
7
8

每个表单类必须继承自FlaskForm, 其中StringField等为表单中具体的字段，每个字段常用参数如下：

3. 在模板中渲染表单

3.1 传入表单实例

from forms import LoginForm

@app.route('/login', methods=['GET', 'POST'])
def login():
    form = LoginForm()
    # form.validate()用来验证用户输入的数据是否符合之前validators中给出的要求
    # 也可用 form.validate_on_submit()代替下面的条件
    if request.method == 'POST' and form.validate():
        ... # 处理POST请求
    return render_template('login.html', form=form)
1
2
3
4
5
6
7
8
9
10

除了 POST 方法，如果请求的方法是 PUT、 PATCH 和 DELETE 方法， form.validate_on_ submit()也会验证表单数据。在这里不用带心会相应PUT方法，因为在methods中规定了只响应GET和POST方法。

3.2 在模板中渲染表单

<form method="post"> 
    {{ form.csrf_token }} <!-- CSRF令牌隐藏字段 -->

     {{ form.username.label }} 
     {{ form.username(class="form-control") }}  <!--可传入关键字参数-->

     {% for message in form.username.errors %} <!--服务器端验证后的错误信息-->
     <small class="error">{{ message }} </small><br> 
     {% endfor %}

     {{ form.password.label }} 
     {{ form.password(class="form-control", placeholder="hello") }} 

    {{ form.submit(class="btn btn-primary") }} 
</form>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

附：常用WTForms字段

常用的 WTForms 验证器

在实例化验证类时， message参数用来传入自定义错误消息，如果没有设直则使用内置的英文错误消息

详见《Flask Web开发实战》