Extract ReadEngine and WriteEngine types for Excel

Author: davetapley

pandas-stubs/_typing.pyi

@@ -780,4 +780,7 @@ TimeGrouperOrigin: TypeAlias = (
     Timestamp | Literal["epoch", "start", "start_day", "end", "end_day"]
 )
 
+ExcelReadEngine: TypeAlias = Literal["xlrd", "openpyxl", "odf", "pyxlsb"]
+ExcelWriteEngine: TypeAlias = Literal["openpyxl", "odf", "xlsxwriter"]
+
 __all__ = ["npt", "type_t"]

pandas-stubs/io/excel/_base.pyi

@@ -23,6 +23,8 @@ from pandas._libs.lib import NoDefault
 from pandas._typing import (
     Dtype,
     DtypeBackend,
+    ExcelReadEngine,
+    ExcelWriteEngine,
     FilePath,
     IntStrT,
     ListLikeHashable,
@@ -50,7 +52,7 @@ def read_excel(
     index_col: int | Sequence[int] | None = ...,
     usecols: str | UsecolsArgType = ...,
     dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
-    engine: Literal["xlrd", "openpyxl", "odf", "pyxlsb"] | None = ...,
+    engine: ExcelReadEngine | None = ...,
     converters: Mapping[int | str, Callable[[object], object]] | None = ...,
     true_values: Iterable[Hashable] | None = ...,
     false_values: Iterable[Hashable] | None = ...,
@@ -92,7 +94,7 @@ def read_excel(
     index_col: int | Sequence[int] | None = ...,
     usecols: str | UsecolsArgType = ...,
     dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
-    engine: Literal["xlrd", "openpyxl", "odf", "pyxlsb"] | None = ...,
+    engine: ExcelReadEngine | None = ...,
     converters: Mapping[int | str, Callable[[object], object]] | None = ...,
     true_values: Iterable[Hashable] | None = ...,
     false_values: Iterable[Hashable] | None = ...,
@@ -135,7 +137,7 @@ def read_excel(  # type: ignore[misc]
     index_col: int | Sequence[int] | None = ...,
     usecols: str | UsecolsArgType = ...,
     dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
-    engine: Literal["xlrd", "openpyxl", "odf", "pyxlsb"] | None = ...,
+    engine: ExcelReadEngine | None = ...,
     converters: Mapping[int | str, Callable[[object], object]] | None = ...,
     true_values: Iterable[Hashable] | None = ...,
     false_values: Iterable[Hashable] | None = ...,
@@ -177,7 +179,7 @@ def read_excel(
     index_col: int | Sequence[int] | None = ...,
     usecols: str | UsecolsArgType = ...,
     dtype: str | Dtype | Mapping[str, str | Dtype] | None = ...,
-    engine: Literal["xlrd", "openpyxl", "odf", "pyxlsb"] | None = ...,
+    engine: ExcelReadEngine | None = ...,
     converters: Mapping[int | str, Callable[[object], object]] | None = ...,
     true_values: Iterable[Hashable] | None = ...,
     false_values: Iterable[Hashable] | None = ...,
@@ -206,7 +208,7 @@ class ExcelWriter:
     def __init__(
         self,
         path: FilePath | WriteExcelBuffer | ExcelWriter,
-        engine: Literal["auto", "openpyxl", "odf", "xlsxwriter"] | None = ...,
+        engine: ExcelWriteEngine | Literal["auto"] | None = ...,
         date_format: str | None = ...,
         datetime_format: str | None = ...,
         mode: Literal["w", "a"] = ...,
@@ -217,7 +219,7 @@ class ExcelWriter:
     @property
     def supported_extensions(self) -> tuple[str, ...]: ...
     @property
-    def engine(self) -> Literal["openpyxl", "odf", "xlsxwriter"]: ...
+    def engine(self) -> ExcelWriteEngine: ...
     @property
     def sheets(self) -> dict[str, Any]: ...
     @property