問題

你想讀寫JSON(JavaScript Object Notation)編碼格式的數(shù)據(jù)。

解決方案

json 模塊提供了一種很簡單的方式來編碼和解碼JSON數(shù)據(jù)。其中兩個(gè)主要的函數(shù)是 json.dumps() 和 json.loads() ，要比其他序列化函數(shù)庫如pickle的接口少得多。下面演示如何將一個(gè)Python數(shù)據(jù)結(jié)構(gòu)轉(zhuǎn)換為JSON：

import json

data = {
    'name' : 'ACME',
    'shares' : 100,
    'price' : 542.23
}

json_str = json.dumps(data)

下面演示如何將一個(gè)JSON編碼的字符串轉(zhuǎn)換回一個(gè)Python數(shù)據(jù)結(jié)構(gòu)：

data = json.loads(json_str)

如果你要處理的是文件而不是字符串，你可以使用json.dump()和json.load()來編碼和解碼JSON數(shù)據(jù)。例如：

# Writing JSON data
with open('data.json', 'w') as f:
    json.dump(data, f)

# Reading data back
with open('data.json', 'r') as f:
    data = json.load(f)

討論

JSON編碼支持的基本數(shù)據(jù)類型為None，bool，int，float和str，以及包含這些類型數(shù)據(jù)的lists，tuples和dictionaries。對(duì)于dictionaries，keys需要是字符串類型(字典中任何非字符串類型的key在編碼時(shí)會(huì)先轉(zhuǎn)換為字符串)。為了遵循JSON規(guī)范，你應(yīng)該只編碼Python的lists和dictionaries。而且，在web應(yīng)用程序中，頂層對(duì)象被編碼為一個(gè)字典是一個(gè)標(biāo)準(zhǔn)做法。

JSON編碼的格式對(duì)于Python語法而已幾乎是完全一樣的，除了一些小的差異之外。比如，True會(huì)被映射為true，F(xiàn)alse被映射為false，而None會(huì)被映射為null。下面是一個(gè)例子，演示了編碼后的字符串效果：

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

如果你試著去檢查JSON解碼后的數(shù)據(jù)，你通常很難通過簡單的打印來確定它的結(jié)構(gòu)，特別是當(dāng)數(shù)據(jù)的嵌套結(jié)構(gòu)層次很深或者包含大量的字段時(shí)。為了解決這個(gè)問題，可以考慮使用pprint模塊的 pprint() 函數(shù)來代替普通的 print() 函數(shù)。它會(huì)按照key的字母順序并以一種更加美觀的方式輸出。下面是一個(gè)演示如何漂亮的打印輸出Twitter上搜索結(jié)果的例子：

>>> 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解碼會(huì)根據(jù)提供的數(shù)據(jù)創(chuàng)建dicts或lists。如果你想要?jiǎng)?chuàng)建其他類型的對(duì)象，可以給 json.loads() 傳遞object_pairs_hook或object_hook參數(shù)。例如，下面是演示如何解碼JSON數(shù)據(jù)并在一個(gè)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)])
>>>

下面是如何將一個(gè)JSON字典轉(zhuǎn)換為一個(gè)Python對(duì)象例子：

>>> 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
>>>

最后一個(gè)例子中，JSON解碼后的字典作為一個(gè)單個(gè)參數(shù)傳遞給 __init__() 。然后，你就可以隨心所欲的使用它了，比如作為一個(gè)實(shí)例字典來直接使用它。

在編碼JSON的時(shí)候，還有一些選項(xiàng)很有用。如果你想獲得漂亮的格式化字符串后輸出，可以使用 json.dumps() 的indent參數(shù)。它會(huì)使得輸出和pprint()函數(shù)效果類似。比如：

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

對(duì)象實(shí)例通常并不是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
>>>

如果你想序列化對(duì)象實(shí)例，你可以提供一個(gè)函數(shù)，它的輸入是一個(gè)實(shí)例，返回一個(gè)可序列化的字典。例如：

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

如果你想反過來獲取這個(gè)實(shí)例，可以這樣做：

# 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

下面是如何使用這些函數(shù)的例子：

>>> 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 模塊還有很多其他選項(xiàng)來控制更低級(jí)別的數(shù)字、特殊值如NaN等的解析。可以參考官方文檔獲取更多細(xì)節(jié)。