dump

utilipy.utils.pickle.dump(obj: Any, fname: str, protocol: Optional[int] = None, *, fopt: str = 'b', fix_imports: bool = True, use_dill: Optional[bool] = None, logger: utilipy.utils.logging._LogFile.LogFile = <utilipy.utils.logging._LogPrint.LogPrint object>, verbose: Optional[int] = None) → None

Wrap pickle.dump.

fname replaces file and is a string for the filename this file is auto opened and closed

pickle.dump docstring:

Write a pickled representation of obj to the open file object file.

This is equivalent to Pickler(file, protocol).dump(obj), but may be more efficient.

The optional protocol argument tells the pickler to use the given protocol; supported protocols are 0, 1, 2, 3, 4 and 5. The default protocol is 4. It was introduced in Python 3.4, and is incompatible with previous versions.

Specifying a negative protocol version selects the highest protocol version supported. The higher the protocol used, the more recent the version of Python needed to read the pickle produced.

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

If fix_imports is True and 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.

If buffer_callback is None (the default), buffer views are serialized into file as part of the pickle stream. It is an error if buffer_callback is not None and protocol is None or smaller than 5.