使用Pydantic覆写类属性时如何进行数据验证?
Pydantic实例赋值时的字段验证方案
针对你遇到的实例化后修改字段无法触发验证的问题,Pydantic提供了直接的解决机制,分版本说明如下:
Pydantic v1 解决方案
在模型类的Config中开启validate_assignment=True,即可让实例赋值操作触发已定义的验证器:
from pydantic import BaseModel, validator class MyModel(BaseModel): some_field : str = None @validator("some_field") def verify_string(cls, v): print(f"Verifying some_field value: {v}") if not isinstance(v, str): raise ValueError(f"some_field must be str; got type {type(v)}") return v # 开启赋值验证配置 class Config: validate_assignment = True # 实例化模型 m = MyModel(some_field = "test") ## 输出: Verifying some_field value: test print(m.some_field) ## 输出: test # 使用无效类型覆写字段,此时会抛出ValueError m.some_field = 100 # <-- 此处触发验证并抛出错误 print(m.some_field) # 这行代码不会执行
Pydantic v2 解决方案
Pydantic v2默认就会对实例赋值操作进行验证,无需额外配置,仅需将验证器写法改为@field_validator:
from pydantic import BaseModel, field_validator class MyModel(BaseModel): some_field : str | None = None @field_validator("some_field") def verify_string(cls, v): print(f"Verifying some_field value: {v}") if v is not None and not isinstance(v, str): raise ValueError(f"some_field must be str; got type {type(v)}") return v # 实例化模型 m = MyModel(some_field = "test") ## 输出: Verifying some_field value: test print(m.some_field) ## 输出: test # 使用无效类型覆写字段,触发ValidationError m.some_field = 100 # <-- 此处抛出验证错误 print(m.some_field) # 这行代码不会执行
如果需要完全禁止字段被修改,可以在字段定义时添加frozen=True参数,但这属于限制修改而非验证逻辑。
内容的提问来源于stack exchange,提问作者Brian
相关产品推荐
相关产品推荐

