larray.Session.to_pickle

Session.to_pickle(fname, names=None, overwrite=True, display=False, **kwargs)

Dumps objects from the current session to a file using pickle.

WARNING: never load a pickle file (.pkl or .pickle) from an untrusted source, as it can lead to arbitrary code execution.

Parameters:

fname : str

Path for the dump.

names : list of str or None, optional

Names of objects to dump. Defaults to all objects present in the Session.

overwrite: bool, optional

Whether or not to overwrite an existing file, if any. If False, file is updated. Defaults to True.

display : bool, optional

Whether or not to display which file is being worked on. Defaults to False.

Examples

>>> # scalars
>>> i, s = 5, 'string'                                                      # doctest: +SKIP
>>> # axes
>>> a, b = Axis("a=a0..a2"), Axis("b=b0..b2")                               # doctest: +SKIP
>>> # groups
>>> a01 = a['a0,a1'] >> 'a01'                                               # doctest: +SKIP
>>> # arrays
>>> arr1, arr2 = ndtest((a, b)), ndtest(a)                                  # doctest: +SKIP
>>> ses = Session([('i', i), ('s', s), ('a', a), ('b', b), ('a01', a01),
...                ('arr1', arr1), ('arr2', arr2)])                         # doctest: +SKIP
>>> # metadata
>>> ses.meta.title = 'my title'                                             # doctest: +SKIP
>>> ses.meta.author = 'John Smith'                                          # doctest: +SKIP

Save all objects

>>> ses.to_pickle('output.pkl', display=True)                               # doctest: +SKIP
dumping i ... done
dumping s ... done
dumping a ... done
dumping b ... done
dumping a01 ... done
dumping arr1 ... done
dumping arr2 ... done

Save only some objects

>>> ses.to_pickle('output.pkl', names=['s', 'a', 'b', 'arr1', 'arr2'], display=True)    # doctest: +SKIP
dumping s ... done
dumping a ... done
dumping b ... done
dumping arr1 ... done
dumping arr2 ... done