gh-151213: Document asyncio introspection tools#151392
Draft
johnslavik wants to merge 5 commits into
Draft
Conversation
Documentation build overview
7 files changed ·
|
johnslavik
added
needs backport to 3.14
…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)
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I'm currently stuck on the "remote debugging support" part.
Using the
PYTHON_DISABLE_REMOTE_DEBUGenv var,-X disable_remote_debug command-lineCLI knob or--without-remote-debugcompilation flag does not affect theRemoteUnwinder().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 inModules/_remote_debugging/module.c. The security model should also be clearer on what this means. Additionally, the "when to usePYTHON_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