Make pandas.ExcelFile(...) in stubs consistent with the run time ve…

…rsion. (#1117) * Make `pd.ExcelFile` consistent with the run time. * Add test for the signature of `pd.ExcelFile`.
pandas-dev · Feb 13, 2025 · a5a40a7 · a5a40a7
1 parent b5d6fea
commit a5a40a7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/pandas-stubs/io/excel/_base.pyi b/pandas-stubs/io/excel/_base.pyi
@@ -245,9 +245,10 @@ class ExcelFile:
     io: FilePath | ReadBuffer[bytes] | bytes = ...
     def __init__(
         self,
-        io: FilePath | ReadBuffer[bytes] | bytes,
+        path_or_buffer: FilePath | ReadBuffer[bytes] | bytes,
         engine: ExcelReadEngine | None = ...,
         storage_options: StorageOptions = ...,
+        engine_kwargs: dict[str, Any] | None = ...,
     ) -> None: ...
     def __fspath__(self): ...
     @overload

diff --git a/tests/test_io.py b/tests/test_io.py
@@ -1116,6 +1116,14 @@ def test_excel_reader():
             check(assert_type(ef, pd.ExcelFile), pd.ExcelFile)
             check(assert_type(pd.read_excel(ef), pd.DataFrame), pd.DataFrame)
 
+        with pd.ExcelFile(
+            path_or_buffer=path,
+            engine="openpyxl",
+            engine_kwargs={"data_only": True},
+        ) as ef:
+            check(assert_type(ef, pd.ExcelFile), pd.ExcelFile)
+            check(assert_type(pd.read_excel(ef), pd.DataFrame), pd.DataFrame)
+
 
 def test_excel_writer():
     with ensure_clean(".xlsx") as path: