讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

updream

一键生成高质量推广成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

Laper
Laper

剧本策划到成片协作

怎么在Python中使用Pydantic v2进行请求校验?

秋芳姑娘_5074

秋芳姑娘_5074

发布时间:2026-11-20 06:52:38

|

242人浏览过

|

来源于php中文网

原创

Pydantic v2 中通过继承 BaseModel 并使用 Field 显式标注类型和校验规则定义请求模型,FastAPI 0.100+ 原生支持,自动调用 model_validate;查询参数和表单需分别用 Query() 和 Form() 绑定,错误定位应使用 exc.errors()。

怎么在python中使用pydantic v2进行请求校验?

Pydantic v2 中如何定义请求数据模型?

Pydantic v2 把模型定义从 BaseModel 迁移到了 BaseModel(名字没变,但内部机制完全不同),关键区别是默认启用 strict mode、移除了 Config 类的大部分字段,改用 model_config 字典或 @model_config 装饰器。

定义请求体模型时,必须显式标注类型,且推荐使用 Field 控制校验行为:

from pydantic import BaseModel, Field
from typing import Optional
<p>class UserCreate(BaseModel):
username: str = Field(..., min_length=3, max_length=20)
email: str
age: int = Field(ge=0, le=150)  # >=0 and <=150
is_active: Optional[bool] = None
  • ... 表示该字段必填;None 或省略默认值表示可选
  • Field 的 min_length/max_length 对 str 有效,对 int 无效——别错配
  • v2 不再支持 allow_mutation=False 这类旧 Config 写法,要用 model_config = {"frozen": True}

FastAPI 中怎么把 Pydantic v2 模型用于请求校验?

FastAPI 0.100+ 原生兼容 Pydantic v2,直接把模型作为路径函数参数即可,框架会自动调用 .model_validate()(不是旧版的 .parse_obj())解析并校验 JSON 请求体。

常见错误现象:ValidationError: 1 validation error for UserCreate\nemail\n Input should be a valid string——说明传入的是 null 或数字,而字段声明为 str。

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

在清理重构之前使用 Vulture 查找未使用的 Python 代码
在清理重构之前使用 Vulture 查找未使用的 Python 代码

在重构之前对Python代码库运行死代码检测,以便智能体能够标记未使用的函数、类、导入和变量,而不是盲目删除。

下载
  • 确保前端发送的是标准 JSON,比如 {"email": "a@b.c"},而非 {"email": null}(除非字段是 Optional[str])
  • 如果想允许空字符串作为合法值,得加 default="" 并配合 allow_empty=True(但 v2 中空字符串默认被接受,无需额外配置)
  • 嵌套模型要逐层定义,FastAPI 不会自动展开 dict —— 错误写法:user: dict;正确写法:user: UserCreate

如何处理查询参数和表单数据的校验?

Pydantic v2 本身不区分请求来源,校验逻辑统一;但 FastAPI 需要靠依赖注入来绑定不同来源的数据。查询参数用 Query,表单用 Form,它们底层仍走 Pydantic 校验流程。

from fastapi import Query, Form
from pydantic import BaseModel
<p>class SearchParams(BaseModel):
q: str = Field(..., min_length=1)
page: int = Field(1, ge=1)</p><h1>查询参数校验</h1><p>@app.get("/search")
def search(params: SearchParams = Query()): ...</p><h1>表单校验(需安装 python-multipart)</h1><p>@app.post("/upload")
def upload(file: bytes = Form(...), meta: SearchParams = Form()): ...
  • Query() 和 Form() 的括号不能省——否则 FastAPI 当作普通参数,不触发校验
  • 表单中混合文件和 JSON 字段时,非文件字段仍由 Pydantic 解析,但必须用 Form 显式标注,否则报 ValueError: field required
  • URL 编码的查询参数(如 ?q=hello%20world)会被自动解码后再进校验,无需手动 urllib.parse.unquote

遇到 ValidationError 怎么定位具体字段和原因?

Pydantic v2 的错误信息更结构化,但默认只返回第一层错误。调试时建议捕获异常并打印 exc.errors(),它返回一个 list,每项含 loc(字段路径)、msg(提示)、type(错误类型)。

from pydantic import ValidationError
<p>try:
user = UserCreate.model_validate({"username": "ab", "email": 123})
except ValidationError as exc:
print(exc.errors())</p><h1>输出类似:[{'loc': ('username',), 'msg': 'String should have at least 3 characters', ...},</h1><pre class="brush:php;toolbar:false;">#            {'loc': ('email',), 'msg': 'Input should be a valid string', ...}]

  • loc 是 tuple,比如 ('items', 0, 'name') 表示嵌套列表第一个元素的 name 字段
  • 不要依赖 str(exc) 做日志——它可能被截断或格式混乱;始终用 exc.errors()
  • 生产环境别直接返回原始错误给前端,FastAPI 默认已做封装,但自定义异常处理器里记得过滤敏感字段(如数据库字段名)

实际用起来最易忽略的是:Pydantic v2 对 None 的处理比 v1 更严格,哪怕字段声明为 Optional[str],如果传了 null(JSON 中),它仍会通过;但若传了 undefined(前端漏传)且字段没设默认值,就会报错——这个边界在前后端联调时最容易卡住。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

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

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

1971

2023.07.20

python能做什么
python能做什么

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

5604

2023.07.25

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

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

1909

2023.07.31

python教程
python教程

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

34217

2023.08.03

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

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

4007

2023.08.04

python eval
python eval

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

4007

2023.08.04

scratch和python区别
scratch和python区别

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

1283

2023.08.11

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

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

636

2023.08.10

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

20

2026.11.17

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn