Серіалізація члена Enum до JSON

Як мені серіалізувати Enumчлен Python до 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

Як я можу цього уникнути?

Якщо ви хочете закодувати довільний enum.Enumчлен у JSON, а потім декодувати його як той самий член перерахування (а не просто valueатрибут члена перерахування ), ви можете це зробити, написавши власний JSONEncoderклас та функцію декодування, яка передається як object_hookаргумент до json.load()або json.loads():

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Функція спирається на JSON будучи закодований з використанням EnumEncoder, або що - то, поводиться тотожно йому.

Обмеження для учасників PUBLIC_ENUMSнеобхідно, щоб уникнути зловмисно створеного тексту, який використовується, наприклад, для обману виклику коду для збереження приватної інформації (наприклад, секретного ключа, що використовується додатком) до не пов'язаного поля бази даних, звідки він потім може бути виставлений (див. http://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'}

Я знаю, що це старе, але я відчуваю, що це допоможе людям. Я щойно пройшов через цю точну проблему і виявив, чи використовуєте ви перерахування рядків, оголосивши свої перерахування як підклас 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.

Правильна відповідь залежить від того, що ви маєте намір зробити із серіалізованою версією.

Якщо ви збираєтеся десеріалізуватися назад до Python, див . Відповідь Zero .

Якщо ваша серіалізована версія переходить на іншу мову, ви, ймовірно, захочете використовувати IntEnumзамість неї, яка автоматично серіалізується як відповідне ціле число:

from enum import IntEnum
import json

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

json.dumps(Status.success)

і це повертає:

'0'

У Python 3.7 можна просто використовувати json.dumps(enum_obj, default=str)

Мені сподобалась відповідь Zero Pireeus, але я її дещо змінив для роботи з API для веб-служб Amazon (AWS), відомого як Boto.

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)

Сподіваюся, це комусь допомагає.

Якщо ви використовуєте 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}}

Це спрацювало для мене:

class Status(Enum):
    success = 0

    def __json__(self):
        return self.value

Не довелося нічого іншого міняти. Очевидно, що ви отримаєте значення з цього, і вам доведеться виконати якусь іншу роботу, якщо пізніше ви хочете перетворити серіалізоване значення назад у перелік.