Skip to content

TYP: tuple #1528

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
loicdiridollou merged 2 commits into from
Dec 5, 2025
Merged

TYP: tuple #1528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a28b37
tuple + space
cmp0xff Dec 4, 2025
a9c601c
other cases
cmp0xff Dec 4, 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
2 changes: 1 addition & 1 deletion pandas-stubs/_typing.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1080,7 +1080,7 @@ if TYPE_CHECKING: # noqa: PYI002
| Interval[int | float | Timestamp | Timedelta],
)
GroupByObjectNonScalar: TypeAlias = (
tuple
tuple[_HashableTa, ...]
| list[_HashableTa]
| Function
| list[Function]
Expand Down
8 changes: 4 additions & 4 deletions pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1401,7 +1401,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[tuple, Literal[True]]: ...
) -> DataFrameGroupBy[tuple[Hashable, ...], Literal[True]]: ...
@overload
def groupby( # type: ignore[overload-overlap]
self,
Expand All @@ -1412,7 +1412,7 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> DataFrameGroupBy[tuple, Literal[False]]: ...
) -> DataFrameGroupBy[tuple[Hashable, ...], Literal[False]]: ...
@overload
def groupby( # pyright: ignore reportOverlappingOverload
self,
Expand Down Expand Up @@ -1505,8 +1505,8 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
) -> Self | Series: ...
def melt(
self,
id_vars: tuple | Sequence | np_ndarray | None = ...,
value_vars: tuple | Sequence | np_ndarray | None = ...,
id_vars: Sequence[Hashable] | np_ndarray | None = ...,
value_vars: Sequence[Hashable] | np_ndarray | None = ...,
var_name: Scalar | None = None,
value_name: Scalar = "value",
col_level: int | _str | None = ...,
Expand Down
10 changes: 4 additions & 6 deletions pandas-stubs/core/groupby/indexing.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,14 @@ _GroupByT = TypeVar("_GroupByT", bound=groupby.GroupBy[Any])

class GroupByIndexingMixin: ...

class GroupByPositionalSelector:
groupby_object: groupby.GroupBy
def __getitem__(self, arg: PositionalIndexer | tuple) -> DataFrame | Series: ...

class GroupByNthSelector(Generic[_GroupByT]):
groupby_object: _GroupByT

def __call__(
self,
n: PositionalIndexer | tuple,
n: PositionalIndexer | tuple[int, ...],
dropna: Literal["any", "all"] | None = ...,
) -> DataFrame | Series: ...
def __getitem__(self, n: PositionalIndexer | tuple) -> DataFrame | Series: ...
def __getitem__(
self, n: PositionalIndexer | tuple[int, ...]
) -> DataFrame | Series: ...
2 changes: 1 addition & 1 deletion pandas-stubs/core/indexes/multi.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ class MultiIndex(Index):
@overload
def __getitem__( # pyright: ignore[reportIncompatibleMethodOverride] # ty: ignore[invalid-method-override]
self, key: int
) -> tuple: ...
) -> tuple[Hashable, ...]: ...
def append(self, other): ...
def repeat(self, repeats, axis=...): ...
def drop(self, codes, level: Level | None = None, errors: str = "raise") -> Self: ... # type: ignore[override] # pyright: ignore[reportIncompatibleMethodOverride]
Expand Down
8 changes: 4 additions & 4 deletions pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -845,7 +845,7 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
group_keys: _bool = ...,
observed: _bool | _NoDefaultDoNotUse = ...,
dropna: _bool = ...,
) -> SeriesGroupBy[S1, tuple]: ...
) -> SeriesGroupBy[S1, tuple[Hashable, ...]]: ...
@overload
def groupby(
self,
Expand Down Expand Up @@ -1171,23 +1171,23 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
..., Scalar | Sequence | set | Mapping | NAType | frozenset | None
],
convertDType: _bool = ...,
args: tuple = ...,
args: tuple[Any, ...] = ...,
**kwargs: Any,
) -> Series: ...
@overload
def apply(
self,
func: Callable[..., BaseOffset],
convertDType: _bool = ...,
args: tuple = ...,
args: tuple[Any, ...] = ...,
**kwargs: Any,
) -> Series[BaseOffset]: ...
@overload
def apply(
self,
func: Callable[..., Series],
convertDType: _bool = ...,
args: tuple = ...,
args: tuple[Any, ...] = ...,
**kwargs: Any,
) -> DataFrame: ...
@final
Expand Down
3 changes: 2 additions & 1 deletion pandas-stubs/core/tools/datetimes.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ from datetime import (
datetime,
)
from typing import (
Any,
Literal,
TypeAlias,
TypedDict,
Expand Down Expand Up @@ -31,7 +32,7 @@ from pandas._typing import (
np_ndarray_str,
)

ArrayConvertible: TypeAlias = list | tuple | AnyArrayLike
ArrayConvertible: TypeAlias = list[Any] | tuple[Any, ...] | AnyArrayLike
Scalar: TypeAlias = float | str
DatetimeScalar: TypeAlias = Scalar | datetime | np.datetime64 | date

Expand Down
10 changes: 8 additions & 2 deletions pandas-stubs/io/parquet.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
from typing import Any
from collections.abc import Sequence
from typing import (
Any,
TypeAlias,
)

from pandas import DataFrame

Expand All @@ -10,13 +14,15 @@ from pandas._typing import (
StorageOptions,
)

_Filter: TypeAlias = tuple[str, str, Any]

def read_parquet(
path: FilePath | ReadBuffer[bytes],
engine: ParquetEngine = "auto",
columns: list[str] | None = None,
storage_options: StorageOptions = None,
dtype_backend: DtypeBackend = "numpy_nullable",
filesystem: Any = None,
filters: list[tuple] | list[list[tuple]] | None = None,
filters: Sequence[_Filter] | Sequence[Sequence[_Filter]] | None = None,
**kwargs: Any,
) -> DataFrame: ...
12 changes: 3 additions & 9 deletions tests/indexes/test_indexes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -964,10 +964,7 @@ def test_getitem() -> None:

iints = pd.interval_range(dt.datetime(2000, 1, 1), dt.datetime(2010, 1, 1), 5)
check(
assert_type(
iints,
"pd.IntervalIndex[pd.Interval[pd.Timestamp]]",
),
assert_type(iints, "pd.IntervalIndex[pd.Interval[pd.Timestamp]]"),
pd.IntervalIndex,
pd.Interval,
)
Expand All @@ -980,10 +977,7 @@ def test_getitem() -> None:

iintd = pd.interval_range(pd.Timedelta("1D"), pd.Timedelta("10D"))
check(
assert_type(
iintd,
"pd.IntervalIndex[pd.Interval[pd.Timedelta]]",
),
assert_type(iintd, "pd.IntervalIndex[pd.Interval[pd.Timedelta]]"),
pd.IntervalIndex,
pd.Interval,
)
Expand All @@ -1005,7 +999,7 @@ def test_getitem() -> None:

mi = pd.MultiIndex.from_product([["a", "b"], ["c", "d"]], names=["ab", "cd"])
check(assert_type(mi, pd.MultiIndex), pd.MultiIndex)
check(assert_type(mi[0], tuple), tuple)
check(assert_type(mi[0], tuple[Hashable, ...]), tuple, str)
check(assert_type(mi[[0, 2]], pd.MultiIndex), pd.MultiIndex, tuple)

i0 = pd.Index(["a", "b", "c"])
Expand Down
14 changes: 7 additions & 7 deletions tests/series/test_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1015,14 +1015,14 @@ def test_groupby_result() -> None:
multi_index = pd.MultiIndex.from_tuples([(0, 0), (0, 1), (1, 0)], names=["a", "b"])
s = pd.Series([0, 1, 2], index=multi_index, dtype=int)
iterator = s.groupby(["a", "b"]).__iter__()
assert_type(iterator, Iterator[tuple[tuple, "pd.Series[int]"]])
assert_type(iterator, Iterator[tuple[tuple[Hashable, ...], "pd.Series[int]"]])
index, value = next(iterator)
assert_type((index, value), tuple[tuple, "pd.Series[int]"])
assert_type((index, value), tuple[tuple[Hashable, ...], "pd.Series[int]"])

if PD_LTE_23:
check(assert_type(index, tuple), tuple, np.integer)
check(assert_type(index, tuple[Hashable, ...]), tuple, np.integer)
else:
check(assert_type(index, tuple), tuple, int)
check(assert_type(index, tuple[Hashable, ...]), tuple, int)

check(assert_type(value, "pd.Series[int]"), pd.Series, np.integer)

Expand All @@ -1037,11 +1037,11 @@ def test_groupby_result() -> None:
# GH 674
# grouping by pd.MultiIndex should always resolve to a tuple as well
iterator3 = s.groupby(multi_index).__iter__()
assert_type(iterator3, Iterator[tuple[tuple, "pd.Series[int]"]])
assert_type(iterator3, Iterator[tuple[tuple[Hashable, ...], "pd.Series[int]"]])
index3, value3 = next(iterator3)
assert_type((index3, value3), tuple[tuple, "pd.Series[int]"])
assert_type((index3, value3), tuple[tuple[Hashable, ...], "pd.Series[int]"])

check(assert_type(index3, tuple), tuple, int)
check(assert_type(index3, tuple[Hashable, ...]), tuple, int)
check(assert_type(value3, "pd.Series[int]"), pd.Series, np.integer)

# Explicit by=None
Expand Down
16 changes: 9 additions & 7 deletions tests/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2959,6 +2959,8 @@ def test_groupby_series_methods() -> None:
check(assert_type(gb.nlargest(), pd.Series), pd.Series)
check(assert_type(gb.nsmallest(), pd.Series), pd.Series)
check(assert_type(gb.nth(0), pd.DataFrame | pd.Series), pd.Series)
check(assert_type(gb.nth[0, 1, 2], pd.DataFrame | pd.Series), pd.Series)
check(assert_type(gb.nth((0, 1, 2)), pd.DataFrame | pd.Series), pd.Series)


def test_dataframe_pct_change() -> None:
Expand Down Expand Up @@ -3591,14 +3593,14 @@ def test_groupby_result() -> None:
# GH 142
df = pd.DataFrame({"a": [0, 1, 2], "b": [4, 5, 6], "c": [7, 8, 9]})
iterator = df.groupby(["a", "b"]).__iter__()
assert_type(iterator, Iterator[tuple[tuple, pd.DataFrame]])
assert_type(iterator, Iterator[tuple[tuple[Hashable, ...], pd.DataFrame]])
index, value = next(iterator)
assert_type((index, value), tuple[tuple, pd.DataFrame])
assert_type((index, value), tuple[tuple[Hashable, ...], pd.DataFrame])

if PD_LTE_23:
check(assert_type(index, tuple), tuple, np.integer)
check(assert_type(index, tuple[Hashable, ...]), tuple, np.integer)
else:
check(assert_type(index, tuple), tuple, int)
check(assert_type(index, tuple[Hashable, ...]), tuple, int)

check(assert_type(value, pd.DataFrame), pd.DataFrame)

Expand All @@ -3614,11 +3616,11 @@ def test_groupby_result() -> None:
# grouping by pd.MultiIndex should always resolve to a tuple as well
multi_index = pd.MultiIndex.from_frame(df[["a", "b"]])
iterator3 = df.groupby(multi_index).__iter__()
assert_type(iterator3, Iterator[tuple[tuple, pd.DataFrame]])
assert_type(iterator3, Iterator[tuple[tuple[Hashable, ...], pd.DataFrame]])
index3, value3 = next(iterator3)
assert_type((index3, value3), tuple[tuple, pd.DataFrame])
assert_type((index3, value3), tuple[tuple[Hashable, ...], pd.DataFrame])

check(assert_type(index3, tuple), tuple, int)
check(assert_type(index3, tuple[Hashable, ...]), tuple, int)
check(assert_type(value3, pd.DataFrame), pd.DataFrame)

# Want to make sure these cases are differentiated
Expand Down
4 changes: 2 additions & 2 deletions tests/test_pandas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1712,8 +1712,8 @@ def m2(x: pd.Series) -> int:
assert_type(pd.crosstab(a, b, colnames=["a"], rownames=["b"]), pd.DataFrame),
pd.DataFrame,
)
rownames: list[tuple] = [("b", 1)]
colnames: list[tuple] = [("a",)]
rownames: list[tuple[str, int]] = [("b", 1)]
colnames: list[tuple[str]] = [("a",)]
check(
assert_type(
pd.crosstab(a, b, colnames=colnames, rownames=rownames),
Expand Down