PyDocs

Nav

Superseded modules

Profile

profile

class (source)
  • Profile(timer=None, timeunit=0.0, subcalls=True, builtins=True)
Profiler class.

self.cur is always a tuple.  Each such tuple corresponds to a stack
frame that is currently active (self.cur[-2]).  The following are the
definitions of its members.  We use this external "parallel stack" to
avoid contaminating the program that we are profiling. (old profiler
used to write into the frames local dictionary!!) Derived classes
can change the definition of some entries, as long as they leave
[-2:] intact (frame and previous tuple).  In case an internal error is
detected, the -3 element is used as the function name.

[ 0] = Time that needs to be charged to the parent frame's function.
       It is used so that a function call will not have to access the
       timing data for the parent frame.
[ 1] = Total time spent in this frame's function, excluding time in
       subfunctions (this latter is tallied in cur[2]).
[ 2] = Total time spent in subfunctions, excluding time executing the
       frame's function (this latter is tallied in cur[1]).
[-3] = Name of the function that corresponds to this frame.
[-2] = Actual frame that we correspond to (used to sync exception handling).
[-1] = Our parent 6-tuple (corresponds to frame.f_back).

Timing data for each function is stored as a 5-tuple in the dictionary
self.timings[].  The index is always the name stored in self.cur[-3].
The following are the definitions of the members:

[0] = The number of times this function was called, not counting direct
      or indirect recursion,
[1] = Number of times this function appears on the stack, minus one
[2] = Total time spent internal to this function
[3] = Cumulative time that this function was present on the stack.  In
      non-recursive functions, this is the total execution time from start
      to finish of each invocation of a function, including time spent in
      all subfunctions.
[4] = A dictionary indicating for each function name, the number of times
      it was called by us.
Changed in 3.8
  • 3.8: Added context manager support.
Members of Profile

c

create_stats
Stop collecting profiling data and record the results internally as the current profile.

d

disable
Stop collecting profiling data.
dump_stats
Write the results of the current profile to filename.

e

enable
Start collecting profiling data.

p

print_stats
Create a Stats object based on the current profile and print the results to stdout.

r

run
Profile the cmd via exec().
runcall
Profile func(*args, **kwargs)
runctx
Profile the cmd via exec() with the specified global and local environment.
0 Examples
No examples for profile/Profile.
See Also
No see-alsos for profile/Profile
0 Notes
No notes for Profile