Flask插件-Flask-WTF表单

古城微笑少年丶 2023-05-30 09:26 19阅读 0赞

flask\_wtf是flask框架的表单验证模块，可以很方便生成表单，也可以当做json数据交互的验证工具。

#### 一、安装 ####

pip install Flask-WTF
    pip install WTForms

#### 二、简单使用示例 ####

app.py

from flask import Flask, render_template
    from forms import LoginForm
    from flask_bootstrap import Bootstrap
    
    app = Flask(__name__)
    app.secret_key = 'sdfgdsfg'
    bootstrap = Bootstrap()
    bootstrap.init_app(app)
    
    
    @app.route('/login/', methods=['GET', 'POST'])
    def login():
        form = LoginForm()
        if form.validate_on_submit():
            return "OK"
        return render_template('index.html', form=form)
    
    
    if __name__ == '__main__':
        app.run(host='0.0.0.0', port=8888, debug=True)

forms.py

from flask_wtf import FlaskForm
    from wtforms import StringField, PasswordField, SubmitField
    from wtforms.validators import DataRequired
    
    
    class LoginForm(FlaskForm):
        username = StringField(label="用户名", validators=[DataRequired(message="用户名不能为空！")])
        password = PasswordField(label="密码", validators=[DataRequired(message="密码不能为空！")])
        submit = SubmitField("登录")

templates/index.html

<!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>登录测试</title>
        { % import 'bootstrap/wtf.html' as wtf %}
    </head>
    <body>
            <h1>登录</h1>
            <div class="row">
                <div class="col-md-4">
                    { {  wtf.quick_form(form) }}
                </div>
            </div>
    
        
        
        
        
    
    </body>
    </html>

#### 三、Flask-WTF可定义的字段类型 ####

flask\_wtf完全使用wtforms组件的字段模型，wtforms对字段的定义在fields模块；又分为core和simple，core模块定义了普通使用的字段，simple在core模块的基础上扩展了一些字段，这些字段会自动进行字段级别的校验。

# core.py
    __all__ = (
        'BooleanField', 'DecimalField', 'DateField', 'DateTimeField', 'FieldList',
        'FloatField', 'FormField', 'IntegerField', 'RadioField', 'SelectField',
        'SelectMultipleField', 'StringField',
    )
    常用字段说明：
    BooleanField：布尔类型，如Flask,True
    StringField：字符串类型
    DecimalField：小数点文本字段，如：‘1.23’
    DateField：日期字段，格式：'%Y-%m-%d'
    DateTimeField:日期字段，格式：'%Y-%m-%d %H:%M:%S'
    FieldList:统一字段类型组成列表，如：FieldList(StringField('Name', [validators.required()]))
    FloatField:浮点数类型
    IntegerField：整形
    SelectMultipleField：多选框
    RadioField：单选框
    
    # simple.py
    TextAreaField:文本域，可接受多行输入
    PasswordField：密码字段，输入的不会直接在浏览器明文显示
    FileField：上传文件，但不会处理验证文件，需要手动处理
    HiddenField：隐藏字段
    SubmitField：按钮
    TextField:字符串类型的别名，弃用

#### 四、Flask-WTF字段的验证 ####

字段的参数validators可以指定提交表单的验证序列，按照从左到右的顺序，默认的可选验证在wtforms.validators模块，已经封装的验证方法有：

__all__ = (
        'DataRequired', 'data_required', 'Email', 'email', 'EqualTo', 'equal_to',
        'IPAddress', 'ip_address', 'InputRequired', 'input_required', 'Length',
        'length', 'NumberRange', 'number_range', 'Optional', 'optional',
        'Required', 'required', 'Regexp', 'regexp', 'URL', 'url', 'AnyOf',
        'any_of', 'NoneOf', 'none_of', 'MacAddress', 'mac_address', 'UUID'
    )
    模块中大小写有对应的方式，如DataRequired对应data_required。
    
    DataRequired/data_required:验证数据是否真实存在，即不能为空，必须是非空白字符串，否则触发StopValidation错误。
    InputRequired/input_required：和DataRequired的区别在于可以是空白字符串；
    Required/required:data_required的别名
    Email/email：验证符合邮件的格式，只有最基本的验证；
    EqualTo/equal_to:比较两个字段的值，比如密码和确认密码，如果不相等就触发错误，equal_to(field,message),需要输入另一个字段的名字。
    IPAddress/ip_address:验证是否是ip地址，默认验证IPV4地址。
    MacAddress/mac_address:验证是否符合mac格式；
    UUID：是否是uuid格式；
    URL/url:验证是否符合url格式；
    Regexp/regexp:用提供的正则表达式验证字段；Regexp(r"")
    Length/length:设置字段值的长度，Length(min,max);
    NumberRange/number_range:设置一个数字字段的取值范围，可以针对浮点数和小数；NumberRange(min,max)
    Optional/optional:允许字段为空并停止验证；
    NoneOf/none_of:将传入的数据和无效的比较，是抛出异常；Noneof(values).
    Anyof/any_of:将传入的数据和预设的数据比较，不是异常。Anyof(values).