Python-使用常规编码器使对象JSON可序列化

Question

JSON序列化自定义非序列化对象的常规方法是子类化json.JSONEncoder，然后将自定义编码器传递给转储。

通常看起来像这样：

class CustomEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, foo):
            return obj.to_json()

        return json.JSONEncoder.default(self, obj)

print json.dumps(obj, cls = CustomEncoder)

我想做的是使默认编码器可序列化的东西。我环顾四周，但找不到任何东西。我的想法是，编码器将在某些字段中确定json编码。类似的东西__str__。也许是一个__json__领域。python中是否有类似的东西？

我想使我要制作的模块的一个类可以对使用该包的每个人进行JSON序列化，而无需他们担心实现自己的[琐碎]自定义编码器。

Answer 1

正如我在对你的问题的评论中所说的那样，在查看了json模块的源代码之后，它似乎没有根据自己的意愿来做。但是，可以通过所谓的猴子修补来实现该目标 （请参阅问题什么是猴子修补？）。这可以在你程序包的__init__.py初始化脚本中完成，并且会影响所有后续的json模块序列化，因为模块通常只加载一次，结果缓存在中sys.modules。

该补丁会更改默认的json编码器的default方法，即default default()。

为了简单起见，以下示例实现为独立模块：

模组： make_json_serializable.py

""" Module that monkey-patches json module when it's imported so
JSONEncoder.default() automatically checks for a special "to_json()"
method and uses it to encode the object if found.
"""
from json import JSONEncoder

def _default(self, obj):
    return getattr(obj.__class__, "to_json", _default.default)(obj)

_default.default = JSONEncoder.default  # Save unmodified default.
JSONEncoder.default = _default # Replace it.

使用补丁很简单，因为只需导入模块即可应用补丁。

客户端脚本示例：

import json
import make_json_serializable  # apply monkey-patch

class Foo(object):
    def __init__(self, name):
        self.name = name
    def to_json(self):  # New special method.
        """ Convert to JSON format string representation. """
        return '{"name": "%s"}' % self.name

foo = Foo('sazpaz')
print(json.dumps(foo))  # -> "{\"name\": \"sazpaz\"}"

为了保留对象类型信息，特殊方法还可以将其包含在返回的字符串中：

        return ('{"type": "%s", "name": "%s"}' %
                 (self.__class__.__name__, self.name))

它将产生以下现在包含类名称的JSON：

"{\"type\": \"Foo\", \"name\": \"sazpaz\"}"

魔术师躺在这里
与让替换项default()寻找一个特殊命名的方法相比，甚至更好的是，它能够自动序列化大多数Python对象，包括用户定义的类实例，而无需添加特殊方法。在研究了许多备选方案之后，以下使用该pickle模块的方案对我而言似乎最接近于该理想方案：

模组： make_json_serializable2.py

""" Module that imports the json module and monkey-patches it so
JSONEncoder.default() automatically pickles any Python objects
encountered that aren't standard JSON data types.
"""
from json import JSONEncoder
import pickle

def _default(self, obj):
    return {'_python_object': pickle.dumps(obj)}

JSONEncoder.default = _default  # Replace with the above.

当然，不能对所有内容进行腌制-例如扩展名。但是，有一些方法定义了通过pickle协议通过编写特殊方法来处理它们的方法（类似于你之前和我所描述的方法），但是这样做的情况可能要少得多。

反序列化

无论如何，使用pickle协议还意味着通过在传入的字典中使用任何键的object_hook任何json.loads()调用上提供自定义函数参数'_python_object'（只要有一个键），就很容易重建原始的Python对象。就像是：

def as_python_object(dct):
    try:
        return pickle.loads(str(dct['_python_object']))
    except KeyError:
        return dct

pyobj = json.loads(json_str, object_hook=as_python_object)

如果必须在许多地方执行此操作，则可能有必要定义一个自动提供额外关键字参数的包装函数：

json_pkloads = functools.partial(json.loads, object_hook=as_python_object)

pyobj = json_pkloads(json_str)

当然，也可以通过猴子将其修补到json模块中，从而使函数成为默认值object_hook（而不是None）。

我的想法用pickle从答案由雷蒙德赫廷杰另一个JSON序列化的问题，就是我认为非常可靠以及官方源（如在Python核心开发人员）。

可移植到Python 3

上面的代码无法像Python 3所示那样工作，因为它json.dumps()返回了一个无法处理的bytes对象JSONEncoder。但是，该方法仍然有效。一个简单的方法来解决该问题是latin1“解码”，从返回的值pickle.dumps()，然后选择“编码”它latin1传递到之前pickle.loads()的as_python_object()功能。这工作，因为任意的二进制字符串是有效的latin1，可总是被解码为Unicode，然后再编码回原来的字符串（如指出，这个答案由斯文Marnach）。

（尽管以下内容在Python 2中可以正常工作，但latin1它的解码和编码是多余的。）

from decimal import Decimal

class PythonObjectEncoder(json.JSONEncoder):
    def default(self, obj):
        return {'_python_object': pickle.dumps(obj).decode('latin1')}


def as_python_object(dct):
    try:
        return pickle.loads(dct['_python_object'].encode('latin1'))
    except KeyError:
        return dct


class Foo(object):  # Some user-defined class.
    def __init__(self, name):
        self.name = name

    def __eq__(self, other):
        if not isinstance(other, type(self)):
            # Don't attempt to compare against unrelated types.
            return NotImplemented
        return self.name == other.name


data = [1,2,3, set(['knights', 'who', 'say', 'ni']), {'key':'value'},
        Foo('Bar'), Decimal('3.141592653589793238462643383279502884197169')]
j = json.dumps(data, cls=PythonObjectEncoder, indent=4)
data2 = json.loads(j, object_hook=as_python_object)
assert data == data2  # both should be same