From af68e19148bc07846c7de4ec85ad491423b2b32a Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Thu, 20 Feb 2025 19:40:28 -0500 Subject: [PATCH 1/4] Update docs and overload for Series.rename --- pandas/core/series.py | 43 ++++--------------------------------------- 1 file changed, 4 insertions(+), 39 deletions(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 351622135b31f..27a5ec8c5486b 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -4641,42 +4641,6 @@ def _needs_reindex_multi(self, axes, method, level) -> bool: """ return False - @overload - def rename( - self, - index: Renamer | Hashable | None = ..., - *, - axis: Axis | None = ..., - copy: bool | lib.NoDefault = ..., - inplace: Literal[True], - level: Level | None = ..., - errors: IgnoreRaise = ..., - ) -> None: ... - - @overload - def rename( - self, - index: Renamer | Hashable | None = ..., - *, - axis: Axis | None = ..., - copy: bool | lib.NoDefault = ..., - inplace: Literal[False] = ..., - level: Level | None = ..., - errors: IgnoreRaise = ..., - ) -> Series: ... - - @overload - def rename( - self, - index: Renamer | Hashable | None = ..., - *, - axis: Axis | None = ..., - copy: bool | lib.NoDefault = ..., - inplace: bool = ..., - level: Level | None = ..., - errors: IgnoreRaise = ..., - ) -> Series | None: ... - def rename( self, index: Renamer | Hashable | None = None, @@ -4686,7 +4650,7 @@ def rename( inplace: bool = False, level: Level | None = None, errors: IgnoreRaise = "ignore", - ) -> Series | None: + ) -> Series: """ Alter Series index labels or name. @@ -4734,8 +4698,9 @@ def rename( Returns ------- - Series or None - Series with index labels or name altered or None if ``inplace=True``. + Series + Series with index labels or name altered as a copy or the same object + if ``inplace=True``. See Also -------- From 1b79a2114e788f9e0e070dbf3a54cd9989b4ca68 Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Thu, 20 Feb 2025 20:11:22 -0500 Subject: [PATCH 2/4] GH60942 Revert removal of overloads --- pandas/core/series.py | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 27a5ec8c5486b..9d490acc22bea 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -4641,6 +4641,31 @@ def _needs_reindex_multi(self, axes, method, level) -> bool: """ return False + @overload + def rename( + self, + index: Renamer | Hashable | None = ..., + *, + axis: Axis | None = ..., + copy: bool | lib.NoDefault = ..., + inplace: Literal[True], + level: Level | None = ..., + errors: IgnoreRaise = ..., + ) -> Series | None: ... + + @overload + def rename( + self, + index: Renamer | Hashable | None = ..., + *, + axis: Axis | None = ..., + copy: bool | lib.NoDefault = ..., + inplace: Literal[False] = ..., + level: Level | None = ..., + errors: IgnoreRaise = ..., + ) -> Series: ... + + def rename( self, index: Renamer | Hashable | None = None, @@ -4650,7 +4675,7 @@ def rename( inplace: bool = False, level: Level | None = None, errors: IgnoreRaise = "ignore", - ) -> Series: + ) -> Series | None: """ Alter Series index labels or name. @@ -4699,8 +4724,8 @@ def rename( Returns ------- Series - Series with index labels or name altered as a copy or the same object - if ``inplace=True``. + Series with index labels or name altered as a copy, the same object + if ``inplace=True`` and index is not a dict or callage else None. See Also -------- From 42baf152a7f0b4ddb00c92ea2d51d5a99005cd7b Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Thu, 20 Feb 2025 20:22:43 -0500 Subject: [PATCH 3/4] GH60942 Run pre-commit --- pandas/core/series.py | 1 - 1 file changed, 1 deletion(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 9d490acc22bea..3cf014f338997 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -4665,7 +4665,6 @@ def rename( errors: IgnoreRaise = ..., ) -> Series: ... - def rename( self, index: Renamer | Hashable | None = None, From e89133e1a942ce4a10cef974d78b9c87764496b3 Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Fri, 21 Feb 2025 18:06:07 -0500 Subject: [PATCH 4/4] Update pandas/core/series.py Co-authored-by: Matthew Roeschke <10647082+mroeschke@users.noreply.github.com> --- pandas/core/series.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 3cf014f338997..da46f8ede3409 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -4723,8 +4723,8 @@ def rename( Returns ------- Series - Series with index labels or name altered as a copy, the same object - if ``inplace=True`` and index is not a dict or callage else None. + A shallow copy with index labels or name altered, or the same object + if ``inplace=True`` and index is not a dict or callable else None. See Also --------