pickle — Python 对象序列化 ¶

与其它 Python 模块的关系 ¶

数据流格式 ¶

The data format used by pickle is Python-specific. This has the advantage that there are no restrictions imposed by external standards such as JSON or XDR (which can’t represent pointer sharing); however it means that non-Python programs may not be able to reconstruct pickled Python objects.

默认情况下， pickle data format uses a relatively compact binary representation. If you need optimal size characteristics, you can efficiently compress pickled data.

模块 pickletools contains tools for analyzing data streams generated by pickle . pickletools source code has extensive comments about opcodes used by pickle protocols.

There are currently 6 different protocols which can be used for pickling. The higher the protocol used, the more recent the version of Python needed to read the pickle produced.

• Protocol version 0 is the original “human-readable” protocol and is backwards compatible with earlier versions of Python.

• Protocol version 1 is an old binary format which is also compatible with earlier versions of Python.

• Protocol version 2 was introduced in Python 2.3. It provides much more efficient pickling of 新样式类 es. Refer to PEP 307 for information about improvements brought by protocol 2.

• Protocol version 3 was added in Python 3.0. It has explicit support for bytes objects and cannot be unpickled by Python 2.x. This was the default protocol in Python 3.0–3.7.

• Protocol version 4 was added in Python 3.4. It adds support for very large objects, pickling more kinds of objects, and some data format optimizations. It is the default protocol starting with Python 3.8. Refer to PEP 3154 for information about improvements brought by protocol 4.

• Protocol version 5 was added in Python 3.8. It adds support for out-of-band data and speedup for in-band data. Refer to PEP 574 for information about improvements brought by protocol 5.

模块接口 ¶

To serialize an object hierarchy, you simply call the dumps() function. Similarly, to de-serialize a data stream, you call the loads() function. However, if you want more control over serialization and de-serialization, you can create a Pickler or an Unpickler object, respectively.

pickle module provides the following constants:

pickle. HIGHEST_PROTOCOL ¶

An integer, the highest protocol version available. This value can be passed as a protocol value to functions dump() and dumps() as well as the Pickler 构造函数。

pickle. DEFAULT_PROTOCOL ¶

An integer, the default protocol version used for pickling. May be less than HIGHEST_PROTOCOL . Currently the default protocol is 4, first introduced in Python 3.4 and incompatible with previous versions.

3.0 版改变： 默认协议为 3。

3.8 版改变： 默认协议为 4。

pickle module provides the following functions to make the pickling process more convenient:

pickle. dump ( obj , file , protocol=None , * , fix_imports=True , buffer_callback=None ) ¶

Write the pickled representation of the object obj to the open 文件对象 file 。这相当于 Pickler(file, protocol).dump(obj) .

自变量 file , protocol , fix_imports and buffer_callback 拥有的含义如同在 Pickler 构造函数。

3.8 版改变： buffer_callback 自变量被添加。

pickle. dumps ( obj , protocol=None , * , fix_imports=True , buffer_callback=None ) ¶

Return the pickled representation of the object obj 作为 bytes object, instead of writing it to a file.

自变量 protocol , fix_imports and buffer_callback 拥有的含义如同在 Pickler 构造函数。

3.8 版改变： buffer_callback 自变量被添加。

pickle. load ( file , * , fix_imports=True , encoding="ASCII" , errors="strict" , buffers=None ) ¶

Read the pickled representation of an object from the open 文件对象 file and return the reconstituted object hierarchy specified therein. This is equivalent to Unpickler(file).load() .

The protocol version of the pickle is detected automatically, so no protocol argument is needed. Bytes past the pickled representation of the object are ignored.

自变量 file , fix_imports , encoding , errors , strict and buffers 拥有的含义如同在 Unpickler 构造函数。

3.8 版改变： buffers 自变量被添加。

pickle. loads ( data , / , * , fix_imports=True , encoding="ASCII" , errors="strict" , buffers=None ) ¶

Return the reconstituted object hierarchy of the pickled representation data of an object. data 必须是 像字节对象 .

The protocol version of the pickle is detected automatically, so no protocol argument is needed. Bytes past the pickled representation of the object are ignored.

自变量 file , fix_imports , encoding , errors , strict and buffers 拥有的含义如同在 Unpickler 构造函数。

3.8 版改变： buffers 自变量被添加。

pickle 模块定义了 3 个异常：

exception pickle. PickleError ¶

Common base class for the other pickling exceptions. It inherits Exception .

exception pickle. PicklingError ¶

Error raised when an unpicklable object is encountered by Pickler . It inherits PickleError .

参考 什么可以腌制和取消腌制？ to learn what kinds of objects can be pickled.

exception pickle. UnpicklingError ¶

Error raised when there is a problem unpickling an object, such as a data corruption or a security violation. It inherits PickleError .

Note that other exceptions may also be raised during unpickling, including (but not necessarily limited to) AttributeError, EOFError, ImportError, and IndexError.

pickle module exports three classes, Pickler , Unpickler and PickleBuffer :

class pickle. Pickler ( file , protocol=None , * , fix_imports=True , buffer_callback=None ) ¶

This takes a binary file for writing a pickle data stream.

可选 protocol argument, an integer, tells the pickler to use the given protocol; supported protocols are 0 to HIGHEST_PROTOCOL . If not specified, the default is DEFAULT_PROTOCOL . If a negative number is specified, HIGHEST_PROTOCOL is selected.

file argument must have a write() method that accepts a single bytes argument. It can thus be an on-disk file opened for binary writing, an io.BytesIO instance, or any other custom object that meets this interface.

若 fix_imports 为 True 和 protocol is less than 3, pickle will try to map the new Python 3 names to the old module names used in Python 2, so that the pickle data stream is readable with Python 2.

若 buffer_callback is None (the default), buffer views are serialized into file as part of the pickle stream.

若 buffer_callback is not None, then it can be called any number of times with a buffer view. If the callback returns a false value (such as None), the given buffer is out-of-band ; otherwise the buffer is serialized in-band, i.e. inside the pickle stream.

它是错误若 buffer_callback is not None and protocol is None or smaller than 5.

3.8 版改变： buffer_callback 自变量被添加。

dump ( obj ) ¶

Write the pickled representation of obj to the open file object given in the constructor.

persistent_id ( obj ) ¶

Do nothing by default. This exists so a subclass can override it.

若 persistent_id() 返回 None , obj is pickled as usual. Any other value causes Pickler to emit the returned value as a persistent ID for obj . The meaning of this persistent ID should be defined by Unpickler.persistent_load() . Note that the value returned by persistent_id() cannot itself have a persistent ID.

见 外部对象的持久性 for details and examples of uses.

dispatch_table ¶

A pickler object’s dispatch table is a registry of reduction functions of the kind which can be declared using copyreg.pickle() . It is a mapping whose keys are classes and whose values are reduction functions. A reduction function takes a single argument of the associated class and should conform to the same interface as a __reduce__() 方法。

By default, a pickler object will not have a dispatch_table attribute, and it will instead use the global dispatch table managed by the copyreg module. However, to customize the pickling for a specific pickler object one can set the dispatch_table attribute to a dict-like object. Alternatively, if a subclass of Pickler 拥有 dispatch_table attribute then this will be used as the default dispatch table for instances of that class.

见 分派表 了解用法范例。

3.3 版新增。

reducer_override ( self , obj ) ¶

Special reducer that can be defined in Pickler subclasses. This method has priority over any reducer in the dispatch_table . It should conform to the same interface as a __reduce__() method, and can optionally return NotImplemented to fallback on dispatch_table -registered reducers to pickle obj .

For a detailed example, see 类型、函数和其它对象的自定义缩减 .

3.8 版新增。

fast ¶

Deprecated. Enable fast mode if set to a true value. The fast mode disables the usage of memo, therefore speeding the pickling process by not generating superfluous PUT opcodes. It should not be used with self-referential objects, doing otherwise will cause Pickler to recurse infinitely.

使用 pickletools.optimize() if you need more compact pickles.

class pickle. Unpickler ( file , * , fix_imports=True , encoding="ASCII" , errors="strict" , buffers=None ) ¶

This takes a binary file for reading a pickle data stream.

The protocol version of the pickle is detected automatically, so no protocol argument is needed.

自变量 file must have three methods, a read() method that takes an integer argument, a readinto() method that takes a buffer argument and a readline() method that requires no arguments, as in the io.BufferedIOBase interface. Thus file can be an on-disk file opened for binary reading, an io.BytesIO object, or any other custom object that meets this interface.

可选自变量 fix_imports , encoding and errors are used to control compatibility support for pickle stream generated by Python 2. If fix_imports is true, pickle will try to map the old Python 2 names to the new names used in Python 3. The encoding and errors tell pickle how to decode 8-bit string instances pickled by Python 2; these default to ‘ASCII’ and ‘strict’, respectively. The encoding can be ‘bytes’ to read these 8-bit string instances as bytes objects. Using encoding='latin1' is required for unpickling NumPy arrays and instances of datetime , date and time pickled by Python 2.

若 buffers is None (the default), then all data necessary for deserialization must be contained in the pickle stream. This means that the buffer_callback argument was None when a Pickler was instantiated (or when dump() or dumps() was called).

若 buffers is not None, it should be an iterable of buffer-enabled objects that is consumed each time the pickle stream references an out-of-band buffer view. Such buffers have been given in order to the buffer_callback of a Pickler object.

3.8 版改变： buffers 自变量被添加。

load ( ) ¶

Read the pickled representation of an object from the open file object given in the constructor, and return the reconstituted object hierarchy specified therein. Bytes past the pickled representation of the object are ignored.

persistent_load ( pid ) ¶

Raise an UnpicklingError 在默认情况下。

If defined, persistent_load() should return the object specified by the persistent ID pid . If an invalid persistent ID is encountered, an UnpicklingError should be raised.

见 外部对象的持久性 for details and examples of uses.

find_class ( module , name ) ¶

Import 模块 if necessary and return the object called name from it, where the 模块 and name arguments are str objects. Note, unlike its name suggests, find_class() is also used for finding functions.

Subclasses may override this to gain control over what type of objects and how they can be loaded, potentially reducing security risks. Refer to 限定全局 了解细节。

引发 审计事件 pickle.find_class 采用自变量 module , name .

class pickle. PickleBuffer ( buffer ) ¶

A wrapper for a buffer representing picklable data. buffer 必须是 buffer-providing object, such as a 像字节对象 or a N-dimensional array.

PickleBuffer is itself a buffer provider, therefore it is possible to pass it to other APIs expecting a buffer-providing object, such as memoryview .

PickleBuffer objects can only be serialized using pickle protocol 5 or higher. They are eligible for out-of-band serialization .

3.8 版新增。

raw ( ) ¶

返回 memoryview of the memory area underlying this buffer. The returned object is a one-dimensional, C-contiguous memoryview with format B (unsigned bytes). BufferError is raised if the buffer is neither C- nor Fortran-contiguous.

release ( ) ¶

Release the underlying buffer exposed by the PickleBuffer object.

什么可以腌制和取消腌制？ ¶

The following types can be pickled:

• None , True ，和 False

• integers, floating point numbers, complex numbers

• strings, bytes, bytearrays

• tuples, lists, sets, and dictionaries containing only picklable objects

• functions defined at the top level of a module (using def , not lambda )

• built-in functions defined at the top level of a module

• classes that are defined at the top level of a module

• instances of such classes whose __dict__ or the result of calling __getstate__() is picklable (see section 腌制类实例 了解细节)。

Attempts to pickle unpicklable objects will raise the PicklingError exception; when this happens, an unspecified number of bytes may have already been written to the underlying file. Trying to pickle a highly recursive data structure may exceed the maximum recursion depth, a RecursionError will be raised in this case. You can carefully raise this limit with sys.setrecursionlimit() .

Note that functions (built-in and user-defined) are pickled by “fully qualified” name reference, not by value. 2 This means that only the function name is pickled, along with the name of the module the function is defined in. Neither the function’s code, nor any of its function attributes are pickled. Thus the defining module must be importable in the unpickling environment, and the module must contain the named object, otherwise an exception will be raised. 3

Similarly, classes are pickled by named reference, so the same restrictions in the unpickling environment apply. Note that none of the class’s code or data is pickled, so in the following example the class attribute attr is not restored in the unpickling environment:

class Foo:
    attr = 'A class attribute'
picklestring = pickle.dumps(Foo)
								

These restrictions are why picklable functions and classes must be defined in the top level of a module.

Similarly, when class instances are pickled, their class’s code and data are not pickled along with them. Only the instance data are pickled. This is done on purpose, so you can fix bugs in a class or add methods to the class and still load objects that were created with an earlier version of the class. If you plan to have long-lived objects that will see many versions of a class, it may be worthwhile to put a version number in the objects so that suitable conversions can be made by the class’s __setstate__() 方法。

腌制类实例 ¶

In this section, we describe the general mechanisms available to you to define, customize, and control how class instances are pickled and unpickled.

In most cases, no additional code is needed to make instances picklable. By default, pickle will retrieve the class and the attributes of an instance via introspection. When a class instance is unpickled, its __init__() method is usually not invoked. The default behaviour first creates an uninitialized instance and then restores the saved attributes. The following code shows an implementation of this behaviour:

def save(obj):
    return (obj.__class__, obj.__dict__)
def load(cls, attributes):
    obj = cls.__new__(cls)
    obj.__dict__.update(attributes)
    return obj
								

Classes can alter the default behaviour by providing one or several special methods:

object. __getnewargs_ex__ ( ) ¶

In protocols 2 and newer, classes that implements the __getnewargs_ex__() method can dictate the values passed to the __new__() method upon unpickling. The method must return a pair (args, kwargs) where args is a tuple of positional arguments and kwargs a dictionary of named arguments for constructing the object. Those will be passed to the __new__() method upon unpickling.

You should implement this method if the __new__() method of your class requires keyword-only arguments. Otherwise, it is recommended for compatibility to implement __getnewargs__() .

3.6 版改变： __getnewargs_ex__() 现在用于协议 2 和 3。

object. __getnewargs__ ( ) ¶

This method serves a similar purpose as __getnewargs_ex__() , but supports only positional arguments. It must return a tuple of arguments args which will be passed to the __new__() method upon unpickling.

__getnewargs__() will not be called if __getnewargs_ex__() is defined.

3.6 版改变： 在 Python 3.6 之前， __getnewargs__() was called instead of __getnewargs_ex__() in protocols 2 and 3.

object. __getstate__ ( ) ¶

Classes can further influence how their instances are pickled; if the class defines the method __getstate__() , it is called and the returned object is pickled as the contents for the instance, instead of the contents of the instance’s dictionary. If the __getstate__() method is absent, the instance’s __dict__ is pickled as usual.

object. __setstate__ ( state ) ¶

Upon unpickling, if the class defines __setstate__() , it is called with the unpickled state. In that case, there is no requirement for the state object to be a dictionary. Otherwise, the pickled state must be a dictionary and its items are assigned to the new instance’s dictionary.

注意

若 __getstate__() 返回 False 值， __setstate__() 方法不会被调用当取消腌制时。

Refer to the section 处理有状态对象 for more information about how to use the methods __getstate__() and __setstate__() .

As we shall see, pickle does not use directly the methods described above. In fact, these methods are part of the copy protocol which implements the __reduce__() special method. The copy protocol provides a unified interface for retrieving the data necessary for pickling and copying objects. 4

Although powerful, implementing __reduce__() directly in your classes is error prone. For this reason, class designers should use the high-level interface (i.e., __getnewargs_ex__() , __getstate__() and __setstate__() ) whenever possible. We will show, however, cases where using __reduce__() is the only option or leads to more efficient pickling or both.

object. __reduce__ ( ) ¶

The interface is currently defined as follows. The __reduce__() method takes no argument and shall return either a string or preferably a tuple (the returned object is often referred to as the “reduce value”).

If a string is returned, the string should be interpreted as the name of a global variable. It should be the object’s local name relative to its module; the pickle module searches the module namespace to determine the object’s module. This behaviour is typically useful for singletons.

When a tuple is returned, it must be between two and six items long. Optional items can either be omitted, or None can be provided as their value. The semantics of each item are in order:

• A callable object that will be called to create the initial version of the object.

• A tuple of arguments for the callable object. An empty tuple must be given if the callable does not accept any argument.

• Optionally, the object’s state, which will be passed to the object’s __setstate__() method as previously described. If the object has no such method then, the value must be a dictionary and it will be added to the object’s __dict__ 属性。

• Optionally, an iterator (and not a sequence) yielding successive items. These items will be appended to the object either using obj.append(item) or, in batch, using obj.extend(list_of_items) . This is primarily used for list subclasses, but may be used by other classes as long as they have append() and extend() methods with the appropriate signature. (Whether append() or extend() is used depends on which pickle protocol version is used as well as the number of items to append, so both must be supported.)

• Optionally, an iterator (not a sequence) yielding successive key-value pairs. These items will be stored to the object using obj[key] = value . This is primarily used for dictionary subclasses, but may be used by other classes as long as they implement __setitem__() .

• Optionally, a callable with a (obj, state) signature. This callable allows the user to programmatically control the state-updating behavior of a specific object, instead of using obj ’s static __setstate__() method. If not None , this callable will have priority over obj ’s __setstate__() .

  3.8 版新增： The optional sixth tuple item, (obj, state) , was added.

object. __reduce_ex__ ( protocol ) ¶

Alternatively, a __reduce_ex__() method may be defined. The only difference is this method should take a single integer argument, the protocol version. When defined, pickle will prefer it over the __reduce__() method. In addition, __reduce__() automatically becomes a synonym for the extended version. The main use for this method is to provide backwards-compatible reduce values for older Python releases.

# Simple example presenting how persistent ID can be used to pickle
# external objects by reference.
import pickle
import sqlite3
from collections import namedtuple
# Simple class representing a record in our database.
MemoRecord = namedtuple("MemoRecord", "key, task")
class DBPickler(pickle.Pickler):
    def persistent_id(self, obj):
        # Instead of pickling MemoRecord as a regular class instance, we emit a
        # persistent ID.
        if isinstance(obj, MemoRecord):
            # Here, our persistent ID is simply a tuple, containing a tag and a
            # key, which refers to a specific record in the database.
            return ("MemoRecord", obj.key)
        else:
            # If obj does not have a persistent ID, return None. This means obj
            # needs to be pickled as usual.
            return None
class DBUnpickler(pickle.Unpickler):
    def __init__(self, file, connection):
        super().__init__(file)
        self.connection = connection
    def persistent_load(self, pid):
        # This method is invoked whenever a persistent ID is encountered.
        # Here, pid is the tuple returned by DBPickler.
        cursor = self.connection.cursor()
        type_tag, key_id = pid
        if type_tag == "MemoRecord":
            # Fetch the referenced record from the database and return it.
            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
            key, task = cursor.fetchone()
            return MemoRecord(key, task)
        else:
            # Always raises an error if you cannot return the correct object.
            # Otherwise, the unpickler will think None is the object referenced
            # by the persistent ID.
            raise pickle.UnpicklingError("unsupported persistent object")
def main():
    import io
    import pprint
    # Initialize and populate our database.
    conn = sqlite3.connect(":memory:")
    cursor = conn.cursor()
    cursor.execute("CREATE TABLE memos(key INTEGER PRIMARY KEY, task TEXT)")
    tasks = (
        'give food to fish',
        'prepare group meeting',
        'fight with a zebra',
        )
    for task in tasks:
        cursor.execute("INSERT INTO memos VALUES(NULL, ?)", (task,))
    # Fetch the records to be pickled.
    cursor.execute("SELECT * FROM memos")
    memos = [MemoRecord(key, task) for key, task in cursor]
    # Save the records using our custom DBPickler.
    file = io.BytesIO()
    DBPickler(file).dump(memos)
    print("Pickled records:")
    pprint.pprint(memos)
    # Update a record, just for good measure.
    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")
    # Load the records from the pickle data stream.
    file.seek(0)
    memos = DBUnpickler(file, conn).load()
    print("Unpickled records:")
    pprint.pprint(memos)
if __name__ == '__main__':
    main()
									

f = io.BytesIO()
p = pickle.Pickler(f)
p.dispatch_table = copyreg.dispatch_table.copy()
p.dispatch_table[SomeClass] = reduce_SomeClass
									

class MyPickler(pickle.Pickler):
    dispatch_table = copyreg.dispatch_table.copy()
    dispatch_table[SomeClass] = reduce_SomeClass
f = io.BytesIO()
p = MyPickler(f)
									

copyreg.pickle(SomeClass, reduce_SomeClass)
f = io.BytesIO()
p = pickle.Pickler(f)
									

class TextReader:
    """Print and number lines in a text file."""
    def __init__(self, filename):
        self.filename = filename
        self.file = open(filename)
        self.lineno = 0
    def readline(self):
        self.lineno += 1
        line = self.file.readline()
        if not line:
            return None
        if line.endswith('\n'):
            line = line[:-1]
        return "%i: %s" % (self.lineno, line)
    def __getstate__(self):
        # Copy the object's state from self.__dict__ which contains
        # all our instance attributes. Always use the dict.copy()
        # method to avoid modifying the original state.
        state = self.__dict__.copy()
        # Remove the unpicklable entries.
        del state['file']
        return state
    def __setstate__(self, state):
        # Restore instance attributes (i.e., filename and lineno).
        self.__dict__.update(state)
        # Restore the previously opened file's state. To do so, we need to
        # reopen it and read from it until the line count is restored.
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # Finally, save the file.
        self.file = file
									

>>> reader = TextReader("hello.txt")
>>> reader.readline()
'1: Hello world!'
>>> reader.readline()
'2: I am line number two.'
>>> new_reader = pickle.loads(pickle.dumps(reader))
>>> new_reader.readline()
'3: Goodbye!'
									

类型、函数和其它对象的自定义缩减 ¶

Sometimes, dispatch_table may not be flexible enough. In particular we may want to customize pickling based on another criterion than the object’s type, or we may want to customize the pickling of functions and classes.

For those cases, it is possible to subclass from the Pickler class and implement a reducer_override() method. This method can return an arbitrary reduction tuple (see __reduce__() ). It can alternatively return NotImplemented to fallback to the traditional behavior.

If both the dispatch_table and reducer_override() are defined, then reducer_override() method takes priority.

Here is a simple example where we allow pickling and reconstructing a given class:

import io
import pickle
class MyClass:
    my_attribute = 1
class MyPickler(pickle.Pickler):
    def reducer_override(self, obj):
        """Custom reducer for MyClass."""
        if getattr(obj, "__name__", None) == "MyClass":
            return type, (obj.__name__, obj.__bases__,
                          {'my_attribute': obj.my_attribute})
        else:
            # For any other object, fallback to usual reduction
            return NotImplemented
f = io.BytesIO()
p = MyPickler(f)
p.dump(MyClass)
del MyClass
unpickled_class = pickle.loads(f.getvalue())
assert isinstance(unpickled_class, type)
assert unpickled_class.__name__ == "MyClass"
assert unpickled_class.my_attribute == 1
								

波段外缓冲 ¶

In some contexts, the pickle module is used to transfer massive amounts of data. Therefore, it can be important to minimize the number of memory copies, to preserve performance and resource consumption. However, normal operation of the pickle module, as it transforms a graph-like structure of objects into a sequential stream of bytes, intrinsically involves copying data to and from the pickle stream.

This constraint can be eschewed if both the provider (the implementation of the object types to be transferred) and the consumer (the implementation of the communications system) support the out-of-band transfer facilities provided by pickle protocol 5 and higher.

class ZeroCopyByteArray(bytearray):
    def __reduce_ex__(self, protocol):
        if protocol >= 5:
            return type(self)._reconstruct, (PickleBuffer(self),), None
        else:
            # PickleBuffer is forbidden with pickle protocols <= 4.
            return type(self)._reconstruct, (bytearray(self),)
    @classmethod
    def _reconstruct(cls, obj):
        with memoryview(obj) as m:
            # Get a handle over the original buffer object
            obj = m.obj
            if type(obj) is cls:
                # Original buffer object is a ZeroCopyByteArray, return it
                # as-is.
                return obj
            else:
                return cls(obj)
									

b = ZeroCopyByteArray(b"abc")
data = pickle.dumps(b, protocol=5)
new_b = pickle.loads(data)
print(b == new_b)  # True
print(b is new_b)  # False: a copy was made
									

b = ZeroCopyByteArray(b"abc")
buffers = []
data = pickle.dumps(b, protocol=5, buffer_callback=buffers.append)
new_b = pickle.loads(data, buffers=buffers)
print(b == new_b)  # True
print(b is new_b)  # True: no copy was made
									

限定全局 ¶

By default, unpickling will import any class or function that it finds in the pickle data. For many applications, this behaviour is unacceptable as it permits the unpickler to import and invoke arbitrary code. Just consider what this hand-crafted pickle data stream does when loaded:

>>> import pickle
>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
hello world
0
								

In this example, the unpickler imports the os.system() function and then apply the string argument “echo hello world”. Although this example is inoffensive, it is not difficult to imagine one that could damage your system.

For this reason, you may want to control what gets unpickled by customizing Unpickler.find_class() . Unlike its name suggests, Unpickler.find_class() is called whenever a global (i.e., a class or a function) is requested. Thus it is possible to either completely forbid globals or restrict them to a safe subset.

Here is an example of an unpickler allowing only few safe classes from the builtins module to be loaded:

import builtins
import io
import pickle
safe_builtins = {
    'range',
    'complex',
    'set',
    'frozenset',
    'slice',
}
class RestrictedUnpickler(pickle.Unpickler):
    def find_class(self, module, name):
        # Only allow safe classes from builtins.
        if module == "builtins" and name in safe_builtins:
            return getattr(builtins, name)
        # Forbid everything else.
        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                     (module, name))
def restricted_loads(s):
    """Helper function analogous to pickle.loads()."""
    return RestrictedUnpickler(io.BytesIO(s)).load()
								

A sample usage of our unpickler working has intended:

>>> restricted_loads(pickle.dumps([1, 2, range(15)]))
[1, 2, range(0, 15)]
>>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'os.system' is forbidden
>>> restricted_loads(b'cbuiltins\neval\n'
...                  b'(S\'getattr(__import__("os"), "system")'
...                  b'("echo hello world")\'\ntR.')
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'builtins.eval' is forbidden
								

As our examples shows, you have to be careful with what you allow to be unpickled. Therefore if security is a concern, you may want to consider alternatives such as the marshalling API in xmlrpc.client or third-party solutions.

性能 ¶

Recent versions of the pickle protocol (from protocol 2 and upwards) feature efficient binary encodings for several common features and built-in types. Also, the pickle module has a transparent optimizer written in C.

范例 ¶

For the simplest code, use the dump() and load() 函数。

import pickle
# An arbitrary collection of objects supported by pickle.
data = {
    'a': [1, 2.0, 3, 4+6j],
    'b': ("character string", b"byte string"),
    'c': {None, True, False}
}
with open('data.pickle', 'wb') as f:
    # Pickle the 'data' dictionary using the highest protocol available.
    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)
								

The following example reads the resulting pickled data.

import pickle
with open('data.pickle', 'rb') as f:
    # The protocol version used is detected automatically, so we do not
    # have to specify it.
    data = pickle.load(f)
								

脚注

1

Don’t confuse this with the marshal 模块

2

This is why lambda functions cannot be pickled: all lambda functions share the same name: <lambda> .

3

The exception raised will likely be an ImportError or an AttributeError but it could be something else.

4

copy module uses this protocol for shallow and deep copying operations.

5

The limitation on alphanumeric characters is due to the fact the persistent IDs, in protocol 0, are delimited by the newline character. Therefore if any kind of newline characters occurs in persistent IDs, the resulting pickle will become unreadable.