Skip to content

Commit

Permalink
[3.13] gh-130160: use .. program:: directive for documenting `cProf…
Browse files Browse the repository at this point in the history
…ile` CLI (GH-130314) (#130745)

gh-130160: use `.. program::` directive for documenting `cProfile` CLI (GH-130314)
(cherry picked from commit 5181ddb)

Co-authored-by: Apostol Fet <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
  • Loading branch information
4 people authored Mar 1, 2025
1 parent 2d7145d commit 8edf17f
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions Doc/library/profile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,23 +123,32 @@ 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>

Writes the profile results to a file instead of to stdout.

.. option:: -s <sort_order>

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.

``-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.
.. option:: -m <module>

``-m`` specifies that a module is being profiled instead of a script.
Specifies that a module is being profiled instead of a script.

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

.. versionadded:: 3.8
Added the ``-m`` option to :mod:`profile`.
.. 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

0 comments on commit 8edf17f

Please sign in to comment.