pydantic-validation-decorator

支持手动调用的实用的pydantic验证装饰器

GitHub PyPI

目录

安装

pip install pydantic-validation-decorator -U

开始使用

from pydantic import BaseModel
from typing import Optional
class NotBlankTestModel(BaseModel):
 user_name: Optional[str] = None

from pydantic import BaseModel
from typing import Optional
from pydantic_validation_decorator import NotBlank
class NotBlankTestModel(BaseModel):
 user_name: Optional[str] = None
 @NotBlank(
 field_name='user_name',
 message='user_name cannot be blank',
 )
 def get_user_name(self):
 return self.user_name
 def validate_fields(self):
 self.get_user_name()

from pydantic_validation_decorator import ValidateFields
@ValidateFields(validate_model='not_blank_test', validate_function='validate_fields')
def test_not_blank_decorator(not_blank_test: NotBlankTestModel):
 return not_blank_test.model_dump()

from pydantic_validation_decorator import FieldValidationError
if __name__ == '__main__':
 not_blank_test = NotBlankTestModel()
 try:
 print(test_not_blank_decorator(not_blank_test=not_blank_test))
 except FieldValidationError as e:
 print(e.__dict__)

{'model_name': 'NotBlankTestModel', 'field_name': 'user_name', 'field_value': None, 'validator': 'NotBlank', 'message': 'user_name cannot be blank'}

from pydantic_validation_decorator import (
 ValidateFields,
 NotBlank,
 FieldValidationError,
)
from pydantic import BaseModel
from typing import Optional
class NotBlankTestModel(BaseModel):
 user_name: Optional[str] = None
 @NotBlank(
 field_name='user_name',
 message='user_name cannot be blank',
 )
 def get_user_name(self):
 return self.user_name
 def validate_fields(self):
 self.get_user_name()
@ValidateFields(validate_model='not_blank_test', validate_function='validate_fields')
def test_not_blank_decorator(not_blank_test: NotBlankTestModel):
 return not_blank_test.model_dump()
if __name__ == '__main__':
 not_blank_test = NotBlankTestModel()
 try:
 print(test_not_blank_decorator(not_blank_test=not_blank_test))
 except FieldValidationError as e:
 print(e.__dict__)

已有装饰器列表

@ValidateFields 字段验证装饰器

@Alpha 字段字母验证装饰器

@Network 字段网络类型验证装饰器

@NotBlank 字段非空验证装饰器

@Pattern 字段正则验证装饰器

@Size 字段大小验证装饰器

@Xss 字段Xss验证装饰器

参与贡献

git clone https://github.com/insistence/pydantic-validation-decorator.git
cd pydantic-validation-decorator
# 安装开发环境所需依赖
pip install -r requirements-dev.txt