Skip to content

GH1139 Series.rename inplace #1140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 7, 2025
Merged

GH1139 Series.rename inplace #1140

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
64575f6
GH1139 Series.rename inplace
loicdiridollou Mar 2, 2025
36de55b
Fix linter
loicdiridollou Mar 2, 2025
d65a325
Merge branch 'main' of github.com:loicdiridollou/pandas-stubs into gh…
loicdiridollou Mar 2, 2025
1b6e4c7
GH1139 PR Feedback
loicdiridollou Mar 4, 2025
17a1049
GH1139 PR Feedback
loicdiridollou Mar 4, 2025
470ccf4
GH1139 PR Feedback
loicdiridollou Mar 4, 2025
5f18c66
GH1139 PR Feedback
loicdiridollou Mar 5, 2025
a043807
GH1139 PR Feedback
loicdiridollou Mar 5, 2025
2925083
GH1139 PR Feedback
loicdiridollou Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1043,7 +1043,18 @@ class Series(IndexOpsMixin[S1], NDFrame):
@overload
def rename(
self,
index: Renamer | Hashable | None = ...,
index: Hashable | None,
*,
axis: Axis | None = ...,
copy: bool = ...,
inplace: Literal[True],
level: Level | None = ...,
errors: IgnoreRaise = ...,
) -> Self: ...
@overload
def rename(
self,
index: Renamer = ...,
*,
axis: Axis | None = ...,
copy: bool = ...,
Expand Down
53 changes: 44 additions & 9 deletions tests/test_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
TimedeltaSeries: TypeAlias = pd.Series
TimestampSeries: TypeAlias = pd.Series
OffsetSeries: TypeAlias = pd.Series
ExtensionArray: TypeAlias = np.ndarray

if TYPE_CHECKING:
from pandas._typing import (
Expand Down Expand Up @@ -1137,7 +1138,7 @@ def test_types_set_flags() -> None:

def test_types_getitem() -> None:
s = pd.Series({"key": [0, 1, 2, 3]})
key: list[int] = s["key"]
check(assert_type(s["key"], Any), list)
s2 = pd.Series([0, 1, 2, 3])
check(assert_type(s2[0], int), np.integer)
check(assert_type(s[:2], pd.Series), pd.Series)
Expand Down Expand Up @@ -1180,12 +1181,28 @@ def test_types_rename_axis() -> None:


def test_types_values() -> None:
n1: np.ndarray | ExtensionArray = pd.Series([1, 2, 3]).values
n2: np.ndarray | ExtensionArray = pd.Series(list("aabc")).values
n3: np.ndarray | ExtensionArray = pd.Series(list("aabc")).astype("category").values
n4: np.ndarray | ExtensionArray = pd.Series(
pd.date_range("20130101", periods=3, tz="US/Eastern")
).values
check(
assert_type(pd.Series([1, 2, 3]).values, "np.ndarray | ExtensionArray"),
np.ndarray,
)
check(
assert_type(pd.Series(list("aabc")).values, " np.ndarray | ExtensionArray "),
np.ndarray,
)
check(
assert_type(
pd.Series(list("aabc")).astype("category").values,
"np.ndarray | ExtensionArray",
),
pd.Categorical,
)
check(
assert_type(
pd.Series(pd.date_range("20130101", periods=3, tz="US/Eastern")).values,
"np.ndarray | ExtensionArray",
),
np.ndarray,
)


def test_types_rename() -> None:
Expand All @@ -1211,8 +1228,26 @@ def add1(x: int) -> int:
s5 = pd.Series([1, 2, 3]).rename({1: 10})
check(assert_type(s5, "pd.Series[int]"), pd.Series, np.integer)
# inplace
# TODO fix issue with inplace=True returning a Series, cf pandas #60942
s6: None = pd.Series([1, 2, 3]).rename("A", inplace=True)
check(
assert_type(pd.Series([1, 2, 3]).rename("A", inplace=True), "pd.Series[int]"),
pd.Series,
np.integer,
)
check(
assert_type(pd.Series([1, 2, 3]).rename({1: 4, 2: 5}, inplace=True), None),
type(None),
)
check(
assert_type(
pd.Series([1, 2, 3]).rename(index=None, inplace=True), "pd.Series[int]"
),
pd.Series,
np.integer,
)
# TODO this should not raise an error, the lambda is matched with Hashable
# check(
# assert_type(pd.Series([1, 2, 3]).rename(lambda x: x**2, inplace=True), None), type(None)
# )
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the solution here is to not use Renamer, and have the first overload be for Callable[[Any], Label] with Literal[True] returning None, then have the second overload be for Hashable | None returning Self and the third overload just having Mapping[Any, Label] as the argument.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I do so mypy seems to match the return of the expression with Any instead of None, let me see how I can address

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have pushed for you to take a look but not sure how to address, this is a mypy issue and not pyright, pyright is happy with the current setup and does not flag it.


if TYPE_CHECKING_INVALID_USAGE:
s7 = pd.Series([1, 2, 3]).rename({1: [3, 4, 5]}) # type: ignore[arg-type] # pyright: ignore[reportArgumentType]
Expand Down