From 2929235cfc40c4198b3a014dbbf5a352412d7e0e Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Mon, 13 Feb 2017 21:55:18 -0800 Subject: [PATCH 1/2] Improve docs for pstat module and profile. Clarify that methods takes a string which is interpreted as a re, and not a re object. Clarify what the old `-1`, `0`, `1` and `2` option were. --- Doc/library/profile.rst | 2 +- Lib/pstats.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst index 959d9b98a84691..9b8246de8cf745 100644 --- a/Doc/library/profile.rst +++ b/Doc/library/profile.rst @@ -444,7 +444,7 @@ 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 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 - 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 regular expression (to pattern match the standard name that is printed. If several restrictions are provided, then they are applied sequentially. For example:: diff --git a/Lib/pstats.py b/Lib/pstats.py index d861413d4195f7..f257b6e2546d7e 100644 --- a/Lib/pstats.py +++ b/Lib/pstats.py @@ -48,7 +48,7 @@ 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 + 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 From 29c6e72d1e68d4f91e7cc4c9b736c2c9389bd635 Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Mon, 13 Feb 2017 21:55:54 -0800 Subject: [PATCH 2/2] Rewrap paragraph Re wrap as a second commit, to make review easier. --- Doc/library/profile.rst | 7 ++++--- Lib/pstats.py | 13 ++++++++----- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst index 9b8246de8cf745..bd67fe486abf77 100644 --- a/Doc/library/profile.rst +++ b/Doc/library/profile.rst @@ -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 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 - select a percentage of lines), or a string that will interpreted as a regular expression (to pattern match - the standard name that is printed. If several restrictions are provided, - then they are applied sequentially. For example:: + select a percentage of lines), or a string that will interpreted as a + regular expression (to pattern match the standard name that is printed). + If several restrictions are provided, then they are applied sequentially. + For example:: print_stats(.1, 'foo:') diff --git a/Lib/pstats.py b/Lib/pstats.py index f257b6e2546d7e..2c5bf981b85cf8 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 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. + 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').\