Skip to content

gh-130160: use .. program:: directive for documenting cProfile CLI #130314

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 5 commits into from
Mar 1, 2025
Merged

gh-130160: use .. program:: directive for documenting cProfile CLI #130314

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2cea6bf
use .. program:: directive for documenting cProfile CLI
ApostolFet Feb 19, 2025
77003de
Move versionadded in -m section
ApostolFet Feb 20, 2025
cd6d47b
Update Doc/library/profile.rst
ApostolFet Feb 21, 2025
ab125ed
Update Doc/library/profile.rst
ApostolFet Feb 23, 2025
5ab85db
Update Doc/library/profile.rst
ApostolFet Feb 23, 2025
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
23 changes: 15 additions & 8 deletions Doc/library/profile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,24 +122,31 @@ The :class:`pstats.Stats` class reads profile results from a file and formats
them in various ways.

.. _profile-cli:
.. program:: cProfile

The files :mod:`cProfile` and :mod:`profile` can also be invoked as a script to
profile another script. For example::

python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)

``-o`` writes the profile results to a file instead of to stdout
.. option:: -o <output_file>

``-s`` specifies one of the :func:`~pstats.Stats.sort_stats` sort values to sort
the output by. This only applies when ``-o`` is not supplied.
Writes the profile results to a file instead of to stdout.

``-m`` specifies that a module is being profiled instead of a script.
.. option:: -s <sort_order>

.. versionadded:: 3.7
Added the ``-m`` option to :mod:`cProfile`.
Specifies one of the :func:`~pstats.Stats.sort_stats` sort values to sort
the output by. This only applies when :option:`-o <cProfile -o>` is not supplied.

.. versionadded:: 3.8
Added the ``-m`` option to :mod:`profile`.
.. option:: -m <module>

Specifies that a module is being profiled instead of a script.

.. versionadded:: 3.7
Added the ``-m`` option to :mod:`cProfile`.

.. versionadded:: 3.8
Added the ``-m`` option to :mod:`profile`.

The :mod:`pstats` module's :class:`~pstats.Stats` class has a variety of methods
for manipulating and printing the data saved into a profile results file::
Expand Down
Loading