Skip to content

gh-134861: Add CSV output format to asyncio ps #134862

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
AA-Turner merged 19 commits into from
Aug 6, 2025
Merged

gh-134861: Add CSV output format to asyncio ps #134862

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
cf70073
Add CSV and 🍌SV output formats to `asyncio ps`
dpdani May 28, 2025
75d0b14
Merge branch 'main' into feature/pending-tasks-csv-bsv
dpdani May 28, 2025
4b77995
Update Lib/asyncio/tools.py
dpdani May 29, 2025
f5132c9
Move table output to separate function
dpdani May 29, 2025
cd11ad7
📜🤖 Added by blurb_it.
blurb-it[bot] May 29, 2025
21b581a
explain why 🍌s are relevant
dpdani May 29, 2025
e44226d
make it a secret 🤫
dpdani May 31, 2025
fe3cf6c
Merge branch 'main' into feature/pending-tasks-csv-bsv
dpdani Jun 20, 2025
58da049
Update Misc/NEWS.d/next/Library/2025-05-29-19-00-37.gh-issue-134861.y…
dpdani Aug 1, 2025
a1f69b6
review
dpdani Aug 1, 2025
60cd13b
review
dpdani Aug 1, 2025
3fd565d
review
dpdani Aug 1, 2025
c38f929
review
dpdani Aug 1, 2025
03c655b
splitting
dpdani Aug 6, 2025
637e7f8
Update Lib/asyncio/tools.py
AA-Turner Aug 6, 2025
8bdfcea
Reintroduce _row_header, add _fmt_table_row() utility
AA-Turner Aug 6, 2025
50fc473
fixup! Reintroduce _row_header, add _fmt_table_row() utility
AA-Turner Aug 6, 2025
9729eeb
whitespace
AA-Turner Aug 6, 2025
0d8d00a
fixup! Reintroduce _row_header, add _fmt_table_row() utility
AA-Turner Aug 6, 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
Prev Previous commit
Next Next commit
Reintroduce _row_header, add _fmt_table_row() utility
  • Loading branch information
@AA-Turner
AA-Turner committed Aug 6, 2025
commit 8bdfceaecf3679ef74910240a98b92129be8a09e
10 changes: 6 additions & 4 deletions Lib/asyncio/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import argparse
import ast
import asyncio
import asyncio.tools
import concurrent.futures
import contextvars
import inspect
Expand All @@ -11,6 +10,9 @@
import threading
import types
import warnings
from asyncio.tools import (TaskTableOutputFormat,
display_awaited_by_tasks_table,
display_awaited_by_tasks_tree)

from _colorize import get_theme
from _pyrepl.console import InteractiveColoredConsole
Expand Down Expand Up @@ -153,7 +155,7 @@ def interrupt(self) -> None:
"ps", help="Display a table of all pending tasks in a process"
)
ps.add_argument("pid", type=int, help="Process ID to inspect")
formats = [fmt.value for fmt in asyncio.tools.TaskTableOutputFormat]
formats = [fmt.value for fmt in TaskTableOutputFormat]
ps.add_argument("--format", choices=formats, default="table")
Comment thread
dpdani marked this conversation as resolved.
pstree = subparsers.add_parser(
"pstree", help="Display a tree of all pending tasks in a process"
Expand All @@ -162,10 +164,10 @@ def interrupt(self) -> None:
args = parser.parse_args()
match args.command:
case "ps":
asyncio.tools.display_awaited_by_tasks_table(args.pid, args.format)
display_awaited_by_tasks_table(args.pid, format=args.format)
sys.exit(0)
case "pstree":
asyncio.tools.display_awaited_by_tasks_tree(args.pid)
display_awaited_by_tasks_tree(args.pid)
sys.exit(0)
case None:
pass # continue to the interactive shell
Expand Down
38 changes: 23 additions & 15 deletions Lib/asyncio/tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
"""Tools to analyze tasks running in asyncio programs."""

from collections import defaultdict, namedtuple
import csv
from itertools import count
from enum import Enum, StrEnum, auto
import sys
from _remote_debugging import RemoteUnwinder, FrameInfo
from collections import defaultdict
from enum import Enum, StrEnum, auto
from itertools import chain, count


class NodeType(Enum):
Expand Down Expand Up @@ -248,28 +248,36 @@ def display_awaited_by_tasks_table(pid, *, format=TaskTableOutputFormat.table):
if format == TaskTableOutputFormat.table:
_display_awaited_by_tasks_table(table)
else:
_display_awaited_by_tasks_csv(table, format)
_display_awaited_by_tasks_csv(table, format=format)


_row_header = ('tid', 'task id', 'task name', 'coroutine stack',
'awaiter chain', 'awaiter name', 'awaiter id')

def _display_awaited_by_tasks_table(table) -> None:
# Print the table in a simple tabular format
print(
f"{'tid':<10} {'task id':<20} {'task name':<20} {'coroutine stack':<50} {'awaiter chain':<50} {'awaiter name':<15} {'awaiter id':<15}"
)
print("-" * 180)

def _display_awaited_by_tasks_table(table):
"""Print the table in a simple tabular format."""
print(_fmt_table_row(*_row_header))
print('-' * 180)
for row in table:
print(f"{row[0]:<10} {row[1]:<20} {row[2]:<20} {row[3]:<50} {row[4]:<50} {row[5]:<15} {row[6]:<15}")
print(_fmt_table_row(*row))


def _fmt_table_row(tid, task_id, task_name, coro_stack,
awaiter_chain, awaiter_name, awaiter_id):
# Format a single row for the table format
return (f'{tid:<10} {task_id:<20} {task_name:<20} {coro_stack:<50} '
f'{awaiter_chain:<50} {awaiter_name:<15} {awaiter_id:<15}')


def _display_awaited_by_tasks_csv(table, format: TaskTableOutputFormat) -> None:
csv_header = ('tid', 'task id', 'task name', 'coroutine stack',
'awaiter chain', 'awaiter name', 'awaiter id')
def _display_awaited_by_tasks_csv(table, *, format):
"""Print the table in CSV format"""
if format == TaskTableOutputFormat.csv:
delimiter = ','
else:
raise ValueError(f"Unknown output format: {format}")
csv_writer = csv.writer(sys.stdout, delimiter=delimiter)
csv_writer.writerow(csv_header)
csv_writer.writerow(_row_header)
csv_writer.writerows(table)


Expand Down
Loading