Web应用程序的一个重要方面是为用户提供用户界面。HTML提供了一个<form>标签,用于设计界面。
可以适当地使用Form(表单)元素,例如文本输入,单选按钮,选择等。
用户输入的数据以Http请求消息的形式通过GET或POST方法提交给服务器端脚本。
服务器端脚本必须从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 表示<textarea> HTML表单元素 |
8 | PasswordField 表示<input type = 'password'> HTML表单元素 |
9 | SubmitField 表示<input type = 'submit'>表单元素 |
例如,包含文本字段的表单可以设计如下:
from flask_wtf import Formfrom wtforms import TextFieldclass ContactForm(Form): name = TextField("Name Of Student")
除了'name'字段,还会自动创建CSRF令牌的隐藏字段。这是为了防止Cross Site Request Forgery(跨站请求伪造)攻击。
渲染时,这将导致等效的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_templatefrom forms import ContactFormapp = 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()函数将验证表单数据并抛出验证错误。Error消息将发送到模板。在HTML模板中,动态呈现error消息。
{% for message in form.name.errors %} {{ message }}{% endfor %}
以下示例演示了上面给出的概念。Contact表单的设计如下(forms.py)。
from flask_wtf import FlaskFormfrom wtforms import TextField, IntegerField, TextAreaField, SubmitField, RadioField, SelectFieldfrom wtforms import validators, ValidationErrorclass ContactForm(Form): name = TextField("Name Of Student",[validators.Required("Please enter your name.")]) Gender = RadioField('Gender', choices = [('M','Male'),('F','Female')]) Address = TextAreaField("Address") email = TextField("Email",[validators.Required("Please enter your email address."), validators.Email("Please enter your email address.")]) Age = IntegerField("age") language = SelectField('Languages', choices = [('cpp', 'C++'), ('py', 'Python')]) submit = SubmitField("Send")
验证器应用于Name和Email字段。
下面给出了Flask应用程序脚本(formexample.py)。
from flask import Flask, render_template, request, flashfrom forms import ContactFormapp = 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)的脚本如下:
<!doctype html><html> <body> <h2 style = "text-align: center;">Contact Form</h2> {% for message in form.name.errors %} <div>{{ message }}</div> {% endfor %} <form action = "http://localhost:5000/contact" method = post> <fieldset> <legend>Contact Form</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。显示Contact表单将如下所示。
如果有任何错误,页面将如下所示:
如果没有错误,将显示'success.html'。
关闭