Fixing implementation logic and unit tests

pandas-dev · mroeschke · Apr 12, 2023 · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023
commit c05f1824eda0db0738ca8b86f28f5acd5a6405b3
@@ -289,7 +289,7 @@
 
     .. versionadded:: 2.0
 
-engine_kwargs : dict
+engine_kwargs : dict, default None
     Arbitrary keyword arguments passed to excel engine.
 
 Returns
@@ -491,9 +491,9 @@ def read_excel(
         should_close = True
         io = ExcelFile(
             io,
-            engine_kwargs,
             storage_options=storage_options,
             engine=engine,
+            engine_kwargs=engine_kwargs,
         )
     elif engine and engine != io.engine:
         raise ValueError(
@@ -538,9 +538,12 @@ class BaseExcelReader(metaclass=abc.ABCMeta):
     def __init__(
         self,
         filepath_or_buffer,
-        engine_kwargs,
         storage_options: StorageOptions = None,
+        engine_kwargs: None = None,
     ) -> None:
+        if engine_kwargs is None:
+            engine_kwargs = {}
+
         # First argument can also be bytes, so create a buffer
         if isinstance(filepath_or_buffer, bytes):
             filepath_or_buffer = BytesIO(filepath_or_buffer)
@@ -1435,8 +1438,6 @@ class ExcelFile:
         A file-like object, xlrd workbook or openpyxl workbook.
         If a string or path object, expected to be a path to a
         .xls, .xlsx, .xlsb, .xlsm, .odf, .ods, or .odt file.
-    engine_kwargs: dict
-        Arbitrary keyword arguments passed to excel engine.
     engine : str, default None
         If io is not a buffer or path, this must be set to identify io.
         Supported engines: ``xlrd``, ``openpyxl``, ``odf``, ``pyxlsb``
@@ -1471,6 +1472,8 @@ class ExcelFile:
 
             Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.
             This is not supported, switch to using ``openpyxl`` instead.
+    engine_kwargs: dict, default None
+        Arbitrary keyword arguments passed to excel engine.
     """
 
     from pandas.io.excel._odfreader import ODFReader
@@ -1488,10 +1491,13 @@ class ExcelFile:
     def __init__(
         self,
         path_or_buffer,
-        engine_kwargs,
         engine: str | None = None,
         storage_options: StorageOptions = None,
+        engine_kwargs: None = None,
     ) -> None:
+        if engine_kwargs is None:
+            engine_kwargs = {}
+
         if engine is not None and engine not in self._engines:
             raise ValueError(f"Unknown engine: {engine}")
 
@@ -1537,8 +1543,8 @@ def __init__(
 
         self._reader = self._engines[engine](
             self._io,
-            engine_kwargs,
             storage_options=storage_options,
+            engine_kwargs=engine_kwargs,
         )
 
     def __fspath__(self):

@@ -30,8 +30,8 @@ class ODFReader(BaseExcelReader):
     def __init__(
         self,
         filepath_or_buffer: FilePath | ReadBuffer[bytes],
-        engine_kwargs,
         storage_options: StorageOptions = None,
+        engine_kwargs: None = None,
     ) -> None:
         """
         Read tables out of OpenDocument formatted files.
@@ -40,15 +40,15 @@ def __init__(
         ----------
         filepath_or_buffer : str, path to be parsed or
             an open readable stream.
-        engine_kwargs : dict
-            Arbitrary keyword arguments passed to excel engine.
         {storage_options}
+        engine_kwargs : dict, default None
+            Arbitrary keyword arguments passed to excel engine.
         """
         import_optional_dependency("odf")
         super().__init__(
             filepath_or_buffer,
-            engine_kwargs,
             storage_options=storage_options,
+            engine_kwargs=engine_kwargs,
         )
 
     @property

@@ -535,8 +535,8 @@ class OpenpyxlReader(BaseExcelReader):
     def __init__(
         self,
         filepath_or_buffer: FilePath | ReadBuffer[bytes],
-        engine_kwargs,
         storage_options: StorageOptions = None,
+        engine_kwargs: None = None,
     ) -> None:
         """
         Reader using openpyxl engine.
@@ -545,15 +545,15 @@ def __init__(
         ----------
         filepath_or_buffer : str, path object or Workbook
             Object to be parsed.
-        engine_kwargs : dict
-            Arbitrary keyword arguments passed to excel engine.
         {storage_options}
+        engine_kwargs : dict, default None
+            Arbitrary keyword arguments passed to excel engine.
         """
         import_optional_dependency("openpyxl")
         super().__init__(
             filepath_or_buffer,
-            engine_kwargs,
             storage_options=storage_options,
+            engine_kwargs=engine_kwargs,
         )
 
     @property

@@ -24,8 +24,8 @@ class PyxlsbReader(BaseExcelReader):
     def __init__(
         self,
         filepath_or_buffer: FilePath | ReadBuffer[bytes],
-        engine_kwargs,
         storage_options: StorageOptions = None,
+        engine_kwargs: None = None,
     ) -> None:
         """
         Reader using pyxlsb engine.
@@ -34,17 +34,17 @@ def __init__(
         ----------
         filepath_or_buffer : str, path object, or Workbook
             Object to be parsed.
-        engine_kwargs : dict
-            Arbitrary keyword arguments passed to excel engine.
         {storage_options}
+        engine_kwargs : dict, default None
+            Arbitrary keyword arguments passed to excel engine.
         """
         import_optional_dependency("pyxlsb")
         # This will call load_workbook on the filepath or buffer
         # And set the result to the book-attribute
         super().__init__(
             filepath_or_buffer,
-            engine_kwargs,
             storage_options=storage_options,
+            engine_kwargs=engine_kwargs,
         )
 
     @property

@@ -24,8 +24,8 @@ class XlrdReader(BaseExcelReader):
     def __init__(
         self,
         filepath_or_buffer,
-        engine_kwargs,
         storage_options: StorageOptions = None,
+        engine_kwargs: None = None,
     ) -> None:
         """
         Reader using xlrd engine.
@@ -34,16 +34,16 @@ def __init__(
         ----------
         filepath_or_buffer : str, path object or Workbook
             Object to be parsed.
-        engine_kwargs : dict
-            Arbitrary keyword arguments passed to excel engine.
         {storage_options}
+        engine_kwargs : dict, default None
+            Arbitrary keyword arguments passed to excel engine.
         """
         err_msg = "Install xlrd >= 2.0.1 for xls Excel support"
         import_optional_dependency("xlrd", extra=err_msg)
         super().__init__(
             filepath_or_buffer,
-            engine_kwargs,
             storage_options=storage_options,
+            engine_kwargs=engine_kwargs,
         )
 
     @property