Skip to content

Commit e887eae

Browse files
authored
[itertools] More specific type hints for batched(..., strict=True) (#15277)
1 parent 77f8e8f commit e887eae

File tree

2 files changed

+39
-3
lines changed

2 files changed

+39
-3
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
from __future__ import annotations
2+
3+
import sys
4+
from typing_extensions import assert_type
5+
6+
if sys.version_info >= (3, 13):
7+
from itertools import batched
8+
9+
assert_type(batched([0], 1, strict=True), batched[tuple[int]])
10+
assert_type(batched([0, 0], 2, strict=True), batched[tuple[int, int]])
11+
assert_type(batched([0, 0, 0], 3, strict=True), batched[tuple[int, int, int]])
12+
assert_type(batched([0, 0, 0, 0], 4, strict=True), batched[tuple[int, int, int, int]])
13+
assert_type(batched([0, 0, 0, 0, 0], 5, strict=True), batched[tuple[int, int, int, int, int]])
14+
15+
assert_type(batched([0], 2), batched[tuple[int, ...]])
16+
assert_type(batched([0], 2, strict=False), batched[tuple[int, ...]])
17+
18+
def f() -> int:
19+
return 3
20+
21+
assert_type(batched([0, 0, 0], f(), strict=True), batched[tuple[int, ...]])

stdlib/itertools.pyi

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -343,9 +343,24 @@ if sys.version_info >= (3, 12):
343343
@disjoint_base
344344
class batched(Generic[_T_co]):
345345
if sys.version_info >= (3, 13):
346-
def __new__(cls, iterable: Iterable[_T_co], n: int, *, strict: bool = False) -> Self: ...
346+
@overload
347+
def __new__(cls, iterable: Iterable[_T], n: Literal[1], *, strict: Literal[True]) -> batched[tuple[_T]]: ...
348+
@overload
349+
def __new__(cls, iterable: Iterable[_T], n: Literal[2], *, strict: Literal[True]) -> batched[tuple[_T, _T]]: ...
350+
@overload
351+
def __new__(cls, iterable: Iterable[_T], n: Literal[3], *, strict: Literal[True]) -> batched[tuple[_T, _T, _T]]: ...
352+
@overload
353+
def __new__(
354+
cls, iterable: Iterable[_T], n: Literal[4], *, strict: Literal[True]
355+
) -> batched[tuple[_T, _T, _T, _T]]: ...
356+
@overload
357+
def __new__(
358+
cls, iterable: Iterable[_T], n: Literal[5], *, strict: Literal[True]
359+
) -> batched[tuple[_T, _T, _T, _T, _T]]: ...
360+
@overload
361+
def __new__(cls, iterable: Iterable[_T], n: int, *, strict: bool = False) -> batched[tuple[_T, ...]]: ...
347362
else:
348-
def __new__(cls, iterable: Iterable[_T_co], n: int) -> Self: ...
363+
def __new__(cls, iterable: Iterable[_T], n: int) -> batched[tuple[_T, ...]]: ...
349364

350365
def __iter__(self) -> Self: ...
351-
def __next__(self) -> tuple[_T_co, ...]: ...
366+
def __next__(self) -> _T_co: ...

0 commit comments

Comments
 (0)