Changed new keyword parameter 'kind' to 'include'

Author: roberthdevries

doc/source/whatsnew/v1.1.0.rst

@@ -340,7 +340,7 @@ I/O
 - Bug in :class:`HDFStore` that caused it to set to ``int64`` the dtype of a ``datetime64`` column when reading a DataFrame in Python 3 from fixed format written in Python 2 (:issue:`31750`)
 - Bug in :meth:`read_excel` where a UTF-8 string with a high surrogate would cause a segmentation violation (:issue:`23809`)
 - Bug in :meth:`read_csv` was causing a file descriptor leak on an empty file (:issue:`31488`)
-- :meth:`HDFStore.keys` has now an optional `kind` parameter that allows the retrieval of all native HDF5 table names (:issue:`29916`)
+- :meth:`HDFStore.keys` has now an optional `include` parameter that allows the retrieval of all native HDF5 table names (:issue:`29916`)
 
 
 Plotting

pandas/io/pytables.py

@@ -580,15 +580,15 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, traceback):
         self.close()
 
-    def keys(self, kind: Optional[str] = "pandas") -> List[str]:
+    def keys(self, include: Optional[str] = "pandas") -> List[str]:
         """
         Return a list of keys corresponding to objects stored in HDFStore.
 
         Parameters
         ----------
-        kind : str, default 'pandas'
+        include : str, default 'pandas'
                 When kind equals 'pandas' return pandas objects
-                When kind equals 'table' return Table objects
+                When kind equals 'native' return native HDF5 Table objects
                 Otherwise fail with a ValueError
 
         Returns
@@ -600,15 +600,17 @@ def keys(self, kind: Optional[str] = "pandas") -> List[str]:
         ------
         raises ValueError if kind has an illegal value
         """
-        if kind == "pandas":
+        if include == "pandas":
             return [n._v_pathname for n in self.groups()]
 
-        if kind == "tables":
-            self._check_if_open()
+        if include == "native":
+            assert self._handle is not None  # mypy
             return [
                 n._v_pathname for n in self._handle.walk_nodes("/", classname="Table")
             ]
-        raise ValueError(f"`kind` should be either 'pandas' or 'table' but is [{kind}]")
+        raise ValueError(
+            f"`include` should be either 'pandas' or 'native' but is [{include}]"
+        )
 
     def __iter__(self):
         return iter(self.keys())

pandas/tests/io/pytables/test_store.py

@@ -313,10 +313,10 @@ class Table3(tables.IsDescription):
                 h5file.create_table(group, "table2", Table2, "Table 2")
                 h5file.create_table(group, "table3", Table3, "Table 3")
             with HDFStore(path) as store:
-                assert len(store.keys(kind="tables")) == 3
+                assert len(store.keys(include="native")) == 3
                 expected = {"/group/table1", "/group/table2", "/group/table3"}
-                assert set(store.keys(kind="tables")) == expected
-                assert set(store.keys(kind="pandas")) == set()
+                assert set(store.keys(include="native")) == expected
+                assert set(store.keys(include="pandas")) == set()
 
     def test_keys_ignore_hdf_softlink(self, setup_path):