Skip to content

fix overload defaults for as_index in groupby #1321

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix overload defaults for as_index in groupby #1321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 25 additions & 17 deletions pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1145,7 +1145,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
errors: IgnoreRaise = "ignore",
) -> None: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: Scalar,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1162,14 +1162,15 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
by: Scalar,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[Scalar, Literal[False]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: DatetimeIndex,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1181,19 +1182,20 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
dropna: _bool = ...,
) -> DataFrameGroupBy[Timestamp, Literal[True]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: DatetimeIndex,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[Timestamp, Literal[False]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: TimedeltaIndex,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1210,14 +1212,15 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
by: TimedeltaIndex,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[Timedelta, Literal[False]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: PeriodIndex,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1234,14 +1237,15 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
by: PeriodIndex,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[Period, Literal[False]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: IntervalIndex[IntervalT],
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1258,14 +1262,15 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
by: IntervalIndex[IntervalT],
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[IntervalT, Literal[False]]: ...
@overload
def groupby( # type: ignore[overload-overlap] # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: MultiIndex | GroupByObjectNonScalar | None = ...,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1277,19 +1282,20 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
dropna: _bool = ...,
) -> DataFrameGroupBy[tuple, Literal[True]]: ...
@overload
def groupby( # type: ignore[overload-overlap]
def groupby(
self,
by: MultiIndex | GroupByObjectNonScalar | None = ...,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[tuple, Literal[False]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
def groupby(
self,
by: Series[SeriesByT],
axis: AxisIndex | _NoDefaultDoNotUse = ...,
Expand All @@ -1306,7 +1312,8 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
by: Series[SeriesByT],
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
Expand All @@ -1330,7 +1337,8 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
by: CategoricalIndex | Index | Series,
axis: AxisIndex | _NoDefaultDoNotUse = ...,
level: IndexLabel | None = ...,
as_index: Literal[False] = ...,
*,
as_index: Literal[False],
sort: _bool = ...,
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
Expand Down
8 changes: 4 additions & 4 deletions tests/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,8 +689,8 @@ def test_types_mean() -> None:
pd.Series,
)
if TYPE_CHECKING_INVALID_USAGE:
df3: pd.DataFrame = df.groupby(axis=1, level=0).mean() # type: ignore[call-overload] # pyright: ignore[reportArgumentType, reportCallIssue]
df4: pd.DataFrame = df.groupby(axis=1, level=0, dropna=True).mean() # type: ignore[call-overload] # pyright: ignore[reportArgumentType, reportCallIssue]
df3: pd.DataFrame = df.groupby(axis=1, level=0).mean() # type: ignore[call-overload] # pyright: ignore[reportArgumentType]
df4: pd.DataFrame = df.groupby(axis=1, level=0, dropna=True).mean() # type: ignore[call-overload] # pyright: ignore[reportArgumentType]


def test_types_median() -> None:
Expand All @@ -703,8 +703,8 @@ def test_types_median() -> None:
pd.Series,
)
if TYPE_CHECKING_INVALID_USAGE:
df3: pd.DataFrame = df.groupby(axis=1, level=0).median() # type: ignore[call-overload] # pyright: ignore[reportArgumentType, reportCallIssue]
df4: pd.DataFrame = df.groupby(axis=1, level=0, dropna=True).median() # type: ignore[call-overload] # pyright: ignore[reportArgumentType, reportCallIssue]
df3: pd.DataFrame = df.groupby(axis=1, level=0).median() # type: ignore[call-overload] # pyright: ignore[reportArgumentType]
df4: pd.DataFrame = df.groupby(axis=1, level=0, dropna=True).median() # type: ignore[call-overload] # pyright: ignore[reportArgumentType]


def test_types_iterrows() -> None:
Expand Down
Loading