如何在Python中实现枚举类(Enum)的序列化?

P粉602998670

P粉602998670

2026-06-17

785人浏览

原创

Python 3.14.2
Python 3.14.2

Python 3.14.2是Python编程语言在2025年12月5日发布的稳定版本,属于3.14系列的第二个维护更新。该版本包含了18项修复,重点解决了多进程、数据类及正则表达式等模块的回归问题,并修复了CVE-2025-12084等安全漏洞。此版本标志着自由线程模式(移除GIL)正式获得官方支持,是Python发展的重要里程碑。

下载
json.dumps()无法直接序列化enum成员,因其非基础类型且不自动调用__str__;需通过default参数、自定义jsonencoder或strenum(python 3.11+)实现序列化。

如何在python中实现枚举类(enum)的序列化?

Python 的 Enum 默认不能被 json.dumps() 直接序列化,会抛出 TypeError: Object of type XXX is not JSON serializable —— 必须显式提供序列化逻辑。

为什么 json.dumps() 无法直接处理 Enum 成员

因为 Enum 成员是类的实例(如 Color.RED),不是基础类型(str/int),而 json 模块只认 dictliststrintfloatboolNone。它不会自动调用 __str____repr__

  • 错误现象:json.dumps({"status": Status.ACTIVE})TypeError: Object of type Status is not JSON serializable
  • 即使你重写了 __str__json 也不会用它
  • Enumvaluename 都是可访问属性,但需手动提取

最简方案:用 default 参数 + 类型判断

json.dumps() 中传入 default 回调函数,对 Enum 成员返回其 value(或 name)。

import json
from enum import Enum
<p>class Status(Enum):
ACTIVE = 1
INACTIVE = 0</p><p>data = {"status": Status.ACTIVE}
json_str = json.dumps(data, default=lambda x: x.value if isinstance(x, Enum) else None)</p><h1>→ {"status": 1}</h1><p></p>
  • 推荐优先用 x.value,语义更接近“数据值”;若需字符串标识(如 API 返回字段名),改用 x.name
  • default 函数必须覆盖所有非标准类型,否则仍会报错;建议加 else raise TypeError(...) 显式兜底
  • 该方式不侵入原有 Enum 类,适合临时、轻量场景

更健壮的做法:自定义 JSONEncoder 子类

当项目中多处需要序列化 Enum,且希望统一行为(比如所有 Enum 都转 name),应封装为独立编码器。

class EnumEncoder(json.JSONEncoder):
    def encode(self, obj):
        if isinstance(obj, Enum):
            return json.dumps(obj.name)  # 或 obj.value
        return super().encode(obj)
<p>json.dumps(data, cls=EnumEncoder)
</p>
  • 注意:不要重写 default 方法后又调用 super().default() —— 它默认返回 NotImplemented,容易漏掉其他类型
  • 如果 Enum 值本身是 str(如 Color.RED = "red"),用 obj.value 更自然;若值是 int 但你想暴露语义名,才用 obj.name
  • 该方案可配合 json.loads()object_hook 实现反序列化,但要注意:仅靠名字无法无歧义还原具体 Enum 类,需额外上下文

使用 StrEnum(Python 3.11+)简化字符串枚举序列化

若你的枚举值全是字符串,且运行环境 ≥ Python 3.11,StrEnum 是更干净的选择 —— 它继承自 str,天然可被 json 序列化。

from enum import StrEnum
<p>class Role(StrEnum):
ADMIN = "admin"
USER = "user"</p><p>json.dumps({"role": Role.ADMIN})  # → {"role": "admin"},无需任何额外配置
</p>
  • StrEnum 成员既是 str 又是 Enum 成员,支持字符串操作(.upper())、in 判断、类型检查
  • 但它只解决“值为字符串”的场景;数值型、复合值(如 namedtuple)枚举仍需前述方案
  • 低版本 Python 可用 class Role(str, Enum): 模拟,但要注意 isinstance(x, str)True,可能影响某些类型分发逻辑

真正麻烦的不是怎么转,而是团队是否对“序列化时用 name 还是 value”达成一致 —— 同一个 Enum 在不同接口里混用两种策略,会让前端或下游服务难以维护。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1105

4

python能做什么
python能做什么

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

2023.07.25

2072

7

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

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

2023.07.31

1185

3

python教程
python教程

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

2023.08.03

8844

23

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

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

2023.08.04

1479

5

python eval
python eval

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

2023.08.04

1552

5

scratch和python区别
scratch和python区别

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

2023.08.11

881

5

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

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

2023.08.10

531

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1111

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PyCharm官方快速入门指南
PyCharm官方快速入门指南

共0课时 | 0人学习

Python函数定义官方教程
Python函数定义官方教程

共0课时 | 0人学习

Python 3.14.6官方文档
Python 3.14.6官方文档

共0课时 | 0人学习