6.2 读写JSON数据

问题

你想读写JSON(JavaScript Object Notation)编码格式的数据。

解决方案

json 模块提供了一种很简单的方式来编码和解码JSON数据。其中两个主要的函数是 json.dumps() 和 json.loads() ，要比其他序列化函数库如pickle的接口少得多。下面演示如何将一个Python数据结构转换为JSON：

  1. import json
  2.  
  3. data = {
  4.     'name' : 'ACME',
  5.     'shares' : 100,
  6.     'price' : 542.23
  7. }
  8.  
  9. json_str = json.dumps(data)

下面演示如何将一个JSON编码的字符串转换回一个Python数据结构：

  1. data = json.loads(json_str)

如果你要处理的是文件而不是字符串，你可以使用 json.dump() 和 json.load() 来编码和解码JSON数据。例如：

  1. # Writing JSON data
  2. with open('data.json', 'w') as f:
  3.     json.dump(data, f)
  4.  
  5. # Reading data back
  6. with open('data.json', 'r') as f:
  7.     data = json.load(f)

讨论

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。下面是一个例子，演示了编码后的字符串效果：

  1. >>> json.dumps(False)
  2. 'false'
  3. >>> d = {'a': True,
  4. ...     'b': 'Hello',
  5. ...     'c': None}
  6. >>> json.dumps(d)
  7. '{"b": "Hello", "c": null, "a": true}'
  8. >>>

如果你试着去检查JSON解码后的数据，你通常很难通过简单的打印来确定它的结构，特别是当数据的嵌套结构层次很深或者包含大量的字段时。为了解决这个问题，可以考虑使用pprint模块的 pprint() 函数来代替普通的 print() 函数。它会按照key的字母顺序并以一种更加美观的方式输出。下面是一个演示如何漂亮的打印输出Twitter上搜索结果的例子：

  1. >>> from urllib.request import urlopen
  2. >>> import json
  3. >>> u = urlopen('http://search.twitter.com/search.json?q=python&rpp=5')
  4. >>> resp = json.loads(u.read().decode('utf-8'))
  5. >>> from pprint import pprint
  6. >>> pprint(resp)
  7. {'completed_in': 0.074,
  8. 'max_id': 264043230692245504,
  9. 'max_id_str': '264043230692245504',
  10. 'next_page': '?page=2&max_id=264043230692245504&q=python&rpp=5',
  11. 'page': 1,
  12. 'query': 'python',
  13. 'refresh_url': '?since_id=264043230692245504&q=python',
  14. 'results': [{'created_at': 'Thu, 01 Nov 2012 16:36:26 +0000',
  15.             'from_user': ...
  16.             },
  17.             {'created_at': 'Thu, 01 Nov 2012 16:36:14 +0000',
  18.             'from_user': ...
  19.             },
  20.             {'created_at': 'Thu, 01 Nov 2012 16:36:13 +0000',
  21.             'from_user': ...
  22.             },
  23.             {'created_at': 'Thu, 01 Nov 2012 16:36:07 +0000',
  24.             'from_user': ...
  25.             }
  26.             {'created_at': 'Thu, 01 Nov 2012 16:36:04 +0000',
  27.             'from_user': ...
  28.             }],
  29. 'results_per_page': 5,
  30. 'since_id': 0,
  31. 'since_id_str': '0'}
  32. >>>

一般来讲，JSON解码会根据提供的数据创建dicts或lists。如果你想要创建其他类型的对象，可以给 json.loads() 传递object_pairs_hook或object_hook参数。例如，下面是演示如何解码JSON数据并在一个OrderedDict中保留其顺序的例子：

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

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

  1. >>> class JSONObject:
  2. ...     def __init__(self, d):
  3. ...         self.__dict__ = d
  4. ...
  5. >>>
  6. >>> data = json.loads(s, object_hook=JSONObject)
  7. >>> data.name
  8. 'ACME'
  9. >>> data.shares
  10. 50
  11. >>> data.price
  12. 490.1
  13. >>>

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

在编码JSON的时候，还有一些选项很有用。如果你想获得漂亮的格式化字符串后输出，可以使用 json.dumps() 的indent参数。它会使得输出和pprint()函数效果类似。比如：

  1. >>> print(json.dumps(data))
  2. {"price": 542.23, "name": "ACME", "shares": 100}
  3. >>> print(json.dumps(data, indent=4))
  4. {
  5.     "price": 542.23,
  6.     "name": "ACME",
  7.     "shares": 100
  8. }
  9. >>>

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

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

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

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

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

  1. # Dictionary mapping names to known classes
  2. classes = {
  3.     'Point' : Point
  4. }
  5.  
  6. def unserialize_object(d):
  7.     clsname = d.pop('__classname__', None)
  8.     if clsname:
  9.         cls = classes[clsname]
  10.         obj = cls.__new__(cls) # Make instance without calling __init__
  11.         for key, value in d.items():
  12.             setattr(obj, key, value)
  13.         return obj
  14.     else:
  15.         return d

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

  1. >>> p = Point(2,3)
  2. >>> s = json.dumps(p, default=serialize_instance)
  3. >>> s
  4. '{"__classname__": "Point", "y": 3, "x": 2}'
  5. >>> a = json.loads(s, object_hook=unserialize_object)
  6. >>> a
  7. <__main__.Point object at 0x1017577d0>
  8. >>> a.x
  9. 2
  10. >>> a.y
  11. 3
  12. >>>

json 模块还有很多其他选项来控制更低级别的数字、特殊值如NaN等的解析。可以参考官方文档获取更多细节。

原文:

http://python3-cookbook.readthedocs.io/zh_CN/latest/c06/p02_read-write_json_data.html