From b1e98abeb09c1c8031cda5a1b9ca24e768a5b532 Mon Sep 17 00:00:00 2001 From: Apostol Fet <90645107+ApostolFet@users.noreply.github.com> Date: Sat, 1 Mar 2025 23:39:25 +0300 Subject: [PATCH] gh-130160: use `.. program::` directive for documenting `cProfile` CLI (GH-130314) (cherry picked from commit 5181ddb29f969c1718f3f4f9618c260807b2886c) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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> --- Doc/library/profile.rst | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst index b89655ea472dee..a2887c59283227 100644 --- a/Doc/library/profile.rst +++ b/Doc/library/profile.rst @@ -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 + + Writes the profile results to a file instead of to stdout. + +.. option:: -s + + Specifies one of the :func:`~pstats.Stats.sort_stats` sort values + to sort the output by. + This only applies when :option:`-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 -``-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::