dump_pickle

dump_pickle(key, *subkeys, name, obj, mode='wb', open_kwargs=None, pickle_dump_kwargs=None)[source]

Dump an object to a file with pickle.

Parameters:
  • key (str) – The module name

  • subkeys (str) – A sequence of additional strings to join. If none are given, returns the directory for this module.

  • name (str) – The name of the file to open

  • obj (Any) – The object to dump

  • mode (str) – The read mode, passed to open()

  • open_kwargs (Optional[Mapping[str, Any]]) – Additional keyword arguments passed to open()

  • pickle_dump_kwargs (Optional[Mapping[str, Any]]) – Keyword arguments to pass through to pickle.dump().

Return type:

None