使用Flask和Pydantic實現參數驗證

1 簡介

Pydantic是一個用于數據驗證和解析的 Python 庫，版本2的性能有較大提升，很多框架使用Pydantic做數據校驗。

# 官方參考文檔
https://docs.pydantic.dev/latest/# Github地址
https://github.com/pydantic/pydantic

2 使用Flask自定義參數校驗

2.1 結構

2.2 源代碼

app_result.py

import jsonfrom flask import jsonifydef result(data: object = None, code: int = 200, msg: str = "success"):"""Set the result of web:param data: It is data of status:param code: It is code of status:param msg: It is a message of status:return: dict"""# 將對象轉化為json字符串data_json_str = json.dumps(data, ensure_ascii=False, default=lambda obj: obj.__dict__)# 將json字符串轉化為json字典data_json_dict = json.loads(data_json_str)# 設置返回值字典result_dict = {"code": code,"msg": msg,"data": data_json_dict}return jsonify(result_dict)

validate_request.py

from flask import request
from pydantic import ValidationErrorfrom entity.app.app_result import resultdef validate_form(form_object):# 設置含有請求參數的裝飾器def inner(fun):def inner_sub():try:# 獲取Content-Typecontent_type = request.content_typeif content_type is None:return result(code=400, msg="No parameters")# 驗證參數form_instance = None# 獲取 “application/json” 請求if "application/json" in content_type:# 獲取json字典數據parameters = request.get_json(silent=True)# 將字典轉化為對象form_instance = form_object(**parameters)else:# 獲取 "application/x-www-form-urlencoded" 或者 "multipart/form-data" 請求等parameters = request.form.to_dict()# 將字典轉化為對象form_instance = form_object(**parameters)# print(parameters)return fun(form_instance)except ValidationError as e:print(e.json())# 存儲錯誤參數列表parameters_invalid = list()# 處理參數for error in e.errors():parameters_invalid.append({"attr": error.get("loc")[0],"msg": error.get("msg")})return result(parameters_invalid, code=400, msg="The parameter is invalid")# 更改視圖名稱inner_sub.__name__ = fun.__name__return inner_subreturn inner

data_form.py

from typing import Optionalfrom pydantic import BaseModel, Field, field_validatorclass DataForm(BaseModel):# Python中"..."3個點是Ellipsis對象，主要用于切片操作和類型注解?# pydantic中Field的"..."3個點表示必填項name: str = Field(..., title="The name of the item", description="deldldlddl", max_length=5)desc: Optional[str] = Field(..., title="The description of the item", max_length=2)price: float = Field(..., title="The price of the item", ge=0.01)"""# 如果不使用Field設置驗證參數，可以使用@field_validator注解# 自定義驗證器@field_validator('price')# cls是一個用于類方法的參數，代表類本身def age_must_be_positive(cls, v):if v < 0:raise ValueError('年齡不能為負數')return v"""

index.py

from flask import Flask, Blueprintfrom test.data_form import DataForm
from entity.form.validate_request import validate_formapp = Flask(__name__)# 構建藍本
admin = Blueprint("admin", __name__)@admin.route("/info")
@validate_form(DataForm)
def info(info_form: DataForm):print(info_form.name)print(info_form.desc)return "Hello Admin"@admin.route("/msg")
@validate_form(DataForm)
def msg(msg_form: DataForm):print(msg_form)return "Hello Admin"# 注冊藍本
app.register_blueprint(admin, url_prefix='/admin')if __name__ == '__main__':app.run(host='0.0.0.0', debug=True)

2.3 返回值