Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 1 | """Class for printing reports on profiled python code.""" |
| 2 | |
Benjamin Peterson | 8d77069 | 2011-06-27 09:14:34 -0500 | [diff] [blame] | 3 | # Written by James Roskind |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 4 | # Based on prior profile module by Sjoerd Mullender... |
| 5 | # which was hacked somewhat by: Guido van Rossum |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 6 | |
Benjamin Peterson | 8d77069 | 2011-06-27 09:14:34 -0500 | [diff] [blame] | 7 | # Copyright Disney Enterprises, Inc. All Rights Reserved. |
| 8 | # Licensed to PSF under a Contributor Agreement |
Benjamin Peterson | 0f93d3d | 2011-06-27 09:18:46 -0500 | [diff] [blame] | 9 | # |
Benjamin Peterson | 8d77069 | 2011-06-27 09:14:34 -0500 | [diff] [blame] | 10 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 11 | # you may not use this file except in compliance with the License. |
| 12 | # You may obtain a copy of the License at |
Benjamin Peterson | 0f93d3d | 2011-06-27 09:18:46 -0500 | [diff] [blame] | 13 | # |
Benjamin Peterson | 8d77069 | 2011-06-27 09:14:34 -0500 | [diff] [blame] | 14 | # http://www.apache.org/licenses/LICENSE-2.0 |
Benjamin Peterson | 0f93d3d | 2011-06-27 09:18:46 -0500 | [diff] [blame] | 15 | # |
Benjamin Peterson | 8d77069 | 2011-06-27 09:14:34 -0500 | [diff] [blame] | 16 | # Unless required by applicable law or agreed to in writing, software |
| 17 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 18 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, |
| 19 | # either express or implied. See the License for the specific language |
| 20 | # governing permissions and limitations under the License. |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 21 | |
| 22 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 23 | import sys |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 24 | import os |
| 25 | import time |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 26 | import marshal |
Guido van Rossum | 9694fca | 1997-10-22 21:00:49 +0000 | [diff] [blame] | 27 | import re |
Daniel Olshansky | 01602ae | 2020-01-15 17:51:54 -0500 | [diff] [blame] | 28 | |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 29 | from enum import Enum |
Raymond Hettinger | c50846a | 2010-04-05 18:56:31 +0000 | [diff] [blame] | 30 | from functools import cmp_to_key |
Daniel Olshansky | 01602ae | 2020-01-15 17:51:54 -0500 | [diff] [blame] | 31 | from dataclasses import dataclass |
| 32 | from typing import Dict |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 33 | |
Daniel Olshansky | 01602ae | 2020-01-15 17:51:54 -0500 | [diff] [blame] | 34 | __all__ = ["Stats", "SortKey", "FunctionProfile", "StatsProfile"] |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 35 | |
| 36 | class SortKey(str, Enum): |
| 37 | CALLS = 'calls', 'ncalls' |
| 38 | CUMULATIVE = 'cumulative', 'cumtime' |
| 39 | FILENAME = 'filename', 'module' |
| 40 | LINE = 'line' |
| 41 | NAME = 'name' |
| 42 | NFL = 'nfl' |
| 43 | PCALLS = 'pcalls' |
| 44 | STDNAME = 'stdname' |
| 45 | TIME = 'time', 'tottime' |
| 46 | |
| 47 | def __new__(cls, *values): |
| 48 | obj = str.__new__(cls) |
| 49 | |
| 50 | obj._value_ = values[0] |
| 51 | for other_value in values[1:]: |
| 52 | cls._value2member_map_[other_value] = obj |
| 53 | obj._all_values = values |
| 54 | return obj |
| 55 | |
Skip Montanaro | c62c81e | 2001-02-12 02:00:42 +0000 | [diff] [blame] | 56 | |
Daniel Olshansky | 01602ae | 2020-01-15 17:51:54 -0500 | [diff] [blame] | 57 | @dataclass(unsafe_hash=True) |
| 58 | class FunctionProfile: |
| 59 | ncalls: int |
| 60 | tottime: float |
| 61 | percall_tottime: float |
| 62 | cumtime: float |
| 63 | percall_cumtime: float |
| 64 | file_name: str |
| 65 | line_number: int |
| 66 | |
| 67 | @dataclass(unsafe_hash=True) |
| 68 | class StatsProfile: |
| 69 | '''Class for keeping track of an item in inventory.''' |
| 70 | total_tt: float |
| 71 | func_profiles: Dict[str, FunctionProfile] |
| 72 | |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 73 | class Stats: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 74 | """This class is used for creating reports from data generated by the |
| 75 | Profile class. It is a "friend" of that class, and imports data either |
| 76 | by direct access to members of Profile class, or by reading in a dictionary |
| 77 | that was emitted (via marshal) from the Profile class. |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 78 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 79 | The big change from the previous Profiler (in terms of raw functionality) |
| 80 | is that an "add()" method has been provided to combine Stats from |
| 81 | several distinct profile runs. Both the constructor and the add() |
| 82 | method now take arbitrarily many file names as arguments. |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 83 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 84 | All the print methods now take an argument that indicates how many lines |
| 85 | to print. If the arg is a floating point number between 0 and 1.0, then |
| 86 | it is taken as a decimal percentage of the available lines to be printed |
| 87 | (e.g., .1 means print 10% of all available lines). If it is an integer, |
| 88 | it is taken to mean the number of lines of data that you wish to have |
| 89 | printed. |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 90 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 91 | The sort_stats() method now processes some additional options (i.e., in |
Matthias Bussonnier | 8fb1f6e | 2017-02-20 21:30:00 -0800 | [diff] [blame] | 92 | addition to the old -1, 0, 1, or 2 that are respectively interpreted as |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 93 | 'stdname', 'calls', 'time', and 'cumulative'). It takes either an |
| 94 | arbitrary number of quoted strings or SortKey enum to select the sort |
| 95 | order. |
Matthias Bussonnier | 8fb1f6e | 2017-02-20 21:30:00 -0800 | [diff] [blame] | 96 | |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 97 | For example sort_stats('time', 'name') or sort_stats(SortKey.TIME, |
| 98 | SortKey.NAME) sorts on the major key of 'internal function time', and on |
| 99 | the minor key of 'the name of the function'. Look at the two tables in |
| 100 | sort_stats() and get_sort_arg_defs(self) for more examples. |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 101 | |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 102 | All methods return self, so you can string together commands like: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 103 | Stats('foo', 'goo').strip_dirs().sort_stats('calls').\ |
| 104 | print_stats(5).print_callers(5) |
| 105 | """ |
| 106 | |
Georg Brandl | 7837a96 | 2009-09-02 20:33:30 +0000 | [diff] [blame] | 107 | def __init__(self, *args, stream=None): |
| 108 | self.stream = stream or sys.stdout |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 109 | if not len(args): |
| 110 | arg = None |
| 111 | else: |
| 112 | arg = args[0] |
| 113 | args = args[1:] |
| 114 | self.init(arg) |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 115 | self.add(*args) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 116 | |
| 117 | def init(self, arg): |
| 118 | self.all_callees = None # calc only if needed |
| 119 | self.files = [] |
| 120 | self.fcn_list = None |
| 121 | self.total_tt = 0 |
| 122 | self.total_calls = 0 |
| 123 | self.prim_calls = 0 |
| 124 | self.max_name_len = 0 |
Georg Brandl | eb7e569 | 2010-10-22 06:29:21 +0000 | [diff] [blame] | 125 | self.top_level = set() |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 126 | self.stats = {} |
| 127 | self.sort_arg_dict = {} |
| 128 | self.load_stats(arg) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 129 | try: |
| 130 | self.get_top_level_stats() |
Georg Brandl | 9a8439d | 2010-10-22 06:35:59 +0000 | [diff] [blame] | 131 | except Exception: |
| 132 | print("Invalid timing data %s" % |
| 133 | (self.files[-1] if self.files else ''), file=self.stream) |
| 134 | raise |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 135 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 136 | def load_stats(self, arg): |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 137 | if arg is None: |
| 138 | self.stats = {} |
| 139 | return |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 140 | elif isinstance(arg, str): |
Giampaolo Rodola' | 2f50aaf | 2013-02-12 02:04:27 +0100 | [diff] [blame] | 141 | with open(arg, 'rb') as f: |
| 142 | self.stats = marshal.load(f) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 143 | try: |
| 144 | file_stats = os.stat(arg) |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 145 | arg = time.ctime(file_stats.st_mtime) + " " + arg |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 146 | except: # in case this is not unix |
| 147 | pass |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 148 | self.files = [arg] |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 149 | elif hasattr(arg, 'create_stats'): |
| 150 | arg.create_stats() |
| 151 | self.stats = arg.stats |
| 152 | arg.stats = {} |
| 153 | if not self.stats: |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 154 | raise TypeError("Cannot create or construct a %r object from %r" |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 155 | % (self.__class__, arg)) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 156 | return |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 157 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 158 | def get_top_level_stats(self): |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 159 | for func, (cc, nc, tt, ct, callers) in self.stats.items(): |
| 160 | self.total_calls += nc |
| 161 | self.prim_calls += cc |
| 162 | self.total_tt += tt |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 163 | if ("jprofile", 0, "profiler") in callers: |
Georg Brandl | eb7e569 | 2010-10-22 06:29:21 +0000 | [diff] [blame] | 164 | self.top_level.add(func) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 165 | if len(func_std_string(func)) > self.max_name_len: |
| 166 | self.max_name_len = len(func_std_string(func)) |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 167 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 168 | def add(self, *arg_list): |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 169 | if not arg_list: |
| 170 | return self |
| 171 | for item in reversed(arg_list): |
| 172 | if type(self) != type(item): |
| 173 | item = Stats(item) |
| 174 | self.files += item.files |
| 175 | self.total_calls += item.total_calls |
| 176 | self.prim_calls += item.prim_calls |
| 177 | self.total_tt += item.total_tt |
| 178 | for func in item.top_level: |
Georg Brandl | eb7e569 | 2010-10-22 06:29:21 +0000 | [diff] [blame] | 179 | self.top_level.add(func) |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 180 | |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 181 | if self.max_name_len < item.max_name_len: |
| 182 | self.max_name_len = item.max_name_len |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 183 | |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 184 | self.fcn_list = None |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 185 | |
Georg Brandl | 8393843 | 2010-10-22 06:28:01 +0000 | [diff] [blame] | 186 | for func, stat in item.stats.items(): |
| 187 | if func in self.stats: |
| 188 | old_func_stat = self.stats[func] |
| 189 | else: |
| 190 | old_func_stat = (0, 0, 0, 0, {},) |
| 191 | self.stats[func] = add_func_stats(old_func_stat, stat) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 192 | return self |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 193 | |
Fred Drake | 9c43910 | 2003-05-14 14:28:09 +0000 | [diff] [blame] | 194 | def dump_stats(self, filename): |
| 195 | """Write the profile data to a file we know how to load back.""" |
Giampaolo Rodola' | 2f50aaf | 2013-02-12 02:04:27 +0100 | [diff] [blame] | 196 | with open(filename, 'wb') as f: |
Fred Drake | 9c43910 | 2003-05-14 14:28:09 +0000 | [diff] [blame] | 197 | marshal.dump(self.stats, f) |
Fred Drake | 9c43910 | 2003-05-14 14:28:09 +0000 | [diff] [blame] | 198 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 199 | # list the tuple indices and directions for sorting, |
| 200 | # along with some printable description |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 201 | sort_arg_dict_default = { |
| 202 | "calls" : (((1,-1), ), "call count"), |
Andrew Svetlov | c3e5b10 | 2012-10-07 19:18:39 +0300 | [diff] [blame] | 203 | "ncalls" : (((1,-1), ), "call count"), |
| 204 | "cumtime" : (((3,-1), ), "cumulative time"), |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 205 | "cumulative": (((3,-1), ), "cumulative time"), |
Andrew Svetlov | c3e5b10 | 2012-10-07 19:18:39 +0300 | [diff] [blame] | 206 | "filename" : (((4, 1), ), "file name"), |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 207 | "line" : (((5, 1), ), "line number"), |
| 208 | "module" : (((4, 1), ), "file name"), |
| 209 | "name" : (((6, 1), ), "function name"), |
| 210 | "nfl" : (((6, 1),(4, 1),(5, 1),), "name/file/line"), |
Andrew Svetlov | 2ef4584 | 2012-10-07 18:58:42 +0300 | [diff] [blame] | 211 | "pcalls" : (((0,-1), ), "primitive call count"), |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 212 | "stdname" : (((7, 1), ), "standard name"), |
| 213 | "time" : (((2,-1), ), "internal time"), |
Andrew Svetlov | c3e5b10 | 2012-10-07 19:18:39 +0300 | [diff] [blame] | 214 | "tottime" : (((2,-1), ), "internal time"), |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 215 | } |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 216 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 217 | def get_sort_arg_defs(self): |
| 218 | """Expand all abbreviations that are unique.""" |
| 219 | if not self.sort_arg_dict: |
| 220 | self.sort_arg_dict = dict = {} |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 221 | bad_list = {} |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 222 | for word, tup in self.sort_arg_dict_default.items(): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 223 | fragment = word |
| 224 | while fragment: |
| 225 | if not fragment: |
| 226 | break |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 227 | if fragment in dict: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 228 | bad_list[fragment] = 0 |
| 229 | break |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 230 | dict[fragment] = tup |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 231 | fragment = fragment[:-1] |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 232 | for word in bad_list: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 233 | del dict[word] |
| 234 | return self.sort_arg_dict |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 235 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 236 | def sort_stats(self, *field): |
| 237 | if not field: |
| 238 | self.fcn_list = 0 |
| 239 | return self |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 240 | if len(field) == 1 and isinstance(field[0], int): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 241 | # Be compatible with old profiler |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 242 | field = [ {-1: "stdname", |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 243 | 0: "calls", |
| 244 | 1: "time", |
| 245 | 2: "cumulative"}[field[0]] ] |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 246 | elif len(field) >= 2: |
| 247 | for arg in field[1:]: |
| 248 | if type(arg) != type(field[0]): |
| 249 | raise TypeError("Can't have mixed argument type") |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 250 | |
| 251 | sort_arg_defs = self.get_sort_arg_defs() |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 252 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 253 | sort_tuple = () |
| 254 | self.sort_type = "" |
| 255 | connector = "" |
| 256 | for word in field: |
mwidjaja | 863b1e4 | 2018-01-25 20:49:56 -0800 | [diff] [blame] | 257 | if isinstance(word, SortKey): |
| 258 | word = word.value |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 259 | sort_tuple = sort_tuple + sort_arg_defs[word][0] |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 260 | self.sort_type += connector + sort_arg_defs[word][1] |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 261 | connector = ", " |
| 262 | |
| 263 | stats_list = [] |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 264 | for func, (cc, nc, tt, ct, callers) in self.stats.items(): |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 265 | stats_list.append((cc, nc, tt, ct) + func + |
| 266 | (func_std_string(func), func)) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 267 | |
Raymond Hettinger | c50846a | 2010-04-05 18:56:31 +0000 | [diff] [blame] | 268 | stats_list.sort(key=cmp_to_key(TupleComp(sort_tuple).compare)) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 269 | |
| 270 | self.fcn_list = fcn_list = [] |
| 271 | for tuple in stats_list: |
| 272 | fcn_list.append(tuple[-1]) |
| 273 | return self |
| 274 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 275 | def reverse_order(self): |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 276 | if self.fcn_list: |
| 277 | self.fcn_list.reverse() |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 278 | return self |
| 279 | |
| 280 | def strip_dirs(self): |
| 281 | oldstats = self.stats |
| 282 | self.stats = newstats = {} |
| 283 | max_name_len = 0 |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 284 | for func, (cc, nc, tt, ct, callers) in oldstats.items(): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 285 | newfunc = func_strip_path(func) |
| 286 | if len(func_std_string(newfunc)) > max_name_len: |
| 287 | max_name_len = len(func_std_string(newfunc)) |
| 288 | newcallers = {} |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 289 | for func2, caller in callers.items(): |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 290 | newcallers[func_strip_path(func2)] = caller |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 291 | |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 292 | if newfunc in newstats: |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 293 | newstats[newfunc] = add_func_stats( |
| 294 | newstats[newfunc], |
| 295 | (cc, nc, tt, ct, newcallers)) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 296 | else: |
| 297 | newstats[newfunc] = (cc, nc, tt, ct, newcallers) |
| 298 | old_top = self.top_level |
Georg Brandl | eb7e569 | 2010-10-22 06:29:21 +0000 | [diff] [blame] | 299 | self.top_level = new_top = set() |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 300 | for func in old_top: |
Georg Brandl | eb7e569 | 2010-10-22 06:29:21 +0000 | [diff] [blame] | 301 | new_top.add(func_strip_path(func)) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 302 | |
| 303 | self.max_name_len = max_name_len |
| 304 | |
| 305 | self.fcn_list = None |
| 306 | self.all_callees = None |
| 307 | return self |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 308 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 309 | def calc_callees(self): |
Georg Brandl | 9a8439d | 2010-10-22 06:35:59 +0000 | [diff] [blame] | 310 | if self.all_callees: |
| 311 | return |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 312 | self.all_callees = all_callees = {} |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 313 | for func, (cc, nc, tt, ct, callers) in self.stats.items(): |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 314 | if not func in all_callees: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 315 | all_callees[func] = {} |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 316 | for func2, caller in callers.items(): |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 317 | if not func2 in all_callees: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 318 | all_callees[func2] = {} |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 319 | all_callees[func2][func] = caller |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 320 | return |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 321 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 322 | #****************************************************************** |
| 323 | # The following functions support actual printing of reports |
| 324 | #****************************************************************** |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 325 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 326 | # Optional "amount" is either a line count, or a percentage of lines. |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 327 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 328 | def eval_print_amount(self, sel, list, msg): |
| 329 | new_list = list |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 330 | if isinstance(sel, str): |
| 331 | try: |
| 332 | rex = re.compile(sel) |
| 333 | except re.error: |
| 334 | msg += " <Invalid regular expression %r>\n" % sel |
| 335 | return new_list, msg |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 336 | new_list = [] |
| 337 | for func in list: |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 338 | if rex.search(func_std_string(func)): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 339 | new_list.append(func) |
| 340 | else: |
| 341 | count = len(list) |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 342 | if isinstance(sel, float) and 0.0 <= sel < 1.0: |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 343 | count = int(count * sel + .5) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 344 | new_list = list[:count] |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 345 | elif isinstance(sel, int) and 0 <= sel < count: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 346 | count = sel |
| 347 | new_list = list[:count] |
| 348 | if len(list) != len(new_list): |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 349 | msg += " List reduced from %r to %r due to restriction <%r>\n" % ( |
| 350 | len(list), len(new_list), sel) |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 351 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 352 | return new_list, msg |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 353 | |
Daniel Olshansky | 01602ae | 2020-01-15 17:51:54 -0500 | [diff] [blame] | 354 | def get_stats_profile(self): |
| 355 | """This method returns an instance of StatsProfile, which contains a mapping |
| 356 | of function names to instances of FunctionProfile. Each FunctionProfile |
| 357 | instance holds information related to the function's profile such as how |
| 358 | long the function took to run, how many times it was called, etc... |
| 359 | """ |
| 360 | func_list = self.fcn_list[:] if self.fcn_list else list(self.stats.keys()) |
| 361 | if not func_list: |
| 362 | return StatsProfile(0, {}) |
| 363 | |
| 364 | total_tt = float(f8(self.total_tt)) |
| 365 | func_profiles = {} |
| 366 | stats_profile = StatsProfile(total_tt, func_profiles) |
| 367 | |
| 368 | for func in func_list: |
| 369 | cc, nc, tt, ct, callers = self.stats[func] |
| 370 | file_name, line_number, func_name = func |
| 371 | ncalls = str(nc) if nc == cc else (str(nc) + '/' + str(cc)) |
| 372 | tottime = float(f8(tt)) |
| 373 | percall_tottime = -1 if nc == 0 else float(f8(tt/nc)) |
| 374 | cumtime = float(f8(ct)) |
| 375 | percall_cumtime = -1 if cc == 0 else float(f8(ct/cc)) |
| 376 | func_profile = FunctionProfile( |
| 377 | ncalls, |
| 378 | tottime, # time spent in this function alone |
| 379 | percall_tottime, |
| 380 | cumtime, # time spent in the function plus all functions that this function called, |
| 381 | percall_cumtime, |
| 382 | file_name, |
| 383 | line_number |
| 384 | ) |
| 385 | func_profiles[func_name] = func_profile |
| 386 | |
| 387 | return stats_profile |
| 388 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 389 | def get_print_list(self, sel_list): |
| 390 | width = self.max_name_len |
| 391 | if self.fcn_list: |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 392 | stat_list = self.fcn_list[:] |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 393 | msg = " Ordered by: " + self.sort_type + '\n' |
| 394 | else: |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 395 | stat_list = list(self.stats.keys()) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 396 | msg = " Random listing order was used\n" |
| 397 | |
| 398 | for selection in sel_list: |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 399 | stat_list, msg = self.eval_print_amount(selection, stat_list, msg) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 400 | |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 401 | count = len(stat_list) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 402 | |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 403 | if not stat_list: |
| 404 | return 0, stat_list |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 405 | print(msg, file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 406 | if count < len(self.stats): |
| 407 | width = 0 |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 408 | for func in stat_list: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 409 | if len(func_std_string(func)) > width: |
| 410 | width = len(func_std_string(func)) |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 411 | return width+2, stat_list |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 412 | |
| 413 | def print_stats(self, *amount): |
| 414 | for filename in self.files: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 415 | print(filename, file=self.stream) |
Georg Brandl | 9a8439d | 2010-10-22 06:35:59 +0000 | [diff] [blame] | 416 | if self.files: |
| 417 | print(file=self.stream) |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 418 | indent = ' ' * 8 |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 419 | for func in self.top_level: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 420 | print(indent, func_get_function_name(func), file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 421 | |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 422 | print(indent, self.total_calls, "function calls", end=' ', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 423 | if self.total_calls != self.prim_calls: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 424 | print("(%d primitive calls)" % self.prim_calls, end=' ', file=self.stream) |
Senthil Kumaran | 5e703cf | 2010-11-20 17:02:50 +0000 | [diff] [blame] | 425 | print("in %.3f seconds" % self.total_tt, file=self.stream) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 426 | print(file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 427 | width, list = self.get_print_list(amount) |
| 428 | if list: |
| 429 | self.print_title() |
| 430 | for func in list: |
| 431 | self.print_line(func) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 432 | print(file=self.stream) |
| 433 | print(file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 434 | return self |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 435 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 436 | def print_callees(self, *amount): |
| 437 | width, list = self.get_print_list(amount) |
| 438 | if list: |
| 439 | self.calc_callees() |
| 440 | |
| 441 | self.print_call_heading(width, "called...") |
| 442 | for func in list: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 443 | if func in self.all_callees: |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 444 | self.print_call_line(width, func, self.all_callees[func]) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 445 | else: |
| 446 | self.print_call_line(width, func, {}) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 447 | print(file=self.stream) |
| 448 | print(file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 449 | return self |
| 450 | |
| 451 | def print_callers(self, *amount): |
| 452 | width, list = self.get_print_list(amount) |
| 453 | if list: |
| 454 | self.print_call_heading(width, "was called by...") |
| 455 | for func in list: |
| 456 | cc, nc, tt, ct, callers = self.stats[func] |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 457 | self.print_call_line(width, func, callers, "<-") |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 458 | print(file=self.stream) |
| 459 | print(file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 460 | return self |
| 461 | |
| 462 | def print_call_heading(self, name_size, column_title): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 463 | print("Function ".ljust(name_size) + column_title, file=self.stream) |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 464 | # print sub-header only if we have new-style callers |
| 465 | subheader = False |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 466 | for cc, nc, tt, ct, callers in self.stats.values(): |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 467 | if callers: |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 468 | value = next(iter(callers.values())) |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 469 | subheader = isinstance(value, tuple) |
| 470 | break |
| 471 | if subheader: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 472 | print(" "*name_size + " ncalls tottime cumtime", file=self.stream) |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 473 | |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 474 | def print_call_line(self, name_size, source, call_dict, arrow="->"): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 475 | print(func_std_string(source).ljust(name_size) + arrow, end=' ', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 476 | if not call_dict: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 477 | print(file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 478 | return |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 479 | clist = sorted(call_dict.keys()) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 480 | indent = "" |
| 481 | for func in clist: |
| 482 | name = func_std_string(func) |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 483 | value = call_dict[func] |
| 484 | if isinstance(value, tuple): |
| 485 | nc, cc, tt, ct = value |
| 486 | if nc != cc: |
| 487 | substats = '%d/%d' % (nc, cc) |
| 488 | else: |
| 489 | substats = '%d' % (nc,) |
| 490 | substats = '%s %s %s %s' % (substats.rjust(7+2*len(indent)), |
| 491 | f8(tt), f8(ct), name) |
| 492 | left_width = name_size + 1 |
| 493 | else: |
| 494 | substats = '%s(%r) %s' % (name, value, f8(self.stats[func][3])) |
| 495 | left_width = name_size + 3 |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 496 | print(indent*left_width + substats, file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 497 | indent = " " |
| 498 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 499 | def print_title(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 500 | print(' ncalls tottime percall cumtime percall', end=' ', file=self.stream) |
| 501 | print('filename:lineno(function)', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 502 | |
Georg Brandl | 9a8439d | 2010-10-22 06:35:59 +0000 | [diff] [blame] | 503 | def print_line(self, func): # hack: should print percentages |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 504 | cc, nc, tt, ct, callers = self.stats[func] |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 505 | c = str(nc) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 506 | if nc != cc: |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 507 | c = c + '/' + str(cc) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 508 | print(c.rjust(9), end=' ', file=self.stream) |
| 509 | print(f8(tt), end=' ', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 510 | if nc == 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 511 | print(' '*8, end=' ', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 512 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 513 | print(f8(tt/nc), end=' ', file=self.stream) |
| 514 | print(f8(ct), end=' ', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 515 | if cc == 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 516 | print(' '*8, end=' ', file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 517 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 518 | print(f8(ct/cc), end=' ', file=self.stream) |
| 519 | print(func_std_string(func), file=self.stream) |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 520 | |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 521 | class TupleComp: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 522 | """This class provides a generic function for comparing any two tuples. |
| 523 | Each instance records a list of tuple-indices (from most significant |
| 524 | to least significant), and sort direction (ascending or decending) for |
| 525 | each tuple-index. The compare functions can then be used as the function |
| 526 | argument to the system sort() function when a list of tuples need to be |
| 527 | sorted in the instances order.""" |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 528 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 529 | def __init__(self, comp_select_list): |
| 530 | self.comp_select_list = comp_select_list |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 531 | |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 532 | def compare (self, left, right): |
| 533 | for index, direction in self.comp_select_list: |
| 534 | l = left[index] |
| 535 | r = right[index] |
| 536 | if l < r: |
| 537 | return -direction |
| 538 | if l > r: |
| 539 | return direction |
| 540 | return 0 |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 541 | |
Raymond Hettinger | 70b64fc | 2008-01-30 20:15:17 +0000 | [diff] [blame] | 542 | |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 543 | #************************************************************************** |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 544 | # func_name is a triple (file:string, line:int, name:string) |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 545 | |
| 546 | def func_strip_path(func_name): |
Fred Drake | 9c43910 | 2003-05-14 14:28:09 +0000 | [diff] [blame] | 547 | filename, line, name = func_name |
| 548 | return os.path.basename(filename), line, name |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 549 | |
| 550 | def func_get_function_name(func): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 551 | return func[2] |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 552 | |
| 553 | def func_std_string(func_name): # match what old profile produced |
Armin Rigo | a871ef2 | 2006-02-08 12:53:56 +0000 | [diff] [blame] | 554 | if func_name[:2] == ('~', 0): |
| 555 | # special case for built-in functions |
| 556 | name = func_name[2] |
| 557 | if name.startswith('<') and name.endswith('>'): |
| 558 | return '{%s}' % name[1:-1] |
| 559 | else: |
| 560 | return name |
| 561 | else: |
| 562 | return "%s:%d(%s)" % func_name |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 563 | |
| 564 | #************************************************************************** |
penguindustin | 9646630 | 2019-05-06 14:57:17 -0400 | [diff] [blame] | 565 | # The following functions combine statistics for pairs functions. |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 566 | # The bulk of the processing involves correctly handling "call" lists, |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 567 | # such as callers and callees. |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 568 | #************************************************************************** |
| 569 | |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 570 | def add_func_stats(target, source): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 571 | """Add together all the stats for two profile entries.""" |
| 572 | cc, nc, tt, ct, callers = source |
| 573 | t_cc, t_nc, t_tt, t_ct, t_callers = target |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 574 | return (cc+t_cc, nc+t_nc, tt+t_tt, ct+t_ct, |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 575 | add_callers(t_callers, callers)) |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 576 | |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 577 | def add_callers(target, source): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 578 | """Combine two caller lists in a single list.""" |
| 579 | new_callers = {} |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 580 | for func, caller in target.items(): |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 581 | new_callers[func] = caller |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 582 | for func, caller in source.items(): |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 583 | if func in new_callers: |
Georg Brandl | 2d3c4e7 | 2010-08-02 17:24:49 +0000 | [diff] [blame] | 584 | if isinstance(caller, tuple): |
| 585 | # format used by cProfile |
Serhiy Storchaka | 3f2e6f1 | 2018-02-26 16:50:11 +0200 | [diff] [blame] | 586 | new_callers[func] = tuple(i + j for i, j in zip(caller, new_callers[func])) |
Georg Brandl | 2d3c4e7 | 2010-08-02 17:24:49 +0000 | [diff] [blame] | 587 | else: |
| 588 | # format used by profile |
| 589 | new_callers[func] += caller |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 590 | else: |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 591 | new_callers[func] = caller |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 592 | return new_callers |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 593 | |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 594 | def count_calls(callers): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 595 | """Sum the caller statistics to get total number of calls received.""" |
| 596 | nc = 0 |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 597 | for calls in callers.values(): |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 598 | nc += calls |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 599 | return nc |
Guido van Rossum | adb3105 | 1994-06-23 11:42:52 +0000 | [diff] [blame] | 600 | |
| 601 | #************************************************************************** |
| 602 | # The following functions support printing of reports |
| 603 | #************************************************************************** |
| 604 | |
| 605 | def f8(x): |
Tim Peters | 7d01685 | 2001-10-08 06:13:19 +0000 | [diff] [blame] | 606 | return "%8.3f" % x |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 607 | |
| 608 | #************************************************************************** |
| 609 | # Statistics browser added by ESR, April 2001 |
| 610 | #************************************************************************** |
| 611 | |
| 612 | if __name__ == '__main__': |
| 613 | import cmd |
Eric S. Raymond | 9cb9857 | 2001-04-14 01:48:41 +0000 | [diff] [blame] | 614 | try: |
| 615 | import readline |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 616 | except ImportError: |
Eric S. Raymond | 9cb9857 | 2001-04-14 01:48:41 +0000 | [diff] [blame] | 617 | pass |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 618 | |
| 619 | class ProfileBrowser(cmd.Cmd): |
| 620 | def __init__(self, profile=None): |
Martin v. Löwis | 66b6e19 | 2001-07-28 14:44:03 +0000 | [diff] [blame] | 621 | cmd.Cmd.__init__(self) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 622 | self.prompt = "% " |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 623 | self.stats = None |
| 624 | self.stream = sys.stdout |
Raymond Hettinger | 16e3c42 | 2002-06-01 16:07:16 +0000 | [diff] [blame] | 625 | if profile is not None: |
Georg Brandl | b1a97af | 2010-08-02 12:06:18 +0000 | [diff] [blame] | 626 | self.do_read(profile) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 627 | |
| 628 | def generic(self, fn, line): |
| 629 | args = line.split() |
| 630 | processed = [] |
| 631 | for term in args: |
| 632 | try: |
| 633 | processed.append(int(term)) |
| 634 | continue |
| 635 | except ValueError: |
| 636 | pass |
| 637 | try: |
| 638 | frac = float(term) |
| 639 | if frac > 1 or frac < 0: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 640 | print("Fraction argument must be in [0, 1]", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 641 | continue |
| 642 | processed.append(frac) |
| 643 | continue |
| 644 | except ValueError: |
| 645 | pass |
| 646 | processed.append(term) |
| 647 | if self.stats: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 648 | getattr(self.stats, fn)(*processed) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 649 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 650 | print("No statistics object is loaded.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 651 | return 0 |
Eric S. Raymond | 53b809d | 2001-04-26 07:32:38 +0000 | [diff] [blame] | 652 | def generic_help(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 653 | print("Arguments may be:", file=self.stream) |
| 654 | print("* An integer maximum number of entries to print.", file=self.stream) |
| 655 | print("* A decimal fractional number between 0 and 1, controlling", file=self.stream) |
| 656 | print(" what fraction of selected entries to print.", file=self.stream) |
| 657 | print("* A regular expression; only entries with function names", file=self.stream) |
| 658 | print(" that match it are printed.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 659 | |
| 660 | def do_add(self, line): |
Georg Brandl | 3e4f2ec | 2010-08-01 07:48:43 +0000 | [diff] [blame] | 661 | if self.stats: |
Stefan Krah | e12a68b | 2016-08-02 22:30:24 +0200 | [diff] [blame] | 662 | try: |
| 663 | self.stats.add(line) |
Serhiy Storchaka | 55fe1ae | 2017-04-16 10:46:38 +0300 | [diff] [blame] | 664 | except OSError as e: |
Stefan Krah | e12a68b | 2016-08-02 22:30:24 +0200 | [diff] [blame] | 665 | print("Failed to load statistics for %s: %s" % (line, e), file=self.stream) |
Georg Brandl | 3e4f2ec | 2010-08-01 07:48:43 +0000 | [diff] [blame] | 666 | else: |
| 667 | print("No statistics object is loaded.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 668 | return 0 |
| 669 | def help_add(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 670 | print("Add profile info from given file to current statistics object.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 671 | |
| 672 | def do_callees(self, line): |
Eric S. Raymond | 3c1858a | 2001-04-14 15:16:05 +0000 | [diff] [blame] | 673 | return self.generic('print_callees', line) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 674 | def help_callees(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 675 | print("Print callees statistics from the current stat object.", file=self.stream) |
Eric S. Raymond | 53b809d | 2001-04-26 07:32:38 +0000 | [diff] [blame] | 676 | self.generic_help() |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 677 | |
| 678 | def do_callers(self, line): |
Eric S. Raymond | 3c1858a | 2001-04-14 15:16:05 +0000 | [diff] [blame] | 679 | return self.generic('print_callers', line) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 680 | def help_callers(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 681 | print("Print callers statistics from the current stat object.", file=self.stream) |
Eric S. Raymond | 53b809d | 2001-04-26 07:32:38 +0000 | [diff] [blame] | 682 | self.generic_help() |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 683 | |
| 684 | def do_EOF(self, line): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 685 | print("", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 686 | return 1 |
| 687 | def help_EOF(self): |
Xtreak | 0d70227 | 2019-06-03 04:42:33 +0530 | [diff] [blame] | 688 | print("Leave the profile browser.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 689 | |
| 690 | def do_quit(self, line): |
| 691 | return 1 |
| 692 | def help_quit(self): |
Xtreak | 0d70227 | 2019-06-03 04:42:33 +0530 | [diff] [blame] | 693 | print("Leave the profile browser.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 694 | |
| 695 | def do_read(self, line): |
| 696 | if line: |
| 697 | try: |
| 698 | self.stats = Stats(line) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 699 | except OSError as err: |
Georg Brandl | 50da60c | 2008-01-06 21:38:54 +0000 | [diff] [blame] | 700 | print(err.args[1], file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 701 | return |
Georg Brandl | f02e736 | 2010-08-01 07:57:47 +0000 | [diff] [blame] | 702 | except Exception as err: |
| 703 | print(err.__class__.__name__ + ':', err, file=self.stream) |
| 704 | return |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 705 | self.prompt = line + "% " |
Martin v. Löwis | 22adac5 | 2001-06-07 05:49:05 +0000 | [diff] [blame] | 706 | elif len(self.prompt) > 2: |
Georg Brandl | f02e736 | 2010-08-01 07:57:47 +0000 | [diff] [blame] | 707 | line = self.prompt[:-2] |
| 708 | self.do_read(line) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 709 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 710 | print("No statistics object is current -- cannot reload.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 711 | return 0 |
| 712 | def help_read(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 713 | print("Read in profile data from a specified file.", file=self.stream) |
Georg Brandl | f02e736 | 2010-08-01 07:57:47 +0000 | [diff] [blame] | 714 | print("Without argument, reload the current file.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 715 | |
| 716 | def do_reverse(self, line): |
Georg Brandl | 3e4f2ec | 2010-08-01 07:48:43 +0000 | [diff] [blame] | 717 | if self.stats: |
| 718 | self.stats.reverse_order() |
| 719 | else: |
| 720 | print("No statistics object is loaded.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 721 | return 0 |
| 722 | def help_reverse(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 723 | print("Reverse the sort order of the profiling report.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 724 | |
| 725 | def do_sort(self, line): |
Georg Brandl | 3e4f2ec | 2010-08-01 07:48:43 +0000 | [diff] [blame] | 726 | if not self.stats: |
| 727 | print("No statistics object is loaded.", file=self.stream) |
| 728 | return |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 729 | abbrevs = self.stats.get_sort_arg_defs() |
Andrew M. Kuchling | 0a62823 | 2010-04-02 17:02:57 +0000 | [diff] [blame] | 730 | if line and all((x in abbrevs) for x in line.split()): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 731 | self.stats.sort_stats(*line.split()) |
Eric S. Raymond | 53b809d | 2001-04-26 07:32:38 +0000 | [diff] [blame] | 732 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 733 | print("Valid sort keys (unique prefixes are accepted):", file=self.stream) |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 734 | for (key, value) in Stats.sort_arg_dict_default.items(): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 735 | print("%s -- %s" % (key, value[1]), file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 736 | return 0 |
| 737 | def help_sort(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 738 | print("Sort profile data according to specified keys.", file=self.stream) |
| 739 | print("(Typing `sort' without arguments lists valid keys.)", file=self.stream) |
Martin v. Löwis | 27c430e | 2001-07-30 10:21:13 +0000 | [diff] [blame] | 740 | def complete_sort(self, text, *args): |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 741 | return [a for a in Stats.sort_arg_dict_default if a.startswith(text)] |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 742 | |
| 743 | def do_stats(self, line): |
| 744 | return self.generic('print_stats', line) |
| 745 | def help_stats(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 746 | print("Print statistics from the current stat object.", file=self.stream) |
Eric S. Raymond | 53b809d | 2001-04-26 07:32:38 +0000 | [diff] [blame] | 747 | self.generic_help() |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 748 | |
| 749 | def do_strip(self, line): |
Georg Brandl | 3e4f2ec | 2010-08-01 07:48:43 +0000 | [diff] [blame] | 750 | if self.stats: |
| 751 | self.stats.strip_dirs() |
| 752 | else: |
| 753 | print("No statistics object is loaded.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 754 | def help_strip(self): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 755 | print("Strip leading path information from filenames in the report.", file=self.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 756 | |
Georg Brandl | f02e736 | 2010-08-01 07:57:47 +0000 | [diff] [blame] | 757 | def help_help(self): |
| 758 | print("Show help for a given command.", file=self.stream) |
| 759 | |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 760 | def postcmd(self, stop, line): |
| 761 | if stop: |
| 762 | return stop |
| 763 | return None |
| 764 | |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 765 | if len(sys.argv) > 1: |
| 766 | initprofile = sys.argv[1] |
| 767 | else: |
| 768 | initprofile = None |
| 769 | try: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 770 | browser = ProfileBrowser(initprofile) |
Antoine Pitrou | 9d8c186 | 2012-03-14 17:47:11 +0100 | [diff] [blame] | 771 | for profile in sys.argv[2:]: |
| 772 | browser.do_add(profile) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 773 | print("Welcome to the profile statistics browser.", file=browser.stream) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 774 | browser.cmdloop() |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 775 | print("Goodbye.", file=browser.stream) |
Eric S. Raymond | 4f3980d | 2001-04-13 00:23:01 +0000 | [diff] [blame] | 776 | except KeyboardInterrupt: |
| 777 | pass |
| 778 | |
| 779 | # That's all, folks. |