Skip to content

bpo-46072: Document --enable-stats option. #30139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 16, 2021
Merged

bpo-46072: Document --enable-stats option. #30139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0253c3
Document --enable-stats option.
markshannon Dec 16, 2021
e294b0f
Fix formatting
markshannon Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Doc/using/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,17 @@ General Options

.. versionadded:: 3.11

.. cmdoption:: --enable-pystats
Copy link
Member

Choose a reason for hiding this comment

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

342b93f says --with-pystats. Which one is correct?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is. @tiran requested that it was changed to --enable-pystats


Turn on internal statistics gathering.
Copy link
Member

Choose a reason for hiding this comment

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

Would you mind to give a more more details? In the issue, you wrote: "Currently various parts of the VM gather stats: the GC, dicts, the bytecode interpreter, type lookup cache, etc.".

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd rather not because, as it says, they are internal. We may well add or remove stats when we need them and this documentation will end up being a pain to maintain or just wrong.


The statistics will be dumped to a arbitrary (probably unique) file in
``/tmp/py_stats/``, or ``C:\temp\py_stats\`` on Windows.

Use ``Tools//summarize_stats.py`` to read the stats.

.. versionadded:: 3.11


Install Options
---------------
Expand Down
0 ...scripts/summarize_specialization_stats.py → Tools/scripts/summarize_stats.py
View file
Open in desktop
File renamed without changes.