Skip to content

gh-91048: Add filename:line_no information to asyncio pstree #133478

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

gh-91048: Add filename:line_no information to asyncio pstree #133478

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
ab2b0c5
Add filename:line_no information to `asyncio pstree`
ambv May 5, 2025
abac798
Adapt test
ambv May 5, 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
1 change: 1 addition & 0 deletions Lib/asyncio/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ def interrupt(self) -> None:
parser = argparse.ArgumentParser(
prog="python3 -m asyncio",
description="Interactive asyncio shell and CLI tools",
color=True,
)
subparsers = parser.add_subparsers(help="sub-commands", dest="command")
ps = subparsers.add_parser(
Expand Down
14 changes: 11 additions & 3 deletions Lib/asyncio/tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,21 @@ class CycleFoundException(Exception):


# ─── indexing helpers ───────────────────────────────────────────
def _format_stack_entry(elem: tuple[str, str, int] | str) -> str:
if isinstance(elem, tuple):
fqname, path, line_no = elem
return f"{fqname} {path}:{line_no}"

return elem


def _index(result):
id2name, awaits = {}, []
for _thr_id, tasks in result:
for tid, tname, awaited in tasks:
id2name[tid] = tname
for stack, parent_id in awaited:
stack = [elem[0] if isinstance(elem, tuple) else elem for elem in stack]
stack = [_format_stack_entry(elem) for elem in stack]
awaits.append((parent_id, stack, tid))
return id2name, awaits

Expand Down Expand Up @@ -106,7 +114,7 @@ def dfs(v):
# ─── PRINT TREE FUNCTION ───────────────────────────────────────
def build_async_tree(result, task_emoji="(T)", cor_emoji=""):
"""
Build a list of strings for pretty-print a async call tree.
Build a list of strings for pretty-print an async call tree.

The call tree is produced by `get_all_async_stacks()`, prefixing tasks
with `task_emoji` and coroutine frames with `cor_emoji`.
Expand Down Expand Up @@ -169,7 +177,7 @@ def build_task_table(result):
return table

def _print_cycle_exception(exception: CycleFoundException):
print("ERROR: await-graph contains cycles – cannot print a tree!", file=sys.stderr)
print("ERROR: await-graph contains cycles - cannot print a tree!", file=sys.stderr)
print("", file=sys.stderr)
for c in exception.cycles:
inames = " → ".join(exception.id2name.get(tid, hex(tid)) for tid in c)
Expand Down
41 changes: 24 additions & 17 deletions Lib/test/test_asyncio/test_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,18 @@
3,
"timer",
[
[["awaiter3", "awaiter2", "awaiter"], 4],
[["awaiter1_3", "awaiter1_2", "awaiter1"], 5],
[["awaiter1_3", "awaiter1_2", "awaiter1"], 6],
[["awaiter3", "awaiter2", "awaiter"], 7],
[[("awaiter3", "/path/to/app.py", 130),
("awaiter2", "/path/to/app.py", 120),
("awaiter", "/path/to/app.py", 110)], 4],
[[("awaiterB3", "/path/to/app.py", 190),
("awaiterB2", "/path/to/app.py", 180),
("awaiterB", "/path/to/app.py", 170)], 5],
[[("awaiterB3", "/path/to/app.py", 190),
("awaiterB2", "/path/to/app.py", 180),
("awaiterB", "/path/to/app.py", 170)], 6],
[[("awaiter3", "/path/to/app.py", 130),
("awaiter2", "/path/to/app.py", 120),
("awaiter", "/path/to/app.py", 110)], 7],
],
),
(
Expand Down Expand Up @@ -91,29 +99,29 @@
" │ └── __aexit__",
" │ └── _aexit",
" │ ├── (T) child1_1",
" │ │ └── awaiter",
" │ │ └── awaiter2",
" │ │ └── awaiter3",
" │ │ └── awaiter /path/to/app.py:110",
" │ │ └── awaiter2 /path/to/app.py:120",
" │ │ └── awaiter3 /path/to/app.py:130",
" │ │ └── (T) timer",
" │ └── (T) child2_1",
" │ └── awaiter1",
" │ └── awaiter1_2",
" │ └── awaiter1_3",
" │ └── awaiterB /path/to/app.py:170",
" │ └── awaiterB2 /path/to/app.py:180",
" │ └── awaiterB3 /path/to/app.py:190",
" │ └── (T) timer",
" └── (T) root2",
" └── bloch",
" └── blocho_caller",
" └── __aexit__",
" └── _aexit",
" ├── (T) child1_2",
" │ └── awaiter",
" │ └── awaiter2",
" │ └── awaiter3",
" │ └── awaiter /path/to/app.py:110",
" │ └── awaiter2 /path/to/app.py:120",
" │ └── awaiter3 /path/to/app.py:130",
" │ └── (T) timer",
" └── (T) child2_2",
" └── awaiter1",
" └── awaiter1_2",
" └── awaiter1_3",
" └── awaiterB /path/to/app.py:170",
" └── awaiterB2 /path/to/app.py:180",
" └── awaiterB3 /path/to/app.py:190",
" └── (T) timer",
]
]
Expand Down Expand Up @@ -589,7 +597,6 @@


class TestAsyncioToolsTree(unittest.TestCase):

def test_asyncio_utils(self):
for input_, tree in TEST_INPUTS_TREE:
with self.subTest(input_):
Expand Down
Loading