Bir Enum üyesini JSON'a seri hale getirme

Bir Python Enumüyesini JSON'a nasıl serileştirebilirim, böylece ortaya çıkan JSON'u tekrar bir Python nesnesine seri durumdan çıkarabilirim?

Örneğin, bu kod:

from enum import Enum    
import json

class Status(Enum):
    success = 0

json.dumps(Status.success)

hataya neden olur:

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

Bundan nasıl kaçınabilirim?

Rasgele bir enum.Enumüyeyi JSON'a kodlamak ve ardından aynı enum üyesi olarak (yalnızca enum üyesinin valueözniteliği yerine) kodunu çözmek istiyorsanız, bunu özel bir JSONEncodersınıf ve object_hookbağımsız değişken olarak iletilecek bir kod çözme işlevi yazarak yapabilirsiniz json.load()veya 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_enumFonksiyon kullanılarak kodlanmış olan JSON dayanır EnumEncoderbuna aynı şekilde davranır, ya da bir şey.

Üyelerine kısıtlama, PUBLIC_ENUMSkötü amaçla oluşturulmuş bir metnin, örneğin, özel bilgileri (örneğin, uygulama tarafından kullanılan gizli bir anahtar) ilgisiz bir veritabanı alanına kaydedilmesi için kandırarak arama kodunu kullanmaktan kaçınmak için gereklidir. (bkz. http://chat.stackoverflow.com/transcript/message/35999686#35999686 ).

Örnek kullanım:

>>> 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'}

Bunun eski olduğunu biliyorum ama bunun insanlara yardımcı olacağını düşünüyorum. Tam olarak bu sorunu aştım ve dize numaralandırmaları kullanıp kullanmadığınızı keşfettim, numaralandırmalarınızı strhemen hemen tüm durumlar için işe yarayan bir alt sınıf olarak ilan ettim :

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'))

Çıktı:

LogLevel.DEBUG
"DEBUG"
DEBUG
LogLevel.DEBUG

Gördüğünüz gibi, JSON'un yüklenmesi dizeyi çıktılar, DEBUGancak kolayca bir LogLevel nesnesine geri dönüştürülebilir. Özel bir JSONEncoder oluşturmak istemiyorsanız iyi bir seçenek.

Doğru cevap, serileştirilmiş sürümle ne yapmak istediğinize bağlıdır.

Python'a geri dönecekseniz, Zero'nun cevabına bakın .

Serileştirilmiş sürümünüz başka bir dile gidiyorsa, muhtemelen IntEnumbunun yerine, karşılık gelen tamsayı olarak otomatik olarak serileştirilen bir kullanmak isteyeceksiniz :

from enum import IntEnum
import json

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

json.dumps(Status.success)

ve bu şunu döndürür:

'0'

Python 3.7'de, sadece kullanabilir json.dumps(enum_obj, default=str)

Zero Piraeus'un cevabını beğendim, ancak Boto olarak bilinen Amazon Web Services (AWS) için API ile çalışmak üzere biraz değiştirdim.

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

Daha sonra bu yöntemi veri modelime ekledim:

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

Umarım bu birine yardımcı olur.

jsonpickleEn kolay yolu kullanıyorsanız aşağıdaki gibi bakmalısınız.

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 serileştirme sonra beklendiği gibi olacak {"status": 0}yerine

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

Bu benim için çalıştı:

class Status(Enum):
    success = 0

    def __json__(self):
        return self.value

Başka hiçbir şeyi değiştirmek zorunda kalmadı. Açıkçası, bundan yalnızca değeri elde edeceksiniz ve serileştirilmiş değeri daha sonra numaralandırmaya geri dönüştürmek istiyorsanız başka bir iş yapmanız gerekecek.