Flask 教程

Flask WTF


Web 应用程序的一个重要方面是为用户提供一个用户界面。HTML 提供了一个<form>标签,用于设计一个接口。可以适当使用表单的元素,如文本输入,广播,选择等。

通过GETPOST方法将用户输入的数据以 Http 请求消息的形式提交给服务器端脚本。

  • 服务器端脚本必须从 http 请求数据重新创建表单元素。所以实际上,表单元素必须被定义两次 - 一次是 HTML,一次是服务器端脚本。
  • 使用 HTML 表单的另一个缺点是很难(如果不是不可能)动态地呈现表单元素。HTML 本身无法验证用户的输入。

这就是WTForms,一个灵活的表单,渲染和验证库来得方便的地方。Flask-WTF 扩展为这个 WTForms 库提供了一个简单的接口。

使用 Flask-WTF,可以在 Python 脚本中定义表单域并使用 HTML 模板来呈现它们。也可以将验证应用于 WTF 字段。

下面让我们看看这个动态生成 HTML 是如何工作的。

首先,需要安装 Flask-WTF 扩展。

pip install flask-WTF

已安装的软件包包含一个 Form 类,该类必须用作用户定义表单的父级。WTforms 包包含各种表单域的定义。下面列出了一些标准表单字段。

编号 标准表单字段 描述
1 TextField 表示<input type ='text'> HTML 表单元素
2 BooleanField 表示<input type ='checkbox'> HTML 表单元素
3 DecimalField 用小数显示数字的文本字段
4 IntegerField 用于显示整数的文本字段
5 RadioField 表示<input type ='radio'>的 HTML 表单元素
6 SelectField 表示选择表单元素
7 TextAreaField 表示<testarea> html 表单元素
8 PasswordField 表示<input type ='password'> HTML 表单元素
9 SubmitField 表示<input type ='submit'>表单元素

例如,可以设计一个包含文本字段的表单,如下所示 -

from flask_wtf import Form
from wtforms import TextField

class ContactForm(Form):
    name = TextField("Name Of Student")

除了name字段之外,还会自动创建一个 CSRF 令牌的隐藏字段。这是为了防止跨站请求伪造攻击。

渲染时,这将产生一个等效的 HTML 脚本,如下所示。

<input id = "csrf_token" name = "csrf_token" type = "hidden" />
<label for = "name">Name Of Student</label><br>
<input id = "name" name = "name" type = "text" value = "" />

用户定义的表单类在 Flask 应用程序中使用,表单使用模板呈现。

from flask import Flask, render_template
from forms import ContactForm
app = Flask(__name__)
app.secret_key = 'development key'

@app.route('/contact')
def contact():
    form = ContactForm()
    return render_template('contact.html', form = form)

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

WTForms 包也包含验证器类,在验证表单域时非常有用。以下列表显示了常用的验证器。

编号 验证器类 描述
1 DataRequired 检查输入栏是否为空
2 Email 检查字段中的文本是否遵循电子邮件 ID 约定
3 IPAddress 验证输入字段中的 IP 地址
4 Length 验证输入字段中字符串的长度是否在给定范围内
5 NumberRange 在给定范围内的输入字段中验证一个数字
6 URL 验证输入字段中输入的 URL

将联系表单的name字段应用'DataRequired'验证规则。

name = TextField("Name Of Student",[validators.Required("Please enter your name.")])

表单对象的validate()函数验证表单数据,并在验证失败时抛出验证错误。错误消息被发送到模板。在 HTML 模板中,错误消息是动态呈现的。

{% for message in form.name.errors %}
   {{ message }}
{% endfor %}

以下示例演示了上面给出的概念。联系人表单代码如下(forms.py)。

from flask_wtf import Form
from wtforms import TextField, IntegerField, TextAreaField, SubmitField, RadioField, SelectField

from wtforms import validators, ValidationError

class ContactForm(Form):
    name = TextField("学生姓名",[validators.Required("Please enter your name.")])
    Gender = RadioField('性别', choices = [('M','Male'),('F','Female')])
    Address = TextAreaField("地址")

    email = TextField("Email",[validators.Required("Please enter your email address."),
      validators.Email("Please enter your email address.")])

    Age = IntegerField("年龄")
    language = SelectField('语言', choices = [('cpp', 'C++'), ('py', 'Python')])
    submit = SubmitField("提交")

验证器应用于名称和电子邮件字段。下面给出的是 Flask 应用程序脚本(formexample.py)。

from flask import Flask, render_template, request, flash
from forms import ContactForm
app = Flask(__name__)
app.secret_key = 'development key'

@app.route('/contact', methods = ['GET', 'POST'])
def contact():
    form = ContactForm()

    if request.method == 'POST':
       if form.validate() == False:
          flash('All fields are required.')
          return render_template('contact.html', form = form)
       else:
          return render_template('success.html')
    elif request.method == 'GET':
          return render_template('contact.html', form = form)

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

模板的脚本(contact.html)如下所示 -

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Flask 示例</title>
</head>
   <body>

     <h2 style = "text-align: center;">联系人表单</h2>

      {% for message in form.name.errors %}
         <div>{{ message }}</div>
      {% endfor %}

      {% for message in form.email.errors %}
         <div>{{ message }}</div>
      {% endfor %}

      <form action = "http://localhost:5000/contact" method = post>
         <fieldset>
            <legend>填写项</legend>
            {{ form.hidden_tag() }}

            <div style = font-size:20px; font-weight:bold; margin-left:150px;>
               {{ form.name.label }}<br>
               {{ form.name }}
               <br>

               {{ form.Gender.label }} {{ form.Gender }}
               {{ form.Address.label }}<br>
               {{ form.Address }}
               <br>

               {{ form.email.label }}<br>
               {{ form.email }}
               <br>

               {{ form.Age.label }}<br>
               {{ form.Age }}
               <br>

               {{ form.language.label }}<br>
               {{ form.language }}
               <br>
               {{ form.submit }}
            </div>

         </fieldset>
      </form>

   </body>
</html>

在 Python shell 中运行formexample.py,并访问 URL => http://localhost:5000/contact 。联系人表单将显示如下。

如果有错误信息,页面将如下所示 -

如果没有错误,将呈现success.html页面的内容,如下所示 -