Visitar URL original
bpo-29554: Improve docs for pstat module and profile. (#88) (#227) · python/cpython@b067a5e · GitHub
Skip to content

Commit b067a5e

Browse files
berkerpeksagberkerpeksag
authored
bpo-29554: Improve docs for pstat module and profile. (#88) (#227)
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. (cherry picked from commit 8fb1f6e)
1 parent e9c0e55 commit b067a5e

2 files changed

Lines changed: 12 additions & 8 deletions

File tree

‎Doc/library/profile.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -444,9 +444,10 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
444444
significant entries. Initially, the list is taken to be the complete set
445445
of profiled functions. Each restriction is either an integer (to select a
446446
count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to
447-
select a percentage of lines), or a regular expression (to pattern match
448-
the standard name that is printed. If several restrictions are provided,
449-
then they are applied sequentially. For example::
447+
select a percentage of lines), or a string that will interpreted as a
448+
regular expression (to pattern match the standard name that is printed).
449+
If several restrictions are provided, then they are applied sequentially.
450+
For example::
450451

451452
print_stats(.1, 'foo:')
452453

‎Lib/pstats.py‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,14 @@ class Stats:
4848
printed.
4949
5050
The sort_stats() method now processes some additional options (i.e., in
51-
addition to the old -1, 0, 1, or 2). It takes an arbitrary number of
52-
quoted strings to select the sort order. For example sort_stats('time',
53-
'name') sorts on the major key of 'internal function time', and on the
54-
minor key of 'the name of the function'. Look at the two tables in
55-
sort_stats() and get_sort_arg_defs(self) for more examples.
51+
addition to the old -1, 0, 1, or 2 that are respectively interpreted as
52+
'stdname', 'calls', 'time', and 'cumulative'). It takes an arbitrary number
53+
of quoted strings to select the sort order.
54+
55+
For example sort_stats('time', 'name') sorts on the major key of 'internal
56+
function time', and on the minor key of 'the name of the function'. Look at
57+
the two tables in sort_stats() and get_sort_arg_defs(self) for more
58+
examples.
5659
5760
All methods return self, so you can string together commands like:
5861
Stats('foo', 'goo').strip_dirs().sort_stats('calls').\

0 commit comments

Comments
 (0)