Skip to content

Commit 257e287

Browse files
authored
Stdlib: correct many parameter names (#9815)
1 parent 4b755c7 commit 257e287

30 files changed

+384
-355
lines changed

stdlib/_tkinter.pyi

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ class Tcl_Obj:
2222
@property
2323
def typename(self) -> str: ...
2424
__hash__: ClassVar[None] # type: ignore[assignment]
25-
def __eq__(self, __other): ...
26-
def __ge__(self, __other): ...
27-
def __gt__(self, __other): ...
28-
def __le__(self, __other): ...
29-
def __lt__(self, __other): ...
30-
def __ne__(self, __other): ...
25+
def __eq__(self, __value): ...
26+
def __ge__(self, __value): ...
27+
def __gt__(self, __value): ...
28+
def __le__(self, __value): ...
29+
def __lt__(self, __value): ...
30+
def __ne__(self, __value): ...
3131

3232
class TclError(Exception): ...
3333

stdlib/array.pyi

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,23 +61,23 @@ class array(MutableSequence[_T], Generic[_T]):
6161

6262
def __len__(self) -> int: ...
6363
@overload
64-
def __getitem__(self, __i: SupportsIndex) -> _T: ...
64+
def __getitem__(self, __key: SupportsIndex) -> _T: ...
6565
@overload
66-
def __getitem__(self, __s: slice) -> array[_T]: ...
66+
def __getitem__(self, __key: slice) -> array[_T]: ...
6767
@overload # type: ignore[override]
68-
def __setitem__(self, __i: SupportsIndex, __o: _T) -> None: ...
68+
def __setitem__(self, __key: SupportsIndex, __value: _T) -> None: ...
6969
@overload
70-
def __setitem__(self, __s: slice, __o: array[_T]) -> None: ...
71-
def __delitem__(self, __i: SupportsIndex | slice) -> None: ...
72-
def __add__(self, __x: array[_T]) -> array[_T]: ...
73-
def __ge__(self, __other: array[_T]) -> bool: ...
74-
def __gt__(self, __other: array[_T]) -> bool: ...
75-
def __iadd__(self, __x: array[_T]) -> Self: ... # type: ignore[override]
76-
def __imul__(self, __n: int) -> Self: ...
77-
def __le__(self, __other: array[_T]) -> bool: ...
78-
def __lt__(self, __other: array[_T]) -> bool: ...
79-
def __mul__(self, __n: int) -> array[_T]: ...
80-
def __rmul__(self, __n: int) -> array[_T]: ...
70+
def __setitem__(self, __key: slice, __value: array[_T]) -> None: ...
71+
def __delitem__(self, __key: SupportsIndex | slice) -> None: ...
72+
def __add__(self, __value: array[_T]) -> array[_T]: ...
73+
def __ge__(self, __value: array[_T]) -> bool: ...
74+
def __gt__(self, __value: array[_T]) -> bool: ...
75+
def __iadd__(self, __value: array[_T]) -> Self: ... # type: ignore[override]
76+
def __imul__(self, __value: int) -> Self: ...
77+
def __le__(self, __value: array[_T]) -> bool: ...
78+
def __lt__(self, __value: array[_T]) -> bool: ...
79+
def __mul__(self, __value: int) -> array[_T]: ...
80+
def __rmul__(self, __value: int) -> array[_T]: ...
8181
def __copy__(self) -> array[_T]: ...
8282
def __deepcopy__(self, __unused: Any) -> array[_T]: ...
8383

stdlib/builtins.pyi

Lines changed: 205 additions & 205 deletions
Large diffs are not rendered by default.

stdlib/collections/__init__.pyi

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -236,19 +236,19 @@ class deque(MutableSequence[_T], Generic[_T]):
236236
def __copy__(self) -> Self: ...
237237
def __len__(self) -> int: ...
238238
# These methods of deque don't take slices, unlike MutableSequence, hence the type: ignores
239-
def __getitem__(self, __index: SupportsIndex) -> _T: ... # type: ignore[override]
240-
def __setitem__(self, __i: SupportsIndex, __x: _T) -> None: ... # type: ignore[override]
241-
def __delitem__(self, __i: SupportsIndex) -> None: ... # type: ignore[override]
242-
def __contains__(self, __o: object) -> bool: ...
239+
def __getitem__(self, __key: SupportsIndex) -> _T: ... # type: ignore[override]
240+
def __setitem__(self, __key: SupportsIndex, __value: _T) -> None: ... # type: ignore[override]
241+
def __delitem__(self, __key: SupportsIndex) -> None: ... # type: ignore[override]
242+
def __contains__(self, __key: object) -> bool: ...
243243
def __reduce__(self) -> tuple[type[Self], tuple[()], None, Iterator[_T]]: ...
244-
def __iadd__(self, __iterable: Iterable[_T]) -> Self: ...
245-
def __add__(self, __other: Self) -> Self: ...
246-
def __mul__(self, __other: int) -> Self: ...
247-
def __imul__(self, __other: int) -> Self: ...
248-
def __lt__(self, __other: deque[_T]) -> bool: ...
249-
def __le__(self, __other: deque[_T]) -> bool: ...
250-
def __gt__(self, __other: deque[_T]) -> bool: ...
251-
def __ge__(self, __other: deque[_T]) -> bool: ...
244+
def __iadd__(self, __value: Iterable[_T]) -> Self: ...
245+
def __add__(self, __value: Self) -> Self: ...
246+
def __mul__(self, __value: int) -> Self: ...
247+
def __imul__(self, __value: int) -> Self: ...
248+
def __lt__(self, __value: deque[_T]) -> bool: ...
249+
def __le__(self, __value: deque[_T]) -> bool: ...
250+
def __gt__(self, __value: deque[_T]) -> bool: ...
251+
def __ge__(self, __value: deque[_T]) -> bool: ...
252252
if sys.version_info >= (3, 9):
253253
def __class_getitem__(cls, __item: Any) -> GenericAlias: ...
254254

stdlib/contextlib.pyi

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,14 @@ class _GeneratorContextManager(AbstractContextManager[_T_co], ContextDecorator,
6464
func: Callable[..., Generator[_T_co, Any, Any]]
6565
args: tuple[Any, ...]
6666
kwds: dict[str, Any]
67-
def __exit__(
68-
self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
69-
) -> bool | None: ...
67+
if sys.version_info >= (3, 9):
68+
def __exit__(
69+
self, typ: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
70+
) -> bool | None: ...
71+
else:
72+
def __exit__(
73+
self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
74+
) -> bool | None: ...
7075

7176
def contextmanager(func: Callable[_P, Iterator[_T_co]]) -> Callable[_P, _GeneratorContextManager[_T_co]]: ...
7277

stdlib/contextvars.pyi

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,13 @@ class ContextVar(Generic[_T]):
2222
def name(self) -> str: ...
2323
@overload
2424
def get(self) -> _T: ...
25-
@overload
26-
def get(self, default: _D | _T) -> _D | _T: ...
25+
if sys.version_info >= (3, 8):
26+
@overload
27+
def get(self, default: _D | _T) -> _D | _T: ...
28+
else:
29+
@overload
30+
def get(self, __default: _D | _T) -> _D | _T: ...
31+
2732
def set(self, __value: _T) -> Token[_T]: ...
2833
def reset(self, __token: Token[_T]) -> None: ...
2934
if sys.version_info >= (3, 9):

stdlib/ctypes/__init__.pyi

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -170,10 +170,10 @@ class _Pointer(Generic[_CT], _PointerLike, _CData):
170170
@overload
171171
def __init__(self, arg: _CT) -> None: ...
172172
@overload
173-
def __getitem__(self, __i: int) -> Any: ...
173+
def __getitem__(self, __key: int) -> Any: ...
174174
@overload
175-
def __getitem__(self, __s: slice) -> list[Any]: ...
176-
def __setitem__(self, __i: int, __o: Any) -> None: ...
175+
def __getitem__(self, __key: slice) -> list[Any]: ...
176+
def __setitem__(self, __key: int, __value: Any) -> None: ...
177177

178178
def pointer(__arg: _CT) -> _Pointer[_CT]: ...
179179
def resize(obj: _CData, size: int) -> None: ...
@@ -291,13 +291,13 @@ class Array(Generic[_CT], _CData):
291291
# the array element type would belong are annotated with Any instead.
292292
def __init__(self, *args: Any) -> None: ...
293293
@overload
294-
def __getitem__(self, __i: int) -> Any: ...
294+
def __getitem__(self, __key: int) -> Any: ...
295295
@overload
296-
def __getitem__(self, __s: slice) -> list[Any]: ...
296+
def __getitem__(self, __key: slice) -> list[Any]: ...
297297
@overload
298-
def __setitem__(self, __i: int, __o: Any) -> None: ...
298+
def __setitem__(self, __key: int, __value: Any) -> None: ...
299299
@overload
300-
def __setitem__(self, __s: slice, __o: Iterable[Any]) -> None: ...
300+
def __setitem__(self, __key: slice, __value: Iterable[Any]) -> None: ...
301301
def __iter__(self) -> Iterator[Any]: ...
302302
# Can't inherit from Sized because the metaclass conflict between
303303
# Sized and _CData prevents using _CDataMeta.

stdlib/datetime.pyi

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -82,29 +82,29 @@ class date:
8282
def timetuple(self) -> struct_time: ...
8383
def toordinal(self) -> int: ...
8484
def replace(self, year: int = ..., month: int = ..., day: int = ...) -> Self: ...
85-
def __le__(self, __other: date) -> bool: ...
86-
def __lt__(self, __other: date) -> bool: ...
87-
def __ge__(self, __other: date) -> bool: ...
88-
def __gt__(self, __other: date) -> bool: ...
85+
def __le__(self, __value: date) -> bool: ...
86+
def __lt__(self, __value: date) -> bool: ...
87+
def __ge__(self, __value: date) -> bool: ...
88+
def __gt__(self, __value: date) -> bool: ...
8989
if sys.version_info >= (3, 8):
90-
def __add__(self, __other: timedelta) -> Self: ...
91-
def __radd__(self, __other: timedelta) -> Self: ...
90+
def __add__(self, __value: timedelta) -> Self: ...
91+
def __radd__(self, __value: timedelta) -> Self: ...
9292
@overload
93-
def __sub__(self, __other: timedelta) -> Self: ...
93+
def __sub__(self, __value: timedelta) -> Self: ...
9494
@overload
95-
def __sub__(self, __other: datetime) -> NoReturn: ...
95+
def __sub__(self, __value: datetime) -> NoReturn: ...
9696
@overload
97-
def __sub__(self: _D, __other: _D) -> timedelta: ...
97+
def __sub__(self: _D, __value: _D) -> timedelta: ...
9898
else:
9999
# Prior to Python 3.8, arithmetic operations always returned `date`, even in subclasses
100-
def __add__(self, __other: timedelta) -> date: ...
101-
def __radd__(self, __other: timedelta) -> date: ...
100+
def __add__(self, __value: timedelta) -> date: ...
101+
def __radd__(self, __value: timedelta) -> date: ...
102102
@overload
103-
def __sub__(self, __other: timedelta) -> date: ...
103+
def __sub__(self, __value: timedelta) -> date: ...
104104
@overload
105-
def __sub__(self, __other: datetime) -> NoReturn: ...
105+
def __sub__(self, __value: datetime) -> NoReturn: ...
106106
@overload
107-
def __sub__(self, __other: date) -> timedelta: ...
107+
def __sub__(self, __value: date) -> timedelta: ...
108108

109109
def weekday(self) -> int: ...
110110
def isoweekday(self) -> int: ...
@@ -139,10 +139,10 @@ class time:
139139
def tzinfo(self) -> _TzInfo | None: ...
140140
@property
141141
def fold(self) -> int: ...
142-
def __le__(self, __other: time) -> bool: ...
143-
def __lt__(self, __other: time) -> bool: ...
144-
def __ge__(self, __other: time) -> bool: ...
145-
def __gt__(self, __other: time) -> bool: ...
142+
def __le__(self, __value: time) -> bool: ...
143+
def __lt__(self, __value: time) -> bool: ...
144+
def __ge__(self, __value: time) -> bool: ...
145+
def __gt__(self, __value: time) -> bool: ...
146146
def isoformat(self, timespec: str = ...) -> str: ...
147147
@classmethod
148148
def fromisoformat(cls, __time_string: str) -> Self: ...
@@ -193,29 +193,29 @@ class timedelta:
193193
@property
194194
def microseconds(self) -> int: ...
195195
def total_seconds(self) -> float: ...
196-
def __add__(self, __other: timedelta) -> timedelta: ...
197-
def __radd__(self, __other: timedelta) -> timedelta: ...
198-
def __sub__(self, __other: timedelta) -> timedelta: ...
199-
def __rsub__(self, __other: timedelta) -> timedelta: ...
196+
def __add__(self, __value: timedelta) -> timedelta: ...
197+
def __radd__(self, __value: timedelta) -> timedelta: ...
198+
def __sub__(self, __value: timedelta) -> timedelta: ...
199+
def __rsub__(self, __value: timedelta) -> timedelta: ...
200200
def __neg__(self) -> timedelta: ...
201201
def __pos__(self) -> timedelta: ...
202202
def __abs__(self) -> timedelta: ...
203-
def __mul__(self, __other: float) -> timedelta: ...
204-
def __rmul__(self, __other: float) -> timedelta: ...
203+
def __mul__(self, __value: float) -> timedelta: ...
204+
def __rmul__(self, __value: float) -> timedelta: ...
205205
@overload
206-
def __floordiv__(self, __other: timedelta) -> int: ...
206+
def __floordiv__(self, __value: timedelta) -> int: ...
207207
@overload
208-
def __floordiv__(self, __other: int) -> timedelta: ...
208+
def __floordiv__(self, __value: int) -> timedelta: ...
209209
@overload
210-
def __truediv__(self, __other: timedelta) -> float: ...
210+
def __truediv__(self, __value: timedelta) -> float: ...
211211
@overload
212-
def __truediv__(self, __other: float) -> timedelta: ...
213-
def __mod__(self, __other: timedelta) -> timedelta: ...
214-
def __divmod__(self, __other: timedelta) -> tuple[int, timedelta]: ...
215-
def __le__(self, __other: timedelta) -> bool: ...
216-
def __lt__(self, __other: timedelta) -> bool: ...
217-
def __ge__(self, __other: timedelta) -> bool: ...
218-
def __gt__(self, __other: timedelta) -> bool: ...
212+
def __truediv__(self, __value: float) -> timedelta: ...
213+
def __mod__(self, __value: timedelta) -> timedelta: ...
214+
def __divmod__(self, __value: timedelta) -> tuple[int, timedelta]: ...
215+
def __le__(self, __value: timedelta) -> bool: ...
216+
def __lt__(self, __value: timedelta) -> bool: ...
217+
def __ge__(self, __value: timedelta) -> bool: ...
218+
def __gt__(self, __value: timedelta) -> bool: ...
219219
def __bool__(self) -> bool: ...
220220

221221
class datetime(date):
@@ -302,20 +302,20 @@ class datetime(date):
302302
def utcoffset(self) -> timedelta | None: ...
303303
def tzname(self) -> str | None: ...
304304
def dst(self) -> timedelta | None: ...
305-
def __le__(self, __other: datetime) -> bool: ... # type: ignore[override]
306-
def __lt__(self, __other: datetime) -> bool: ... # type: ignore[override]
307-
def __ge__(self, __other: datetime) -> bool: ... # type: ignore[override]
308-
def __gt__(self, __other: datetime) -> bool: ... # type: ignore[override]
305+
def __le__(self, __value: datetime) -> bool: ... # type: ignore[override]
306+
def __lt__(self, __value: datetime) -> bool: ... # type: ignore[override]
307+
def __ge__(self, __value: datetime) -> bool: ... # type: ignore[override]
308+
def __gt__(self, __value: datetime) -> bool: ... # type: ignore[override]
309309
if sys.version_info >= (3, 8):
310310
@overload # type: ignore[override]
311-
def __sub__(self, __other: timedelta) -> Self: ...
311+
def __sub__(self, __value: timedelta) -> Self: ...
312312
@overload
313-
def __sub__(self: _D, __other: _D) -> timedelta: ...
313+
def __sub__(self: _D, __value: _D) -> timedelta: ...
314314
else:
315315
# Prior to Python 3.8, arithmetic operations always returned `datetime`, even in subclasses
316-
def __add__(self, __other: timedelta) -> datetime: ...
317-
def __radd__(self, __other: timedelta) -> datetime: ...
316+
def __add__(self, __value: timedelta) -> datetime: ...
317+
def __radd__(self, __value: timedelta) -> datetime: ...
318318
@overload # type: ignore[override]
319-
def __sub__(self, __other: datetime) -> timedelta: ...
319+
def __sub__(self, __value: datetime) -> timedelta: ...
320320
@overload
321-
def __sub__(self, __other: timedelta) -> datetime: ...
321+
def __sub__(self, __value: timedelta) -> datetime: ...

stdlib/email/charset.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class Charset:
2020
def header_encode_lines(self, string: str, maxlengths: Iterator[int]) -> list[str]: ...
2121
def body_encode(self, string: str) -> str: ...
2222
def __eq__(self, other: object) -> bool: ...
23-
def __ne__(self, __other: object) -> bool: ...
23+
def __ne__(self, __value: object) -> bool: ...
2424

2525
def add_charset(
2626
charset: str, header_enc: int | None = None, body_enc: int | None = None, output_charset: str | None = None

stdlib/email/header.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class Header:
1717
def append(self, s: bytes | bytearray | str, charset: Charset | str | None = None, errors: str = "strict") -> None: ...
1818
def encode(self, splitchars: str = ";, \t", maxlinelen: int | None = None, linesep: str = "\n") -> str: ...
1919
def __eq__(self, other: object) -> bool: ...
20-
def __ne__(self, __other: object) -> bool: ...
20+
def __ne__(self, __value: object) -> bool: ...
2121

2222
# decode_header() either returns list[tuple[str, None]] if the header
2323
# contains no encoded parts, or list[tuple[bytes, str | None]] if the header

stdlib/enum.pyi

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,15 @@ class EnumMeta(ABCMeta):
106106

107107
def __iter__(self: type[_EnumMemberT]) -> Iterator[_EnumMemberT]: ...
108108
def __reversed__(self: type[_EnumMemberT]) -> Iterator[_EnumMemberT]: ...
109-
def __contains__(self: type[Any], obj: object) -> bool: ...
109+
if sys.version_info >= (3, 12):
110+
def __contains__(self: type[Any], value: object) -> bool: ...
111+
elif sys.version_info >= (3, 11):
112+
def __contains__(self: type[Any], member: object) -> bool: ...
113+
elif sys.version_info >= (3, 10):
114+
def __contains__(self: type[Any], obj: object) -> bool: ...
115+
else:
116+
def __contains__(self: type[Any], member: object) -> bool: ...
117+
110118
def __getitem__(self: type[_EnumMemberT], name: str) -> _EnumMemberT: ...
111119
@_builtins_property
112120
def __members__(self: type[_EnumMemberT]) -> types.MappingProxyType[str, _EnumMemberT]: ...

stdlib/fractions.pyi

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,25 @@ class Fraction(Rational):
103103
def __rmod__(b, a: int | Fraction) -> Fraction: ...
104104
@overload
105105
def __rmod__(b, a: float) -> float: ...
106-
@overload
107-
def __divmod__(a, b: int | Fraction) -> tuple[int, Fraction]: ...
108-
@overload
109-
def __divmod__(a, b: float) -> tuple[float, Fraction]: ...
110-
@overload
111-
def __rdivmod__(b, a: int | Fraction) -> tuple[int, Fraction]: ...
112-
@overload
113-
def __rdivmod__(b, a: float) -> tuple[float, Fraction]: ...
106+
if sys.version_info >= (3, 8):
107+
@overload
108+
def __divmod__(a, b: int | Fraction) -> tuple[int, Fraction]: ...
109+
@overload
110+
def __divmod__(a, b: float) -> tuple[float, Fraction]: ...
111+
@overload
112+
def __rdivmod__(a, b: int | Fraction) -> tuple[int, Fraction]: ...
113+
@overload
114+
def __rdivmod__(a, b: float) -> tuple[float, Fraction]: ...
115+
else:
116+
@overload
117+
def __divmod__(self, other: int | Fraction) -> tuple[int, Fraction]: ...
118+
@overload
119+
def __divmod__(self, other: float) -> tuple[float, Fraction]: ...
120+
@overload
121+
def __rdivmod__(self, other: int | Fraction) -> tuple[int, Fraction]: ...
122+
@overload
123+
def __rdivmod__(self, other: float) -> tuple[float, Fraction]: ...
124+
114125
@overload
115126
def __pow__(a, b: int) -> Fraction: ...
116127
@overload

stdlib/heapq.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ def merge(
1515
) -> Iterable[_S]: ...
1616
def nlargest(n: int, iterable: Iterable[_S], key: Callable[[_S], SupportsRichComparison] | None = None) -> list[_S]: ...
1717
def nsmallest(n: int, iterable: Iterable[_S], key: Callable[[_S], SupportsRichComparison] | None = None) -> list[_S]: ...
18-
def _heapify_max(__x: list[Any]) -> None: ... # undocumented
18+
def _heapify_max(__heap: list[Any]) -> None: ... # undocumented

stdlib/ipaddress.pyi

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ class _BaseAddress(_IPAddressBase, SupportsInt):
3636
def __add__(self, other: int) -> Self: ...
3737
def __int__(self) -> int: ...
3838
def __sub__(self, other: int) -> Self: ...
39-
def __format__(self, fmt: str) -> str: ...
39+
if sys.version_info >= (3, 9):
40+
def __format__(self, fmt: str) -> str: ...
41+
4042
def __eq__(self, other: object) -> bool: ...
4143
def __lt__(self, other: Self) -> bool: ...
4244
if sys.version_info >= (3, 11):

stdlib/mmap.pyi

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ class mmap(Iterable[int], Sized):
6060
def read(self, n: int | None = ...) -> bytes: ...
6161
def write(self, bytes: ReadableBuffer) -> int: ...
6262
@overload
63-
def __getitem__(self, __index: int) -> int: ...
63+
def __getitem__(self, __key: int) -> int: ...
6464
@overload
65-
def __getitem__(self, __index: slice) -> bytes: ...
66-
def __delitem__(self, __index: int | slice) -> NoReturn: ...
65+
def __getitem__(self, __key: slice) -> bytes: ...
66+
def __delitem__(self, __key: int | slice) -> NoReturn: ...
6767
@overload
68-
def __setitem__(self, __index: int, __object: int) -> None: ...
68+
def __setitem__(self, __key: int, __value: int) -> None: ...
6969
@overload
70-
def __setitem__(self, __index: slice, __object: ReadableBuffer) -> None: ...
70+
def __setitem__(self, __key: slice, __value: ReadableBuffer) -> None: ...
7171
# Doesn't actually exist, but the object actually supports "in" because it has __getitem__,
7272
# so we claim that there is also a __contains__ to help type checkers.
7373
def __contains__(self, __o: object) -> bool: ...

0 commit comments

Comments
 (0)