0

0

如何在 Pydantic 中序列化时自动排除具有默认值的字段

霞舞

霞舞

发布时间:2026-02-01 16:04:01

|

695人浏览过

|

来源于php中文网

原创

如何在 Pydantic 中序列化时自动排除具有默认值的字段

pydantic 提供了 `exclude_defaults=true` 参数,可在调用 `model_dump()` 时跳过所有使用默认值初始化的字段,从而实现 json 序列化时不包含默认值,兼顾数据简洁性与模型一致性。

在构建 API 响应、配置导出或前端通信等场景中,避免将未显式设置的默认字段写入 JSON 是一种常见需求——它能减小载荷体积、提升可读性,并减少客户端对冗余字段的处理逻辑。

Pydantic v2(推荐使用)已弃用旧版 json() 方法和 default=pydantic_encoder 的手动 JSON 序列化方式,转而推荐使用更灵活、语义清晰的 model_dump() 和 model_dump_json() 方法。

✅ 正确做法:使用 model_dump(exclude_defaults=True)
以下为适配你原始示例的优化写法(Pydantic v2+):

import json
from typing import List
from pydantic import BaseModel, Field

class Animal(BaseModel):
    name: str
    legs: int
    tails: int = 1  # 默认值为 1

class AnimalList(BaseModel):
    animals: List[Animal]

# 构造实例:dog 未显式传 tails → 使用默认值;human 显式设为 0
animals = AnimalList(animals=[
    Animal(name='dog', legs=4),
    Animal(name='human', legs=2, tails=0)
])

# ✅ 序列化时自动排除默认值字段(如 dog.tails=1 不输出)
dumped = animals.model_dump(exclude_defaults=True)
j = json.dumps(dumped, indent=2)
print(j)

输出结果符合预期:

{
  "animals": [
    {"name": "dog", "legs": 4},
    {"name": "human", "legs": 2, "tails": 0}
  ]
}

? 补充说明:exclude_defaults 的行为逻辑

VidAU
VidAU

VidAU AI 是一款AI驱动的数字人视频创作平台,旨在简化视频内容创作流程

下载
  • 仅排除字段定义中声明的默认值(如 tails: int = 1 或 tails: int = Field(default=1)),不依赖运行时值是否“等于”默认值;
  • 若字段为 Optional 或 Union 类型且值为 None,exclude_defaults=True 不会自动排除该字段(除非显式设为 Field(default=None, exclude=True));
  • 对嵌套模型(如 AnimalList 包含 Animal)递归生效。

? 进阶建议:用 Field(default=...) + None 实现语义更清晰的“可选字段”
若业务上希望 tails 是真正可选的字段(即缺失时视为“未提供”,而非“使用默认值”),更推荐如下建模方式:

class Animal(BaseModel):
    name: str
    legs: int
    tails: int = Field(default=1, exclude=True)  # 或配合 exclude_defaults 更自然
    # 更推荐:tails: Optional[int] = None  # 并在逻辑中处理 None → 1

但注意:若你后续需反序列化 JSON 并重建对象(如 AnimalList(**json.loads(j))),使用 exclude_defaults=True 生成的 JSON 仍能正确还原——因为 Pydantic 在实例化时会自动填充缺失的默认值字段,无需额外干预。

✅ 总结

  • ✅ 优先使用 model_dump(exclude_defaults=True) 替代手动 json.dumps(..., default=...);
  • ✅ 确保使用 Pydantic v2+(BaseModel.model_dump() 是标准接口);
  • ⚠️ 避免混淆 exclude_defaults 与 exclude_unset:后者仅排除未在初始化时传入的字段(即使有默认值),而 exclude_defaults 排除所有值等于定义默认值的字段;
  • ? 如需细粒度控制(如仅对某字段启用),可用 Field(exclude=True) 或 model_dump(exclude={'tails'})。

通过合理使用 exclude_defaults,你能在保持模型强类型优势的同时,输出更精简、语义更准确的序列化数据。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

422

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

313

2023.10.13

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

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

77

2025.09.10

c语言union的用法
c语言union的用法

c语言union的用法是一种特殊的数据类型,它允许在相同的内存位置存储不同的数据类型,union的使用可以帮助我们节省内存空间,并且可以方便地在不同的数据类型之间进行转换。使用union时需要注意对应的成员是有效的,并且只能同时访问一个成员。本专题为大家提供union相关的文章、下载、课程内容,供大家免费下载体验。

126

2023.09.27

string转int
string转int

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

503

2023.08.02

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

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

545

2024.08.29

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

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

113

2025.08.29

go语言 注释编码
go语言 注释编码

本专题整合了go语言注释、注释规范等等内容,阅读专题下面的文章了解更多详细内容。

30

2026.01.31

热门下载

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

精品课程

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

共101课时 | 8.7万人学习

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号