FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.13] gh-130160: use `.. program::` directive for documenting `cProfile` CLI (GH-130314) by miss-islington · Pull Request #130745 · python/cpython · GitHub

/ cpython Public

[3.13] gh-130160: use .. program:: directive for documenting cProfile CLI (GH-130314) #130745

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
sobolevn merged 1 commit into from
Mar 1, 2025
+17 −8
Conversation 0 Commits 1 Checks 0 Files changed 1
Merged

[3.13] gh-130160: use .. program:: directive for documenting cProfile CLI (GH-130314) #130745

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
25 changes: 17 additions & 8 deletions Doc/library/profile.rst
Show comments
View file
Open in desktop
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
Show hidden characters
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
Back | FazBrowse Home | New Git URL