rewinded changes in core/session.py --> to_csv, to_excel and to_pickle will be updated in separate PRs

alixdamman · alixdamman · commit 666896c3d59e · 2018-04-06T16:25:23.000+02:00
diff --git a/doc/source/changes/version_0_29.rst.inc b/doc/source/changes/version_0_29.rst.inc
@@ -43,9 +43,6 @@ Miscellaneous improvements
     >>> s2
     Session(arr1, arr2, a, b, a01)
 
-  Note: all axes (groups) of a session are stored in the same CSV file/Excel sheet/HDF group
-  named __axes__ (__groups__).
-
 
 Fixes
 -----
diff --git a/larray/core/session.py b/larray/core/session.py
@@ -280,20 +280,6 @@ def save(self, fname, names=None, engine='auto', overwrite=True, display=False,
         display : bool, optional
             Whether or not to display which file is being worked on. Defaults to False.
 
-        Notes
-        -----
-        When session's objects are saved in CSV files:
-
-            - each array is saved in a separate file
-            - all Axis objects are saved together in the same CSV file named __axes__.csv
-            - all Group objects are saved together in the same CSV file named __groups__.csv
-
-        When saving session's objects to an Excel file:
-
-            - each array is saved in a separate sheet
-            - all Axis objects are saved together in the same sheet named __axes__
-            - all Group objects are saved together in the same sheet named __groups__
-
         Examples
         --------
         >>> # axes
@@ -325,7 +311,10 @@ def save(self, fname, names=None, engine='auto', overwrite=True, display=False,
             engine = ext_default_engine[ext]
         handler_cls = handler_classes[engine]
         handler = handler_cls(fname, overwrite)
-        items = self.items()
+        if engine != 'pandas_hdf':
+            items = self.filter(kind=LArray).items()
+        else:
+            items = self.items()
         if names is not None:
             names_set = set(names)
             items = [(k, v) for k, v in items if k in names_set]
@@ -398,18 +387,17 @@ def to_globals(self, names=None, depth=0, warn=True, inplace=False):
 
     def to_pickle(self, fname, names=None, overwrite=True, display=False, **kwargs):
         """
-        Dumps LArray, Axis and Group objects from the current session to a file using pickle.
+        Dumps all array 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 of the file for the dump.
+            Path for the dump.
         names : list of str or None, optional
-            Names of LArray/Axis/Group objects to dump.
-            Defaults to all objects present in the Session.
+            List of 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.
@@ -418,22 +406,16 @@ def to_pickle(self, fname, names=None, overwrite=True, display=False, **kwargs):
 
         Examples
         --------
-        >>> # 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
-        >>> s = Session([('a', a), ('b', b), ('a01', a01), ('arr1', arr1), ('arr2', arr2)])  # doctest: +SKIP
-
+        >>> arr1, arr2, arr3 = ndtest((2, 2)), ndtest(4), ndtest((3, 2))   # doctest: +SKIP
+        >>> s = Session([('arr1', arr1), ('arr2', arr2), ('arr3', arr3)])  # doctest: +SKIP
 
         Save all arrays
 
         >>> s.to_pickle('output.pkl')  # doctest: +SKIP
 
-        Save only some objects
+        Save only some arrays
 
-        >>> s.to_pickle('output.pkl', ['a', 'b', 'arr1'])  # doctest: +SKIP
+        >>> s.to_pickle('output.pkl', ['arr1', 'arr3'])  # doctest: +SKIP
         """
         self.save(fname, names, ext_default_engine['pkl'], overwrite, display, **kwargs)
 
@@ -480,85 +462,61 @@ def to_hdf(self, fname, names=None, overwrite=True, display=False, **kwargs):
 
     def to_excel(self, fname, names=None, overwrite=True, display=False, **kwargs):
         """
-        Dumps LArray, Axis and Group objects from the current session to an Excel file.
+        Dumps all array objects from the current session to an Excel file.
 
         Parameters
         ----------
         fname : str
-            Path of the file for the dump.
+            Path for the dump.
         names : list of str or None, optional
-            Names of LArray/Axis/Group objects to dump.
-            Defaults to all objects present in the Session.
+            List of 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.
 
-        Notes
-        -----
-        - each array is saved in a separate sheet
-        - all Axis objects are saved together in the same sheet named __axes__
-        - all Group objects are saved together in the same sheet named __groups__
-
         Examples
         --------
-        >>> # 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
-        >>> s = Session([('a', a), ('b', b), ('a01', a01), ('arr1', arr1), ('arr2', arr2)])  # doctest: +SKIP
+        >>> arr1, arr2, arr3 = ndtest((2, 2)), ndtest(4), ndtest((3, 2))   # doctest: +SKIP
+        >>> s = Session([('arr1', arr1), ('arr2', arr2), ('arr3', arr3)])  # doctest: +SKIP
 
         Save all arrays
 
         >>> s.to_excel('output.xlsx')  # doctest: +SKIP
 
-        Save only some objects
+        Save only some arrays
 
-        >>> s.to_excel('output.xlsx', ['a', 'b', 'arr1'])  # doctest: +SKIP
+        >>> s.to_excel('output.xlsx', ['arr1', 'arr3'])  # doctest: +SKIP
         """
         self.save(fname, names, ext_default_engine['xlsx'], overwrite, display, **kwargs)
 
     dump_excel = renamed_to(to_excel, 'dump_excel')
 
     def to_csv(self, fname, names=None, display=False, **kwargs):
         """
-        Dumps LArray, Axis and Group objects from the current session to CSV files.
+        Dumps all array objects from the current session to CSV files.
 
         Parameters
         ----------
         fname : str
             Path for the directory that will contain CSV files.
         names : list of str or None, optional
-            Names of LArray/Axis/Group objects to dump.
-            Defaults to all objects present in the Session.
+            List of names of objects to dump. Defaults to all objects present in the Session.
         display : bool, optional
             Whether or not to display which file is being worked on. Defaults to False.
 
-        Notes
-        -----
-        - each array is saved in a separate file
-        - all Axis objects are saved together in the same CSV file named __axes__.csv
-        - all Group objects are saved together in the same CSV file named __groups__.csv
-
         Examples
         --------
-        >>> # 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
-        >>> s = Session([('a', a), ('b', b), ('a01', a01), ('arr1', arr1), ('arr2', arr2)])  # doctest: +SKIP
+        >>> arr1, arr2, arr3 = ndtest((2, 2)), ndtest(4), ndtest((3, 2))   # doctest: +SKIP
+        >>> s = Session([('arr1', arr1), ('arr2', arr2), ('arr3', arr3)])  # doctest: +SKIP
 
         Save all arrays
 
         >>> s.to_csv('./Output')  # doctest: +SKIP
 
         Save only some arrays
 
-        >>> s.to_csv('./Output', ['a', 'b', 'arr1'])  # doctest: +SKIP
+        >>> s.to_csv('./Output', ['arr1', 'arr3'])  # doctest: +SKIP
         """
         self.save(fname, names, ext_default_engine['csv'], display=display, **kwargs)
 
