0

0

Pydantic 2 中统一将 set 字段序列化为有序列表的优雅方案

花韻仙語

花韻仙語

发布时间:2026-01-31 13:12:04

|

362人浏览过

|

来源于php中文网

原创

Pydantic 2 中统一将 set 字段序列化为有序列表的优雅方案

在 pydantic 2 中,set 类型默认序列化为无序列表,导致 json 输出不稳定。本文介绍如何通过 `@field_serializer` 批量、声明式地将指定 set 字段自动转为排序后的 list,兼顾简洁性、可维护性与继承兼容性。

Pydantic 2 移除了 Pydantic 1 中的 json_encoders 配置,使得全局接管 set 序列化变得不直接。但其函数式序列化机制(@field_serializer)提供了更精准、更可控的替代方案——它允许你按字段名或类型模式声明序列化逻辑,且天然支持继承链中的字段。

最实用的做法是:为所有需排序的 set 字段显式添加 @field_serializer,并指定 when_used='json'(仅在 JSON 序列化时生效),避免影响 model_dump() 等其他导出行为。例如:

from typing import Set, Any
from pydantic import BaseModel, field_serializer

class BaseStudentModel(BaseModel):
    name: str = 'Jane'

class StudentModel(BaseStudentModel):
    courses: Set[str]
    interests: Set[str]

    # 单字段或多字段批量绑定同一序列化器
    @field_serializer('courses', 'interests', when_used='json')
    def sort_sets(self, value: Set[Any]) -> list:
        return sorted(value)

调用 StudentModel(courses={'Math', 'Chemistry'}, interests={'AI', 'Bio'}).model_dump_json() 将稳定输出:

{"name":"Jane","courses":["Chemistry","Math"],"interests":["AI","Bio"]}

优势说明

怡启AI论文
怡启AI论文

专业AI论文写作

下载
  • 零侵入类型定义:无需自定义 SortedSet 类型或修改字段注解;
  • 继承友好:子类可复用父类的 @field_serializer,也可在其基础上扩展新字段;
  • 语义清晰:序列化逻辑与字段强关联,比 model_serializer 更易定位和维护;
  • 性能高效:仅对目标字段执行 sorted(),无反射遍历开销。

⚠️ 注意事项

  • sorted() 要求集合元素可比较(如 str, int, datetime)。若含混合类型或不可比较对象(如 dict、自定义未实现 __lt__ 的类),需改用 sorted(value, key=str) 或自定义 key 函数;
  • 若字段类型为泛型嵌套(如 Set[Union[int, str]]),建议在序列化器中添加类型检查或使用 isinstance(value, set) 增强健壮性;
  • 不推荐在 when_used='always' 下使用该逻辑,否则会影响 model_dump() 返回的原生 Python 结构,违背“仅 JSON 有序”的设计初衷。

综上,@field_serializer 是 Pydantic 2 中实现 set → 排序 list 序列化的首选、标准且可持续演进的方案。它既尊重了框架的设计哲学(显式优于隐式、字段级控制优于全局钩子),又完美平衡了通用性与工程可维护性。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

420

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的详细内容,可以访问本专题下面的文章。

312

2023.10.13

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

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

77

2025.09.10

json数据格式
json数据格式

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

420

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的详细内容,可以访问本专题下面的文章。

312

2023.10.13

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

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

77

2025.09.10

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

54

2026.01.31

热门下载

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

精品课程

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

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 3.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

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

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