Flask---wtforms源码分析

2024-08-31 22:18
文章标签 分析 源码 flask wtforms

本文主要是介绍Flask---wtforms源码分析,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

我在Flask—wtforms使用博文中简单的学习了下wtforms的简单使用,这篇博客就专门来了解下wtforms的源码流程

这里写图片描述

我们在使用Form时候,我们会构造如下的实例对象


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

那我们分析源码就从LoginForm的继承类Form来进行分析

class Form(with_metaclass(FormMeta, BaseForm)):
def with_metaclass(meta, base=object):return meta("NewBase", (base,), {})

说明Form类是通过元类进行构造,FormMeta是type元类,BaseForm是From类继承的父类
我们看下FormMeta元类的初始化__init__方法

    def __init__(cls, name, bases, attrs):type.__init__(cls, name, bases, attrs)cls._unbound_fields = Nonecls._wtforms_meta = None

当在FormMeta初始化方法时候,通过cls.XX操作,会去触发该类的__setattr__方法

 def __setattr__(cls, name, value):"""Add an attribute to the class, clearing `_unbound_fields` if needed."""if name == 'Meta':cls._wtforms_meta = Noneelif not name.startswith('_') and hasattr(value, '_formfield'):cls._unbound_fields = Nonetype.__setattr__(cls, name, value)

然后我们回过头继续看LoginForm

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

我们看下LoginForm类中的user属性,在构造实例时候, 会先调用__new__,然后执行__init__方法,我们先来看Field__new__方法

    def __new__(cls, *args, **kwargs):if '_form' in kwargs and '_name' in kwargs:return super(Field, cls).__new__(cls)else:return UnboundField(cls, *args, **kwargs)

继而跟踪UnboundField代码

 def __init__(self, field_class, *args, **kwargs):UnboundField.creation_counter += 1self.field_class = field_classself.args = argsself.kwargs = kwargsself.creation_counter = UnboundField.creation_counter

通过UnboundField.creation_counter += 1统计UnboundField的实例对象个数

然后回过头来看Field__init__方法,看看初始化做了什么操作?

for v in itertools.chain(self.validators, [self.widget]):flags = getattr(v, 'field_flags', ())for f in flags:setattr(self.flags, f, True)

通过itertools.chain连接validators[self.widget],设置一些默认的校验规则,例如
requiredhidden等等

至此下面的代码中我们完成了一些列的初始化操作

class LoginForm(Form):user = simple.StringField(validators=[Myvalidators(message="用户名必须是safly"),  # 也可以自定义正则validators.DataRequired(message='用户名不能为空.'),# validators.Length(min=6, max=18, message='用户名长度必须大于%(min)d且小于%(max)d')],widget=widgets.TextInput(),render_kw={'class': 'form-control'})

最后生成的数据格式如下:

LoginForm._unbound_fields = None
LoginForm._wtforms_meta = None
LoginForm.name = UnboundField(simple.StringField, *args, **kwargs,creation_counter=1)

我们在使用如下的类似代码,来使用wtforms

    if request.method == 'GET':form = LoginForm()return render_template('login.html',form=form)

所以我们接下来分析LoginForm()的实例化的过程
当在实例化时候,会先调用元类的init,然后是元类的call方法,然后在调用LoginForm的父类系列方法,然后是自己的系列方法,那我们先看下class FormMeta(type)元类的__call__方法

   def __call__(cls, *args, **kwargs):if cls._unbound_fields is None:fields = []for name in dir(cls):if not name.startswith('_'):unbound_field = getattr(cls, name)if hasattr(unbound_field, '_formfield'):fields.append((name, unbound_field))fields.sort(key=lambda x: (x[1].creation_counter, x[0]))cls._unbound_fields = fields# Create a subclass of the 'class Meta' using all the ancestors.if cls._wtforms_meta is None:bases = []for mro_class in cls.__mro__:if 'Meta' in mro_class.__dict__:bases.append(mro_class.Meta)cls._wtforms_meta = type('Meta', tuple(bases), {})return type.__call__(cls, *args, **kwargs)

__call__方法中,获取我们代码LoginForm类中的含有_formfield属性的Field实例,最后 cls._unbound_fields = fields进行赋值操作

然后for mro_class in cls.__mro__
以下是cls.__mro__列表

mroclass <class '__main__.LoginForm'>
mroclass <class 'wtforms.form.Form'>
mroclass <class 'wtforms.compat.NewBase'>
mroclass <class 'wtforms.form.BaseForm'>
mroclass <class 'object'>

我们最终在class Form(with_metaclass(FormMeta, BaseForm)):类中找到了Meta

Meta = DefaultMeta

最后通过元类构造cls._wtforms_meta = type('Meta', tuple(bases), {})

通过上述的操作,我们看下数据状态

LoginForm._unbound_fields = [('name',UnboundField(simple.StringField, *args, **kwargs,creation_counter=1),),('pwd',UnboundField(simple.PasswordField, *args, **kwargs,creation_counter=2),),]LoginForm._wtforms_meta = class Meta(DefaultMeta):passLoginForm.name = UnboundField(simple.StringField, *args, **kwargs,creation_counter=1)

最后在继续看class Form(with_metaclass(FormMeta, BaseForm))类,当执行完元类的__init__、__call__方法之后,就会去执行Form类的__init__方法,

 def __init__(self, formdata=None, obj=None, prefix='', data=None, meta=None, **kwargs):meta_obj = self._wtforms_meta()if meta is not None and isinstance(meta, dict):meta_obj.update_values(meta)super(Form, self).__init__(self._unbound_fields, meta=meta_obj, prefix=prefix)for name, field in iteritems(self._fields):# Set all the fields to attributes so that they obscure the class# attributes with the same names.setattr(self, name, field)self.process(formdata, obj, data=data, **kwargs)

通过super(Form, self).__init__(self._unbound_fields, meta=meta_obj, prefix=prefix)可以看出它继承了父类的BaseForm__init__方法

    def __init__(self, fields, prefix='', meta=DefaultMeta()):if prefix and prefix[-1] not in '-_;:/.':prefix += '-'self.meta = metaself._prefix = prefixself._errors = Noneself._fields = OrderedDict()if hasattr(fields, 'items'):fields = fields.items()translations = self._get_translations()extra_fields = []if meta.csrf:self._csrf = meta.build_csrf(self)extra_fields.extend(self._csrf.setup_form(self))for name, unbound_field in itertools.chain(fields, extra_fields):options = dict(name=name, prefix=prefix, translations=translations)field = meta.bind_field(self, unbound_field, options)self._fields[name] = field

此时的数据格式如下:

LoginForm对象._fields = {'name': simple.StringField() }
LoginForm对象.name = simple.StringField()

然后执行Form类中的__init__方法

   for name, field in iteritems(self._fields):# Set all the fields to attributes so that they obscure the class# attributes with the same names.setattr(self, name, field)self.process(formdata, obj, data=data, **kwargs)
 def process(self, formdata=None, obj=None, data=None, **kwargs):formdata = self.meta.wrap_formdata(self, formdata)if data is not None:# XXX we want to eventually process 'data' as a new entity.#     Temporarily, this can simply be merged with kwargs.kwargs = dict(data, **kwargs)for name, field, in iteritems(self._fields):if obj is not None and hasattr(obj, name):field.process(formdata, getattr(obj, name))elif name in kwargs:field.process(formdata, kwargs[name])else:field.process(formdata)

以上就是LoginForm()的执行流程

我们知道wtforms最终是渲染到页面上,我们就来看下print(form.name)做了什么操作把?
它会执行Field类的__str__方法

 def __str__(self):return self()

调用对象自身,继而调用该对象的__call__方法

    def __call__(self, **kwargs):return self.meta.render_field(self, kwargs)
 def render_field(self, field, render_kw):other_kw = getattr(field, 'render_kw', None)if other_kw is not None:render_kw = dict(other_kw, **render_kw)return field.widget(field, **render_kw)

继而调用field.widget__call__方法

 def __call__(self, field, **kwargs):kwargs.setdefault('id', field.id)kwargs.setdefault('type', self.input_type)if 'value' not in kwargs:kwargs['value'] = field._value()return HTMLString('<input %s>' % self.html_params(name=field.name, **kwargs))

我们最后看看是如何进行校验操作的吧?

 def validate(self):"""Validates the form by calling `validate` on each field, passing anyextra `Form.validate_<fieldname>` validators to the field validator."""extra = {}for name in self._fields:inline = getattr(self.__class__, 'validate_%s' % name, None)if inline is not None:extra[name] = [inline]return super(Form, self).validate(extra)

我们在进行字段校验时候,会书写如下的代码:

    def validate_name(self, field):"""自定义pwd_confirm字段规则,例:与pwd字段是否一致:param field::return:"""# 最开始初始化时,self.data中已经有所有的值print(field.data) # 当前name传过来的值# print(self.data) # 当前传过来的所有的值:name,gender.....obj = SQLHelper.fetch_one('select id from user where user =%s',[field.data,])if obj:raise validators.ValidationError("用户名已经存在") # 继续后续验证

最后调用父类的方法进行验证

  def validate(self, extra_validators=None):self._errors = Nonesuccess = Truefor name, field in iteritems(self._fields):if extra_validators is not None and name in extra_validators:extra = extra_validators[name]else:extra = tuple()if not field.validate(self, extra):success = Falsereturn success

以上wtforms的源码流程

这篇关于Flask---wtforms源码分析的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1125146

相关文章

性能分析之MySQL索引实战案例

文章目录 一、前言二、准备三、MySQL索引优化四、MySQL 索引知识回顾五、总结 一、前言 在上一讲性能工具之 JProfiler 简单登录案例分析实战中已经发现SQL没有建立索引问题,本文将一起从代码层去分析为什么没有建立索引? 开源ERP项目地址:https://gitee.com/jishenghua/JSH_ERP 二、准备 打开IDEA找到登录请求资源路径位置

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来,一站式有声阅读平台听书系统 🌟&nbsp;开篇:遇见未来,从“智听”开始 在这个快节奏的时代,你是否渴望在忙碌的间隙,找到一片属于自己的宁静角落?是否梦想着能随时随地,沉浸在知识的海洋,或是故事的奇幻世界里?今天,就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统,它正悄悄改变着我们的阅读方式,让未来触手可及! 📚&nbsp;第一站:海量资源,应有尽有 走进“智听

Java ArrayList扩容机制 (源码解读)

结论:初始长度为10,若所需长度小于1.5倍原长度,则按照1.5倍扩容。若不够用则按照所需长度扩容。 一. 明确类内部重要变量含义         1:数组默认长度         2:这是一个共享的空数组实例,用于明确创建长度为0时的ArrayList ,比如通过 new ArrayList<>(0),ArrayList 内部的数组 elementData 会指向这个 EMPTY_EL

如何在Visual Studio中调试.NET源码

今天偶然在看别人代码时,发现在他的代码里使用了Any判断List<T>是否为空。 我一般的做法是先判断是否为null,再判断Count。 看了一下Count的源码如下: 1 [__DynamicallyInvokable]2 public int Count3 {4 [__DynamicallyInvokable]5 get

SWAP作物生长模型安装教程、数据制备、敏感性分析、气候变化影响、R模型敏感性分析与贝叶斯优化、Fortran源代码分析、气候数据降尺度与变化影响分析

查看原文>>>全流程SWAP农业模型数据制备、敏感性分析及气候变化影响实践技术应用 SWAP模型是由荷兰瓦赫宁根大学开发的先进农作物模型,它综合考虑了土壤-水分-大气以及植被间的相互作用;是一种描述作物生长过程的一种机理性作物生长模型。它不但运用Richard方程,使其能够精确的模拟土壤中水分的运动,而且耦合了WOFOST作物模型使作物的生长描述更为科学。 本文让更多的科研人员和农业工作者

MOLE 2.5 分析分子通道和孔隙

软件介绍 生物大分子通道和孔隙在生物学中发挥着重要作用,例如在分子识别和酶底物特异性方面。 我们介绍了一种名为 MOLE 2.5 的高级软件工具,该工具旨在分析分子通道和孔隙。 与其他可用软件工具的基准测试表明,MOLE 2.5 相比更快、更强大、功能更丰富。作为一项新功能,MOLE 2.5 可以估算已识别通道的物理化学性质。 软件下载 https://pan.quark.cn/s/57

工厂ERP管理系统实现源码(JAVA)

工厂进销存管理系统是一个集采购管理、仓库管理、生产管理和销售管理于一体的综合解决方案。该系统旨在帮助企业优化流程、提高效率、降低成本,并实时掌握各环节的运营状况。 在采购管理方面,系统能够处理采购订单、供应商管理和采购入库等流程,确保采购过程的透明和高效。仓库管理方面,实现库存的精准管理,包括入库、出库、盘点等操作,确保库存数据的准确性和实时性。 生产管理模块则涵盖了生产计划制定、物料需求计划、

衡石分析平台使用手册-单机安装及启动

单机安装及启动​ 本文讲述如何在单机环境下进行 HENGSHI SENSE 安装的操作过程。 在安装前请确认网络环境,如果是隔离环境,无法连接互联网时,请先按照 离线环境安装依赖的指导进行依赖包的安装,然后按照本文的指导继续操作。如果网络环境可以连接互联网,请直接按照本文的指导进行安装。 准备工作​ 请参考安装环境文档准备安装环境。 配置用户与安装目录。 在操作前请检查您是否有 sud

线性因子模型 - 独立分量分析(ICA)篇

序言 线性因子模型是数据分析与机器学习中的一类重要模型,它们通过引入潜变量( latent variables \text{latent variables} latent variables)来更好地表征数据。其中,独立分量分析( ICA \text{ICA} ICA)作为线性因子模型的一种,以其独特的视角和广泛的应用领域而备受关注。 ICA \text{ICA} ICA旨在将观察到的复杂信号

Spring 源码解读:自定义实现Bean定义的注册与解析

引言 在Spring框架中,Bean的注册与解析是整个依赖注入流程的核心步骤。通过Bean定义,Spring容器知道如何创建、配置和管理每个Bean实例。本篇文章将通过实现一个简化版的Bean定义注册与解析机制,帮助你理解Spring框架背后的设计逻辑。我们还将对比Spring中的BeanDefinition和BeanDefinitionRegistry,以全面掌握Bean注册和解析的核心原理。