如何使用Python的pydantic库进行类属性的运行时数据验证?

胖强同学_5531

胖强同学_5531

2026-07-27

367人浏览

原创

Pydantic v2 中 BaseModel 的验证仅在实例化时触发,赋值不自动验证;需设 validate_assignment=True 才支持赋值校验;自定义校验用 @field_validator;model_dump() 默认转原生类型,可用 round_trip=True 或 mode 参数控制;嵌套错误需捕获 ValidationError 并解析 errors()。

如何使用python的pydantic库进行类属性的运行时数据验证?

pydantic v2 中 BaseModel 的验证何时触发?

验证只在实例化时(即调用 MyModel(...))自动执行,赋值操作本身不触发重验证。比如定义了 age: int > 0,但后续写 obj.age = -5 不会报错——这常被误认为“验证失效”,其实是设计如此。

  • 验证发生在 __init__ 阶段,包括类型转换(如字符串转 int)和约束检查(如 @field_validator)
  • 字段赋值走的是普通 Python 属性设置逻辑,除非你显式启用 validate_assignment=True
  • 若需赋值时也验证,必须在模型定义中加配置:
    class User(BaseModel):
        age: int
        model_config = {"validate_assignment": True}

怎么写一个带自定义校验逻辑的字段?

用 @field_validator 装饰器,而不是旧版的 @validator(v2 已移除)。它接收原始输入值,返回处理后的值或抛出 ValueError/TypeError。

  • 装饰器参数填字段名字符串,支持多个字段一次装饰
  • 函数第一个参数是待校验的值,第二个可选参数是 ValidationInfo(含上下文如字段名、数据字典)
  • 别在 validator 里改 info.data —— 它是只读快照,修改无效
  • 示例:邮箱域名白名单校验
    from pydantic import BaseModel, field_validator
    
    class Contact(BaseModel):
        email: str
        @field_validator("email")
        def domain_must_be_company(cls, v):
            if not v.endswith("@example.com"):
                raise ValueError("only @example.com allowed")
            return v

为什么 model_dump() 后字段类型变了?

model_dump() 默认返回 Python 原生类型(datetime → str,Decimal → float),不是深拷贝原始对象。如果你需要保持类型不变,得关掉序列化转换:

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
  • 加参数 round_trip=True 可保留类型(但要求目标类型可被 JSON 反序列化,否则报错)
  • 更稳妥的做法是用 model_dump(mode="json") 得到 JSON 兼容结构,或 model_dump(mode="python") 得到原生类型映射
  • 注意:即使 mode="python",datetime 这类仍可能被转成 str,除非你手动配 serializer

嵌套模型验证失败时错误信息太模糊?

默认错误提示只说“1 validation error”,不指明哪个嵌套字段出问题。关键在于打开 strict=True 或用 model_validate() 替代构造函数,并捕获 ValidationError 手动解析。

  • 直接 print exc.errors() 能看到带 loc(位置路径)的详细列表,例如 [{"loc": ["address", "zip_code"], "msg": "field required"}]
  • 避免用 try/except ValueError 捕获——必须捕获 pydantic.ValidationError
  • 调试时建议加 raise_errors=True 参数给 model_validate(),它比构造函数报错更透明

复杂嵌套 + 自定义 validator 的组合容易漏掉中间层的 None 或空字典,实际校验前最好先确认输入结构是否符合预期。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1851

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5064

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1809

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

30537

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3627

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3647

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1243

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2823

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程