cpython-lru_cache-weakref: Lib/profile.py annotate

annotate Lib/profile.py @ 25838:8540887bcec6 2.2

Backport of 2.183: Fix memory leak in add_subclass() found by NealN with valgrind.

author	Guido van Rossum <guido@python.org>
date	Fri, 18 Oct 2002 13:42:21 +0000
parents	3e8460fb2fbe
children	a1de0bab5475

rev	line source
4573 73758db2f464 /usr/local/bin/python -> /usr/bin/env python Guido van Rossum <guido@python.org> parents: 4347 diff changeset	1 #! /usr/bin/env python
839 1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	2 #
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	3 # Class for profiling python code. rev 1.0 6/2/94
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	4 #
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	5 # Based on prior profile module by Sjoerd Mullender...
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	6 # which was hacked somewhat by: Guido van Rossum
839 1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	7 #
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	8 # See profile.doc for more information
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	9
11706 b6f52c1ef6da More trivial comment -> docstring transformations by Ka-Ping Yee, Guido van Rossum <guido@python.org> parents: 10827 diff changeset	10 """Class for profiling Python code."""
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	11
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	12 # Copyright 1994, by InfoSeek Corporation, all rights reserved.
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	13 # Written by James Roskind
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	14 #
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	15 # Permission to use, copy, modify, and distribute this Python software
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	16 # and its associated documentation for any purpose (subject to the
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	17 # restriction in the following sentence) without fee is hereby granted,
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	18 # provided that the above copyright notice appears in all copies, and
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	19 # that both that copyright notice and this permission notice appear in
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	20 # supporting documentation, and that the name of InfoSeek not be used in
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	21 # advertising or publicity pertaining to distribution of the software
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	22 # without specific, written prior permission. This permission is
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	23 # explicitly restricted to the copying and modification of the software
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	24 # to remain in Python, compiled Python, or other languages (such as C)
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	25 # wherein the modified or derived code is exclusively imported into a
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	26 # Python module.
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	27 #
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	28 # INFOSEEK CORPORATION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	29 # SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	30 # FITNESS. IN NO EVENT SHALL INFOSEEK CORPORATION BE LIABLE FOR ANY
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	31 # SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	32 # RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	33 # CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	34 # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	35
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	36
839 1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	37
1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	38 import sys
1006 903071377d29 Added a _v21 def to FL.py and added two new input field types Guido van Rossum <guido@python.org> parents: 839 diff changeset	39 import os
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	40 import time
1006 903071377d29 Added a _v21 def to FL.py and added two new input field types Guido van Rossum <guido@python.org> parents: 839 diff changeset	41 import marshal
839 1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	42
16562 623456576d6a __all__ for several more modules Skip Montanaro <skip@pobox.com> parents: 15870 diff changeset	43 __all__ = ["run","help","Profile"]
839 1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	44
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	45 # Sample timer for use with
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	46 #i_count = 0
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	47 #def integer_timer():
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	48 # global i_count
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	49 # i_count = i_count + 1
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	50 # return i_count
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	51 #itimes = integer_timer # replace with C coded timer returning integers
839 1780eb8fde2b Initial revision Guido van Rossum <guido@python.org> parents: diff changeset	52
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	53 #**************************************************************************
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	54 # The following are the static member functions for the profiler class
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	55 # Note that an instance of Profile() is not needed to call them.
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	56 #**************************************************************************
1006 903071377d29 Added a _v21 def to FL.py and added two new input field types Guido van Rossum <guido@python.org> parents: 839 diff changeset	57
17042 3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	58 def run(statement, filename=None):
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	59 """Run statement under profiler optionally saving results in filename
1006 903071377d29 Added a _v21 def to FL.py and added two new input field types Guido van Rossum <guido@python.org> parents: 839 diff changeset	60
17042 3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	61 This function takes a single argument that can be passed to the
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	62 "exec" statement, and an optional file name. In all cases this
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	63 routine attempts to "exec" its first argument and gather profiling
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	64 statistics from the execution. If no file name is present, then this
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	65 function automatically prints a simple profiling report, sorted by the
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	66 standard name string (file/line/function-name) that is presented in
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	67 each line.
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	68 """
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	69 prof = Profile()
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	70 try:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	71 prof = prof.run(statement)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	72 except SystemExit:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	73 pass
17042 3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	74 if filename is not None:
3375a2a98e56 Add doc string for run from profile.doc. (pydoc motivates me to write Jeremy Hylton <jeremy@alum.mit.edu> parents: 16562 diff changeset	75 prof.dump_stats(filename)
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	76 else:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	77 return prof.print_stats()
1357 2fac209e1c3f * profile.py, pdb.py: added help() function Guido van Rossum <guido@python.org> parents: 1335 diff changeset	78
2fac209e1c3f * profile.py, pdb.py: added help() function Guido van Rossum <guido@python.org> parents: 1335 diff changeset	79 # print help
2fac209e1c3f * profile.py, pdb.py: added help() function Guido van Rossum <guido@python.org> parents: 1335 diff changeset	80 def help():
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	81 for dirname in sys.path:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	82 fullname = os.path.join(dirname, 'profile.doc')
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	83 if os.path.exists(fullname):
21238 3e8460fb2fbe Added a missing period at the end of an error message. Fred Drake <fdrake@acm.org> parents: 20480 diff changeset	84 sts = os.system('${PAGER-more} ' + fullname)
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	85 if sts: print '*** Pager exit status:', sts
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	86 break
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	87 else:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	88 print 'Sorry, can\'t find the help file "profile.doc"',
21238 3e8460fb2fbe Added a missing period at the end of an error message. Fred Drake <fdrake@acm.org> parents: 20480 diff changeset	89 print 'along the Python search path.'
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	90
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	91
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	92 if os.name == "mac":
18164 efb5069cc74f An import MacOS was missing after the code-rearranging. Added. Jack Jansen <jack.jansen@cwi.nl> parents: 18056 diff changeset	93 import MacOS
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	94 def _get_time_mac(timer=MacOS.GetTicks):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	95 return timer() / 60.0
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	96
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	97 if hasattr(os, "times"):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	98 def _get_time_times(timer=os.times):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	99 t = timer()
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	100 return t[0] + t[1]
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	101
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	102
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	103 class Profile:
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	104 """Profiler class.
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	105
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	106 self.cur is always a tuple. Each such tuple corresponds to a stack
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	107 frame that is currently active (self.cur[-2]). The following are the
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	108 definitions of its members. We use this external "parallel stack" to
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	109 avoid contaminating the program that we are profiling. (old profiler
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	110 used to write into the frames local dictionary!!) Derived classes
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	111 can change the definition of some entries, as long as they leave
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	112 [-2:] intact (frame and previous tuple). In case an internal error is
6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	113 detected, the -3 element is used as the function name.
11706 b6f52c1ef6da More trivial comment -> docstring transformations by Ka-Ping Yee, Guido van Rossum <guido@python.org> parents: 10827 diff changeset	114
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	115 [ 0] = Time that needs to be charged to the parent frame's function.
6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	116 It is used so that a function call will not have to access the
6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	117 timing data for the parent frame.
6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	118 [ 1] = Total time spent in this frame's function, excluding time in
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	119 subfunctions (this latter is tallied in cur[2]).
20302 c5345c0abd70 Typo repair in comment. Tim Peters <tim.peters@gmail.com> parents: 20300 diff changeset	120 [ 2] = Total time spent in subfunctions, excluding time executing the
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	121 frame's function (this latter is tallied in cur[1]).
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	122 [-3] = Name of the function that corresponds to this frame.
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	123 [-2] = Actual frame that we correspond to (used to sync exception handling).
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	124 [-1] = Our parent 6-tuple (corresponds to frame.f_back).
11706 b6f52c1ef6da More trivial comment -> docstring transformations by Ka-Ping Yee, Guido van Rossum <guido@python.org> parents: 10827 diff changeset	125
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	126 Timing data for each function is stored as a 5-tuple in the dictionary
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	127 self.timings[]. The index is always the name stored in self.cur[-3].
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	128 The following are the definitions of the members:
11706 b6f52c1ef6da More trivial comment -> docstring transformations by Ka-Ping Yee, Guido van Rossum <guido@python.org> parents: 10827 diff changeset	129
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	130 [0] = The number of times this function was called, not counting direct
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	131 or indirect recursion,
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	132 [1] = Number of times this function appears on the stack, minus one
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	133 [2] = Total time spent internal to this function
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	134 [3] = Cumulative time that this function was present on the stack. In
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	135 non-recursive functions, this is the total execution time from start
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	136 to finish of each invocation of a function, including time spent in
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	137 all subfunctions.
20297 79392ab2c02a Repair some longstanding comment errors: Tim Peters <tim.peters@gmail.com> parents: 20295 diff changeset	138 [4] = A dictionary indicating for each function name, the number of times
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	139 it was called by us.
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	140 """
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	141
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	142 bias = 0 # calibration constant
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	143
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	144 def __init__(self, timer=None, bias=None):
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	145 self.timings = {}
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	146 self.cur = None
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	147 self.cmd = ""
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	148
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	149 if bias is None:
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	150 bias = self.bias
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	151 self.bias = bias # Materialize in local dict for lookup speed.
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	152
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	153 if not timer:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	154 if os.name == 'mac':
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	155 self.timer = MacOS.GetTicks
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	156 self.dispatcher = self.trace_dispatch_mac
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	157 self.get_time = _get_time_mac
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	158 elif hasattr(time, 'clock'):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	159 self.timer = self.get_time = time.clock
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	160 self.dispatcher = self.trace_dispatch_i
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	161 elif hasattr(os, 'times'):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	162 self.timer = os.times
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	163 self.dispatcher = self.trace_dispatch
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	164 self.get_time = _get_time_times
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	165 else:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	166 self.timer = self.get_time = time.time
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	167 self.dispatcher = self.trace_dispatch_i
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	168 else:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	169 self.timer = timer
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	170 t = self.timer() # test out timer function
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	171 try:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	172 length = len(t)
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	173 except TypeError:
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	174 self.get_time = timer
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	175 self.dispatcher = self.trace_dispatch_i
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	176 else:
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	177 if length == 2:
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	178 self.dispatcher = self.trace_dispatch
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	179 else:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	180 self.dispatcher = self.trace_dispatch_l
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	181 # This get_time() implementation needs to be defined
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	182 # here to capture the passed-in timer in the parameter
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	183 # list (for performance). Note that we can't assume
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	184 # the timer() result contains two values in all
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	185 # cases.
19117 8cbf984c9c13 Fix two bugs detected by PyChecker: there's no need for redundant Guido van Rossum <guido@python.org> parents: 18164 diff changeset	186 import operator
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	187 def get_time_timer(timer=timer,
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	188 reduce=reduce, reducer=operator.add):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	189 return reduce(reducer, timer(), 0)
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	190 self.get_time = get_time_timer
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	191 self.t = self.get_time()
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	192 self.simulate_call('profiler')
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	193
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	194 # Heavily optimized dispatch routine for os.times() timer
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	195
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	196 def trace_dispatch(self, frame, event, arg):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	197 timer = self.timer
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	198 t = timer()
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	199 t = t[0] + t[1] - self.t - self.bias
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	200
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	201 if self.dispatch[event](self, frame,t):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	202 t = timer()
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	203 self.t = t[0] + t[1]
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	204 else:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	205 r = timer()
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	206 self.t = r[0] + r[1] - t # put back unrecorded delta
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	207
20297 79392ab2c02a Repair some longstanding comment errors: Tim Peters <tim.peters@gmail.com> parents: 20295 diff changeset	208 # Dispatch routine for best timer program (return = scalar, fastest if
79392ab2c02a Repair some longstanding comment errors: Tim Peters <tim.peters@gmail.com> parents: 20295 diff changeset	209 # an integer but float works too -- and time.clock() relies on that).
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	210
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	211 def trace_dispatch_i(self, frame, event, arg):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	212 timer = self.timer
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	213 t = timer() - self.t - self.bias
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	214 if self.dispatch[event](self, frame,t):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	215 self.t = timer()
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	216 else:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	217 self.t = timer() - t # put back unrecorded delta
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	218
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	219 # Dispatch routine for macintosh (timer returns time in ticks of
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	220 # 1/60th second)
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	221
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	222 def trace_dispatch_mac(self, frame, event, arg):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	223 timer = self.timer
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	224 t = timer()/60.0 - self.t - self.bias
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	225 if self.dispatch[event](self, frame, t):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	226 self.t = timer()/60.0
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	227 else:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	228 self.t = timer()/60.0 - t # put back unrecorded delta
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	229
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	230 # SLOW generic dispatch routine for timer returning lists of numbers
6451 10413179a72a Use better timer on the mac Guido van Rossum <guido@python.org> parents: 4573 diff changeset	231
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	232 def trace_dispatch_l(self, frame, event, arg):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	233 get_time = self.get_time
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	234 t = get_time() - self.t - self.bias
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	235
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	236 if self.dispatch[event](self, frame, t):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	237 self.t = get_time()
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	238 else:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	239 self.t = get_time() - t # put back unrecorded delta
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	240
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	241 # In the event handlers, the first 3 elements of self.cur are unpacked
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	242 # into vrbls w/ 3-letter names. The last two characters are meant to be
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	243 # mnemonic:
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	244 # _pt self.cur[0] "parent time" time to be charged to parent frame
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	245 # _it self.cur[1] "internal time" time spent directly in the function
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	246 # _et self.cur[2] "external time" time spent in subfunctions
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	247
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	248 def trace_dispatch_exception(self, frame, t):
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	249 rpt, rit, ret, rfn, rframe, rcur = self.cur
20235 acfb278662c6 Undo previous patch; it did not quite work out. Fred Drake <fdrake@acm.org> parents: 20133 diff changeset	250 if (rframe is not frame) and rcur:
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	251 return self.trace_dispatch_return(rframe, t)
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	252 self.cur = rpt, rit+t, ret, rfn, rframe, rcur
20238 e7aca2a302cd Hopefully fix the profiler right. Add a test suite that checks that Guido van Rossum <guido@python.org> parents: 20235 diff changeset	253 return 1
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	254
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	255
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	256 def trace_dispatch_call(self, frame, t):
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	257 if self.cur and frame.f_back is not self.cur[-2]:
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	258 rpt, rit, ret, rfn, rframe, rcur = self.cur
20238 e7aca2a302cd Hopefully fix the profiler right. Add a test suite that checks that Guido van Rossum <guido@python.org> parents: 20235 diff changeset	259 if not isinstance(rframe, Profile.fake_frame):
20298 6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	260 assert rframe.f_back is frame.f_back, ("Bad call", rfn,
6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	261 rframe, rframe.f_back,
6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	262 frame, frame.f_back)
20238 e7aca2a302cd Hopefully fix the profiler right. Add a test suite that checks that Guido van Rossum <guido@python.org> parents: 20235 diff changeset	263 self.trace_dispatch_return(rframe, 0)
20298 6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	264 assert (self.cur is None or \
6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	265 frame.f_back is self.cur[-2]), ("Bad call",
6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	266 self.cur[-3])
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	267 fcode = frame.f_code
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	268 fn = (fcode.co_filename, fcode.co_firstlineno, fcode.co_name)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	269 self.cur = (t, 0, 0, fn, frame, self.cur)
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	270 timings = self.timings
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	271 if timings.has_key(fn):
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	272 cc, ns, tt, ct, callers = timings[fn]
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	273 timings[fn] = cc, ns + 1, tt, ct, callers
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	274 else:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	275 timings[fn] = 0, 0, 0, 0, {}
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	276 return 1
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	277
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	278 def trace_dispatch_return(self, frame, t):
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	279 if frame is not self.cur[-2]:
20298 6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	280 assert frame is self.cur[-2].f_back, ("Bad return", self.cur[-3])
6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	281 self.trace_dispatch_return(self.cur[-2], 0)
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	282
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	283 # Prefix "r" means part of the Returning or exiting frame.
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	284 # Prefix "p" means part of the Previous or Parent or older frame.
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	285
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	286 rpt, rit, ret, rfn, frame, rcur = self.cur
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	287 rit = rit + t
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	288 frame_total = rit + ret
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	289
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	290 ppt, pit, pet, pfn, pframe, pcur = rcur
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	291 self.cur = ppt, pit + rpt, pet + frame_total, pfn, pframe, pcur
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	292
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	293 timings = self.timings
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	294 cc, ns, tt, ct, callers = timings[rfn]
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	295 if not ns:
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	296 # This is the only occurrence of the function on the stack.
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	297 # Else this is a (directly or indirectly) recursive call, and
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	298 # its cumulative time will get updated when the topmost call to
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	299 # it returns.
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	300 ct = ct + frame_total
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	301 cc = cc + 1
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	302
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	303 if callers.has_key(pfn):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	304 callers[pfn] = callers[pfn] + 1 # hack: gather more
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	305 # stats such as the amount of time added to ct courtesy
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	306 # of this specific call, and the contribution to cc
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	307 # courtesy of this call.
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	308 else:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	309 callers[pfn] = 1
20300 874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	310
874bb17074b0 Guido points out that the comments for self.cur[2] were subtly but Tim Peters <tim.peters@gmail.com> parents: 20298 diff changeset	311 timings[rfn] = cc, ns - 1, tt + rit, ct, callers
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	312
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	313 return 1
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	314
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	315
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	316 dispatch = {
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	317 "call": trace_dispatch_call,
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	318 "exception": trace_dispatch_exception,
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	319 "return": trace_dispatch_return,
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	320 }
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	321
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	322
20298 6211684ed9dd At Guido's request, changed the code that's conceptually asserting stuff Tim Peters <tim.peters@gmail.com> parents: 20297 diff changeset	323 # The next few functions play with self.cmd. By carefully preloading
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	324 # our parallel stack, we can force the profiled result to include
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	325 # an arbitrary string as the name of the calling function.
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	326 # We use self.cmd as that string, and the resulting stats look
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	327 # very nice :-).
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	328
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	329 def set_cmd(self, cmd):
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	330 if self.cur[-1]: return # already set
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	331 self.cmd = cmd
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	332 self.simulate_call(cmd)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	333
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	334 class fake_code:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	335 def __init__(self, filename, line, name):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	336 self.co_filename = filename
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	337 self.co_line = line
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	338 self.co_name = name
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	339 self.co_firstlineno = 0
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	340
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	341 def __repr__(self):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	342 return repr((self.co_filename, self.co_line, self.co_name))
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	343
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	344 class fake_frame:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	345 def __init__(self, code, prior):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	346 self.f_code = code
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	347 self.f_back = prior
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	348
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	349 def simulate_call(self, name):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	350 code = self.fake_code('profile', 0, name)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	351 if self.cur:
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	352 pframe = self.cur[-2]
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	353 else:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	354 pframe = None
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	355 frame = self.fake_frame(code, pframe)
20480 dd0cdd3defd8 Minor code cleanups based on comments from Neal Norwitz. Fred Drake <fdrake@acm.org> parents: 20350 diff changeset	356 self.dispatch['call'](self, frame, 0)
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	357
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	358 # collect stats from pending stack, including getting final
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	359 # timings for self.cmd frame.
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	360
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	361 def simulate_cmd_complete(self):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	362 get_time = self.get_time
a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	363 t = get_time() - self.t
20289 6e7d5ae2800f The fix to profile semantics broke the miserable but advertised way to Tim Peters <tim.peters@gmail.com> parents: 20238 diff changeset	364 while self.cur[-1]:
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	365 # We can cause assertion errors here if
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	366 # dispatch_trace_return checks for a frame match!
20480 dd0cdd3defd8 Minor code cleanups based on comments from Neal Norwitz. Fred Drake <fdrake@acm.org> parents: 20350 diff changeset	367 self.dispatch['return'](self, self.cur[-2], t)
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	368 t = 0
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	369 self.t = get_time() - t
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	370
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	371
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	372 def print_stats(self):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	373 import pstats
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	374 pstats.Stats(self).strip_dirs().sort_stats(-1). \
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	375 print_stats()
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	376
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	377 def dump_stats(self, file):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	378 f = open(file, 'wb')
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	379 self.create_stats()
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	380 marshal.dump(self.stats, f)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	381 f.close()
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	382
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	383 def create_stats(self):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	384 self.simulate_cmd_complete()
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	385 self.snapshot_stats()
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	386
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	387 def snapshot_stats(self):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	388 self.stats = {}
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	389 for func in self.timings.keys():
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	390 cc, ns, tt, ct, callers = self.timings[func]
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	391 callers = callers.copy()
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	392 nc = 0
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	393 for func_caller in callers.keys():
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	394 nc = nc + callers[func_caller]
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	395 self.stats[func] = cc, nc, tt, ct, callers
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	396
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	397
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	398 # The following two methods can be called by clients to use
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	399 # a profiler to profile a statement, given as a string.
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	400
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	401 def run(self, cmd):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	402 import __main__
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	403 dict = __main__.__dict__
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	404 return self.runctx(cmd, dict, dict)
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	405
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	406 def runctx(self, cmd, globals, locals):
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	407 self.set_cmd(cmd)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	408 sys.setprofile(self.dispatcher)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	409 try:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	410 exec cmd in globals, locals
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	411 finally:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	412 sys.setprofile(None)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	413 return self
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	414
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	415 # This method is more useful to profile a single function call.
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	416 def runcall(self, func, args, *kw):
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	417 self.set_cmd(`func`)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	418 sys.setprofile(self.dispatcher)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	419 try:
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	420 return apply(func, args, kw)
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	421 finally:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	422 sys.setprofile(None)
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	423
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	424
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	425 #******************************************************************
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	426 # The following calculates the overhead for using a profiler. The
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	427 # problem is that it takes a fair amount of time for the profiler
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	428 # to stop the stopwatch (from the time it receives an event).
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	429 # Similarly, there is a delay from the time that the profiler
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	430 # re-starts the stopwatch before the user's code really gets to
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	431 # continue. The following code tries to measure the difference on
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	432 # a per-event basis.
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	433 #
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	434 # Note that this difference is only significant if there are a lot of
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	435 # events, and relatively little user code per event. For example,
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	436 # code with small functions will typically benefit from having the
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	437 # profiler calibrated for the current platform. This could be
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	438 # done on the fly during init() time, but it is not worth the
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	439 # effort. Also note that if too large a value specified, then
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	440 # execution time on some functions will actually appear as a
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	441 # negative number. It is normal for some functions (with very
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	442 # low call counts) to have such negative stats, even if the
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	443 # calibration figure is "correct."
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	444 #
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	445 # One alternative to profile-time calibration adjustments (i.e.,
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	446 # adding in the magic little delta during each event) is to track
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	447 # more carefully the number of events (and cumulatively, the number
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	448 # of events during sub functions) that are seen. If this were
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	449 # done, then the arithmetic could be done after the fact (i.e., at
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	450 # display time). Currently, we track only call/return events.
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	451 # These values can be deduced by examining the callees and callers
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	452 # vectors for each functions. Hence we can almost correct the
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	453 # internal time figure at print time (note that we currently don't
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	454 # track exception event processing counts). Unfortunately, there
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	455 # is currently no similar information for cumulative sub-function
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	456 # time. It would not be hard to "get all this info" at profiler
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	457 # time. Specifically, we would have to extend the tuples to keep
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	458 # counts of this in each frame, and then extend the defs of timing
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	459 # tuples to include the significant two figures. I'm a bit fearful
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	460 # that this additional feature will slow the heavily optimized
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	461 # event/time ratio (i.e., the profiler would run slower, fur a very
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	462 # low "value added" feature.)
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	463 #**************************************************************
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	464
20324 429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	465 def calibrate(self, m, verbose=0):
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	466 if self.__class__ is not Profile:
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	467 raise TypeError("Subclasses must override .calibrate().")
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	468
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	469 saved_bias = self.bias
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	470 self.bias = 0
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	471 try:
20350 0a915b22e006 Repair key stutter + auto-complete ugliness. Tim Peters <tim.peters@gmail.com> parents: 20347 diff changeset	472 return self._calibrate_inner(m, verbose)
20347 b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	473 finally:
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	474 self.bias = saved_bias
b79ffd3fca28 Allow the profiler's calibration constant to be specified in the constructor Tim Peters <tim.peters@gmail.com> parents: 20324 diff changeset	475
20350 0a915b22e006 Repair key stutter + auto-complete ugliness. Tim Peters <tim.peters@gmail.com> parents: 20347 diff changeset	476 def _calibrate_inner(self, m, verbose):
18056 a232a6c3fc8c Performance improvements to the profiler: Fred Drake <fdrake@acm.org> parents: 17042 diff changeset	477 get_time = self.get_time
20324 429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	478
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	479 # Set up a test case to be run with and without profiling. Include
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	480 # lots of calls, because we're trying to quantify stopwatch overhead.
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	481 # Do not raise any exceptions, though, because we want to know
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	482 # exactly how many profile events are generated (one call event, +
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	483 # one return event, per Python-level call).
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	484
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	485 def f1(n):
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	486 for i in range(n):
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	487 x = 1
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	488
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	489 def f(m, f1=f1):
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	490 for i in range(m):
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	491 f1(100)
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	492
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	493 f(m) # warm up the cache
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	494
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	495 # elapsed_noprofile <- time f(m) takes without profiling.
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	496 t0 = get_time()
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	497 f(m)
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	498 t1 = get_time()
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	499 elapsed_noprofile = t1 - t0
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	500 if verbose:
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	501 print "elapsed time without profiling =", elapsed_noprofile
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	502
20324 429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	503 # elapsed_profile <- time f(m) takes with profiling. The difference
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	504 # is profiling overhead, only some of which the profiler subtracts
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	505 # out on its own.
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	506 p = Profile()
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	507 t0 = get_time()
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	508 p.runctx('f(m)', globals(), locals())
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	509 t1 = get_time()
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	510 elapsed_profile = t1 - t0
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	511 if verbose:
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	512 print "elapsed time with profiling =", elapsed_profile
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	513
20324 429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	514 # reported_time <- "CPU seconds" the profiler charged to f and f1.
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	515 total_calls = 0.0
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	516 reported_time = 0.0
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	517 for (filename, line, funcname), (cc, ns, tt, ct, callers) in \
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	518 p.timings.items():
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	519 if funcname in ("f", "f1"):
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	520 total_calls += cc
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	521 reported_time += tt
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	522
20324 429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	523 if verbose:
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	524 print "'CPU seconds' profiler reported =", reported_time
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	525 print "total # calls =", total_calls
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	526 if total_calls != m + 1:
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	527 raise ValueError("internal error: total calls = %d" % total_calls)
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	528
20324 429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	529 # reported_time - elapsed_noprofile = overhead the profiler wasn't
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	530 # able to measure. Divide by twice the number of calls (since there
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	531 # are two profiler events per call in this test) to get the hidden
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	532 # overhead per event.
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	533 mean = (reported_time - elapsed_noprofile) / 2.0 / total_calls
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	534 if verbose:
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	535 print "mean stopwatch overhead per profile event =", mean
429a08e2fc78 A brand new implementation of Profile.calibrate(). This measures an Tim Peters <tim.peters@gmail.com> parents: 20302 diff changeset	536 return mean
1746 1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	537
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	538 #****************************************************************************
1940892d2fe3 Merge alpha100 branch back to main trunk Guido van Rossum <guido@python.org> parents: 1435 diff changeset	539 def Stats(*args):
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	540 print 'Report generating functions are in the "pstats" module\a'
4347 a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	541
a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	542
a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	543 # When invoked as main program, invoke the profiler on a script
a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	544 if __name__ == '__main__':
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	545 if not sys.argv[1:]:
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	546 print "usage: profile.py scriptfile [arg] ..."
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	547 sys.exit(2)
4347 a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	548
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	549 filename = sys.argv[1] # Get script filename
4347 a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	550
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	551 del sys.argv[0] # Hide "profile.py" from argument list
4347 a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	552
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	553 # Insert script directory in front of module search path
010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	554 sys.path.insert(0, os.path.dirname(filename))
4347 a5c29accc438 Add main program similar to pdb. Guido van Rossum <guido@python.org> parents: 3634 diff changeset	555
15870 010d03853546 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 13912 diff changeset	556 run('execfile(' + `filename` + ')')

Mercurial > cpython-lru_cache-weakref

annotate Lib/profile.py @ 25838:8540887bcec6 2.2