Skip to content

Commit 637ece0

Browse files
authored
[_thread] Deprecate undocumented synonyms (#15436)
1 parent d4a1c39 commit 637ece0

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

stdlib/_thread.pyi

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ from collections.abc import Callable
55
from threading import Thread
66
from types import TracebackType
77
from typing import Any, Final, NoReturn, final, overload
8-
from typing_extensions import TypeVarTuple, Unpack, disjoint_base
8+
from typing_extensions import TypeVarTuple, Unpack, deprecated, disjoint_base
99

1010
_Ts = TypeVarTuple("_Ts")
1111

@@ -38,9 +38,12 @@ if sys.version_info >= (3, 13):
3838
def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ...
3939
def release(self) -> None: ...
4040
def locked(self) -> bool: ...
41-
def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ...
42-
def release_lock(self) -> None: ...
43-
def locked_lock(self) -> bool: ...
41+
@deprecated("Obsolete synonym. Use `acquire()` instead.")
42+
def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ... # undocumented
43+
@deprecated("Obsolete synonym. Use `release()` instead.")
44+
def release_lock(self) -> None: ... # undocumented
45+
@deprecated("Obsolete synonym. Use `locked()` instead.")
46+
def locked_lock(self) -> bool: ... # undocumented
4447
def __enter__(self) -> bool: ...
4548
def __exit__(
4649
self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
@@ -53,9 +56,12 @@ else:
5356
def acquire(self, blocking: bool = True, timeout: float = -1) -> bool: ...
5457
def release(self) -> None: ...
5558
def locked(self) -> bool: ...
56-
def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ...
57-
def release_lock(self) -> None: ...
58-
def locked_lock(self) -> bool: ...
59+
@deprecated("Obsolete synonym. Use `acquire()` instead.")
60+
def acquire_lock(self, blocking: bool = True, timeout: float = -1) -> bool: ... # undocumented
61+
@deprecated("Obsolete synonym. Use `release()` instead.")
62+
def release_lock(self) -> None: ... # undocumented
63+
@deprecated("Obsolete synonym. Use `locked()` instead.")
64+
def locked_lock(self) -> bool: ... # undocumented
5965
def __enter__(self) -> bool: ...
6066
def __exit__(
6167
self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
@@ -65,12 +71,12 @@ else:
6571
def start_new_thread(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]], /) -> int: ...
6672
@overload
6773
def start_new_thread(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any], /) -> int: ...
68-
69-
# Obsolete synonym for start_new_thread()
7074
@overload
71-
def start_new(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]], /) -> int: ...
75+
@deprecated("Obsolete synonym. Use `start_new_thread()` instead.")
76+
def start_new(function: Callable[[Unpack[_Ts]], object], args: tuple[Unpack[_Ts]], /) -> int: ... # undocumented
7277
@overload
73-
def start_new(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any], /) -> int: ...
78+
@deprecated("Obsolete synonym. Use `start_new_thread()` instead.")
79+
def start_new(function: Callable[..., object], args: tuple[Any, ...], kwargs: dict[str, Any], /) -> int: ... # undocumented
7480

7581
if sys.version_info >= (3, 10):
7682
def interrupt_main(signum: signal.Signals = signal.SIGINT, /) -> None: ...
@@ -79,9 +85,11 @@ else:
7985
def interrupt_main() -> None: ...
8086

8187
def exit() -> NoReturn: ...
82-
def exit_thread() -> NoReturn: ... # Obsolete synonym for exit()
88+
@deprecated("Obsolete synonym. Use `exit()` instead.")
89+
def exit_thread() -> NoReturn: ... # undocumented
8390
def allocate_lock() -> LockType: ...
84-
def allocate() -> LockType: ... # Obsolete synonym for allocate_lock()
91+
@deprecated("Obsolete synonym. Use `allocate_lock()` instead.")
92+
def allocate() -> LockType: ... # undocumented
8593
def get_ident() -> int: ...
8694
def stack_size(size: int = 0, /) -> int: ...
8795

0 commit comments

Comments
 (0)