在 Python 很常常做的一件事就是 Python 数据类型和 JSON 数据类型的转换。
然而存在一个显著的问题,JSON 作为一种数据交换格局有固定的数据类型,然而 Python 作为编程语言除了内置的数据类型认为还能编写自定义的数据类型。
比方你必定遇到过相似的问题:
>>> import json>>> import decimal>>> >>> data = {'key1': 'string', 'key2': 10, 'key3': decimal.Decimal('1.45')}>>> json.dumps(data)Traceback (most recent call last): File "<input>", line 1, in <module> json.dumps(data) File "/usr/lib/python3.6/json/__init__.py", line 231, in dumps return _default_encoder.encode(obj) File "/usr/lib/python3.6/json/encoder.py", line 199, in encode chunks = self.iterencode(o, _one_shot=True) File "/usr/lib/python3.6/json/encoder.py", line 257, in iterencode return _iterencode(o, 0) File "/usr/lib/python3.6/json/encoder.py", line 180, in default o.__class__.__name__)TypeError: Object of type 'Decimal' is not JSON serializable
那么问题就来了,如何把各种各样的 Python 数据类型转化成 JSON 数据类型。一种很不 pythonic 的做法就是,先转换成某种能和 JSON 数据类型间接转换的值,而后在 dump,这么做很间接很暴力,然而在各种花式数据类型背后就很有力。
Google 是解决问题的重要形式之一,当你一顿搜寻过后,你就会发现其实能够在 dumps 时 encode 这个阶段对数据进行转化。
所以你必定是那么做的,完满地解决了问题。
>>> class DecimalEncoder(json.JSONEncoder):... def default(self, obj):... if isinstance(obj, decimal.Decimal):... return float(obj)... return super(DecimalEncoder, self).default(obj)... ... >>> >>> json.dumps(data, cls=DecimalEncoder)'{"key1": "string", "key2": 10, "key3": 1.45}'
JSON 的 Encode 过程
文中代码摘自 github.com/python/cpyt…
删除了简直所有的 docstring,因为代码太长,间接截取了重要片段。能够在片段最上方的链接查看残缺的代码。
相熟 json 这个库的都晓得根本只有4个罕用的 API,别离是 dump、dumps 和 load、loads。
源码位于 cpython/Lib/json 中
# https://github.com/python/cpython/blob/master/Lib/json/__init__.py#L183-L238def dumps(obj, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw): # cached encoder if (not skipkeys and ensure_ascii and check_circular and allow_nan and cls is None and indent is None and separators is None and default is None and not sort_keys and not kw): return _default_encoder.encode(obj) if cls is None: cls = JSONEncoder # 重点 return cls( skipkeys=skipkeys, ensure_ascii=ensure_ascii, check_circular=check_circular, allow_nan=allow_nan, indent=indent, separators=separators, default=default, sort_keys=sort_keys, **kw).encode(obj)
间接看到最初的 return。能够发现如果不提供 cls 默认就应用 JSONEncoder,而后调用该类的实例办法 encode。
encode 办法也非常简略:
# https://github.com/python/cpython/blob/191e993365ac3206f46132dcf46236471ec54bfa/Lib/json/encoder.py#L182-L202def encode(self, o): # str 类型间接 encode 后返回 if isinstance(o, str): if self.ensure_ascii: return encode_basestring_ascii(o) else: return encode_basestring(o) # chunks 是数据中的各个局部 chunks = self.iterencode(o, _one_shot=True) if not isinstance(chunks, (list, tuple)): chunks = list(chunks) return ''.join(chunks)
能够看出最初的咱们失去 JSON 都是 chunks 拼接失去的,chunks 是调用 self.iterencode 办法失去的。
# https://github.com/python/cpython/blob/191e993365ac3206f46132dcf46236471ec54bfa/Lib/json/encoder.py#L204-257 if (_one_shot and c_make_encoder is not None and self.indent is None): _iterencode = c_make_encoder( markers, self.default, _encoder, self.indent, self.key_separator, self.item_separator, self.sort_keys, self.skipkeys, self.allow_nan) else: _iterencode = _make_iterencode( markers, self.default, _encoder, self.indent, floatstr, self.key_separator, self.item_separator, self.sort_keys, self.skipkeys, _one_shot)return _iterencode(o, 0)
iterencode 办法比拟长,咱们只关怀最初几行。
返回值 _iterencode,是函数中 c_make_encoder 或者 _make_iterencode 这两个高阶函数的返回值。
c_make_encoder 是来自 _json 这个 module ,这个 module 是一个 c 模块,咱们不去关怀这个模块怎么实现的。转去钻研等同作用的 _make_iterencode 办法。
# https://github.com/python/cpython/blob/191e993365ac3206f46132dcf46236471ec54bfa/Lib/json/encoder.py#L259-441def _iterencode(o, _current_indent_level): if isinstance(o, str): yield _encoder(o) elif o is None: yield 'null' elif o is True: yield 'true' elif o is False: yield 'false' elif isinstance(o, int): # see comment for int/float in _make_iterencode yield _intstr(o) elif isinstance(o, float): # see comment for int/float in _make_iterencode yield _floatstr(o) elif isinstance(o, (list, tuple)): yield from _iterencode_list(o, _current_indent_level) elif isinstance(o, dict): yield from _iterencode_dict(o, _current_indent_level) else: if markers is not None: markerid = id(o) if markerid in markers: raise ValueError("Circular reference detected") markers[markerid] = o o = _default(o) yield from _iterencode(o, _current_indent_level) if markers is not None: del markers[markerid]return _iterencode
同样须要关怀的只有返回的这个函数,代码里各种 if-elif-else 逐个把内置类型转换成 JSON 类型。在对面无奈辨认的类型时候就应用了 _default() 这个办法,而后递归调用解析各个值。
_default 就是最后面那个被笼罩的 default。
到这里就能够齐全理解 Python 是如何 encode 成 JSON 数据。
总结一下流程,json.dumps() 调用 JSONEncoder 的实例办法 encode(),随后应用 iterencode() 递归转化各种类型,最初把 chunks 拼接成字符串后返回。
优雅的解决方案通过后面的流程剖析之后,晓得为什么继承 JSONEncoder 而后笼罩 default 办法就能够实现自定义类型解析了。
兴许你当前须要解析 datetime 类型数据,你可定会那么做:
class ExtendJSONEncoder(json.JSONEncoder): def default(self, obj): if isinstance(obj, decimal.Decimal): return int(obj) if isinstance(obj, datetime.datetime): return obj.strftime(DATETIME_FORMAT) return super(ExtendJSONEncoder, self).default(obj)
最初调用父类是 default() 办法纯正是为了触发异样。
Python 能够应用 singledispatch 来解决这种单泛型问题。
import jsonfrom datetime import datetimefrom decimal import Decimalfrom functools import singledispatchclass MyClass: def __init__(self, value): self._value = value def get_value(self): return self._value# 创立三个非内置类型的实例mc = MyClass('i am class MyClass ')dm = Decimal('11.11')dt = datetime.now()@singledispatchdef convert(o): raise TypeError('can not convert type')@convert.register(datetime)def _(o): return o.strftime('%b %d %Y %H:%M:%S') @convert.register(Decimal)def _(o): return float(o)@convert.register(MyClass)def _(o): return o.get_value()class ExtendJSONEncoder(json.JSONEncoder): def default(self, obj): try: return convert(obj) except TypeError: return super(ExtendJSONEncoder, self).default(obj)data = { 'mc': mc, 'dm': dm, 'dt': dt}json.dumps(data, cls=ExtendJSONEncoder)# {"mc": "i am class MyClass ", "dm": 11.11, "dt": "Nov 10 2017 17:31:25"}
这种写法比拟合乎设计模式的标准。如果当前有了新的类型,不必再批改 ExtendJSONEncoder 类,只须要增加适当的 singledispatch 办法就能够了, 比拟 pythonic 。