PyDocs

Nav

Debugging and profiling

Stats

pstats

class (source)
  • Stats(*filenames_or_profile, stream=sys.stdout)
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 that are respectively interpreted as
'stdname', 'calls', 'time', and 'cumulative').  It takes either an
arbitrary number of quoted strings or SortKey enum to select the sort
order.

For example sort_stats('time', 'name') or sort_stats(SortKey.TIME,
SortKey.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)
Members of Stats

a

add
Add profiling data from additional files.

d

dump_stats
Write the profile data to a file we know how to load back.

g

get_stats_profile
This method returns an instance of StatsProfile, which contains a mapping of function names to instances of FunctionProfile.

p

print_callees
Print the functions called by each function in the statistics.
print_callers
Print the callers of each function in the statistics.
print_stats
Print a report of the profiling statistics.

r

reverse_order
Reverse the current sort order.

s

sort_stats
Sort the statistics according to the specified criteria.
strip_dirs
Remove leading path information from all filenames.
0 Examples
No examples for pstats/Stats.
See Also
No see-alsos for pstats/Stats
0 Notes
No notes for Stats