Skip to content

Add asyncio.tools stubs for 3.14 #14305

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
1 change: 0 additions & 1 deletion stdlib/@tests/stubtest_allowlists/py314.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
# ====================================================================

_zstd.ZstdCompressor.set_pledged_input_size
asyncio.tools
compression.zstd.ZstdCompressor.set_pledged_input_size
concurrent.interpreters
multiprocessing.managers.BaseListProxy.clear
Expand Down
1 change: 1 addition & 0 deletions stdlib/VERSIONS
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ asyncio.staggered: 3.8-
asyncio.taskgroups: 3.11-
asyncio.threads: 3.9-
asyncio.timeouts: 3.11-
asyncio.tools: 3.14-
asyncio.trsock: 3.8-
asyncore: 3.0-3.11
atexit: 3.0-
Expand Down
41 changes: 41 additions & 0 deletions stdlib/asyncio/tools.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
from collections.abc import Iterable
from enum import Enum
from typing import NamedTuple, SupportsIndex, type_check_only

@type_check_only
class _AwaitedInfo(NamedTuple): # AwaitedInfo_Type from _remote_debugging
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also don't think that comments are appropriate here since exactly the same namedtuples are also defined in tests

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think they serve a purpose, but I'm happy to remove them if that's preferred. They document that these are actually struct sequence types from _remote_debugging, which typeshed doesn't have stubs for (yet). If typeshed later adds stubs for _remote_debugging, we'd likely want to replace these, so I think it's helpful to have some note reminding us of what these types represent. (Typing the real struct sequence types is a bit trickier, which is why I just used a local approximation here)

thread_id: int
awaited_by: list[_TaskInfo]

@type_check_only
class _TaskInfo(NamedTuple): # TaskInfo_Type from _remote_debugging
task_id: int
task_name: str
coroutine_stack: list[_CoroInfo]
awaited_by: list[_TaskInfo]

@type_check_only
class _CoroInfo(NamedTuple): # CoroInfo_Type from _remote_debugging
call_stack: list[_FrameInfo]
task_name: int | str

@type_check_only
class _FrameInfo(NamedTuple): # FrameInfo_Type from _remote_debugging
filename: str
lineno: int
funcname: str

class NodeType(Enum):
COROUTINE = 1
TASK = 2

class CycleFoundException(Exception):
cycles: list[list[int]]
id2name: dict[int, str]
def __init__(self, cycles: list[list[int]], id2name: dict[int, str]) -> None: ...

def get_all_awaited_by(pid: SupportsIndex) -> list[_AwaitedInfo]: ...
def build_async_tree(result: Iterable[_AwaitedInfo], task_emoji: str = "(T)", cor_emoji: str = "") -> list[list[str]]: ...
def build_task_table(result: Iterable[_AwaitedInfo]) -> list[list[int | str]]: ...
def display_awaited_by_tasks_table(pid: SupportsIndex) -> None: ...
def display_awaited_by_tasks_tree(pid: SupportsIndex) -> None: ...