gh-142927: Clarify pstats file output in docs and CLI - #143388
Merged
pablogsal merged 1 commit intoJan 3, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Comment thread
Doc/library/profiling.sampling.rst
Outdated
| ``<format>_<PID>.<ext>`` (for example, ``flamegraph_12345.html``). | ||
| :option:`--heatmap` creates a directory named ``heatmap_<PID>``. | ||
|
|
||
|
|
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Suggested change
Sorry, something went wrong.
When running the `profiling.sampling` module in pstats mode, the output can be emitted in two different ways: text to stdout or a binary file when the `--output` argument is set. The current documentation and help text is confusing as it does not distinguish between these two output formats so it may be surprising to the user to get different formats depending whether `--output` is set or not.
lkollar
force-pushed
the
profiling/docs-fix
branch
from
b1aec93 to
ed314a3
Compare
January 3, 2026 18:26
pablogsal
approved these changes
Jan 3, 2026
thunder-coding
pushed a commit
to thunder-coding/cpython
that referenced
this pull request
Feb 15, 2026
…43388) When running the `profiling.sampling` module in pstats mode, the output can be emitted in two different ways: text to stdout or a binary file when the `--output` argument is set. The current documentation and help text is confusing as it does not distinguish between these two output formats so it may be surprising to the user to get different formats depending whether `--output` is set or not.
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
Reviewers
3 participants
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.
When running the profiling.sampling module in pstats mode, the output can be emitted in two different ways: text to stdout or a binary file when the --output argument is set.
The current documentation and help text is confusing as it does not distinguish between these two output formats so it may be surprising to the user to get different formats depending whether --output is set or not.
📚 Documentation preview 📚: https://cpython-previews--143388.org.readthedocs.build/