使用常规encod使对象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

我建议在类定义中加入hack。这样，一旦定义了类，它就支持JSON。示例：

import json

class MyClass( object ):

    def _jsonSupport( *args ):
        def default( self, xObject ):
            return { 'type': 'MyClass', 'name': xObject.name() }

        def objectHook( obj ):
            if 'type' not in obj:
                return obj
            if obj[ 'type' ] != 'MyClass':
                return obj
            return MyClass( obj[ 'name' ] )
        json.JSONEncoder.default = default
        json._default_decoder = json.JSONDecoder( object_hook = objectHook )

    _jsonSupport()

    def __init__( self, name ):
        self._name = name

    def name( self ):
        return self._name

    def __repr__( self ):
        return '<MyClass(name=%s)>' % self._name

myObject = MyClass( 'Magneto' )
jsonString = json.dumps( [ myObject, 'some', { 'other': 'objects' } ] )
print "json representation:", jsonString

decoded = json.loads( jsonString )
print "after decoding, our object is the first in the list", decoded[ 0 ]

Answer 2

您可以像这样扩展dict类：

#!/usr/local/bin/python3
import json

class Serializable(dict):

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # hack to fix _json.so make_encoder serialize properly
        self.__setitem__('dummy', 1)

    def _myattrs(self):
        return [
            (x, self._repr(getattr(self, x))) 
            for x in self.__dir__() 
            if x not in Serializable().__dir__()
        ]

    def _repr(self, value):
        if isinstance(value, (str, int, float, list, tuple, dict)):
            return value
        else:
            return repr(value)

    def __repr__(self):
        return '<%s.%s object at %s>' % (
            self.__class__.__module__,
            self.__class__.__name__,
            hex(id(self))
        )

    def keys(self):
        return iter([x[0] for x in self._myattrs()])

    def values(self):
        return iter([x[1] for x in self._myattrs()])

    def items(self):
        return iter(self._myattrs())

现在要使用常规编码器使类可序列化，请扩展“serializable”：

class MySerializableClass(Serializable):

    attr_1 = 'first attribute'
    attr_2 = 23

    def my_function(self):
        print('do something here')


obj = MySerializableClass()

print(obj)将打印如下内容：

<__main__.MySerializableClass object at 0x1073525e8>

print(json.dumps(obj, indent=4))将打印如下内容：

{
    "attr_1": "first attribute",
    "attr_2": 23,
    "my_function": "<bound method MySerializableClass.my_function of <__main__.MySerializableClass object at 0x1073525e8>>"
}

Answer 3

正如我在对您的问题的评论中所说，在查看了json模块的源代码之后，它似乎不适合做您想要的事情。然而，这个目标可以通过所谓的monkey-patching来实现 （见问题What is a monkey patch?）。 这可以在包的__init__.py初始化脚本中完成，并且会影响所有后续的json模块序列化，因为模块通常只加载一次，结果缓存在sys.modules中。

修补程序将默认json编码器的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协议定义的，它们通过编写与您之前所建议的类似的特殊方法来处理这些问题，但对于数量少得多的情况，这样做可能是必要的。

不管怎样，使用pickle协议还意味着，通过对任何使用传入字典中的任何'_python_object'键的调用提供自定义的object_hook函数参数，只要有一个键，就可以相当容易地重构原始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)

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

我的想法是使用pickle从answerby Raymond Hettinger到另一个JSON序列化问题，我认为这个问题非常可信，而且是一个官方源代码（在Python核心开发人员中也是如此）。

移植到Python 3

上面的代码不能像Python 3中所示工作，因为json.dumps()返回了bytes对象，而JSONEncoder无法处理该对象。然而，这种方法仍然有效。解决此问题的一个简单方法是latin1“解码”从pickle.dumps()返回的值，然后从latin1对其进行“编码”，然后再将其传递到as_python_object()函数中的pickle.loads()。这是因为任意二进制字符串都是有效的latin1，它们总是可以被解码为Unicode，然后再次编码回原始字符串（如Sven Marnach在this answer中指出的那样）。

^{（尽管下面的代码在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

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