gh-134861: Add CSV output format to `python -m asyncio ps` (#134862)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Daniele Parmeggiani 2025-08-06 22:10:40 +02:00 committed by GitHub
parent 0953200b13
commit 470cbe97a5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 51 additions and 12 deletions

View file

@ -1,8 +1,9 @@
"""Tools to analyze tasks running in asyncio programs."""
from collections import defaultdict, namedtuple
from collections import defaultdict
import csv
from itertools import count
from enum import Enum
from enum import Enum, StrEnum, auto
import sys
from _remote_debugging import RemoteUnwinder, FrameInfo
@ -232,18 +233,51 @@ def _get_awaited_by_tasks(pid: int) -> list:
sys.exit(1)
def display_awaited_by_tasks_table(pid: int) -> None:
class TaskTableOutputFormat(StrEnum):
table = auto()
csv = auto()
def display_awaited_by_tasks_table(pid, *, format=TaskTableOutputFormat.table):
"""Build and print a table of all pending tasks under `pid`."""
tasks = _get_awaited_by_tasks(pid)
table = build_task_table(tasks)
# 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)
format = TaskTableOutputFormat(format)
if format == TaskTableOutputFormat.table:
_display_awaited_by_tasks_table(table)
else:
_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):
"""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):
"""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(_row_header)
csv_writer.writerows(table)
def display_awaited_by_tasks_tree(pid: int) -> None: