Skip to content

gh-151213: Document asyncio debugging tools#151392

Merged
pablogsal merged 12 commits into
python:mainfrom
johnslavik:gh-151213-document-asyncio-debugging-tools
Jul 8, 2026
Merged

gh-151213: Document asyncio debugging tools#151392
pablogsal merged 12 commits into
python:mainfrom
johnslavik:gh-151213-document-asyncio-debugging-tools

Conversation

@johnslavik

@johnslavik johnslavik commented Jun 12, 2026

Copy link
Copy Markdown
Member

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jun 12, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jun 12, 2026
@read-the-docs-community

read-the-docs-community Bot commented Jun 12, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33493594 | 📁 Comparing 28ba686 against main (c375992)

  🔍 Preview build  

119 files changed · + 1 added · ± 117 modified · - 1 deleted

+ Added

± Modified

- Deleted

@johnslavik johnslavik added needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Jun 12, 2026
…asyncio-tools

- Rewrite What's New intro to lead with developer problem/value rather
  than "Added a new command-line interface"
- Drop the misleading "remote debugging support" cross-reference from
  both asyncio-tools.rst and What's New; PYTHON_DISABLE_REMOTE_DEBUG
  does not affect RemoteUnwinder-based task introspection
- Document cycle detection under the pstree option in asyncio-tools.rst
  (previously only mentioned in What's New)
@johnslavik

Copy link
Copy Markdown
Member Author

I cut off remote debugging reference for now.

The What's New text was already correct; only asyncio-tools.rst
needed changes.
- Add one-sentence value summary to the module intro
- Document all seven columns of the ps table output
- Note that ps does not perform cycle detection
- Add motivation sentences to both ps and pstree option descriptions
- Document cycle detection behavior under pstree
@johnslavik johnslavik requested a review from pablogsal June 14, 2026 04:32
@johnslavik johnslavik marked this pull request as ready for review June 14, 2026 04:38
@johnslavik johnslavik changed the title gh-151213: Document asyncio introspection tools gh-151213: Document asyncio debugging tools 🍌 Jun 14, 2026
@kumaraditya303

Copy link
Copy Markdown
Contributor

Please don't use emojis for PR titles.

Comment thread Doc/library/asyncio-tools.rst Outdated
Comment thread Doc/library/asyncio-tools.rst
@johnslavik johnslavik changed the title gh-151213: Document asyncio debugging tools 🍌 gh-151213: Document asyncio debugging tools Jun 14, 2026
Co-authored-by: Stan Ulbrych <stan@python.org>

The :mod:`!asyncio` module can be invoked as a script via ``python -m
asyncio`` to inspect the task graph of another running Python process without
modifying it or restarting it. The :mod:`!asyncio.tools` submodule implements

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the submodule is not documented, I'd prefer to keep that private for now

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

In that case, it may be better to document it as private, as currently it is technically public per PEP 387.

@pablogsal pablogsal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Comment thread Doc/library/asyncio-tools.rst Outdated
@pablogsal pablogsal merged commit b2d8db1 into python:main Jul 8, 2026
31 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 8, 2026
@miss-islington-app

Copy link
Copy Markdown

Thanks @johnslavik for the PR, and @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Jul 8, 2026

Copy link
Copy Markdown

GH-153370 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Jul 8, 2026
@bedevere-app

bedevere-app Bot commented Jul 8, 2026

Copy link
Copy Markdown

GH-153371 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 8, 2026
pablogsal pushed a commit that referenced this pull request Jul 8, 2026
gh-151213: Document asyncio debugging tools (GH-151392)
(cherry picked from commit b2d8db1)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
pablogsal pushed a commit that referenced this pull request Jul 8, 2026
gh-151213: Document asyncio debugging tools (GH-151392)
(cherry picked from commit b2d8db1)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
@bedevere-app

bedevere-app Bot commented Jul 9, 2026

Copy link
Copy Markdown

GH-153399 is a backport of this pull request to the 3.14 branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants