Python 對象序列化——pickle and cPickle

Taonce 發(fā)布于2019-07-24 17:38 / 1432人閱讀

摘要：對象序列化從這篇文章粗略翻譯的模塊可以實現(xiàn)任意的對象轉(zhuǎn)換為一系列字節(jié)即序列化對象的算法。的文檔明確的表明它不提供安全保證。而利用則可以控制序列化的細節(jié)。

Python 對象序列化——pickle and cPickle

從這篇文章粗略翻譯的pickle and cPickle

pickle模塊可以實現(xiàn)任意的Python對象轉(zhuǎn)換為一系列字節(jié)(即序列化對象)的算法。這些字節(jié)流可以被傳輸或存儲,接著也可以重構(gòu)為一個和原先對象具有相同特征的新對象。

cPickle模塊實現(xiàn)了同樣的算法,但它是用c而不是python。因此,它比python實現(xiàn)的快上好幾倍, 但是不允許使用者去繼承Pickle。如果繼承對于你的使用不是很重要,那么你大可以使用cPickle。

  Woring: pickle的文檔明確的表明它不提供安全保證。所以慎用pickle來作為內(nèi)部進程通信或者數(shù)

  據(jù)存儲,也不要相信那些你不能驗證安全性的數(shù)據(jù)。

Importing

通常優(yōu)先試用 cPickle，只有當 cPickle 無法正常 import 的時候，采用 pickle 來替代。

try:
   import cPickle as pickle
except:
   import pickle

Encoding and Decoding Data in Strings

第一個示例是將數(shù)據(jù)結(jié)構(gòu)編碼為字符串，然后輸出到控制臺。例子中數(shù)據(jù)結(jié)構(gòu)完全由基本類型組成。pickle 可以編碼任意類的實例，就像下面栗子中演示的那樣：用 pickle.dumps() 來創(chuàng)建對象的字符串表示。

try:
    import cPickle as pickle
except:
    import pickle
import pprint

data = [ { "a":"A", "b":2, "c":3.0 } ]
print "DATA:",
pprint.pprint(data)

data_string = pickle.dumps(data)
print "PICKLE:", data_string

pickle 默認試用 ASSCII 字符串來進行編碼解碼。也支持效率更高的二進制格式，但是下面的例子為了方便閱讀,還是使用了 ASSCII 碼。

$ python pickle_string.py

DATA:[{"a": "A", "b": 2, "c": 3.0}]
PICKLE: (lp1
(dp2
S"a"
S"A"
sS"c"
F3
sS"b"
I2
sa.

數(shù)據(jù)被序列化之后，你就可以將他寫入文件、socket、pipe、etc.然后你可以讀取文件并unpickle 這些數(shù)據(jù)來構(gòu)造一個新的對象。


try:
    import cPickle as pickle
except:
    import pickle
import pprint

data1 = [ { "a":"A", "b":2, "c":3.0 } ]
print "BEFORE:",
pprint.pprint(data1)

data1_string = pickle.dumps(data1)

data2 = pickle.loads(data1_string)
print "AFTER:",
pprint.pprint(data2)

print "SAME?:", (data1 is data2)
print "EQUAL?:", (data1 == data2)

如同例子中演示的那樣，新的對象與之前的對象相等，但是并不是同一個對象。


$ python pickle_unpickle.py

BEFORE:[{"a": "A", "b": 2, "c": 3.0}]
AFTER:[{"a": "A", "b": 2, "c": 3.0}]
SAME?: False
EQUAL?: True

Working with Streams

除了 dumps() 跟 loads(), pickle 還有其他比較方便的方法來操作類文件流。可以同時寫入多個對象到一個 stream 中，然后對象數(shù)量與大小的時候從 stream 讀取他們。


try:
    import cPickle as pickle
except:
    import pickle
import pprint
from StringIO import StringIO

class SimpleObject(object):

    def __init__(self, name):
        self.name = name
        l = list(name)
        l.reverse()
        self.name_backwards = "".join(l)
        return

data = []
data.append(SimpleObject("pickle"))
data.append(SimpleObject("cPickle"))
data.append(SimpleObject("last"))

# Simulate a file with StringIO
out_s = StringIO()

# Write to the stream
for o in data:
    print "WRITING: %s (%s)" % (o.name, o.name_backwards)
    pickle.dump(o, out_s)
    out_s.flush()

# Set up a read-able stream
in_s = StringIO(out_s.getvalue())

# Read the data
while True:
    try:
        o = pickle.load(in_s)
    except EOFError:
        break
    else:
        print "READ: %s (%s)" % (o.name, o.name_backwards)

上面例子中使用了 StringIO 緩沖區(qū)來模擬streams，這樣我們在建立可讀流的時候可以玩一些技巧。一些接單的數(shù)據(jù)庫格式也可以使用 pickles 來存儲數(shù)據(jù)，當然，如果試用 shelve 來存儲會更加簡單。

$ python pickle_stream.py

WRITING: pickle (elkcip)
WRITING: cPickle (elkciPc)
WRITING: last (tsal)
READ: pickle (elkcip)
READ: cPickle (elkciPc)
READ: last (tsal)

除了存儲數(shù)據(jù)，pickles 用來做內(nèi)部通信的機會也很多。舉個例子：用 os.fork() 和 os.pipe() 可以建立一個工作進程，然后這個進程會從管道中讀取數(shù)據(jù)并把結(jié)果傳遞給另外一個管道。因為這些代碼是用來管理worker pool 跟發(fā)送任務(wù)跟接受任務(wù)的，沒有什么特殊的內(nèi)容，所以這些核心代碼可以被拿來重復(fù)利用。如果你在試用 pipe 或者 sockets，那么在 dumping完對象之后，不要忘記刷新它們并通過其間的連接將數(shù)據(jù)推送到另外一個進程。如果你不想自己寫 worker pool manager 的話，可以看一下multiprocessing。

Problems Reconstructing Objects

需要注意的是，在序列化實例的時候，我們只是對于數(shù)據(jù)來進行序列化，而無法對類的定義進行序列化。
下面的栗子：

try:
    import cPickle as pickle
except:
    import pickle
import sys

class SimpleObject(object):

    def __init__(self, name):
        self.name = name
        l = list(name)
        l.reverse()
        self.name_backwards = "".join(l)
        return

if __name__ == "__main__":
    data = []
    data.append(SimpleObject("pickle"))
    data.append(SimpleObject("cPickle"))
    data.append(SimpleObject("last"))

    try:
        filename = sys.argv[1]
    except IndexError:
        raise RuntimeError("Please specify a filename as an argument to %s" % sys.argv[0])

    out_s = open(filename, "wb")
    try:
        # Write to the stream
        for o in data:
            print "WRITING: %s (%s)" % (o.name, o.name_backwards)
            pickle.dump(o, out_s)
    finally:
        out_s.close()

運行的時候，這個腳本會以命令行中給出的參數(shù)創(chuàng)建一個文件。

$ python pickle_dump_to_file_1.py test.dat

WRITING: pickle (elkcip)
WRITING: cPickle (elkciPc)
WRITING: last (tsal)

下面是一個會報錯的栗子：

try:
    import cPickle as pickle
except:
    import pickle
import pprint
from StringIO import StringIO
import sys


try:
    filename = sys.argv[1]
except IndexError:
    raise RuntimeError("Please specify a filename as an argument to %s" % sys.argv[0])

in_s = open(filename, "rb")
try:
    # Read the data
    while True:
        try:
            o = pickle.load(in_s)
        except EOFError:
            break
        else:
            print "READ: %s (%s)" % (o.name, o.name_backwards)
finally:
    in_s.close()

這個報錯是因為沒有SimpleObject類。

$ python pickle_load_from_file_1.py test.dat

Traceback (most recent call last):
  File "pickle_load_from_file_1.py", line 52, in 
    o = pickle.load(in_s)
AttributeError: "module" object has no attribute "SimpleObject"

我們通過從原來的腳本中import SimpleObject來修正上面的錯誤。
在上面文件中的增加下面一行:

from pickle_dump_to_file_1 import SimpleObject

$ python pickle_load_from_file_2.py test.dat

READ: pickle (elkcip)
READ: cPickle (elkciPc)
READ: last (tsal)

像sockets, file handles, database connections ...這些數(shù)據(jù)類型是無法被序列化的，我們在處理類似數(shù)據(jù)類型的時候不得不特殊處理。而利用pickle protocol 則可以控制序列化的細節(jié)。

class Data(object):
    def __init__(self, x, y):
        self._x = x
        self._y = y

    def __getstate__(self):
        d = self.__dict__.copy()
        del d["_y"]
        return d
    def __setstate__(self, state):
        self.__dict__.update(state)
d = Data(10, 20)
s = cPickle.dumps(d, 2)
d2 = cPickle.loads(s)
##d2.__dict__
##{"_x": 10}