Python中JSON编码模块详解

JSON

编码支持的基本数据类型为 None ， bool ， int ， float 和 str ， 以及包含这些类型数据的lists，tuples和dictionaries。 对于dictionaries，keys需要是字符串类型(字典中任何非字符串类型的key在编码时会先转换为字符串)。 为了遵循JSON规范，你应该只编码Python的lists和dictionaries。 而且，在web应用程序中，顶层对象被编码为一个字典是一个标准做法。

JSON 编码格式几乎与 Python 语法相同，除了一些细微差别。例如，True 将映射为 true，False 将映射为 false，None 将映射为 null。这是一个演示对编码字符串的影响的示例：

>>> json.dumps(False)
'false'
>>> d = {'a': True,
...   'b': 'Hello',
...   'c': None}
>>> json.dumps(d)
'{"b": "Hello", "c": null, "a": true}'
>>>

如果你尝试检查 JSON 解码的数据，通常很难通过简单地打印来确定其结构，尤其是当数据嵌套很深或包含大量字段时。要解决这个问题，可以考虑使用 pprint 模块的 pprint() 函数来代替普通的 print() 函数。它将按字母顺序按键并以更好的方式输出。下面是一个演示如何漂亮地打印出来自 Twitter 的搜索结果的示例：

>>> from urllib.request import urlopen
>>> import json
>>> u = urlopen('http://search.twitter.com/search.json?q=python&rpp=5')
>>> resp = json.loads(u.read().decode('utf-8'))
>>> from pprint import pprint
>>> pprint(resp)
{'completed_in': 0.074,
'max_id': 264043230692245504,
'max_id_str': '264043230692245504',
'next_page': '?page=2&max_id=264043230692245504&q=python&rpp=5',
'page': 1,
'query': 'python',
'refresh_url': '?since_id=264043230692245504&q=python',
'results': [{'created_at': 'Thu, 01 Nov 2012 16:36:26 +0000',
      'from_user': ...
      },
      {'created_at': 'Thu, 01 Nov 2012 16:36:14 +0000',
      'from_user': ...
      },
      {'created_at': 'Thu, 01 Nov 2012 16:36:13 +0000',
      'from_user': ...
      },
      {'created_at': 'Thu, 01 Nov 2012 16:36:07 +0000',
      'from_user': ...
      }
      {'created_at': 'Thu, 01 Nov 2012 16:36:04 +0000',
      'from_user': ...
      }],
'results_per_page': 5,
'since_id': 0,
'since_id_str': '0'}
>>>

通常，JSON 解码会根据提供的数据创建字典或列表。如果你想创建其他类型的对象，你可以将 object_pairs_hook 或 object_hook 参数传递给 json.loads()。例如，这里有一个示例演示如何解码 JSON 数据并在 OrderedDict 中保留其顺序：

>>> s = '{"name": "ACME", "shares": 50, "price": 490.1}'
>>> from collections import OrderedDict
>>> data = json.loads(s, object_pairs_hook=OrderedDict)
>>> data
OrderedDict([('name', 'ACME'), ('shares', 50), ('price', 490.1)])
>>>

下面是如何将一个JSON字典转换为一个Python对象例子：

>>> class JSONObject:
...   def __init__(self, d):
...     self.__dict__ = d
...
>>>
>>> data = json.loads(s, object_hook=JSONObject)
>>> data.name
'ACME'
>>> data.shares
50
>>> data.price
490.1
>>>

在最后一个示例中，JSON 解码的字典作为单个参数传递给 __init__()。然后，你可以随心所欲地使用它，比如直接将它用作实例字典。

还有一些选项在编码 JSON 时很有用。如果你想得到一个漂亮的格式化字符串输出，你可以使用 json.dumps() 的缩进参数。它将使输出类似于 pprint() 函数。例如：

>>> print(json.dumps(data))
{"price": 542.23, "name": "ACME", "shares": 100}
>>> print(json.dumps(data, indent=4))
{
  "price": 542.23,
  "name": "ACME",
  "shares": 100
}
>>>

对象实例通常并不是JSON可序列化的。例如：

>>> class Point:
...   def __init__(self, x, y):
...     self.x = x
...     self.y = y
...
>>> p = Point(2, 3)
>>> json.dumps(p)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/local/lib/python3.3/json/__init__.py", line 226, in dumps
    return _default_encoder.encode(obj)
  File "/usr/local/lib/python3.3/json/encoder.py", line 187, in encode
    chunks = self.iterencode(o, _one_shot=True)
  File "/usr/local/lib/python3.3/json/encoder.py", line 245, in iterencode
    return _iterencode(o, 0)
  File "/usr/local/lib/python3.3/json/encoder.py", line 169, in default
    raise TypeError(repr(o) + " is not JSON serializable")
TypeError: <__main__.Point object at 0x1006f2650> is not JSON serializable
>>>

如果你想序列化对象实例，你可以提供一个函数，将一个实例作为输入并返回一个可序列化的字典。例如：

def serialize_instance(obj):
  d = { '__classname__' : type(obj).__name__ }
  d.update(vars(obj))
  return d

如果你想反过来获取这个实例，可以这样做：

# Dictionary mapping names to known classes
classes = {
  'Point' : Point
}
 
def unserialize_object(d):
  clsname = d.pop('__classname__', None)
  if clsname:
    cls = classes[clsname]
    obj = cls.__new__(cls) # Make instance without calling __init__
    for key, value in d.items():
      setattr(obj, key, value)
      return obj
  else:
    return d

下面是如何使用这些函数的例子：

>>> p = Point(2,3)
>>> s = json.dumps(p, default=serialize_instance)
>>> s
'{"__classname__": "Point", "y": 3, "x": 2}'
>>> a = json.loads(s, object_hook=unserialize_object)
>>> a
<__main__.Point object at 0x1017577d0>
>>> a.x
2
>>> a.y
3
>>>

json 模块还有许多其他选项来控制解析低级数字、特殊值如 NaN 等。