Skip to content

gh-151213: Document asyncio introspection tools#151392

Draft
johnslavik wants to merge 2 commits into
python:mainfrom
johnslavik:gh-151213-document-asyncio-debugging-tools
Draft

gh-151213: Document asyncio introspection tools#151392
johnslavik wants to merge 2 commits into
python:mainfrom
johnslavik:gh-151213-document-asyncio-debugging-tools

Conversation

@johnslavik

@johnslavik johnslavik commented Jun 12, 2026

Copy link
Copy Markdown
Member

I'm currently stuck on the "remote debugging support" part.

Using the PYTHON_DISABLE_REMOTE_DEBUG env var, -X disable_remote_debug command-line CLI knob or --without-remote-debug compilation flag does not affect the RemoteUnwinder().get_all_awaited_by() API (that asyncio tools use) at all, so even mentioning "remote debugging support" is too vague, borderline incorrect.

On a side note, I think it would be nice to clarify that "remote debugging support" in https://docs.python.org/3/howto/remote_debugging.html#disabling-remote-debugging strictly means the execution API (sys.remote_exec), not necessarily the rest of the pieces defined in Modules/_remote_debugging/module.c. The security model should also be clearer on what this means. Additionally, the "when to use PYTHON_DISABLE_REMOTE_DEBUG" section is bottom of the page and could be merged with (or at least linked by) the section on disabling remote debugging at the top of the page to increase info locality. -- I'll make a separate issue to address all three observations.

cc @pablogsal

@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 #33108101 | 📁 Comparing 2a8afdf against main (c375992)

  🔍 Preview build  

3 files changed
+ library/asyncio-tools.html
± library/asyncio-graph.html
± library/asyncio.html

@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
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 needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant