PyDocs

Data Persistence

PyDocs
PyDocs
Data Persistence
All modules

pickle

Create portable serialized representations of Python objects.

See module copyreg for a mechanism for registering custom picklers.
See module pickletools source for extensive comments.

Classes:

    Pickler
    Unpickler

Functions:

    dump(object, file)
    dumps(object) -> string
    load(file) -> object
    loads(bytes) -> object

Misc variables:

    format_version
    compatible_formats

© Python Software Foundation. PSF License Version 2 · Official docs ↗

Symbols in pickle

d

DEFAULT_PROTOCOL
An integer, the default protocol version used for pickling.
dump
Write a pickled representation of obj to the open file object file.
dumps
Return the pickled representation of the object as a bytes object.

h

HIGHEST_PROTOCOL
An integer, the highest protocol version available.

l

load
Read and return an object from the pickle data stored in a file.
loads
Read and return an object from the given pickle data.

p

PickleBuffer
Wrapper for potentially out-of-band buffers
PickleError
Common base class for the other pickling exceptions.
Pickler
This takes a binary file for writing a pickle data stream.
PicklingError
Error raised when an unpicklable object is encountered by Pickler.

u

Unpickler
This takes a binary file for reading a pickle data stream.
UnpicklingError
Error raised when there is a problem unpickling an object, such as a data corruption or a security violation.