Pydantic 数据验证讲解
文章目录一、为什么需要 Pydantic二、安装三、基础模型BaseModel四、Field更精细的控制五、自定义验证器1. 字段验证器field_validator2. 模型级验证器model_validator六、嵌套模型与复杂类型七、配置管理pydantic-settings八、常用进阶特性速览九、与 FastAPI 的结合预告十、最佳实践Pydantic 是 Python 中最流行的数据验证与设置管理库深度结合类型注解能自动做类型转换、数据校验、生成文档和序列化。它是 FastAPI 的核心依赖也广泛应用于配置管理、API 接口、数据处理等场景。当前主流版本是Pydantic v2性能大幅提升API 更清晰。一、为什么需要 Pydantic传统手动验证defcreate_user(data:dict):ifnamenotindataornotisinstance(data[name],str):raiseValueError(name 必须是字符串)ifageindataand(notisinstance(data[age],int)ordata[age]0):raiseValueError(age 必须是非负整数)# ... 非常繁琐使用 Pydantic 后frompydanticimportBaseModelclassUser(BaseModel):name:strage:intuserUser(nameAlice,age25)# 自动验证 转换print(user.name,user.age)优点声明式代码简洁自动类型转换如25→25详细的错误信息与 IDE / 类型检查器完美配合支持 JSON 序列化/反序列化可生成 JSON Schema二、安装pipinstallpydantic# 如果需要配置管理pipinstallpydantic-settings三、基础模型BaseModelfrompydanticimportBaseModel,FieldclassUser(BaseModel):name:strage:intemail:str|NoneNone# 可选字段is_active:boolTrue# 默认值# 创建实例自动验证userUser(nameAlice,age25)# 字符串 25 会自动转成 intprint(user)# nameAlice age25 emailNone is_activeTrueprint(user.model_dump())# 转成字典v2 推荐用法print(user.model_dump_json())# 转成 JSON 字符串常用方法Pydantic v2方法作用model_dump()转成 Python 字典model_dump_json()转成 JSON 字符串model_validate()从字典/对象创建并验证model_validate_json()从 JSON 字符串创建并验证model_json_schema()生成 JSON Schema四、Field更精细的控制frompydanticimportBaseModel,FieldclassUser(BaseModel):name:strField(min_length2,max_length50,description用户名)age:intField(gt0,lt150,example25)# gt大于, lt小于score:floatField(default0,ge0,le100)# ge大于等于tags:list[str]Field(default_factorylist)# 可变默认值用 default_factorypassword:strField(reprFalse)# 不在 repr 中显示常用约束参数min_length/max_length字符串、列表等gt/ge/lt/le数值pattern正则字符串default/default_factorydescription、example用于文档生成alias别名用于接收/输出不同字段名五、自定义验证器1. 字段验证器field_validatorfrompydanticimportBaseModel,field_validatorclassUser(BaseModel):name:strage:intfield_validator(name)classmethoddefname_must_not_be_empty(cls,v:str)-str:ifnotv.strip():raiseValueError(姓名不能为空)returnv.strip().title()# 可顺便做转换field_validator(age)classmethoddefage_check(cls,v:int)-int:ifv0:raiseValueError(年龄不能为负数)returnv2. 模型级验证器model_validator用于跨字段校验frompydanticimportBaseModel,model_validatorclassRegisterForm(BaseModel):password:strconfirm_password:strmodel_validator(modeafter)defcheck_passwords_match(self)-RegisterForm:ifself.password!self.confirm_password:raiseValueError(两次密码不一致)returnselfmodebefore在验证前处理原始数据modeafter在字段验证后处理。六、嵌套模型与复杂类型frompydanticimportBaseModelfromdatetimeimportdatetimeclassAddress(BaseModel):city:strstreet:strclassUser(BaseModel):name:straddress:Address# 嵌套模型tags:list[str][]metadata:dict[str,str]{}created_at:datetime userUser(nameAlice,address{city:北京,street:中关村大街},# 自动转成 Address 对象created_at2026-08-24T12:00:00# 自动解析时间)print(user.address.city)# 北京支持的类型非常丰富list、dict、set、tuple、Optional、Union、Literal、自定义类等。七、配置管理pydantic-settings非常适合读取环境变量和.env文件frompydantic_settingsimportBaseSettings,SettingsConfigDictclassSettings(BaseSettings):model_configSettingsConfigDict(env_file.env,env_file_encodingutf-8,extraignore# 忽略未定义的环境变量)app_name:strMyAppdebug:boolFalsedatabase_url:strmax_connections:int10settingsSettings()print(settings.database_url)对应.env文件DATABASE_URLpostgresql://user:passlocalhost/db DEBUGtrue八、常用进阶特性速览特性说明Literal限制字段只能是特定值EmailStr邮箱格式验证需安装email-validatorHttpUrlURL 验证conint/constr等带约束的类型v2 更推荐用 FieldConfigDict模型配置frozenTrue不可变、extraforbid禁止额外字段等computed_field计算字段model_serializer自定义序列化逻辑TypeAdapter不需要完整模型也能验证简单类型示例禁止额外字段 不可变frompydanticimportBaseModel,ConfigDictclassUser(BaseModel):model_configConfigDict(extraforbid,frozenTrue)name:strage:int九、与 FastAPI 的结合预告FastAPI 直接使用 Pydantic 模型做请求体验证和响应序列化fromfastapiimportFastAPIfrompydanticimportBaseModel appFastAPI()classUserCreate(BaseModel):name:strage:intapp.post(/users/)defcreate_user(user:UserCreate):return{message:f创建用户{user.name}}这就是为什么学 FastAPI 之前强烈建议先掌握 Pydantic。十、最佳实践优先使用类型注解 Field 约束少写手动 if 判断可变默认值一定要用default_factory生产环境建议设置extraforbid防止多余字段悄悄进入复杂校验优先用field_validator/model_validator配置类继承BaseSettings业务数据模型继承BaseModelv2 中统一使用model_dump()、model_validate()等方法旧的.dict()、.parse_obj()已弃用 感谢阅读想了解更多 我的博客网站 | 记录思考分享干货 我的个人主页 | 关于我、开源项目

相关新闻

Lapse:基于MCP的AI Agent共享记忆空间,让笔记成为Agent的持久化上下文

Lapse:基于MCP的AI Agent共享记忆空间,让笔记成为Agent的持久化上下文

这次我们来看一个很有意思的开源项目:Lapse。它第一眼看上去就是个笔记应用,但作者给它的定位多了一层——同时也是你的 AI Agents 的共享记忆空间。从项目介绍来看,它是 notes app,核心能力却是通过 MCP(Model Contex…

2026/10/31 8:04:09 阅读更多 →
3D-ResNet视频行为识别实战:从原理到部署的完整指南

3D-ResNet视频行为识别实战:从原理到部署的完整指南

简介:在计算机视觉领域,视频行为识别是一项核心任务,旨在让机器理解视频中的人类动作。其技术原理主要基于深度学习模型,特别是卷积神经网络(CNN)的时空扩展。3D卷积神经网络(3D-CNN&#xff09…

2026/10/24 9:16:04 阅读更多 →
Unity ARPG技能系统实战:数据驱动设计与可视化编辑器开发

Unity ARPG技能系统实战:数据驱动设计与可视化编辑器开发

简介:在游戏开发领域,数据驱动设计是一种核心架构思想,它通过将游戏逻辑与配置数据分离,实现内容的高度可配置与快速迭代。其原理在于将频繁变化的元素(如技能效果、数值)抽象为结构化数据,运行…

2026/10/29 17:22:58 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年,我大部分时间都在跟浏览器标签页打交道,直到第一次把桌面应用跑起来,才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词,最开始是在某段时间频繁出现在同事的讨论里,一个用HTML…

2026/11/1 0:24:43 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介:亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档,主要面向智能锁安装人员、终端用户及售后维护者,帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件,大小4.37MB,内容结构清晰&#xff…

2026/10/31 10:20:19 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统,整车要求空载跑到8m/s,电机转速已经拉到额定点,驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令,转速纹丝不动,三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/10/31 10:20:23 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年,用它写过嵌入式驱动、做过游戏服务端,也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词,我其实挺感慨的——这门语言的难点从来不是语法多,而是知识点之间的耦合太深…

2026/11/1 1:06:58 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介:亚太天能T109滑盖智能锁产品说明书以PDF格式发布,适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开,先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能,再给出完整安装步骤&…

2026/10/31 10:30:19 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历:翻开源码注释、论文摘要或者一份专业报告,每个字都认识,连在一起却像天书。想找人聊聊,身边要么没人懂,要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型,几秒钟之后&a…

2026/10/31 9:29:43 阅读更多 →

日新闻

周新闻

月新闻