added engine argument to the read_hdf method and all to_hdf methods

Author: alixdamman

larray/core/array.py

@@ -6701,7 +6701,7 @@ def to_csv(self, filepath, sep=',', na_rep='', wide=True, value_name='value', dr
             series = self.to_series(value_name, dropna is not None)
             series.to_csv(filepath, sep=sep, na_rep=na_rep, header=True, **kwargs)
 
-    def to_hdf(self, filepath, key):
+    def to_hdf(self, filepath, key, engine='auto'):
         r"""
         Writes array to a HDF file.
 
@@ -6714,6 +6714,9 @@ def to_hdf(self, filepath, key):
             Path where the hdf file has to be written.
         key : str or Group
             Key (path) of the array within the HDF file (see Notes below).
+        engine: {'auto', 'tables', 'pandas'}, optional
+            Dump using `engine`. Use 'pandas' to update an HDF file generated with a LArray version previous to 0.31.
+            Defaults to 'auto' (use default engine if you don't know the LArray version used to produced the HDF file).
 
         Notes
         -----
@@ -6735,7 +6738,7 @@ def to_hdf(self, filepath, key):
         >>> a.to_hdf('test.h5', 'arrays/a')  # doctest: +SKIP
         """
         from larray.inout.hdf import LHDFStore
-        with LHDFStore(filepath) as store:
+        with LHDFStore(filepath, engine=engine) as store:
             store.put(key, self)
 
     def to_stata(self, filepath_or_buffer, **kwargs):

larray/core/axis.py

@@ -1304,7 +1304,7 @@ def align(self, other, join='outer'):
             else:
                 return self
 
-    def to_hdf(self, filepath, key=None):
+    def to_hdf(self, filepath, key=None, engine='auto'):
         r"""
         Writes axis to a HDF file.
 
@@ -1319,6 +1319,9 @@ def to_hdf(self, filepath, key=None):
             Key (path) of the axis within the HDF file (see Notes below).
             If None, the name of the axis is used.
             Defaults to None.
+        engine: {'auto', 'tables', 'pandas'}, optional
+            Dump using `engine`. Use 'pandas' to update an HDF file generated with a LArray version previous to 0.31.
+            Defaults to 'auto' (use default engine if you don't know the LArray version used to produced the HDF file).
 
         Notes
         -----
@@ -1349,7 +1352,7 @@ def to_hdf(self, filepath, key=None):
             if self.name is None:
                 raise ValueError("Argument key must be provided explicitly in case of anonymous axis")
             key = self.name
-        with LHDFStore(filepath) as store:
+        with LHDFStore(filepath, engine=engine) as store:
             store.put(key, self)
 
     @property

larray/core/group.py

@@ -1396,7 +1396,7 @@ def containing(self, substring):
             substring = substring.eval()
         return LGroup([v for v in self.eval() if substring in v], axis=self.axis)
 
-    def to_hdf(self, filepath, key=None, axis_key=None):
+    def to_hdf(self, filepath, key=None, axis_key=None, engine='auto'):
         r"""
         Writes group to a HDF file.
 
@@ -1417,6 +1417,9 @@ def to_hdf(self, filepath, key=None, axis_key=None):
             Key (path) of the associated axis in the HDF file (see Notes below).
             If None, the name of the axis associated with the group is used.
             Defaults to None.
+        engine: {'auto', 'tables', 'pandas'}, optional
+            Dump using `engine`. Use 'pandas' to update an HDF file generated with a LArray version previous to 0.31.
+            Defaults to 'auto' (use default engine if you don't know the LArray version used to produced the HDF file).
 
         Notes
         -----
@@ -1458,7 +1461,7 @@ def to_hdf(self, filepath, key=None, axis_key=None):
             if self.name is None:
                 raise ValueError("Argument key must be provided explicitly in case of anonymous group")
             key = self.name
-        with LHDFStore(filepath) as store:
+        with LHDFStore(filepath, engine=engine) as store:
             store.put(key, self, axis_key=axis_key)
 
     # this makes range(LGroup(int)) possible

larray/inout/hdf.py

@@ -346,7 +346,7 @@ class LHDFStore(object):
     Parameters
     ----------
     filepath : str or PathLike object
-        File path to HDF5 file
+        File path to HDF5 file.
     mode : {'a', 'w', 'r', 'r+'}, default 'a'
 
         ``'r'``
@@ -562,13 +562,13 @@ def put(self, key, value, **kwargs):
 
 
 def read_hdf(filepath_or_buffer, key, fill_value=nan, na=nan, sort_rows=False, sort_columns=False,
-             name=None, **kwargs):
+             name=None, engine='auto', **kwargs):
     r"""Reads an axis or group or array named key from a HDF5 file in filepath (path+name)
 
     Parameters
     ----------
-    filepath_or_buffer : str or LArrayHDFStore
-        Path and name where the HDF5 file is stored or a HDFStore object.
+    filepath_or_buffer : str or PathLike object
+        Path and name where the HDF5 file is stored.
     key : str or Group
         Name of the object to read.
     fill_value : scalar or LArray, optional
@@ -585,6 +585,9 @@ def read_hdf(filepath_or_buffer, key, fill_value=nan, na=nan, sort_rows=False, s
     name : str, optional
         Name of the axis or group to return. If None, name is set to passed key.
         Defaults to None.
+    engine: {'auto', 'tables', 'pandas'}, optional
+        Load using `engine`. Use 'pandas' to read an HDF file generated with a LArray version previous to 0.31.
+        Defaults to 'auto' (use default engine if you don't know the LArray version used to produced the HDF file).
 
     Returns
     -------
@@ -610,7 +613,7 @@ def read_hdf(filepath_or_buffer, key, fill_value=nan, na=nan, sort_rows=False, s
         fill_value = na
         warnings.warn("read_hdf `na` argument has been renamed to `fill_value`. Please use that instead.",
                       FutureWarning, stacklevel=2)
-    with LHDFStore(filepath_or_buffer, **kwargs) as store:
+    with LHDFStore(filepath_or_buffer, engine=engine, **kwargs) as store:
         res = store.get(key, fill_value=fill_value, sort_rows=sort_rows, sort_columns=sort_columns, name=name)
     return res