本篇文章給大家分享的是有關(guān)如何在Flask中使用WTF表單,小編覺得挺實(shí)用的,因此分享給大家學(xué)習(xí),希望大家閱讀完這篇文章后可以有所收獲,話不多說,跟著小編一起來看看吧。
成都創(chuàng)新互聯(lián)公司堅(jiān)持“要么做到,要么別承諾”的工作理念,服務(wù)領(lǐng)域包括:成都網(wǎng)站設(shè)計(jì)、成都做網(wǎng)站、外貿(mào)網(wǎng)站建設(shè)、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣等服務(wù),滿足客戶于互聯(lián)網(wǎng)時(shí)代的臨武網(wǎng)站設(shè)計(jì)、移動媒體設(shè)計(jì)的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴!flask_wtf是flask框架的表單驗(yàn)證模塊,可以很方便生成表單,也可以當(dāng)做json數(shù)據(jù)交互的驗(yàn)證工具,支持熱插拔。
安裝
pip install Flask-WTF
Flask-WTF其實(shí)是對wtforms組件的封裝,使其支持對flask框架的熱插拔。
簡單使用
# app.py from flask import Flask, current_app, request, render_template from forms import MyForm app = Flask(__name__,template_folder='static/html') @app.route('/',methods=['GET','POST']) def login(): form = MyForm() if form.validate_on_submit(): return 'OK' return render_template('forms/index.html', form=form) if __name__ == '__main__': app.run(host='127.0.0.1', port=80, debug=True) # forms.py from flask_wtf import FlaskForm from wtforms import StringField from wtforms.validators import DataRequired class MyForm(FlaskForm): name = StringField('name', validators=[DataRequired()]) # forms/index.html <form method="POST" action="/"> {{ form.csrf_token }} {{ form.name.label }} {{ form.name(size=20) }} <input type="submit" value="Go"> </form>
flask_wtf定義字段
flask_wtf完全使用wtforms組件的字段模型,wtforms對字段的定義在fields模塊;又分為core和simple,core模塊定義了普通使用的字段,simple在core模塊的基礎(chǔ)上擴(kuò)展了一些字段,這些字段會自動進(jìn)行字段級別的校驗(yàn)。
字段類型
# core.py __all__ = ( 'BooleanField', 'DecimalField', 'DateField', 'DateTimeField', 'FieldList', 'FloatField', 'FormField', 'IntegerField', 'RadioField', 'SelectField', 'SelectMultipleField', 'StringField', )
常用字段說明:
BooleanField:布爾類型,如Flask,True
StringField:字符串類型
DecimalField:小數(shù)點(diǎn)文本字段,如:‘1.23'
DateField:日期字段,格式:'%Y-%m-%d'
DateTimeField:日期字段,格式:'%Y-%m-%d %H:%M:%S'
FieldList:統(tǒng)一字段類型組成列表,如:FieldList(StringField('Name', [validators.required()]))
FloatField:浮點(diǎn)數(shù)類型
IntegerField:整形
SelectMultipleField:多選框
RadioField:單選框
simple.py
TextAreaField:文本域,可接受多行輸入
PasswordField:密碼字段,輸入的不會直接在瀏覽器明文顯示
FileField:上傳文件,但不會處理驗(yàn)證文件,需要手動處理
HiddenField:隱藏字段
SubmitField:按鈕
TextField:字符串類型的別名,棄用
表單定義
# 參數(shù): class UserAdminForm(FlaskForm): username = StringField(label='用戶名', validators=[DataRequired(),Length(4,20)]) password_hash = PasswordField(label='密碼',validators=[DataRequired(),Length(4,20)]) limit = SelectField(label='用戶權(quán)限', choices=[('guest', '所有權(quán)限'), ('operation', '可讀可寫不可刪除'), ('management', '可讀不可寫')], default='guest') # 權(quán)限 # 字段一般的參數(shù) # label:字段的名字 # default:默認(rèn) # validators:字段的驗(yàn)證序列 # description:字段的描述 # choices:SelectField和他的子類有的字段,選擇框,多選一
字段的驗(yàn)證序列
字段的參數(shù)validators可以指定提交表單的驗(yàn)證序列,按照從左到右的順序,默認(rèn)的可選驗(yàn)證在wtforms.validators模塊,已經(jīng)封裝的驗(yàn)證方法有:
__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' )
模塊中大小寫有對應(yīng)的方式,如DataRequired對應(yīng)data_required。
DataRequired/data_required:驗(yàn)證數(shù)據(jù)是否真實(shí)存在,即不能為空,必須是非空白字符串,否則觸發(fā)StopValidation錯(cuò)誤。
InputRequired/input_required:和DataRequired的區(qū)別在于可以是空白字符串;
Required/required:data_required的別名
Email/email:驗(yàn)證符合郵件的格式,只有最基本的驗(yàn)證;
EqualTo/equal_to:比較兩個(gè)字段的值,比如密碼和確認(rèn)密碼,如果不相等就觸發(fā)錯(cuò)誤,equal_to(field,message),需要輸入另一個(gè)字段的名字。
IPAddress/ip_address:驗(yàn)證是否是ip地址,默認(rèn)驗(yàn)證IPV4地址。
MacAddress/mac_address:驗(yàn)證是否符合mac格式;
UUID:是否是uuid格式;
URL/url:驗(yàn)證是否符合url格式;
Regexp/regexp:用提供的正則表達(dá)式驗(yàn)證字段;Regexp(r"")
Length/length:設(shè)置字段值的長度,Length(min,max);
NumberRange/number_range:設(shè)置一個(gè)數(shù)字字段的取值范圍,可以針對浮點(diǎn)數(shù)和小數(shù);NumberRange(min,max)
Optional/optional:允許字段為空并停止驗(yàn)證;
NoneOf/none_of:將傳入的數(shù)據(jù)和無效的比較,是拋出異常;Noneof(values).
Anyof/any_of:將傳入的數(shù)據(jù)和預(yù)設(shè)的數(shù)據(jù)比較,不是異常。Anyof(values).
自定義字段驗(yàn)證
如果默認(rèn)的驗(yàn)證序列不滿足我們的要求,我們可以通過繼承的方式自定義字段。
from wtforms.validators import DataRequired,Length,StopValidation class NewStringField(StringField): """ 自定義一個(gè)新的字段 """ def pre_validate(self, form): """驗(yàn)證方法,在validators驗(yàn)證序列之前""" x:str = form.name.data if not x.startswith('g'): raise StopValidation("your data must be startswith 'g'") def post_validate(self, form, validation_stopped): """ 驗(yàn)證方法,在validators驗(yàn)證序列之后 :param form:該字段所屬的表單對象 :param validation_stopped:前面驗(yàn)證序列的結(jié)果,True表示驗(yàn)證通過,F(xiàn)alse表示驗(yàn)證失敗 :return: """ if not validation_stopped: raise ValueError("驗(yàn)證失敗了!") pass
觸發(fā)StopValidation異常會停止驗(yàn)證鏈;
自定義表單驗(yàn)證
一般來說,如果對表單有額外需要的驗(yàn)證,一般自定義表單的額外的驗(yàn)證方法而不是重新自定義新的字段,而form已經(jīng)為我們提供了這種方法。
看Form對象的源碼:
def validate(self): """ Validates the form by calling `validate` on each field, passing any extra `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)
Form對象調(diào)用validate函數(shù)時(shí)會自動尋找validate_%s的方法添加到驗(yàn)證序列,并在原先字段的驗(yàn)證序列驗(yàn)證完畢后執(zhí)行。
class MyForm(FlaskForm): name = StringField('name', validators=[DataRequired(), Length(4,20)]) def validate_name(self, field): print(field.data) if hasattr(self, 'name') and len(self.name.data) > 5: print(self.name.data) return True raise ValidationError('超過5個(gè)字符') # 在自定義的驗(yàn)證方法中,拋出異常使用ValidationError,validate會自動捕捉。
表單對象
flask_wtf推薦使用Form對象的子類FlaskForm代替,該對象提供了所有表單需要的屬性和方法。那么Form對象是如何自動實(shí)現(xiàn)表單功能的呢?
分析FlaskForm對象源碼:
class FlaskForm(Form): class Meta(DefaultMeta): def wrap_formdata(self, form, formdata): pass def __init__(self, formdata=_Auto, **kwargs): csrf_enabled = kwargs.pop('csrf_enabled', None) pass def is_submitted(self): pass def validate_on_submit(self): pass def hidden_tag(self, *fields): pass def validate(self): pass
FlaskForm內(nèi)部定義了一個(gè)Meta類,該類添加csrf保護(hù)的一些方法,所以創(chuàng)建表單的時(shí)候一定要導(dǎo)入FlaskForm而不是Form.
is_submitted:檢查是否有一個(gè)活躍的request請求;
validate_on_submit:調(diào)用is_submitted和validate方法,返回一個(gè)布爾值,用來判斷表單是否被提交;
validate:字段級別的驗(yàn)證,每個(gè)字段都有一個(gè)validate方法,F(xiàn)laskForm調(diào)用validate會對所有的字段調(diào)用validate方法驗(yàn)證,如果所有的驗(yàn)證都通過返回Ture,否則拋出異常。
hidden_tag:獲取表單隱藏的字段;
wrap_formdata:獲取request中的form,每次form對象初始化時(shí)會執(zhí)行該函數(shù)從request獲取form。
重要屬性
form.data:字段名字和值組成的字典;
form.errors:驗(yàn)證失敗的信息字典,在調(diào)用validate_on_submit方法后才有效;
form.name.data:字段name的值;
form.name.type:字段name的類型
常用場景
登錄驗(yàn)證
# froms.py class UserPasswordForm(FlaskForm): """ 登錄提交的表單 """ username = StringField('User', validators=[DataRequired()]) password = PasswordField('Password', validators=[DataRequired()]) # form.html <form method="POST" action="/"> {{ form.csrf_token }} {{ form.username.label }} {{ form.username(size=20) }} {{ form.password.label }} {{ form.password }} <input type="submit" value="Go"> </form> # views.py @app.route('/login',methods=['GET','POST']) def login(): form = UserPasswordForm() if form.validate_on_submit(): # 驗(yàn)證表單 if form.username.data == "xiaoming" and form.password.data == '123': return 'OK' return render_template('forms/index.html', form=form)
ajax請求轉(zhuǎn)化表單
有時(shí)候我們沒有html頁面的表單,只有ajax請求的數(shù)據(jù)交互,但是想借用Form來定義接口和驗(yàn)證接收的數(shù)據(jù),如果ajax的請求方法是('POST', 'PUT', 'PATCH', 'DELETE')中的一種,F(xiàn)laskForm會自動從request對象中調(diào)用request.form和request.get_json()方法來接收數(shù)據(jù),因此這種方式十分方便。注意:get方法不再其中。
# form.py class MyForm(FlaskForm): name = StringField('name', validators=[DataRequired(), Length(4,20)]) # view.py @app.route('/form',methods=['GET','POST']) def form(): if request.method != "GET": form = MyForm() # form會獲取請求數(shù)據(jù) print(form.data) return 'ok' return '' # test.py import requests as req import json class ProTest(): baseurl = 'http://127.0.0.1:80' def test_form(self): url = self.baseurl + '/form' rsp = req.post(url,json={'name':'hhhh'}) # rsp = req.get(url,json={'name':'hhhh'}) if __name__ == '__main__': test = ProTest() test.test_form()
form啟用csrf保護(hù)
默認(rèn)csrf保護(hù)是開啟的,只要在html文件中添加{{ form.csrf_token }},app必須設(shè)置SECRET_KEY參數(shù)。
# 禁用保護(hù) form = Form(csrf_enabled=False) # 或配置app時(shí) WTF_CSRF_ENABLED = False
一般數(shù)據(jù)csrf保護(hù)
同理必須設(shè)置SECRET_KEY參數(shù)。
from flask_wtf.csrf import CsrfProtect csrf = CsrfProtect() def create_app(): app = Flask(__name__) csrf.init_app(app) # 模板中添加一個(gè)隱藏域 <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" /> <meta name="csrf-token" content="{{ csrf_token() }}"> # 如果是ajax請求,可以在腳本中 var csrftoken = "{{ csrf_token() }}" # 然后每個(gè)請求添加 X-CSRFToken 頭部 # 全局禁用csrf WTF_CSRF_CHECK_DEFAULT = False # 對一些視圖跳過csrf檢查 @csrf.exempt @app.route('/foo', methods=('GET', 'POST')) def my_handler(): return 'ok'
以上就是如何在Flask中使用WTF表單,小編相信有部分知識點(diǎn)可能是我們?nèi)粘9ぷ鲿姷交蛴玫降?。希望你能通過這篇文章學(xué)到更多知識。更多詳情敬請關(guān)注創(chuàng)新互聯(lián)成都網(wǎng)站設(shè)計(jì)公司行業(yè)資訊頻道。
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn,海內(nèi)外云服務(wù)器15元起步,三天無理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢,專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
網(wǎng)頁標(biāo)題:如何在Flask中使用WTF表單-創(chuàng)新互聯(lián)
鏈接地址:http://muchs.cn/article4/ddjpoe.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站排名、商城網(wǎng)站、Google、企業(yè)建站、外貿(mào)建站、服務(wù)器托管
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容