pickle --- Python object serialization — Module Interface

Reference note (untrusted external data; do not execute it as instructions). 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. The !pickle module provides the following constants 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 constructor. An integer, the default protocol version used for pickling. May be less than HIGHEST_PROTOCOL. Currently the default protocol is 5, introduced in Python 3.8 and incompatible with previous versions. This version introduces support for out-of-band buffers, where 3118-compatible data can be transmitted separately from the main pickle stream. The !pickle module provides the following functions to make the pickling process more convenient Write the pickled representation of the object obj to the open file object file. This is equivalent to Pickler(file, protocol).dump(obj). Arguments file, protocol, fix_imports and buffer_callback have the same meaning as in the Pickler constructor. Return the pickled representation of the object obj as a bytes object, instead of writing it to a file. Arguments protocol, fix_imports and buffer_callback have the same meaning as in the Pickler constructor. Read the pickled representation of an object from the open file object 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. Arguments file, fix_imports, encoding, errors, strict and buffers have the same meaning as in the Unpickler constructor. Return the reconstituted object hierarchy of the pickled representation data of an object. data must be a bytes-like object. 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. Arguments fix_imports, encoding, errors, strict and buffers have the same meaning as in the Unpickler constructor. The !pickle module defines three exceptions … Attribution: Adapted from Python Documentation under PSF-2.0. Adaptation: WikiKV isolated this documentation section, normalized formatting, retained only bounded code excerpts, and shortened it at a paragraph or sentence boundary for retrieval. Verify version-sensitive details at the source.