pydantic 后端学习基础教程

下面按“对象 → 用途 → 时机”整理的一份简易学习教程。主要逻辑是模型和字段是骨架配置是策略验证器管输入序列化器管输出before / after / plain / wrap** 是插入点。**0. 学习地图抽象概念模型 字段 具体用途配置 验证器 序列化器 生命周期before / after / plain / wrap学习顺序建议会定义模型和字段会写模型配置和字段配置会写字段验证器、模型验证器会写字段序列化器、模型序列化器理解它们谁先谁后做一个小项目User / Product / Order1. 抽象概念模型和字段模型模型就是BaseModel的子类描述一类数据结构。frompydanticimportBaseModelclassUser(BaseModel):id:intname:str字段字段由类型注解和Field 配置组成。frompydanticimportBaseModel,FieldclassUser(BaseModel):id:intname:strField(min_length2,max_length20)id: int字段名和类型Field(...)字段级配置如默认值、约束、别名模型配置模型级配置写在model_config里frompydanticimportBaseModel,ConfigDictclassUser(BaseModel):model_configConfigDict(extraforbid)id:intname:str2. 具体用途一配置配置分两层层级写法作用模型级model_config ConfigDict(...)控制整个模型行为字段级Field(...)控制单个字段常用模型配置model_configConfigDict(extraforbid,# 禁止额外字段str_strip_whitespaceTrue,# 字符串去首尾空格validate_assignmentTrue,# 赋值时也验证from_attributesTrue,# 支持从对象属性读取frozenTrue,# 实例不可变)常用字段配置name:strField(min_length2,max_length20)age:intField(ge0,le150)price:floatField(gt0)3. 具体用途二验证器验证器管输入原始数据如何变成合法模型。3.1 字段验证器用field_validator只作用于一个或多个字段。frompydanticimportBaseModel,field_validatorclassUser(BaseModel):age:intfield_validator(age,modebefore)classmethoddefparse_age(cls,v):ifisinstance(v,str):returnint(v)returnvfield_validator(age,modeafter)classmethoddefcheck_age(cls,v):ifv0:raiseValueError(age 不能为负)returnv四种模式模式含义before在 Pydantic 默认验证前执行after在 Pydantic 默认验证后执行默认模式plain完全替代默认验证Field约束也会失效wrap包裹默认验证可调用handler进入内部逻辑wrap示例frompydanticimportfield_validatorfield_validator(age,modewrap)classmethoddefwrap_age(cls,v,handler):print(before wrap)resulthandler(v)# 进入默认验证print(after wrap)returnresultplain示例field_validator(age,modeplain)classmethoddefplain_age(cls,v):returnint(v)# 完全接管不再走默认验证3.2 模型验证器用model_validator作用于整个模型适合跨字段校验。frompydanticimportBaseModel,model_validatorclassRegister(BaseModel):password:strconfirm:strmodel_validator(modeafter)defcheck_password(self):ifself.password!self.confirm:raiseValueError(两次密码不一致)returnself模型验证器支持beforeafterwrap注意模型验证器 **没有 **plain。4. 具体用途三序列化器序列化器管输出模型实例如何变成 dict / JSON。4.1 字段序列化器frompydanticimportBaseModel,field_serializerclassUser(BaseModel):name:strfield_serializer(name,modeplain)defserialize_name(self,v):returnv.upper()字段序列化器只有两种模式模式含义plain替代默认序列化默认模式wrap包裹默认序列化可调用handlerwrap示例field_serializer(name,modewrap)defserialize_name(self,v,handler):resulthandler(v)returnresult!4.2 模型序列化器frompydanticimportBaseModel,model_serializerclassUser(BaseModel):id:intname:strmodel_serializer(modewrap)defserialize_model(self,handler):datahandler(self)data[extra]helloreturndata模型序列化器同样只有plainwrap5. 生命周期总览5.1 验证顺序模型 wrap → 模型 before → 字段 wrap → 字段 before → 核心验证类型转换 Field 约束 嵌套模型 → 字段 after → 字段 wrap 后处理 → 模型 after → 模型 wrap 后处理 → 模型实例简记模型 wrap → 模型 before → 字段 wrap → 字段 before → 核心验证 → 字段 after → 模型 after → 模型 wrap 后处理5.2 序列化顺序模型 wrap → 默认模型序列化 → 遍历字段 → 字段 wrap → 默认字段序列化 → 字段 wrap 后处理 → 模型 wrap 后处理 → 最终 dict / JSON如果某层用了plain就直接替代该层默认逻辑。5.3 模式支持表模式字段验证器模型验证器字段序列化器模型序列化器before✅✅❌❌after✅✅❌❌plain✅❌✅✅wrap✅✅✅✅说明字段验证器支持before、after、plain、wrap模型验证器支持before、after、wrap**不支持 **plain字段序列化器只支持plain、wrap模型序列化器只支持plain、wrap简记验证器有 before / after / plain / wrap 模型验证器没有 plain 序列化器只有 plain / wrap 字段和模型序列化器都一样6. 综合模板frompydanticimport(BaseModel,Field,ConfigDict,field_validator,model_validator,field_serializer,model_serializer,)classProduct(BaseModel):model_configConfigDict(extraforbid,str_strip_whitespaceTrue)name:strField(min_length2)price:floatField(gt0)quantity:intField(ge0)field_validator(price,modebefore)classmethoddefparse_price(cls,v):ifisinstance(v,str):vv.replace($,).strip()returnvfield_validator(price,modeafter)classmethoddefround_price(cls,v):returnround(v,2)model_validator(modeafter)defcheck_business(self):ifself.quantity0andself.price100:raiseValueError(quantity0 时 price 不能超过 100)returnselffield_serializer(price,modeplain)defserialize_price(self,v):returnf${v:.2f}model_serializer(modewrap)defserialize_model(self,handler):datahandler(self)data[total]self.price*self.quantityreturndata pProduct(name Apple ,price$3.456,quantity2)print(p)print(p.model_dump())7. 学习路线模型和字段会写BaseModel、类型注解、Field配置会写ConfigDict知道extra、frozen、validate_assignment字段验证器会写before、after理解plain、wrap模型验证器会写跨字段校验如密码确认字段序列化器会隐藏字段、格式化字段模型序列化器会包装整个输出生命周期能说清验证和序列化的先后顺序练习做一个User注册模型要求邮箱自动转小写密码和确认密码一致序列化时隐藏密码输出时增加full_name8. 常见坑Pydantic v2 用model_config ConfigDict(...)不再用class Configfield_validator默认是afterplain会跳过默认验证和Field约束wrap必须调用handler才会执行默认逻辑序列化器没有before/after只有plain/wrap模型验证器没有plain验证和序列化是两条独立管道先验证后序列化序列化不会重新验证model_开头字段受保护必要时设置protected_namespaces()按这个顺序学先把模型和字段用熟再学配置然后验证器最后序列化器你就能把 Pydantic 的主干掌握住。