mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 16:39:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

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

Co-authored-by: Apostol Fet <90645107+ApostolFet@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2025-03-01 21:45:33 +01:00 • committed by GitHub
parent 2d7145decb
commit 8edf17f260
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Doc/library/profile.rst
View file

@ -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>
``-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::