0

0

pydantic v2 如何让字段在序列化时完全忽略(不输出)

舞姬之光

舞姬之光

发布时间:2026-01-23 19:52:02

|

836人浏览过

|

来源于php中文网

原创

Pydantic v2 中临时排除字段用 .model_dump(exclude=...),永久排除用 Field(exclude=True);私有字段不再自动忽略,必须显式设置 exclude;exclude=True 不影响验证,仅控制序列化输出。

pydantic v2 如何让字段在序列化时完全忽略(不输出)

pydantic v2 中用 exclude 参数临时跳过字段序列化

最直接的方式是在调用 .model_dump().model_dump_json() 时传入 exclude 参数。它支持字段名字符串、setdict(用于嵌套排除)等多种形式:

  • exclude={"password"} —— 忽略顶层字段 password
  • exclude={"credentials": {"token"}} —— 忽略嵌套模型中 credentials.token
  • exclude={"_internal_id", "cache_ttl"} —— 一次排除多个字段

注意:exclude 是运行时控制,不影响模型定义,也不影响验证逻辑;同一实例多次调用可传不同 exclude 值。

Field(exclude=True) 让字段默认不参与序列化

若某个字段**永远不该出现在序列化结果里**(比如敏感缓存、内部状态),在字段定义时加 exclude=True 即可:

from pydantic import BaseModel, Field

class User(BaseModel): name: str password: str = Field(exclude=True) # 序列化时自动忽略 _version: int = Field(default=1, exclude=True)

这个设置会作用于所有序列化方法(.model_dump().model_dump_json().json() 等),且不会出现在 .model_json_schema() 的输出中。

⚠️ 容易踩的坑:exclude=True 不等于“不参与验证”——字段仍会校验类型、约束(如 min_length),只是不输出。如果真想完全跳过校验和序列化,得用私有字段 + Field(default=None, exclude=True) 并确保初始化时不传值。

用私有字段(下划线开头)配合 model_config = ConfigDict(ignored_types=(type,))?别这么干

pydantic v2 **不再自动忽略以下划线开头的字段**。私有字段(如 _temp_cache)默认仍会参与序列化,除非显式设 exclude=True

抖云猫AI论文助手
抖云猫AI论文助手

一款AI论文写作工具,最快 2 分钟,生成 3.5 万字论文。论文可插入表格、代码、公式、图表,依托自研学术抖云猫大模型,生成论文具备严谨的学术专业性。

下载

有人试图通过配置 ignored_types 或自定义 __pydantic_core_schema__ 绕过,但这些方式要么无效,要么破坏模型一致性。正确做法就是老老实实写 Field(exclude=True)

另外,Field(default_factory=...) 配合 exclude=True 是安全的,适用于需要动态生成但不暴露的内部值。

序列化时字段消失但反序列化仍需传入?检查 defaultdefault_factory

如果字段设置了 exclude=True,但它在构造模型实例时又必须提供(比如没有默认值),那它虽然不出现在输出里,却仍是必填项。这时容易误以为“被忽略了所以可以不传”,结果报 ValidationError

  • 要彻底移出输入/输出双通道:用 Field(default=None, exclude=True) + 初始化时确保不传该字段
  • 或改用 typing.ClassVar(仅限真正只读的类级别常量)
  • Field(init=False) 可让字段不参与 __init__,但需配合 exclude=True 才能不出现在序列化中

最稳妥的组合是:field_name: str = Field(default="fallback", exclude=True, init=False) —— 既不进初始化,也不进序列化,只在模型内部用。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

417

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

76

2025.09.10

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1491

2023.10.24

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6108

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

814

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1064

2023.12.21

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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