将枚举成员序列化为 JSON

Question

如何将 Python Enum 成员序列化为 JSON，以便将生成的 JSON 反序列化回 Python 对象？

例如这段代码：

from enum import Enum    
import json

class Status(Enum):
    success = 0

json.dumps(Status.success)

导致错误：

TypeError: <Status.success: 0> is not JSON serializable

我怎样才能避免这种情况？

Answer 1

我知道这已经过时了，但我觉得这会对人们有所帮助。我刚刚解决了这个确切的问题，发现如果你使用字符串枚举，将你的枚举声明为str 的子类几乎适用于所有情况：

import json
from enum import Enum

class LogLevel(str, Enum):
    DEBUG = 'DEBUG'
    INFO = 'INFO'

print(LogLevel.DEBUG)
print(json.dumps(LogLevel.DEBUG))
print(json.loads('"DEBUG"'))
print(LogLevel('DEBUG'))

将输出：

LogLevel.DEBUG
"DEBUG"
DEBUG
LogLevel.DEBUG

如您所见，加载 JSON 会输出字符串 DEBUG，但它很容易转换回 LogLevel 对象。如果您不想创建自定义 JSONEncoder，这是一个不错的选择。

Answer 2

正确答案取决于您打算如何处理序列化版本。

如果您要反序列化回 Python，请参阅 Zero's answer。

如果您的序列化版本要转为另一种语言，那么您可能希望使用IntEnum，它会自动序列化为相应的整数：

from enum import IntEnum
import json

class Status(IntEnum):
    success = 0
    failure = 1

json.dumps(Status.success)

这会返回：

'0'

Answer 3

如果您想将任意 enum.Enum 成员编码为 JSON 然后解码 它作为同一个枚举成员（而不是简单地枚举成员的value 属性），您可以通过编写自定义JSONEncoder 类和一个解码函数来作为object_hook 参数传递给json.load() 或@ 987654323@:

PUBLIC_ENUMS = {
    'Status': Status,
    # ...
}

class EnumEncoder(json.JSONEncoder):
    def default(self, obj):
        if type(obj) in PUBLIC_ENUMS.values():
            return {"__enum__": str(obj)}
        return json.JSONEncoder.default(self, obj)

def as_enum(d):
    if "__enum__" in d:
        name, member = d["__enum__"].split(".")
        return getattr(PUBLIC_ENUMS[name], member)
    else:
        return d

as_enum 函数依赖于使用 EnumEncoder 编码的 JSON，或者与其行为相同的东西。

对PUBLIC_ENUMS 成员的限制是必要的，以避免恶意制作的文本被用于，例如，欺骗调用代码将私人信息（例如应用程序使用的密钥）保存到不相关的数据库字段，从然后可以将其暴露在哪里（请参阅https://chat.stackoverflow.com/transcript/message/35999686#35999686）。

示例用法：

>>> data = {
...     "action": "frobnicate",
...     "status": Status.success
... }
>>> text = json.dumps(data, cls=EnumEncoder)
>>> text
'{"status": {"__enum__": "Status.success"}, "action": "frobnicate"}'
>>> json.loads(text, object_hook=as_enum)
{'status': <Status.success: 0>, 'action': 'frobnicate'}

Answer 4

在 Python >= 3.7 中，可以只使用 json.dumps(enum_obj, default=str)

如果你想使用枚举值，你可以这样做

json.dumps(enum_obj, default=lambda x: x.value)

或者如果你想使用枚举名称，

json.dumps(enum_obj, default=lambda x: x.name)

Answer 5

我喜欢 Zero Piraeus 的回答，但为了使用称为 Boto 的 Amazon Web Services (AWS) API 对其稍作修改。

class EnumEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, Enum):
            return obj.name
        return json.JSONEncoder.default(self, obj)

然后我将此方法添加到我的数据模型中：

    def ToJson(self) -> str:
        return json.dumps(self.__dict__, cls=EnumEncoder, indent=1, sort_keys=True)

我希望这对某人有所帮助。

Answer 6

你只需要从str或int类继承：

from enum import Enum, unique

@unique            
class StatusEnum(int, Enum):
    pending: int = 11                                      
    approved: int = 15                                       
    declined: int = 266

就是这样，它将使用任何 JSON 编码器进行序列化。

Answer 7

如果您使用jsonpickle，最简单的方法应该如下所示。

from enum import Enum
import jsonpickle


@jsonpickle.handlers.register(Enum, base=True)
class EnumHandler(jsonpickle.handlers.BaseHandler):

    def flatten(self, obj, data):
        return obj.value  # Convert to json friendly format


if __name__ == '__main__':
    class Status(Enum):
        success = 0
        error = 1

    class SimpleClass:
        pass

    simple_class = SimpleClass()
    simple_class.status = Status.success

    json = jsonpickle.encode(simple_class, unpicklable=False)
    print(json)

在 Json 序列化之后，您将拥有预期的 {"status": 0} 而不是

{"status": {"__objclass__": {"py/type": "__main__.Status"}, "_name_": "success", "_value_": 0}}

Answer 8

这对我有用：

class Status(Enum):
    success = 0

    def __json__(self):
        return self.value

无需更改任何其他内容。显然，您只能从中获取值，如果您想稍后将序列化值转换回枚举，则需要做一些其他工作。