Nối tiếp một thành viên Enum cho JSON

Làm cách nào để tuần tự hóa một Enumthành viên Python thành JSON, để tôi có thể giải mã JSON kết quả trở lại thành một đối tượng Python?

Ví dụ, mã này:

from enum import Enum    
import json

class Status(Enum):
    success = 0

json.dumps(Status.success)

dẫn đến lỗi:

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

Làm thế nào tôi có thể tránh điều đó?

Nếu bạn muốn mã hóa một enum.Enumthành viên tùy ý thành JSON và sau đó giải mã nó thành cùng một thành viên enum (thay vì chỉ đơn giản là valuethuộc tính của thành viên enum ), bạn có thể làm như vậy bằng cách viết một JSONEncoderlớp tùy chỉnh và một hàm giải mã để chuyển làm object_hookđối số cho json.load()hoặc 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

Các as_enumchức năng dựa vào JSON đã được mã hóa sử dụng EnumEncoder, hoặc một cái gì đó mà cư xử hệt với nó.

Hạn chế đối với các thành viên của PUBLIC_ENUMSlà cần thiết để tránh một văn bản được tạo thủ công độc hại được sử dụng, chẳng hạn như lừa mã gọi để lưu thông tin cá nhân (ví dụ: khóa bí mật được ứng dụng sử dụng) vào trường cơ sở dữ liệu không liên quan, từ đó nó có thể bị lộ (xem http://chat.stackoverflow.com/transcript/message/35999686#35999686 ).

Ví dụ sử dụng:

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

Tôi biết điều này đã cũ nhưng tôi cảm thấy điều này sẽ giúp ích cho mọi người. Tôi vừa mới xem xét vấn đề chính xác này và phát hiện ra nếu bạn đang sử dụng chuỗi enums, việc khai báo enums của bạn như một lớp con strhoạt động tốt cho hầu hết các trường hợp:

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

Sẽ xuất:

LogLevel.DEBUG
"DEBUG"
DEBUG
LogLevel.DEBUG

Như bạn có thể thấy, việc tải JSON sẽ xuất ra chuỗi DEBUGnhưng nó có thể dễ dàng chuyển trở lại thành một đối tượng LogLevel. Một tùy chọn tốt nếu bạn không muốn tạo bộ mã hóa JSONEnc tùy chỉnh.

Câu trả lời chính xác phụ thuộc vào những gì bạn định làm với phiên bản được đăng nhiều kỳ.

Nếu bạn định phi công nghệ hóa trở lại Python, hãy xem câu trả lời của Zero .

Nếu phiên bản được tuần tự hóa của bạn chuyển sang một ngôn ngữ khác thì bạn có thể muốn sử dụng một ngôn ngữ IntEnumthay thế, được tự động tuần tự hóa dưới dạng số nguyên tương ứng:

from enum import IntEnum
import json

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

json.dumps(Status.success)

và điều này trả về:

'0'

Trong Python 3.7, có thể sử dụng json.dumps(enum_obj, default=str)

Tôi thích câu trả lời của Zero Piraeus, nhưng đã sửa đổi nó một chút để làm việc với API cho Amazon Web Services (AWS) được gọi là Boto.

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

Sau đó, tôi đã thêm phương pháp này vào mô hình dữ liệu của mình:

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

Tôi hi vọng điêu nay se giup được ai đo.

Nếu bạn đang sử dụng cách jsonpickledễ nhất sẽ như bên dưới.

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)

Sau khi tuần tự hóa Json, bạn sẽ có như mong đợi {"status": 0}thay vì

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

Điều này đã làm việc cho tôi:

class Status(Enum):
    success = 0

    def __json__(self):
        return self.value

Không phải thay đổi bất cứ điều gì khác. Rõ ràng, bạn sẽ chỉ nhận được giá trị từ việc này và sẽ cần thực hiện một số công việc khác nếu bạn muốn chuyển đổi giá trị được tuần tự hóa trở lại vào enum sau này.