dump_pickle

dump_pickle(key: str, *subkeys: str, name: str, obj: Any, mode: Literal['wb'] = 'wb', open_kwargs: Mapping[str, Any] | None = None, pickle_dump_kwargs: Mapping[str, Any] | None = None) None[source]

Dump an object to a file with pickle.

Parameters:
  • key – The module name

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

  • name – The name of the file to open

  • obj – The object to dump

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

  • open_kwargs – Additional keyword arguments passed to open()

  • pickle_dump_kwargs – Keyword arguments to pass through to pickle.dump().