summaryrefslogtreecommitdiffstats
path: root/Lib/pstats.py
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2017-02-22 01:55:33 (GMT)
committerGitHub <noreply@github.com>2017-02-22 01:55:33 (GMT)
commitb067a5eef7fdf69264d3578654996fc3755df4ea (patch)
treec8717df91dfedb5b4d029be6caddd3683ebb6c70 /Lib/pstats.py
parente9c0e5559bbadb164d7c57b5a47b5544746dcb89 (diff)
downloadcpython-b067a5eef7fdf69264d3578654996fc3755df4ea.zip
cpython-b067a5eef7fdf69264d3578654996fc3755df4ea.tar.gz
cpython-b067a5eef7fdf69264d3578654996fc3755df4ea.tar.bz2
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 8fb1f6e039cbdeb333d83b7a62f0f37af4ce6e02)
Diffstat (limited to 'Lib/pstats.py')
-rw-r--r--Lib/pstats.py13
1 files changed, 8 insertions, 5 deletions
diff --git a/Lib/pstats.py b/Lib/pstats.py
index d861413..2c5bf98 100644
--- a/Lib/pstats.py
+++ b/Lib/pstats.py
@@ -48,11 +48,14 @@ class Stats:
printed.
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
- quoted strings to select the sort order. 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.
+ addition to the old -1, 0, 1, or 2 that are respectively interpreted as
+ 'stdname', 'calls', 'time', and 'cumulative'). It takes an arbitrary number
+ of quoted strings to select the sort order.
+
+ 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:
Stats('foo', 'goo').strip_dirs().sort_stats('calls').\