从零开始学Python-Day55-序列化

Pickle

在程序运行的过程中，所有的变量都是在内存中，比如，定义一个dict：

d = dict(name='Woodman', age=35, salary=5000)

可以随时修改变量，比如把name改成’Zhang’，但是一旦程序结束，变量所占用的内存就被操作系统全部回收。如果没有把修改后的’Zhang’存储到磁盘上，下次重新运行程序，变量又被初始化为’Woodman’。
我们把变量从内存中变成可存储或传输的过程称之为序列化，在Python中叫pickling，在其他语言中也被称之为serialization，marshalling，flattening等等，都是一个意思。序列化之后，就可以把序列化后的内容写入磁盘，或者通过网络传输到别的机器上。
反过来，把变量内容从序列化的对象重新读到内存里称之为反序列化，即unpickling。
Python提供了pickle模块来实现序列化。

首先，我们尝试把一个对象序列化并写入文件：

>>> import pickle
>>> d = dict(name='Woodman', age=35, salary=5000)
>>> pickle.dumps(d)
b'\x80\x04\x95*\x00\x00\x00\x00\x00\x00\x00}\x94(\x8c\x04name\x94\x8c\x07Woodman\x94\x8c\x03age\x94K#\x8c\x06salary\x94M\x88\x13u.'
>>> 

pickle.dumps()方法把任意对象序列化成一个bytes，然后，就可以把这个bytes写入文件。或者用另一个方法pickle.dump()直接把对象序列化后写入一个file-like Object：

import pickle
d = dict(name='Woodman', age=35, salary=5000)
f = open('/Users/hycx-woodman/Downloads/py/dump.txt', 'wb')
pickle.dump(d, f)
f.close()

看看写入的dump.txt文件，这些都是Python保存的对象内部信息。

8004 952a 0000 0000 0000 007d 9428 8c04
6e61 6d65 948c 0757 6f6f 646d 616e 948c
0361 6765 944b 238c 0673 616c 6172 7994
4d88 1375 2e

当我们要把对象从磁盘读到内存时，可以先把内容读到一个bytes，然后用pickle.loads()方法反序列化出对象，也可以直接用pickle.load()方法从一个file-like Object中直接反序列化出对象。我们打开另一个Python命令行来反序列化刚才保存的对象：

>>> f = open('/Users/hycx-woodman/Downloads/py/hello.txt', 'rb')
>>> d = pickle.load(f)
>>> f.close()
>>> d
{'name': 'Woodman', 'age': 35, 'salary': 5000}

当然，这个变量和原来的变量是完全不相干的对象，它们只是内容相同而已。
Pickle的问题和所有其他编程语言特有的序列化问题一样，就是它只能用于Python，并且可能不同版本的Python彼此都不兼容，因此，只能用Pickle保存那些不重要的数据，不能成功地反序列化也没关系。

JSON

如果我们要在不同的编程语言之间传递对象，就必须把对象序列化为标准格式，比如XML，但更好的方法是序列化为JSON，因为JSON表示出来就是一个字符串，可以被所有语言读取，也可以方便地存储到磁盘或者通过网络传输。JSON不仅是标准格式，并且比XML更快，而且可以直接在Web页面中读取，非常方便。
JSON表示的对象就是标准的JavaScript语言的对象，JSON和Python内置的数据类型对应如下：

Python内置的json模块提供了非常完善的Python对象到JSON格式的转换。我们先看看如何把Python对象变成一个JSON：

>>> import json
>>> d = dict(name='Woodman', age=35, salary=5000)
>>> json.dumps(d)
'{"name": "Woodman", "age": 35, "salary": 5000}'

dumps()方法返回一个str，内容就是标准的JSON。类似的，dump()方法可以直接把JSON写入一个file-like Object。
要把JSON反序列化为Python对象，用loads()或者对应的load()方法，前者把JSON的字符串反序列化，后者从file-like Object中读取字符串并反序列化：

>>> json_str = '{"name": "Woodman", "age": 35, "salary": 5000}'
>>> json.loads(json_str)
{'name': 'Woodman', 'age': 35, 'salary': 5000}

由于JSON标准规定JSON编码是UTF-8，所以我们总是能正确地在Python的str与JSON的字符串之间转换。

JSON进阶

Python的dict对象可以直接序列化为JSON的{}，不过，很多时候，我们更喜欢用class表示对象，比如定义Employee类，然后序列化：

>>> import json
>>> class Employee():
	def __init__(self, name, age, salary):
		self.name = name
		self.age = age
		self.salary = salary

		
>>> s = Employee('Woodman', 35, 5000)
>>> print(json.dumps(s))
Traceback (most recent call last):
  File "<pyshell#41>", line 1, in <module>
    print(json.dumps(s))
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/json/__init__.py", line 231, in dumps
    return _default_encoder.encode(obj)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/json/encoder.py", line 199, in encode
    chunks = self.iterencode(o, _one_shot=True)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/json/encoder.py", line 257, in iterencode
    return _iterencode(o, 0)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/json/encoder.py", line 179, in default
    raise TypeError(f'Object of type {o.__class__.__name__} '
TypeError: Object of type Employee is not JSON serializable

我们看到TypeError报错，错误的原因是Employee对象不是一个可序列化为JSON的对象。
我们仔细看看dumps()方法的参数列表，可以发现，除了第一个必须的obj参数外，dumps()方法还提供了一大堆的可选参数：

json.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)

这些可选参数就是让我们来定制JSON序列化。前面的代码之所以无法把Employee类实例序列化为JSON，是因为默认情况下，dumps()方法不知道如何将Employee实例变为一个JSON的{}对象。
可选参数default就是把任意一个对象变成一个可序列为JSON的对象，我们只需要为Employee专门写一个转换函数，再把函数传进去即可：

>>> def Employee2dict(std):
	return {
		'name':std.name,
		'age':std.age,
		'salary':std.salary
		}

这样，Employee实例首先被Employee2dict()函数转换成dict，然后再被顺利序列化为JSON：

>>> print(json.dumps(s, default=Employee2dict))
{"name": "Woodman", "age": 35, "salary": 5000}

不过，下次如果遇到一个Employer类的实例，照样无法序列化为JSON。我们可以偷个懒，把任意class的实例变为dict：

print(json.dumps(s, default=lambda obj: obj.__dict__))

因为通常class的实例都有一个__dict__属性，它就是一个dict，用来存储实例变量。也有少数例外，比如定义了__slots__的class。
同样的道理，如果我们要把JSON反序列化为一个Employee对象实例，loads()方法首先转换出一个dict对象，然后，我们传入的object_hook函数负责把dict转换为Employee实例：

>>> def dict2Employee(d):
	return Employee(d['name'], d['age'], d['salary'])

>>> json_str = '{"name": "Woodman", "age": 35, "salary": 5000}'
>>> print(json.loads(json_str, object_hook=dict2Employee))
<__main__.Employee object at 0x10835f0d0>

打印出的是反序列化的Student实例对象。

小结

Python语言特定的序列化模块是pickle，但如果要把序列化搞得更通用、更符合Web标准，就可以使用json模块。
json模块的dumps()和loads()函数是定义得非常好的接口的典范。当我们使用时，只需要传入一个必须的参数。但是，当默认的序列化或反序列机制不满足我们的要求时，我们又可以传入更多的参数来定制序列化或反序列化的规则，既做到了接口简单易用，又做到了充分的扩展性和灵活性。