python之wtforms组件

作用

  • 生成 HTML 表单。
  • form 表单验证。

基本使用

安装

pip3 install wtforms

示例

  • 登录

    from flask import Flask, render_template, request, redirect
from wtforms import Form
from wtforms.fields import core
from wtforms.fields import html5
from wtforms.fields import simple
from wtforms import validators
from wtforms import widgets

app = Flask(__name__, template_folder='templates')
app.debug = True


class LoginForm(Form):
    name = simple.StringField(
        label='用户名',
        validators=[
            validators.DataRequired(message='用户名不能为空.'),
            validators.Length(min=6, max=18, message='用户名长度必须大于%(min)d且小于%(max)d')
        ],
        widget=widgets.TextInput(),
        render_kw={'class': 'form-control'}

    )
    pwd = simple.PasswordField(
        label='密码',
        validators=[
            validators.DataRequired(message='密码不能为空.'),
            validators.Length(min=8, message='用户名长度必须大于%(min)d'),
            validators.Regexp(regex="^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[$@$!%*?&])[A-Za-z\d$@$!%*?&]{8,}",
                              message='密码至少8个字符，至少1个大写字母，1个小写字母，1个数字和1个特殊字符')

        ],
        widget=widgets.PasswordInput(),
        render_kw={'class': 'form-control'}
    )



@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'GET':
        form = LoginForm()
        return render_template('login.html', form=form)
    else:
        form = LoginForm(formdata=request.form)
        if form.validate():
            print('用户提交数据通过格式验证，提交的值为：', form.data)
        else:
            print(form.errors)
        return render_template('login.html', form=form)

if __name__ == '__main__':
    app.run()
    app.py
    <!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>登录</h1>
<form method="post">
    <!--<input type="text" name="name">-->
    <p>{{form.name.label}} {{form.name}} {{form.name.errors[0] }}</p>

    <!--<input type="password" name="pwd">-->
    <p>{{form.pwd.label}} {{form.pwd}} {{form.pwd.errors[0] }}</p>
    <input type="submit" value="提交">
</form>
</body>
</html>
    login.html

  • 注册

    from flask import Flask, render_template, request, redirect
from wtforms import Form
from wtforms.fields import core
from wtforms.fields import html5
from wtforms.fields import simple
from wtforms import validators
from wtforms import widgets

app = Flask(__name__, template_folder='templates')
app.debug = True



class RegisterForm(Form):
    name = simple.StringField(
        label='用户名',
        validators=[
            validators.DataRequired()
        ],
        widget=widgets.TextInput(),
        render_kw={'class': 'form-control'},
        default='alex'
    )

    pwd = simple.PasswordField(
        label='密码',
        validators=[
            validators.DataRequired(message='密码不能为空.')
        ],
        widget=widgets.PasswordInput(),
        render_kw={'class': 'form-control'}
    )

    pwd_confirm = simple.PasswordField(
        label='重复密码',
        validators=[
            validators.DataRequired(message='重复密码不能为空.'),
            validators.EqualTo('pwd', message="两次密码输入不一致")
        ],
        widget=widgets.PasswordInput(),
        render_kw={'class': 'form-control'}
    )

    email = html5.EmailField(
        label='邮箱',
        validators=[
            validators.DataRequired(message='邮箱不能为空.'),
            validators.Email(message='邮箱格式错误')
        ],
        widget=widgets.TextInput(input_type='email'),
        render_kw={'class': 'form-control'}
    )

    gender = core.RadioField(
        label='性别',
        choices=(
            (1, '男'),
            (2, '女'),
        ),
        coerce=int
    )
    city = core.SelectField(
        label='城市',
        choices=(
            ('bj', '北京'),
            ('sh', '上海'),
        )
    )

    hobby = core.SelectMultipleField(
        label='爱好',
        choices=(
            (1, '篮球'),
            (2, '足球'),
        ),
        coerce=int
    )

    favor = core.SelectMultipleField(
        label='喜好',
        choices=(
            (1, '篮球'),
            (2, '足球'),
        ),
        widget=widgets.ListWidget(prefix_label=False),
        option_widget=widgets.CheckboxInput(),
        coerce=int,
        default=[1, 2]
    )

    def __init__(self, *args, **kwargs):
        super(RegisterForm, self).__init__(*args, **kwargs)
        self.favor.choices = ((1, '篮球'), (2, '足球'), (3, '羽毛球'))

    def validate_pwd_confirm(self, field):
        """
        自定义pwd_confirm字段规则，例：与pwd字段是否一致
        :param field: 
        :return: 
        """
        # 最开始初始化时，self.data中已经有所有的值

        if field.data != self.data['pwd']:
            # raise validators.ValidationError("密码不一致") # 继续后续验证
            raise validators.StopValidation("密码不一致")  # 不再继续后续验证


@app.route('/register', methods=['GET', 'POST'])
def register():
    if request.method == 'GET':
        form = RegisterForm(data={'gender': 1})
        return render_template('register.html', form=form)
    else:
        form = RegisterForm(formdata=request.form)
        if form.validate():
            print('用户提交数据通过格式验证，提交的值为：', form.data)
        else:
            print(form.errors)
        return render_template('register.html', form=form)



if __name__ == '__main__':
    app.run()
    app.py
    <!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>用户注册</h1>
<form method="post" novalidate style="padding:0  50px">
    {% for item in form %}
    <p>{{item.label}}: {{item}} {{item.errors[0] }}</p>
    {% endfor %}
    <input type="submit" value="提交">
</form>
</body>
</html>
    regist.html

原理

知识储备

  • 迭代器

    将一个对象变为可迭代对象，这个对象就可以被 for 循环（迭代器回顾）。

    class Foo(object):

    def __iter__(self):
        return iter(['aa', 'bb', 'cc'])


for item in Foo():
    print(item)

'''
aa
bb
cc
'''
    例：

  • __new__

    对象是什么，取决于 __new__ 方法的返回值。

    class Test2(object):
    pass


class Test1(object):
    def __new__(cls, *args, **kwargs):
        # 此行才是真正实例化 Test1
        obj = super().__new__(cls, *args, **kwargs)
        return obj, Test2()


print(Test1())  # (<__main__.Test1 object at 0x000000000220AB70>, <__main__.Test2 object at 0x000000000220ABE0>)
    例：

  • metaclass

    类的两种创建方式（类实际上也是 type 的一个对象）：

    class Test1(object):
    a1 = 123

    def func(self):
        return 'hello'


print(Test1)  # <class '__main__.Test1'>
print(Test1().func())  # hello

Test2 = type("Test1", (object,), {'a1': 123, 'func': lambda self: 'hello'})
print(Test2)  # <class '__main__.Test1'>
print(Test2().func())  # hello
    例1：
    metaclass 的作用是指定当前类由谁创建，默认是 type ： 
    class my_type(type):
    def __new__(cls, *args, **kwargs):
        print(cls)  # <class '__main__.my_type'>
        print('from my_type.__new__')
        return super().__new__(cls, *args, **kwargs)

    def __init__(self, *args, **kwargs):
        print(self)  # <class '__main__.Test'>
        print('from my_type.__init__')
        super(my_type, self).__init__(*args, **kwargs)

    def __call__(self, *args, **kwargs):
        print(self)  # <class '__main__.Test'>
        print('from my_type.__call__')
        obj = self.__new__(self, *args, **kwargs)
        print(obj)  # <__main__.Test object at 0x0000000002300CC0>
        self.__init__(obj)
        return obj
        # 默认是由 type 中的__call__ 方法执行
        # return super(my_type, self).__call__(*args,**kwargs)


class Test(object, metaclass=my_type):
    def __new__(cls, *args, **kwargs):
        print('from Test.__new__')
        return super(Test, cls).__new__(cls, *args, **kwargs)

    def __init__(self):
        print('from Test.__init__')

    def func(self):
        return 'hello'


t_obj = Test()
print(t_obj)  # <__main__.Test object at 0x0000000002300CC0>

'''
输出结果：
    <class '__main__.my_type'>
    from my_type.__new__
    <class '__main__.Test'>
    from my_type.__init__
    <class '__main__.Test'>
    from my_type.__call__
    from Test.__new__
    <__main__.Test object at 0x0000000002310C18>
    from Test.__init__
    <__main__.Test object at 0x0000000002310C18>

结论：
    当加载创建 Test 类时：
        发现 Test 类指定了 metaclass=my_type，
        即指定了 Test 类由 my_type 类创建，
        此时就会先执行 my_type.__new__ 方法，
        再执行 my_type.__init__ 方法。
    当实例化 Test 类时：
        因为 Test 类实际上也算是 my_type 类的的一个对象，
        执行 Test() 时相当于执行一个对象，
        而执行一个对象时会执行该对象类型也就是 my_type 的 __call__ 方法，
        在上面示例中重写了 __call__ 方法，
        如果没重写，将默认执行 type.__call__ 方法，
        重写的内容和 type 默认执行内容相似：
            先调用将要实例化类的 __new__ 方法创建对象，
            然后将该对象作为 self 参数传入调用该类的 __init__ 方法执行。
'''
    例2：

源码

  • 类的创建

    先查看一下 wtforms.form.Form 的继承结构： Form(with_metaclass(FormMeta, BaseForm)) ，可以看到， Form 继承的是一个 with_metaclass 函数的返回值，查看 with_metaclass 函数：

    1 def with_metaclass(meta, base=object):
2     return meta("NewBase", (base,), {})
    wtforms.compat.with_metaclass

    即它的返回值就是： FormMeta("NewBase", (BaseForm,), {}) 。接着查看 FormMeta 发现它继承了 type ： FormMeta(type) 。所以通过上面知识储备中 metaclass 的学习我们也知道它等价于这样创建的一个类：

    class NewBase(BaseForm,metaclass=FormMeta):
    pass

    而我们使用 Form 时需要继承 Form ，如上面登陆示例中。

    到此我们可以确定 LoginForm 的继承关系： LoginForm(Form(NewBase(BaseForm(object),metaclass=FormMeta))) 。

    所以当脚本加载到 LoginForm 时，因为它间接继承了 NewBase 类，而 NewBase 指定了 metaclass=FormMeta ，所以接着会执行 FormMeta.__init__ 的函数，查看：

    1 def __init__(cls, name, bases, attrs):
2     type.__init__(cls, name, bases, attrs)
3     cls._unbound_fields = None
4     cls._wtforms_meta = None
    wtforms.form.FormMeta.__init__

    此时这里的 cls 就是 NewBase 类了，接着 3、4 行给 NewBase 类新增了两个字段： _unbound_fields、_wtforms_meta  ，所以当 LoginForm 创建完成时，除了上面自己定义的 name、pwd 字段，它还拥有了 _unbound_fields、_wtforms_meta 这两个字段。类的创建部分到此就完成了，得出结论：只要我们使用类继承了 wtforms.form.Form ，那么这个类在创建完成时就会默认拥有 _unbound_fields、_wtforms_meta 两个字段

  • 字段的创建

    查看上述 LoginForm 中的 name 字段，可以看到它的值是通过 StringField 类实例化返回的对象。查看 StringField 类，会发现它的整个继承体系中都没有指定 metaclass ，所以实例化时真正返回的对象是由它的 __new__ ，它的 __new__ 方法继承自 wtforms.fields.core.Field ： 
    1 def __new__(cls, *args, **kwargs):
2     if '_form' in kwargs and '_name' in kwargs:
3         return super(Field, cls).__new__(cls)
4     else:
5         return UnboundField(cls, *args, **kwargs)
    wtforms.fields.core.Field.__new__

    我们实例化时并没有指定 kwargs ，所以会执行第 5 行。这里将要实例化的类也就是 StringField 作为构造参数传入 UnboundField 类，并将其实例对象返回。到这里可以知道，字段创建完成时，示例中 name 字段的值实际上是由 simple.StringField.__new__ 方法返回的 UnboundField 类实例。其它的字段类型其实都继承自 wtforms.fields.core.Field ，所以得出结论：只要是使用 wtforms 提供的字段类型创建的字段，在创建完成时都是 UnboundField 类的实例。

    wtforms 为什么要将所有字段类型都设为 UnboundField 呢？接着继续看一下 UnboundField 类：

     1 class UnboundField(object):
 2     _formfield = True
 3     creation_counter = 0
 4 
 5     def __init__(self, field_class, *args, **kwargs):
 6         UnboundField.creation_counter += 1
 7         self.field_class = field_class
 8         self.args = args
 9         self.kwargs = kwargs
10         self.creation_counter = UnboundField.creation_counter
11 
12     def bind(self, form, name, prefix='', translations=None, **kwargs):
13         kw = dict(
14             self.kwargs,
15             _form=form,
16             _prefix=prefix,
17             _name=name,
18             _translations=translations,
19             **kwargs
20         )
21         return self.field_class(*self.args, **kw)
22 
23     def __repr__(self):
24         return '<UnboundField(%s, %r, %r)>' % (self.field_class.__name__, self.args, self.kwargs)
    wtforms.fields.core.UnboundField

    上面已经知道每个字段创建时都会返回 UnboundField 类的实例，所以会执行它的 __init__ 方法。第 6 行可以看到，它给自己的静态字段也就是第 3 行的 creation_counter = 0 做了自增 1 的操作，然后将 field_class 赋值给当前实例（如果对应示例中 name 字段的创建，这个 field_class 就是 StringField 类），并将自增 1 后的 UnboundField.creation_counter 赋值给当前实例的 creation_counter 属性。得出结论：类中的字段创建完成后，每个字段都有一个 creation_counter 属性，且它的值连续不重复， UnboundField 的作用就是让字段可按定义顺序排序。

  • 对象的创建

    依然以 LoginForm 为例，当实例化它时，因它继承的 NewBase 类关联了 metaclass=FormMeta ，所以会先执行 FormMeta 类中的 __call__ 方法： 
     1 def __call__(cls, *args, **kwargs):
 2     if cls._unbound_fields is None:
 3         fields = []
 4         for name in dir(cls):
 5             if not name.startswith('_'):
 6                 unbound_field = getattr(cls, name)
 7                 if hasattr(unbound_field, '_formfield'):
 8                     fields.append((name, unbound_field))
 9         fields.sort(key=lambda x: (x[1].creation_counter, x[0]))
10         cls._unbound_fields = fields
11 
12     if cls._wtforms_meta is None:
13         bases = []
14         for mro_class in cls.__mro__:
15             if 'Meta' in mro_class.__dict__:
16                 bases.append(mro_class.Meta)
17         cls._wtforms_meta = type('Meta', tuple(bases), {})
18     return type.__call__(cls, *args, **kwargs)
    wtforms.form.FormMeta.__call__

    看第 2 行的判断， cls._unbound_fields 就是在类的创建时赋的值，为 None 。接着走到第 4-10 行，遍历 cls 在这里也就是 LoginForm 中所有的字段名，过滤去除以 '_' 开头的字段名，然后取出对应名字的字段将其添加到 fields 列表中，并在第 9 行给其按字段创建时保存 creation_counter 值排序，然后将其重新赋值给 cls._unbound_fields 。结论：我们自定义字段时字段名不能以 '_' 开头，否则会被过滤导致失效。

    再看 12-17 行，循环当前类的 __mro__ 字段即 LoginForm.__mro__ ，找到包含 Meta 字段的类并将 Meta 添加到 bases 列表，检查 LoginForm.__mro__ 关联的类，发现默认情况下只有 Form 类中有 Meta 字段，如下：

    1 class Form(with_metaclass(FormMeta, BaseForm)):
2     Meta = DefaultMeta
    wtforms.form.Form

    然后在 17 行通过 type 创建一个名为 Meta 且继承了 bases 中的类，将其赋值给 cls._wtforms_meta 。等价于：

    class Meta(DefaultMeta):
    pass

    接着就该继续执行自己类的 __init__ 方法了：

    1 def __init__(self, formdata=None, obj=None, prefix='', data=None, meta=None, **kwargs):
2     meta_obj = self._wtforms_meta()
3     if meta is not None and isinstance(meta, dict):
4         meta_obj.update_values(meta)
5     super(Form, self).__init__(self._unbound_fields, meta=meta_obj, prefix=prefix)
6 
7     for name, field in iteritems(self._fields):
8         setattr(self, name, field)
9     self.process(formdata, obj, data=data, **kwargs)
    wtforms.form.Form.__init__

    直接看到第 5 行，将 self._unbound_fields 作为第一个参数、第 2 行的 self._wtforms_meta() （也就是上面 Meta 类实例）作为 meta 参数传入执行其父类即 wtforms.form.BaseForm 的 __init__ 方法：

     1 def __init__(self, fields, prefix='', meta=DefaultMeta()):
 2     if prefix and prefix[-1] not in '-_;:/.':
 3         prefix += '-'
 4 
 5     self.meta = meta
 6     self._prefix = prefix
 7     self._errors = None
 8     self._fields = OrderedDict()
 9 
10     if hasattr(fields, 'items'):
11         fields = fields.items()
12 
13     translations = self._get_translations()
14     extra_fields = []
15     if meta.csrf:
16         self._csrf = meta.build_csrf(self)
17         extra_fields.extend(self._csrf.setup_form(self))
18 
19     for name, unbound_field in itertools.chain(fields, extra_fields):
20         options = dict(name=name, prefix=prefix, translations=translations)
21         field = meta.bind_field(self, unbound_field, options)
22         self._fields[name] = field
    wtforms.form.BaseForm.__init__

    看 19-22 行，遍历 fields 即传入的 self._unbound_fields ，通过 meta.bind_field(self(当前LoginForm实例), unbound_field(当前遍历字段), options) 即调用传入的 Meta 类实例的 bind_field 方法：

    1 def bind_field(self, form, unbound_field, options):
2     return unbound_field.bind(form=form, **options)
    wtforms.meta.DefaultMeta.bind_field

    而它的返回值又是 UnboundField 实例及遍历字段的 bind 方法的返回值：

     1 def bind(self, form, name, prefix='', translations=None, **kwargs):
 2     kw = dict(
 3         self.kwargs,
 4         _form=form,
 5         _prefix=prefix,
 6         _name=name,
 7         _translations=translations,
 8         **kwargs
 9     )
10     return self.field_class(*self.args, **kw)
    wtforms.fields.core.UnboundField.bind

    可以看到，返回的是 self.field_class 的实例， self.field_class 已经在字段创建时赋值了，如果是 LoginForm 中的 name 字段，那么它返回的就是 StringField 的实例。接着回到 wtforms.form.BaseForm.__init__ 方法中第 22 行，将该实例赋值给 self._fields ，键为字段对应名称，即如果是 name 字段，那么 self._fields['name'] = StringField() 。至此 wtforms.form.Form.__init__ 第 5 行执行完毕，接着看它的 7、8 行：遍历 self._fields ，并将对应字段实例赋值给当前 Form 实例的对应字段，如果是 LoginForm ，那么就是

    loginForm = LoginForm()
loginForm.name = StringField()
loginForm.pwd = PasswordField()

    结论：在 Form 类真正实例化后，它对应类中定义的字段才真正返回它定义时指定的类型，如：

    print(type(LoginForm.name))  # <class 'wtforms.fields.core.UnboundField'>
print(type(LoginForm.pwd))  # <class 'wtforms.fields.core.UnboundField'>
print(type(LoginForm().name))  # <class 'wtforms.fields.core.StringField'>
print(type(LoginForm().pwd))  # <class 'wtforms.fields.simple.PasswordField'>

补充

csrf验证

  • 使用

    from _md5 import md5

from flask import Flask, render_template, request
from wtforms import Form
from wtforms.csrf.core import CSRF
from wtforms.fields import html5
from wtforms.fields import simple

app = Flask(__name__, template_folder='templates')
app.debug = True


class MyCSRF(CSRF):
    def setup_form(self, form):
        self.csrf_context = form.meta.csrf_context()
        self.csrf_secret = form.meta.csrf_secret
        return super(MyCSRF, self).setup_form(form)

    def generate_csrf_token(self, csrf_token):
        gid = self.csrf_secret + self.csrf_context
        token = md5(gid.encode('utf-8')).hexdigest()
        return token

    def validate_csrf_token(self, form, field):
        print(field.data, field.current_token)  # ef20b7d8857d8771101822f0a4cab406 ef20b7d8857d8771101822f0a4cab406
        if field.data != field.current_token:
            raise ValueError('Invalid CSRF')


class TestForm(Form):
    name = html5.EmailField(label='用户名')
    pwd = simple.StringField(label='密码')

    class Meta:
        # -- CSRF
        # 是否自动生成CSRF标签
        csrf = True
        # 生成CSRF标签name
        csrf_field_name = 'csrf_token'

        # 自动生成标签的值，加密用的csrf_secret
        csrf_secret = 'xxxxxx'
        # 自动生成标签的值，加密用的csrf_context
        csrf_context = lambda x: request.url
        # 生成和比较csrf标签
        csrf_class = MyCSRF

        # -- i18n
        # 是否支持本地化
        # locales = False
        locales = ('zh', 'en')
        # 是否对本地化进行缓存
        cache_translations = True
        # 保存本地化缓存信息的字段
        translations_cache = {}


@app.route('/login', methods=['GET', 'POST'])
def index():
    if request.method == 'GET':
        form = TestForm()
    else:
        form = TestForm(formdata=request.form)
        if form.validate():
            print(form.data)  # {'name': 'edad', 'pwd': 'ead', 'csrf_token': 'ef20b7d8857d8771101822f0a4cab406'}
    return render_template('login.html', form=form)


if __name__ == '__main__':
    app.run()
    app.py
    <!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Login</title>
</head>
<body>
<form action="/login" method="post" novalidate>
    {{form.csrf_token}}
    <p>用户名：{{form.name}} {{form.name.errors[0]}}</p>
    <p>密码：{{form.pwd}} {{form.pwd.errors[0]}}</p>
    <input type="submit" value="提交">
</form>
</body>
</html>
    login.html

  • 源码

    经过上面的源码部分，我们已经知道在 Form 对象创建期间会执行 wtforms.form.BaseForm.__init__ ，查看：

     1 def __init__(self, fields, prefix='', meta=DefaultMeta()):
 2     if prefix and prefix[-1] not in '-_;:/.':
 3         prefix += '-'
 4 
 5     self.meta = meta
 6     self._prefix = prefix
 7     self._errors = None
 8     self._fields = OrderedDict()
 9 
10     if hasattr(fields, 'items'):
11         fields = fields.items()
12 
13     translations = self._get_translations()
14     extra_fields = []
15     if meta.csrf:
16         self._csrf = meta.build_csrf(self)
17         extra_fields.extend(self._csrf.setup_form(self))
18 
19     for name, unbound_field in itertools.chain(fields, extra_fields):
20         options = dict(name=name, prefix=prefix, translations=translations)
21         field = meta.bind_field(self, unbound_field, options)
22         self._fields[name] = field
    wtforms.form.BaseForm.__init__

    看第 15-17 行， meta 指的就是 Form 对象创建过程中使用 type 创建的一个名为 'Meta' 的类的实例，而这个类继承了 bases 列表中的类， bases 列表中的类是当前使用 Form 的 __mro__ 列表中的 Meta 字段，默认在 wtforms.form.Form 中有一个 Meta = DefaultMeta 字段。而在上面使用中，我们在使用的 Form 类中自己又定义了一个 Meta 类，所以此时由 type 创建的 Meta 类结构应该如下：

    type('Meta', tuple([TestForm.Meta,wtforms.meta.DefaultMeta]), {})

class Meta(TestForm.Meta,wtforms.meta.DefaultMeta):
    pass

    即 meta 指的就是如上 Meta 的实例，我们已经在自定义的 Meta 类中指定了 csrf=True ，继续执行 16 行，查看 meta.build_csrf(self) 方法：

    1 def build_csrf(self, form):
2     if self.csrf_class is not None:
3         return self.csrf_class()
4 
5     from wtforms.csrf.session import SessionCSRF
6     return SessionCSRF()
    wtforms.meta.DefaultMeta.build_csrf

    接着执行 2、3 行，我们也指定了 csrf_class = MyCSRF ，所以它的返回值就是 MyCSRF 类的实例。即 wtforms.form.BaseForm.__init__ 的 16 行 self._csrf 的值就是 MyCSRF 类的实例。 

    继续执行 17 行，先看 self._csrf.setup_form(self) ，它执行的就是我们自己定义的 MyCSRF.setup_form 函数，在该方法中给 self.csrf_context 和 self.csrf_secret 方法赋了值，接着返回父类的 setup_form 方法的返回值：

     1 field_class = CSRFTokenField
 2 
 3 def setup_form(self, form):
 4     meta = form.meta
 5     field_name = meta.csrf_field_name
 6     unbound_field = self.field_class(
 7         label='CSRF Token',
 8         csrf_impl=self
 9     )
10     return [(field_name, unbound_field)]
    wtforms.csrf.core.CSRF.setup_form

    可以看到返回值是列表套一个元组，元组第一个元素是 meta.csrf_field_name 即 'csrf_token' ，第二个元素是字段类 CSRFTokenField(HiddenField) 的实例，所以在 wtforms.form.BaseForm.__init__ 的 17 行 self._csrf.setup_form(self) 的返回值就是这个列表，接着将其放入列表 extra_fields 中。接着在 19-22 行和 fields 合并为一个列表，遍历，通过 meta.bind_field 方法将其实例化，这次返回的是定义时对应实例，而不是 UnboundField 实例。接着以字段名为键，对应实例为值，保存到 self._fields 中。 

    csrf 验证是由 Form 实例 validate 方法触发的，查看该方法：

    1 def validate(self):
2     extra = {}
3     for name in self._fields:
4         inline = getattr(self.__class__, 'validate_%s' % name, None)
5         if inline is not None:
6             extra[name] = [inline]
7 
8     return super(Form, self).validate(extra)
    wtforms.form.Form.valdate

    接着第 8 行会继续执行父类的 validate 方法：

     1 def validate(self, extra_validators=None):
 2     self._errors = None
 3     success = True
 4     for name, field in iteritems(self._fields):
 5         if extra_validators is not None and name in extra_validators:
 6             extra = extra_validators[name]
 7         else:
 8             extra = tuple()
 9         if not field.validate(self, extra):
10             success = False
11     return success
    wtforms.form.BaseForm.validate

    遍历 self._fields ，在第 9 行通过 field.validate 方法给每个字段进行校验，这里我们只关注刚刚加进来的 csrf_token 字段，进入该 validate 方法：

     1 def validate(self, form, extra_validators=tuple()):
 2     self.errors = list(self.process_errors)
 3     stop_validation = False
 4 
 5     try:
 6         self.pre_validate(form)
 7     except StopValidation as e:
 8         if e.args and e.args[0]:
 9             self.errors.append(e.args[0])
10         stop_validation = True
11     except ValueError as e:
12         self.errors.append(e.args[0])
13 
14     if not stop_validation:
15         chain = itertools.chain(self.validators, extra_validators)
16         stop_validation = self._run_validation_chain(form, chain)
17 
18     try:
19         self.post_validate(form, stop_validation)
20     except ValueError as e:
21         self.errors.append(e.args[0])
22 
23     return len(self.errors) == 0
    wtforms.fields.core.Field.validate

    再看到第 6 行的 pre_validate 方法：

    1 def pre_validate(self, form):
2     self.csrf_impl.validate_csrf_token(form, self)
    wtforms.csrf.core.CSRFTokenField.pre_validate

    接着我们会发现，它是通过 self.csrf_impl.validate_csrf_token(form, self) 验证的，而 self.csrf_impl 正是之前执行 wtforms.csrf.core.CSRF.setup_form 时放入的我们自定义 csrf 认证类的实例即 MyCSRF 的实例，所以折行实际上是执行我们在 MyCSRF 类中自己定义的 validate_csrf_token 方法，所以我们可以在此完成 csrf 验证的逻辑。

     

posted @ 2018-12-20 19:07  zze  阅读(1618)  评论(0)  编辑  收藏  举报