Module pstats :: Class Stats
[hide private]
[frames] | no frames]

_ClassType Stats

This class is used for creating reports from data generated by the
Profile class.  It is a "friend" of that class, and imports data either
by direct access to members of Profile class, or by reading in a dictionary
that was emitted (via marshal) from the Profile class.

The big change from the previous Profiler (in terms of raw functionality)
is that an "add()" method has been provided to combine Stats from
several distinct profile runs.  Both the constructor and the add()
method now take arbitrarily many file names as arguments.

All the print methods now take an argument that indicates how many lines
to print.  If the arg is a floating point number between 0 and 1.0, then
it is taken as a decimal percentage of the available lines to be printed
(e.g., .1 means print 10% of all available lines).  If it is an integer,
it is taken to mean the number of lines of data that you wish to have
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.

All methods return self,  so you can string together commands like:
    Stats('foo', 'goo').strip_dirs().sort_stats('calls').                            print_stats(5).print_callers(5)

Instance Methods [hide private]
 
__init__(self, *args, **kwds)
 
init(self, arg)
 
load_stats(self, arg)
 
get_top_level_stats(self)
 
add(self, *arg_list)
 
dump_stats(self, filename)
Write the profile data to a file we know how to load back.
 
get_sort_arg_defs(self)
Expand all abbreviations that are unique.
 
sort_stats(self, *field)
 
reverse_order(self)
 
strip_dirs(self)
 
calc_callees(self)
 
eval_print_amount(self, sel, list, msg)
 
get_print_list(self, sel_list)
 
print_stats(self, *amount)
 
print_callees(self, *amount)
 
print_callers(self, *amount)
 
print_call_heading(self, name_size, column_title)
 
print_call_line(self, name_size, source, call_dict, arrow='->')
 
print_title(self)
 
print_line(self, func)
Class Variables [hide private]
  sort_arg_dict_default = {'calls': (((1, -1)), 'call count'), '...
Class Variable Details [hide private]

sort_arg_dict_default

Value:
{'calls': (((1, -1)), 'call count'),
 'cumulative': (((3, -1)), 'cumulative time'),
 'file': (((4, 1)), 'file name'),
 'line': (((5, 1)), 'line number'),
 'module': (((4, 1)), 'file name'),
 'name': (((6, 1)), 'function name'),
 'nfl': (((6, 1), (4, 1), (5, 1)), 'name/file/line'),
 'pcalls': (((0, -1)), 'call count'),
...