Add overload for rename_axis

caneff · Oct 5, 2023 · 697b4e8 · 697b4e8
1 parent a5c7946
commit 697b4e8
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/pandas/core/series.py b/pandas/core/series.py
@@ -5004,6 +5004,42 @@ def reindex(  # type: ignore[override]
             tolerance=tolerance,
         )
 
+    @overload
+    def rename_axis(  # type: ignore[override]
+        self,
+        mapper: IndexLabel | lib.NoDefault = ...,
+        *,
+        index = ...,
+        axis: Axis = ...,
+        copy: bool = ...,
+        inplace: bool = Literal[True],
+    ) -> None:
+        ...
+
+    @overload
+    def rename_axis(  # type: ignore[override]
+        self,
+        mapper: IndexLabel | lib.NoDefault = ...,
+        *,
+        index = ...,
+        axis: Axis = ...,
+        copy: bool = ...,
+        inplace: bool = Literal[False],
+    ) -> Self:
+        ...
+
+    @overload
+    def rename_axis(  # type: ignore[override]
+        self,
+        mapper: IndexLabel | lib.NoDefault = ...,
+        *,
+        index = ...,
+        axis: Axis = ...,
+        copy: bool = ...,
+        inplace: bool = ...,
+    ) -> Self | None:
+        ...
+
     @doc(NDFrame.rename_axis)
     def rename_axis(  # type: ignore[override]
         self,