0

0

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

冰川箭仙

冰川箭仙

发布时间:2026-01-21 18:53:20

|

570人浏览过

|

来源于php中文网

原创

最直接推荐的方式是使用 Field(exclude=True)。该方式能彻底排除字段,使其在任何序列化结果中都不出现,且不影响验证或初始化;而 exclude_unset 或 exclude_defaults 仅条件性排除,无法保证字段永远不出现。

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

在 Pydantic v2 中,若想让某个字段**在序列化(如 .model_dump().model_dump_json())时完全不出现**,最直接、推荐的方式是使用 Field(exclude=True)

Field(exclude=True) 彻底排除字段

这是官方支持的、语义明确的标准做法。被标记为 exclude=True 的字段不会出现在任何序列化结果中(无论 exclude_unsetexclude_defaults 等参数如何设置),也不会影响模型验证或初始化。

示例:

from pydantic import BaseModel, Field

class User(BaseModel): name: str email: str internal_id: int = Field(exclude=True) # ✅ 序列化时完全消失

user = User(name="Alice", email="a@example.com", internal_id=123) print(user.model_dump()) # {'name': 'Alice', 'email': 'a@example.com'} print(user.model_dump_json()) # {"name":"Alice","email":"a@example.com"}

避免误用 exclude_unsetexclude_defaults

这两个参数控制的是“条件性排除”,不是字段本身的属性:

Viggle AI
Viggle AI

Viggle AI是一个AI驱动的3D动画生成平台,可以帮助用户创建可控角色的3D动画视频。

下载
  • exclude_unset=True:只对未显式赋值(即使用默认值且未传参)的字段生效;一旦你传了 internal_id=123,它就会出现在输出里。
  • exclude_defaults=True:仅当字段值等于其默认值(包括 DefaultFactory 生成的)时才排除;对非默认值无效。
  • 它们都不能保证字段“永远不出现”,所以不能替代 Field(exclude=True)

其他场景补充说明

如果你需要更细粒度控制(比如仅在 JSON 中排除、或按不同模式切换),可考虑:

  • 自定义 model_dump 调用:显式传入 exclude={'internal_id'},但这是调用侧控制,不改变字段定义本身。
  • @computed_field + exclude=True:适用于动态计算且不应序列化的字段。
  • 私有字段(_xxx)不会自动排除:Pydantic v2 不再按命名约定自动忽略下划线字段,必须显式声明 Field(exclude=True) 才行。

不推荐的写法(易出错)

不要依赖以下方式:

  • internal_id: Optional[int] = None + exclude_unset:不可靠,一旦赋值就暴露。
  • 重写 __pydantic_core_schema__ 或魔改序列化逻辑:过度复杂,破坏可维护性。
  • Field(default=None, exclude=True) 混合写法:exclude=True 已足够,default 是独立配置,无需捆绑。

相关专题

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

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

415

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数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

338

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

542

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

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

53

2025.08.29

C++中int的含义
C++中int的含义

本专题整合了C++中int相关内容,阅读专题下面的文章了解更多详细内容。

197

2025.08.29

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

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

精品课程

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

共101课时 | 8.4万人学习

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号