0

0

Python接口数据校验方法_pydantic实战解析【技巧】

冷炫風刃

冷炫風刃

发布时间:2025-12-26 22:20:03

|

508人浏览过

|

来源于php中文网

原创

Pydantic v2 默认禁止额外字段且校验错误提示不友好,需配置 model_config={"extra": "allow"} 并扁平化 errors() 输出;自定义校验器必须显式 return 值,model_dump() 替代 dict() 且默认行为不同。

python接口数据校验方法_pydantic实战解析【技巧】

Pydantic v2 里 BaseModel 默认不再允许额外字段

很多老项目升级到 Pydantic v2 后,接口接收 JSON 时突然报 ValidationError,提示 “extra fields not permitted”,其实不是数据错了,而是模型默认关掉了未知字段。这和 v1 的宽松行为完全不同。

解决方法是显式开启允许:

from pydantic import BaseModel

class UserRequest(BaseModel): name: str age: int

class Config:
    extra = "allow"  # v1 写法,v2 中已弃用

v2 正确写法改用 model_config

class UserRequest(BaseModel):
    name: str
    age: int
model_config = {"extra": "allow"}
  • "allow":忽略多余字段,不报错
  • "ignore":静默丢弃(不推荐,容易掩盖前端传参错误)
  • "forbid":严格禁止(默认值,也是最安全的选择)

嵌套结构校验失败时,ValidationErrorerrors() 输出难读

当请求体含多层嵌套(比如 address.city 缺失),默认的 e.errors() 返回的是带 loc 元组的字典,像 [{"loc": ["address", "city"], "msg": "Field required"}],直接返回给前端不友好。

立即学习Python免费学习笔记(深入)”;

建议封装一层扁平化处理:

def format_pydantic_errors(e):
    return [
        {"field": ".".join(err["loc"]), "message": err["msg"]}
        for err in e.errors()
    ]

使用示例

try: UserRequest(**data) except ValidationError as e: return {"errors": format_pydantic_errors(e)}

  • 避免直接暴露 loc 给前端,尤其是内部字段名(如 __root__
  • 如果用了 Field(alias=...)loc 仍显示原始字段名,需手动映射别名
  • 批量校验多个对象时,ValidationError 会合并所有错误,errors() 仍可用

@field_validator 做业务逻辑校验,但忘记 return value

自定义校验器里最常踩的坑:写了逻辑判断却没返回值,导致字段被清空为 None。Pydantic 不会帮你兜底。

海螺AI
海螺AI

MiniMax平台的AI对话问答工具,你的AI伙伴

下载

比如校验手机号格式后忘了返回:

from pydantic import field_validator

@field_validator("phone") def validate_phone(cls, v): if not re.match(r"^1[3-9]\d{9}$", v): raise ValueError("invalid phone number")

❌ 忘了 return v → 字段值变成 None

  • 所有 @field_validator 函数必须显式 return 处理后的值(哪怕没改)
  • 若想支持空值跳过校验,加参数 skip_on_failure=True,但慎用,容易掩盖必填逻辑
  • 涉及数据库查重等 IO 操作,不要放在这里——validator 是同步且无 await 支持的

model_dump()dict() 在 v2 中行为不同

v2 废弃了 .dict(),改用 .model_dump()。但很多人迁移时只改函数名,没注意默认参数变化:旧版 .dict(exclude_unset=True) 对应新版的 .model_dump(exclude_unset=True),但默认值变了。

关键差异:

  • .model_dump() 默认导出所有字段(含未设置的默认值)
  • .model_dump(exclude_unset=True) 才等价于旧版 .dict()
  • 如果字段有 default_factory,且没被赋值,exclude_unset=True 也不会排除它——得用 exclude_defaults=True

API 响应常用组合:

user = UserResponse(name="Alice", age=25)
user.model_dump(exclude_unset=True, exclude_none=True)

这样既不传未设置字段,也不传 None 值,更符合 RESTful 接口习惯。

字段级别控制还有 aliasby_aliasexclude 等,但多数场景只需记住:不加 exclude_unset 就很可能把默认值也吐出去,前端拿到意外字段。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

707

2023.06.15

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

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

625

2023.07.20

python能做什么
python能做什么

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

735

2023.07.25

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

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

616

2023.07.31

python教程
python教程

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

1234

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

573

2023.08.04

scratch和python区别
scratch和python区别

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

695

2023.08.11

虚拟号码教程汇总
虚拟号码教程汇总

本专题整合了虚拟号码接收验证码相关教程,阅读下面的文章了解更多详细操作。

25

2025.12.25

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号