Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-29554: Improve docs for pstat module and profile. (#88) 

Clarify that methods take a string which is interpreted as a regex,
not a regex object.

Also clarify what the old `-1`, `0`, `1` and `2` options were.
This commit is contained in:
Matthias Bussonnier 2017-02-20 21:30:00 -08:00 committed by Berker Peksag
parent 112ec38c15
commit 8fb1f6e039
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Doc/library/profile.rst
View File

@ -444,9 +444,10 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
significant entries. Initially, the list is taken to be the complete set significant entries. Initially, the list is taken to be the complete set
of profiled functions. Each restriction is either an integer (to select a of profiled functions. Each restriction is either an integer (to select a
count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to
select a percentage of lines), or a regular expression (to pattern match select a percentage of lines), or a string that will interpreted as a
the standard name that is printed. If several restrictions are provided, regular expression (to pattern match the standard name that is printed).
then they are applied sequentially. For example:: If several restrictions are provided, then they are applied sequentially.
For example::
print_stats(.1, 'foo:') print_stats(.1, 'foo:')

13
Lib/pstats.py
View File

@ -48,11 +48,14 @@ class Stats:
printed. printed.
The sort_stats() method now processes some additional options (i.e., in The sort_stats() method now processes some additional options (i.e., in
addition to the old -1, 0, 1, or 2). It takes an arbitrary number of addition to the old -1, 0, 1, or 2 that are respectively interpreted as
quoted strings to select the sort order. For example sort_stats('time', 'stdname', 'calls', 'time', and 'cumulative'). It takes an arbitrary number
'name') sorts on the major key of 'internal function time', and on the of quoted strings to select the sort order.
minor key of 'the name of the function'. Look at the two tables in
sort_stats() and get_sort_arg_defs(self) for more examples. For example sort_stats('time', 'name') sorts on the major key of 'internal
function time', and on the minor key of 'the name of the function'. Look at
the two tables in sort_stats() and get_sort_arg_defs(self) for more
examples.
All methods return self, so you can string together commands like: All methods return self, so you can string together commands like:
Stats('foo', 'goo').strip_dirs().sort_stats('calls').\ Stats('foo', 'goo').strip_dirs().sort_stats('calls').\