PickleJar

PickleJar is a python module that allows you to work with multiple pickles inside a single file (I call it a “jar”)!

class picklejar.Jar(filepath: str)

A file containing multiple pickle objects

Parameters:

filepath (str, required) – Path to the file

Returns:

None

Return type:

None

dump(items: Any, new_jar: bool = False, collapse: bool = False) → bool

Write a Pickle to the file/jar.

Parameters:

• items (Any) – Item or list of items to pickle

• new_jar (bool, optional) – Start a new jar (Default: False)

• collapse – If items is a list write list as single pickle

Returns:

True on file write

Return type:

bool

exists() → bool

Does the Jar exist

Returns:

True or False

Return type:

bool

load(always_list: bool = False) → Any

Loads all the pickles out of the file/jar

Parameters:

always_list (bool, optional) – Ensure that Jars with single pickle return as a list (Default: False)

Returns:

List of de-pickled objects or de-pickled object if always_list is False and pickled object is not list

Return type:

Any

Raises:

IOError

remove() → bool

Remove the current jar file if it exists

Returns:

True

Return type:

bool

Compatibility

As of version 3.0.0, Picklejar is compatible with the latest versions of Python3, and PyPy! If you are looking to use picklejar with Python2.7 or 3.0 to 3.6, please use version picklejar version 2.1.2!