使Python json编码器支持Python的新数据类

Question

从Python 3.7开始，有一种称为dataclass的东西：

from dataclasses import dataclass

@dataclass
class Foo:
    x: str

但是，以下操作失败：

>>> import json
>>> foo = Foo(x="bar")
>>> json.dumps(foo)
TypeError: Object of type Foo is not JSON serializable

如何制作json。dumps（）将Foo的实例编码到json对象中？

Answer 1

有几个选项来实现这个目标，每个选项的选择意味着分析哪种方法最适合您的需求：

import dataclasses
import json


@dataclass.dataclass
class Foo:
    x: str

foo = Foo(x='1')
json_foo = json.dumps(dataclasses.asdict(foo)) # '{"x": "1"}'

将其选回数据类实例并不简单，因此您可能希望访问该答案https://stackoverflow.com/a/53498623/2067976

from dataclasses import field
from marshmallow_dataclass import dataclass


@dataclass
class Foo:
    x: int = field(metadata={"required": True})

foo = Foo(x='1') # Foo(x='1')
json_foo = foo.Schema().dumps(foo) # '{"x": "1"}'

# Back to class instance.
Foo.Schema().loads(json_foo) # Foo(x=1)

作为marshmallow_dataclass的一个好处，您可以在字段本身使用验证，当有人使用该模式从json反序列化对象时，将使用该验证。

from dataclasses import dataclass
from dataclasses_json import dataclass_json


@dataclass_json
@dataclass
class Foo:
    x: int

foo = Foo(x='1')
json_foo = foo.to_json() # Foo(x='1')
# Back to class instance
Foo.from_json(json_foo) # Foo(x='1')

此外，请注意，marshmallow数据类为您进行了类型转换，而dataclassses json（版本：0.5.1）忽略了这一点。

按照接受的2K答案并重用自定义json编码器。

Answer 2

你不能只使用数据类吗。asdict（）函数将数据类转换为dict？比如：

>>> @dataclass
... class Foo:
...     a: int
...     b: int
...     
>>> x = Foo(1,2)
>>> json.dumps(dataclasses.asdict(x))
'{"a": 1, "b": 2}'

Answer 3

就像您可以为JSON编码器添加对datetime对象或小数的支持一样，您还可以提供自定义编码器子类来序列化数据类：

import dataclasses, json

class EnhancedJSONEncoder(json.JSONEncoder):
        def default(self, o):
            if dataclasses.is_dataclass(o):
                return dataclasses.asdict(o)
            return super().default(o)

json.dumps(foo, cls=EnhancedJSONEncoder)