列挙型メンバーをJSONにシリアル化する

PythonEnumメンバーを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 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)

これが誰かに役立つことを願っています。

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

他に何も変更する必要はありませんでした。明らかに、これから値を取得するだけであり、後でシリアル化された値を列挙型に変換し直す場合は、他の作業を行う必要があります。