Benjamin Peterson | 90f5ba5 | 2010-03-11 22:53:45 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 2 | |
| 3 | # portions copyright 2001, Autonomous Zones Industries, Inc., all rights... |
| 4 | # err... reserved and offered to the public under the terms of the |
| 5 | # Python 2.2 license. |
| 6 | # Author: Zooko O'Whielacronx |
| 7 | # http://zooko.com/ |
| 8 | # mailto:zooko@zooko.com |
| 9 | # |
| 10 | # Copyright 2000, Mojam Media, Inc., all rights reserved. |
| 11 | # Author: Skip Montanaro |
| 12 | # |
| 13 | # Copyright 1999, Bioreason, Inc., all rights reserved. |
| 14 | # Author: Andrew Dalke |
| 15 | # |
| 16 | # Copyright 1995-1997, Automatrix, Inc., all rights reserved. |
| 17 | # Author: Skip Montanaro |
| 18 | # |
| 19 | # Copyright 1991-1995, Stichting Mathematisch Centrum, all rights reserved. |
| 20 | # |
| 21 | # |
| 22 | # Permission to use, copy, modify, and distribute this Python software and |
| 23 | # its associated documentation for any purpose without fee is hereby |
| 24 | # granted, provided that the above copyright notice appears in all copies, |
| 25 | # and that both that copyright notice and this permission notice appear in |
| 26 | # supporting documentation, and that the name of neither Automatrix, |
| 27 | # Bioreason or Mojam Media be used in advertising or publicity pertaining to |
| 28 | # distribution of the software without specific, written prior permission. |
| 29 | # |
| 30 | """program/module to trace Python program or function execution |
| 31 | |
| 32 | Sample use, command line: |
| 33 | trace.py -c -f counts --ignore-dir '$prefix' spam.py eggs |
| 34 | trace.py -t --ignore-dir '$prefix' spam.py eggs |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 35 | trace.py --trackcalls spam.py eggs |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 36 | |
| 37 | Sample use, programmatically |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 38 | import sys |
| 39 | |
| 40 | # create a Trace object, telling it what to ignore, and whether to |
| 41 | # do tracing or line-counting or both. |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 42 | tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix,], |
| 43 | trace=0, count=1) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 44 | # run the new command using the given tracer |
| 45 | tracer.run('main()') |
| 46 | # make a report, placing output in /tmp |
| 47 | r = tracer.results() |
| 48 | r.write_results(show_missing=True, coverdir="/tmp") |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 49 | """ |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 50 | __all__ = ['Trace', 'CoverageResults'] |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 51 | import io |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 52 | import linecache |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 53 | import os |
| 54 | import re |
| 55 | import sys |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 56 | import time |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 57 | import token |
| 58 | import tokenize |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 59 | import inspect |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 60 | import gc |
Alexander Belopolsky | ff09ce2 | 2010-09-24 18:03:12 +0000 | [diff] [blame] | 61 | import dis |
Guido van Rossum | 99603b0 | 2007-07-20 00:22:32 +0000 | [diff] [blame] | 62 | import pickle |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 63 | from warnings import warn as _warn |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame^] | 64 | try: |
| 65 | from time import monotonic as _time |
| 66 | except ImportError: |
| 67 | from time import time as _time |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 68 | |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 69 | try: |
| 70 | import threading |
| 71 | except ImportError: |
| 72 | _settrace = sys.settrace |
| 73 | |
| 74 | def _unsettrace(): |
| 75 | sys.settrace(None) |
| 76 | else: |
| 77 | def _settrace(func): |
| 78 | threading.settrace(func) |
| 79 | sys.settrace(func) |
| 80 | |
| 81 | def _unsettrace(): |
| 82 | sys.settrace(None) |
| 83 | threading.settrace(None) |
| 84 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 85 | def _usage(outfile): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 86 | outfile.write("""Usage: %s [OPTIONS] <file> [ARGS] |
| 87 | |
| 88 | Meta-options: |
| 89 | --help Display this help then exit. |
| 90 | --version Output version information then exit. |
| 91 | |
| 92 | Otherwise, exactly one of the following three options must be given: |
| 93 | -t, --trace Print each line to sys.stdout before it is executed. |
| 94 | -c, --count Count the number of times each line is executed |
| 95 | and write the counts to <module>.cover for each |
| 96 | module executed, in the module's directory. |
| 97 | See also `--coverdir', `--file', `--no-report' below. |
Skip Montanaro | a7b8ac6 | 2003-06-27 19:09:33 +0000 | [diff] [blame] | 98 | -l, --listfuncs Keep track of which functions are executed at least |
Fred Drake | 01c623b | 2003-06-27 19:22:11 +0000 | [diff] [blame] | 99 | once and write the results to sys.stdout after the |
Skip Montanaro | a7b8ac6 | 2003-06-27 19:09:33 +0000 | [diff] [blame] | 100 | program exits. |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 101 | -T, --trackcalls Keep track of caller/called pairs and write the |
| 102 | results to sys.stdout after the program exits. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 103 | -r, --report Generate a report from a counts file; do not execute |
| 104 | any code. `--file' must specify the results file to |
| 105 | read, which must have been created in a previous run |
| 106 | with `--count --file=FILE'. |
| 107 | |
| 108 | Modifiers: |
| 109 | -f, --file=<file> File to accumulate counts over several runs. |
| 110 | -R, --no-report Do not generate the coverage report files. |
| 111 | Useful if you want to accumulate over several runs. |
| 112 | -C, --coverdir=<dir> Directory where the report files. The coverage |
| 113 | report for <package>.<module> is written to file |
| 114 | <dir>/<package>/<module>.cover. |
| 115 | -m, --missing Annotate executable lines that were not executed |
| 116 | with '>>>>>> '. |
| 117 | -s, --summary Write a brief summary on stdout for each file. |
| 118 | (Can only be used with --count or --report.) |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 119 | -g, --timing Prefix each line with the time since the program started. |
| 120 | Only used while tracing. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 121 | |
| 122 | Filters, may be repeated multiple times: |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 123 | --ignore-module=<mod> Ignore the given module(s) and its submodules |
| 124 | (if it is a package). Accepts comma separated |
| 125 | list of module names |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 126 | --ignore-dir=<dir> Ignore files in the given directory (multiple |
| 127 | directories can be joined by os.pathsep). |
| 128 | """ % sys.argv[0]) |
| 129 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 130 | PRAGMA_NOCOVER = "#pragma NO COVER" |
| 131 | |
| 132 | # Simple rx to find lines with no code. |
| 133 | rx_blank = re.compile(r'^\s*(#.*)?$') |
| 134 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 135 | class _Ignore: |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 136 | def __init__(self, modules=None, dirs=None): |
| 137 | self._mods = set() if not modules else set(modules) |
| 138 | self._dirs = [] if not dirs else [os.path.normpath(d) |
| 139 | for d in dirs] |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 140 | self._ignore = { '<string>': 1 } |
| 141 | |
| 142 | def names(self, filename, modulename): |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 143 | if modulename in self._ignore: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 144 | return self._ignore[modulename] |
| 145 | |
| 146 | # haven't seen this one before, so see if the module name is |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 147 | # on the ignore list. |
| 148 | if modulename in self._mods: # Identical names, so ignore |
| 149 | self._ignore[modulename] = 1 |
| 150 | return 1 |
| 151 | |
| 152 | # check if the module is a proper submodule of something on |
| 153 | # the ignore list |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 154 | for mod in self._mods: |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 155 | # Need to take some care since ignoring |
| 156 | # "cmp" mustn't mean ignoring "cmpcache" but ignoring |
| 157 | # "Spam" must also mean ignoring "Spam.Eggs". |
| 158 | if modulename.startswith(mod + '.'): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 159 | self._ignore[modulename] = 1 |
| 160 | return 1 |
| 161 | |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 162 | # Now check that filename isn't in one of the directories |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 163 | if filename is None: |
| 164 | # must be a built-in, so we must ignore |
| 165 | self._ignore[modulename] = 1 |
| 166 | return 1 |
| 167 | |
| 168 | # Ignore a file when it contains one of the ignorable paths |
| 169 | for d in self._dirs: |
| 170 | # The '+ os.sep' is to ensure that d is a parent directory, |
| 171 | # as compared to cases like: |
| 172 | # d = "/usr/local" |
| 173 | # filename = "/usr/local.py" |
| 174 | # or |
| 175 | # d = "/usr/local.py" |
| 176 | # filename = "/usr/local.py" |
| 177 | if filename.startswith(d + os.sep): |
| 178 | self._ignore[modulename] = 1 |
| 179 | return 1 |
| 180 | |
| 181 | # Tried the different ways, so we don't ignore this module |
| 182 | self._ignore[modulename] = 0 |
| 183 | return 0 |
| 184 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 185 | def _modname(path): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 186 | """Return a plausible module name for the patch.""" |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 187 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 188 | base = os.path.basename(path) |
| 189 | filename, ext = os.path.splitext(base) |
| 190 | return filename |
| 191 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 192 | def _fullmodname(path): |
Jeremy Hylton | c8c8b94 | 2003-04-22 15:35:51 +0000 | [diff] [blame] | 193 | """Return a plausible module name for the path.""" |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 194 | |
| 195 | # If the file 'path' is part of a package, then the filename isn't |
| 196 | # enough to uniquely identify it. Try to do the right thing by |
| 197 | # looking in sys.path for the longest matching prefix. We'll |
| 198 | # assume that the rest is the package name. |
| 199 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 200 | comparepath = os.path.normcase(path) |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 201 | longest = "" |
| 202 | for dir in sys.path: |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 203 | dir = os.path.normcase(dir) |
| 204 | if comparepath.startswith(dir) and comparepath[len(dir)] == os.sep: |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 205 | if len(dir) > len(longest): |
| 206 | longest = dir |
| 207 | |
Guido van Rossum | b427c00 | 2003-10-10 23:02:01 +0000 | [diff] [blame] | 208 | if longest: |
| 209 | base = path[len(longest) + 1:] |
| 210 | else: |
| 211 | base = path |
Georg Brandl | 120d633 | 2010-08-01 14:38:17 +0000 | [diff] [blame] | 212 | # the drive letter is never part of the module name |
| 213 | drive, base = os.path.splitdrive(base) |
Guido van Rossum | bbca8da | 2004-02-19 19:16:50 +0000 | [diff] [blame] | 214 | base = base.replace(os.sep, ".") |
| 215 | if os.altsep: |
| 216 | base = base.replace(os.altsep, ".") |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 217 | filename, ext = os.path.splitext(base) |
Georg Brandl | 120d633 | 2010-08-01 14:38:17 +0000 | [diff] [blame] | 218 | return filename.lstrip(".") |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 219 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 220 | class CoverageResults: |
| 221 | def __init__(self, counts=None, calledfuncs=None, infile=None, |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 222 | callers=None, outfile=None): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 223 | self.counts = counts |
| 224 | if self.counts is None: |
| 225 | self.counts = {} |
| 226 | self.counter = self.counts.copy() # map (filename, lineno) to count |
| 227 | self.calledfuncs = calledfuncs |
| 228 | if self.calledfuncs is None: |
| 229 | self.calledfuncs = {} |
| 230 | self.calledfuncs = self.calledfuncs.copy() |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 231 | self.callers = callers |
| 232 | if self.callers is None: |
| 233 | self.callers = {} |
| 234 | self.callers = self.callers.copy() |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 235 | self.infile = infile |
| 236 | self.outfile = outfile |
| 237 | if self.infile: |
Jeremy Hylton | d7ce86d | 2003-07-07 16:08:47 +0000 | [diff] [blame] | 238 | # Try to merge existing counts file. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 239 | try: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 240 | counts, calledfuncs, callers = \ |
| 241 | pickle.load(open(self.infile, 'rb')) |
| 242 | self.update(self.__class__(counts, calledfuncs, callers)) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 243 | except (IOError, EOFError, ValueError) as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 244 | print(("Skipping counts file %r: %s" |
| 245 | % (self.infile, err)), file=sys.stderr) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 246 | |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 247 | def is_ignored_filename(self, filename): |
| 248 | """Return True if the filename does not refer to a file |
| 249 | we want to have reported. |
| 250 | """ |
Brett Cannon | 9fe92d1 | 2012-04-10 21:05:53 -0400 | [diff] [blame] | 251 | return filename.startswith('<') and filename.endswith('>') |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 252 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 253 | def update(self, other): |
| 254 | """Merge in the data from another CoverageResults""" |
| 255 | counts = self.counts |
| 256 | calledfuncs = self.calledfuncs |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 257 | callers = self.callers |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 258 | other_counts = other.counts |
| 259 | other_calledfuncs = other.calledfuncs |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 260 | other_callers = other.callers |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 261 | |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 262 | for key in other_counts: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 263 | counts[key] = counts.get(key, 0) + other_counts[key] |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 264 | |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 265 | for key in other_calledfuncs: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 266 | calledfuncs[key] = 1 |
| 267 | |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 268 | for key in other_callers: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 269 | callers[key] = 1 |
| 270 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 271 | def write_results(self, show_missing=True, summary=False, coverdir=None): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 272 | """ |
| 273 | @param coverdir |
| 274 | """ |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 275 | if self.calledfuncs: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 276 | print() |
| 277 | print("functions called:") |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 278 | calls = self.calledfuncs |
Alexander Belopolsky | 533a167 | 2010-07-20 19:55:18 +0000 | [diff] [blame] | 279 | for filename, modulename, funcname in sorted(calls): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 280 | print(("filename: %s, modulename: %s, funcname: %s" |
| 281 | % (filename, modulename, funcname))) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 282 | |
| 283 | if self.callers: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 284 | print() |
| 285 | print("calling relationships:") |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 286 | lastfile = lastcfile = "" |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 287 | for ((pfile, pmod, pfunc), (cfile, cmod, cfunc)) \ |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 288 | in sorted(self.callers): |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 289 | if pfile != lastfile: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 290 | print() |
| 291 | print("***", pfile, "***") |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 292 | lastfile = pfile |
| 293 | lastcfile = "" |
| 294 | if cfile != pfile and lastcfile != cfile: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 295 | print(" -->", cfile) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 296 | lastcfile = cfile |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 297 | print(" %s.%s -> %s.%s" % (pmod, pfunc, cmod, cfunc)) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 298 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 299 | # turn the counts data ("(filename, lineno) = count") into something |
| 300 | # accessible on a per-file basis |
| 301 | per_file = {} |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 302 | for filename, lineno in self.counts: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 303 | lines_hit = per_file[filename] = per_file.get(filename, {}) |
| 304 | lines_hit[lineno] = self.counts[(filename, lineno)] |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 305 | |
| 306 | # accumulate summary info, if needed |
| 307 | sums = {} |
| 308 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 309 | for filename, count in per_file.items(): |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 310 | if self.is_ignored_filename(filename): |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 311 | continue |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 312 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 313 | if filename.endswith((".pyc", ".pyo")): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 314 | filename = filename[:-1] |
| 315 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 316 | if coverdir is None: |
| 317 | dir = os.path.dirname(os.path.abspath(filename)) |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 318 | modulename = _modname(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 319 | else: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 320 | dir = coverdir |
| 321 | if not os.path.exists(dir): |
| 322 | os.makedirs(dir) |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 323 | modulename = _fullmodname(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 324 | |
| 325 | # If desired, get a list of the line numbers which represent |
| 326 | # executable content (returned as a dict for better lookup speed) |
| 327 | if show_missing: |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 328 | lnotab = _find_executable_linenos(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 329 | else: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 330 | lnotab = {} |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 331 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 332 | source = linecache.getlines(filename) |
| 333 | coverpath = os.path.join(dir, modulename + ".cover") |
Victor Stinner | 64bc3b2 | 2010-11-07 15:47:36 +0000 | [diff] [blame] | 334 | with open(filename, 'rb') as fp: |
| 335 | encoding, _ = tokenize.detect_encoding(fp.readline) |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 336 | n_hits, n_lines = self.write_results_file(coverpath, source, |
Victor Stinner | 64bc3b2 | 2010-11-07 15:47:36 +0000 | [diff] [blame] | 337 | lnotab, count, encoding) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 338 | if summary and n_lines: |
| 339 | percent = int(100 * n_hits / n_lines) |
| 340 | sums[modulename] = n_lines, percent, modulename, filename |
| 341 | |
| 342 | if summary and sums: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 343 | print("lines cov% module (path)") |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 344 | for m in sorted(sums): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 345 | n_lines, percent, modulename, filename = sums[m] |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 346 | print("%5d %3d%% %s (%s)" % sums[m]) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 347 | |
| 348 | if self.outfile: |
| 349 | # try and store counts and module info into self.outfile |
| 350 | try: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 351 | pickle.dump((self.counts, self.calledfuncs, self.callers), |
Jeremy Hylton | d0e2705 | 2003-10-14 20:12:06 +0000 | [diff] [blame] | 352 | open(self.outfile, 'wb'), 1) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 353 | except IOError as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 354 | print("Can't save counts files because %s" % err, file=sys.stderr) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 355 | |
Victor Stinner | 64bc3b2 | 2010-11-07 15:47:36 +0000 | [diff] [blame] | 356 | def write_results_file(self, path, lines, lnotab, lines_hit, encoding=None): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 357 | """Return a coverage results file in path.""" |
| 358 | |
| 359 | try: |
Victor Stinner | 64bc3b2 | 2010-11-07 15:47:36 +0000 | [diff] [blame] | 360 | outfile = open(path, "w", encoding=encoding) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 361 | except IOError as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 362 | print(("trace: Could not open %r for writing: %s" |
| 363 | "- skipping" % (path, err)), file=sys.stderr) |
Guido van Rossum | bbca8da | 2004-02-19 19:16:50 +0000 | [diff] [blame] | 364 | return 0, 0 |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 365 | |
| 366 | n_lines = 0 |
| 367 | n_hits = 0 |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 368 | for lineno, line in enumerate(lines, 1): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 369 | # do the blank/comment match to try to mark more lines |
| 370 | # (help the reader find stuff that hasn't been covered) |
| 371 | if lineno in lines_hit: |
| 372 | outfile.write("%5d: " % lines_hit[lineno]) |
| 373 | n_hits += 1 |
| 374 | n_lines += 1 |
| 375 | elif rx_blank.match(line): |
Walter Dörwald | c171172 | 2003-07-15 10:34:02 +0000 | [diff] [blame] | 376 | outfile.write(" ") |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 377 | else: |
| 378 | # lines preceded by no marks weren't hit |
| 379 | # Highlight them if so indicated, unless the line contains |
| 380 | # #pragma: NO COVER |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 381 | if lineno in lnotab and not PRAGMA_NOCOVER in line: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 382 | outfile.write(">>>>>> ") |
Jeremy Hylton | 546e34b | 2003-06-26 14:56:17 +0000 | [diff] [blame] | 383 | n_lines += 1 |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 384 | else: |
| 385 | outfile.write(" ") |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 386 | outfile.write(line.expandtabs(8)) |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 387 | outfile.close() |
| 388 | |
| 389 | return n_hits, n_lines |
| 390 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 391 | def _find_lines_from_code(code, strs): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 392 | """Return dict where keys are lines in the line number table.""" |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 393 | linenos = {} |
| 394 | |
Alexander Belopolsky | ff09ce2 | 2010-09-24 18:03:12 +0000 | [diff] [blame] | 395 | for _, lineno in dis.findlinestarts(code): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 396 | if lineno not in strs: |
| 397 | linenos[lineno] = 1 |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 398 | |
| 399 | return linenos |
| 400 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 401 | def _find_lines(code, strs): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 402 | """Return lineno dict for all code objects reachable from code.""" |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 403 | # get all of the lineno information from the code of this scope level |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 404 | linenos = _find_lines_from_code(code, strs) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 405 | |
| 406 | # and check the constants for references to other code objects |
| 407 | for c in code.co_consts: |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 408 | if inspect.iscode(c): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 409 | # find another code object, so recurse into it |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 410 | linenos.update(_find_lines(c, strs)) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 411 | return linenos |
| 412 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 413 | def _find_strings(filename, encoding=None): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 414 | """Return a dict of possible docstring positions. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 415 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 416 | The dict maps line numbers to strings. There is an entry for |
| 417 | line that contains only a string or a part of a triple-quoted |
| 418 | string. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 419 | """ |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 420 | d = {} |
| 421 | # If the first token is a string, then it's the module docstring. |
| 422 | # Add this special case so that the test in the loop passes. |
| 423 | prev_ttype = token.INDENT |
Benjamin Peterson | b2fda23 | 2010-10-30 23:51:34 +0000 | [diff] [blame] | 424 | with open(filename, encoding=encoding) as f: |
| 425 | tok = tokenize.generate_tokens(f.readline) |
| 426 | for ttype, tstr, start, end, line in tok: |
| 427 | if ttype == token.STRING: |
| 428 | if prev_ttype == token.INDENT: |
| 429 | sline, scol = start |
| 430 | eline, ecol = end |
| 431 | for i in range(sline, eline + 1): |
| 432 | d[i] = 1 |
| 433 | prev_ttype = ttype |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 434 | return d |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 435 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 436 | def _find_executable_linenos(filename): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 437 | """Return dict where keys are line numbers in the line number table.""" |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 438 | try: |
Victor Stinner | 58c0752 | 2010-11-09 01:08:59 +0000 | [diff] [blame] | 439 | with tokenize.open(filename) as f: |
Benjamin Peterson | b2fda23 | 2010-10-30 23:51:34 +0000 | [diff] [blame] | 440 | prog = f.read() |
Victor Stinner | 58c0752 | 2010-11-09 01:08:59 +0000 | [diff] [blame] | 441 | encoding = f.encoding |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 442 | except IOError as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 443 | print(("Not printing coverage data for %r: %s" |
| 444 | % (filename, err)), file=sys.stderr) |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 445 | return {} |
| 446 | code = compile(prog, filename, "exec") |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 447 | strs = _find_strings(filename, encoding) |
| 448 | return _find_lines(code, strs) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 449 | |
| 450 | class Trace: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 451 | def __init__(self, count=1, trace=1, countfuncs=0, countcallers=0, |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 452 | ignoremods=(), ignoredirs=(), infile=None, outfile=None, |
| 453 | timing=False): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 454 | """ |
| 455 | @param count true iff it should count number of times each |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 456 | line is executed |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 457 | @param trace true iff it should print out each line that is |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 458 | being counted |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 459 | @param countfuncs true iff it should just output a list of |
| 460 | (filename, modulename, funcname,) for functions |
| 461 | that were called at least once; This overrides |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 462 | `count' and `trace' |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 463 | @param ignoremods a list of the names of modules to ignore |
| 464 | @param ignoredirs a list of the names of directories to ignore |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 465 | all of the (recursive) contents of |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 466 | @param infile file from which to read stored counts to be |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 467 | added into the results |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 468 | @param outfile file in which to write the results |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 469 | @param timing true iff timing information be displayed |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 470 | """ |
| 471 | self.infile = infile |
| 472 | self.outfile = outfile |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 473 | self.ignore = _Ignore(ignoremods, ignoredirs) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 474 | self.counts = {} # keys are (filename, linenumber) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 475 | self.pathtobasename = {} # for memoizing os.path.basename |
| 476 | self.donothing = 0 |
| 477 | self.trace = trace |
| 478 | self._calledfuncs = {} |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 479 | self._callers = {} |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 480 | self._caller_cache = {} |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 481 | self.start_time = None |
| 482 | if timing: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame^] | 483 | self.start_time = _time() |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 484 | if countcallers: |
| 485 | self.globaltrace = self.globaltrace_trackcallers |
| 486 | elif countfuncs: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 487 | self.globaltrace = self.globaltrace_countfuncs |
| 488 | elif trace and count: |
| 489 | self.globaltrace = self.globaltrace_lt |
| 490 | self.localtrace = self.localtrace_trace_and_count |
| 491 | elif trace: |
| 492 | self.globaltrace = self.globaltrace_lt |
| 493 | self.localtrace = self.localtrace_trace |
| 494 | elif count: |
| 495 | self.globaltrace = self.globaltrace_lt |
| 496 | self.localtrace = self.localtrace_count |
| 497 | else: |
| 498 | # Ahem -- do nothing? Okay. |
| 499 | self.donothing = 1 |
| 500 | |
| 501 | def run(self, cmd): |
| 502 | import __main__ |
| 503 | dict = __main__.__dict__ |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 504 | self.runctx(cmd, dict, dict) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 505 | |
| 506 | def runctx(self, cmd, globals=None, locals=None): |
| 507 | if globals is None: globals = {} |
| 508 | if locals is None: locals = {} |
| 509 | if not self.donothing: |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 510 | _settrace(self.globaltrace) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 511 | try: |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 512 | exec(cmd, globals, locals) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 513 | finally: |
| 514 | if not self.donothing: |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 515 | _unsettrace() |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 516 | |
| 517 | def runfunc(self, func, *args, **kw): |
| 518 | result = None |
| 519 | if not self.donothing: |
| 520 | sys.settrace(self.globaltrace) |
| 521 | try: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 522 | result = func(*args, **kw) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 523 | finally: |
| 524 | if not self.donothing: |
| 525 | sys.settrace(None) |
| 526 | return result |
| 527 | |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 528 | def file_module_function_of(self, frame): |
| 529 | code = frame.f_code |
| 530 | filename = code.co_filename |
| 531 | if filename: |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 532 | modulename = _modname(filename) |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 533 | else: |
| 534 | modulename = None |
| 535 | |
| 536 | funcname = code.co_name |
| 537 | clsname = None |
| 538 | if code in self._caller_cache: |
| 539 | if self._caller_cache[code] is not None: |
| 540 | clsname = self._caller_cache[code] |
| 541 | else: |
| 542 | self._caller_cache[code] = None |
| 543 | ## use of gc.get_referrers() was suggested by Michael Hudson |
| 544 | # all functions which refer to this code object |
| 545 | funcs = [f for f in gc.get_referrers(code) |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 546 | if inspect.isfunction(f)] |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 547 | # require len(func) == 1 to avoid ambiguity caused by calls to |
| 548 | # new.function(): "In the face of ambiguity, refuse the |
| 549 | # temptation to guess." |
| 550 | if len(funcs) == 1: |
| 551 | dicts = [d for d in gc.get_referrers(funcs[0]) |
| 552 | if isinstance(d, dict)] |
| 553 | if len(dicts) == 1: |
| 554 | classes = [c for c in gc.get_referrers(dicts[0]) |
| 555 | if hasattr(c, "__bases__")] |
| 556 | if len(classes) == 1: |
| 557 | # ditto for new.classobj() |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 558 | clsname = classes[0].__name__ |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 559 | # cache the result - assumption is that new.* is |
| 560 | # not called later to disturb this relationship |
| 561 | # _caller_cache could be flushed if functions in |
| 562 | # the new module get called. |
| 563 | self._caller_cache[code] = clsname |
| 564 | if clsname is not None: |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 565 | funcname = "%s.%s" % (clsname, funcname) |
| 566 | |
| 567 | return filename, modulename, funcname |
| 568 | |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 569 | def globaltrace_trackcallers(self, frame, why, arg): |
| 570 | """Handler for call events. |
| 571 | |
| 572 | Adds information about who called who to the self._callers dict. |
| 573 | """ |
| 574 | if why == 'call': |
| 575 | # XXX Should do a better job of identifying methods |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 576 | this_func = self.file_module_function_of(frame) |
| 577 | parent_func = self.file_module_function_of(frame.f_back) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 578 | self._callers[(parent_func, this_func)] = 1 |
| 579 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 580 | def globaltrace_countfuncs(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 581 | """Handler for call events. |
Tim Peters | 0eadaac | 2003-04-24 16:02:54 +0000 | [diff] [blame] | 582 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 583 | Adds (filename, modulename, funcname) to the self._calledfuncs dict. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 584 | """ |
| 585 | if why == 'call': |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 586 | this_func = self.file_module_function_of(frame) |
| 587 | self._calledfuncs[this_func] = 1 |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 588 | |
| 589 | def globaltrace_lt(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 590 | """Handler for call events. |
| 591 | |
| 592 | If the code block being entered is to be ignored, returns `None', |
| 593 | else returns self.localtrace. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 594 | """ |
| 595 | if why == 'call': |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 596 | code = frame.f_code |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 597 | filename = frame.f_globals.get('__file__', None) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 598 | if filename: |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 599 | # XXX _modname() doesn't work right for packages, so |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 600 | # the ignore support won't work right for packages |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 601 | modulename = _modname(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 602 | if modulename is not None: |
| 603 | ignore_it = self.ignore.names(filename, modulename) |
| 604 | if not ignore_it: |
| 605 | if self.trace: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 606 | print((" --- modulename: %s, funcname: %s" |
| 607 | % (modulename, code.co_name))) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 608 | return self.localtrace |
| 609 | else: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 610 | return None |
| 611 | |
| 612 | def localtrace_trace_and_count(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 613 | if why == "line": |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 614 | # record the file name and line number of every trace |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 615 | filename = frame.f_code.co_filename |
| 616 | lineno = frame.f_lineno |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 617 | key = filename, lineno |
| 618 | self.counts[key] = self.counts.get(key, 0) + 1 |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 619 | |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 620 | if self.start_time: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame^] | 621 | print('%.2f' % (_time() - self.start_time), end=' ') |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 622 | bname = os.path.basename(filename) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 623 | print("%s(%d): %s" % (bname, lineno, |
Georg Brandl | dc50c69 | 2010-08-02 12:40:22 +0000 | [diff] [blame] | 624 | linecache.getline(filename, lineno)), end='') |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 625 | return self.localtrace |
| 626 | |
| 627 | def localtrace_trace(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 628 | if why == "line": |
| 629 | # record the file name and line number of every trace |
| 630 | filename = frame.f_code.co_filename |
| 631 | lineno = frame.f_lineno |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 632 | |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 633 | if self.start_time: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame^] | 634 | print('%.2f' % (_time() - self.start_time), end=' ') |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 635 | bname = os.path.basename(filename) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 636 | print("%s(%d): %s" % (bname, lineno, |
Georg Brandl | dc50c69 | 2010-08-02 12:40:22 +0000 | [diff] [blame] | 637 | linecache.getline(filename, lineno)), end='') |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 638 | return self.localtrace |
| 639 | |
| 640 | def localtrace_count(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 641 | if why == "line": |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 642 | filename = frame.f_code.co_filename |
| 643 | lineno = frame.f_lineno |
| 644 | key = filename, lineno |
| 645 | self.counts[key] = self.counts.get(key, 0) + 1 |
| 646 | return self.localtrace |
| 647 | |
| 648 | def results(self): |
| 649 | return CoverageResults(self.counts, infile=self.infile, |
| 650 | outfile=self.outfile, |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 651 | calledfuncs=self._calledfuncs, |
| 652 | callers=self._callers) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 653 | |
| 654 | def _err_exit(msg): |
| 655 | sys.stderr.write("%s: %s\n" % (sys.argv[0], msg)) |
| 656 | sys.exit(1) |
| 657 | |
| 658 | def main(argv=None): |
| 659 | import getopt |
| 660 | |
| 661 | if argv is None: |
| 662 | argv = sys.argv |
| 663 | try: |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 664 | opts, prog_argv = getopt.getopt(argv[1:], "tcrRf:d:msC:lTg", |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 665 | ["help", "version", "trace", "count", |
| 666 | "report", "no-report", "summary", |
| 667 | "file=", "missing", |
| 668 | "ignore-module=", "ignore-dir=", |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 669 | "coverdir=", "listfuncs", |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 670 | "trackcalls", "timing"]) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 671 | |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 672 | except getopt.error as msg: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 673 | sys.stderr.write("%s: %s\n" % (sys.argv[0], msg)) |
| 674 | sys.stderr.write("Try `%s --help' for more information\n" |
| 675 | % sys.argv[0]) |
| 676 | sys.exit(1) |
| 677 | |
| 678 | trace = 0 |
| 679 | count = 0 |
| 680 | report = 0 |
| 681 | no_report = 0 |
| 682 | counts_file = None |
| 683 | missing = 0 |
| 684 | ignore_modules = [] |
| 685 | ignore_dirs = [] |
| 686 | coverdir = None |
| 687 | summary = 0 |
| 688 | listfuncs = False |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 689 | countcallers = False |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 690 | timing = False |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 691 | |
| 692 | for opt, val in opts: |
| 693 | if opt == "--help": |
Éric Araujo | e7d36fe | 2011-04-17 16:48:52 +0200 | [diff] [blame] | 694 | _usage(sys.stdout) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 695 | sys.exit(0) |
| 696 | |
| 697 | if opt == "--version": |
| 698 | sys.stdout.write("trace 2.0\n") |
| 699 | sys.exit(0) |
| 700 | |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 701 | if opt == "-T" or opt == "--trackcalls": |
| 702 | countcallers = True |
| 703 | continue |
| 704 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 705 | if opt == "-l" or opt == "--listfuncs": |
| 706 | listfuncs = True |
| 707 | continue |
| 708 | |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 709 | if opt == "-g" or opt == "--timing": |
| 710 | timing = True |
| 711 | continue |
| 712 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 713 | if opt == "-t" or opt == "--trace": |
| 714 | trace = 1 |
| 715 | continue |
| 716 | |
| 717 | if opt == "-c" or opt == "--count": |
| 718 | count = 1 |
| 719 | continue |
| 720 | |
| 721 | if opt == "-r" or opt == "--report": |
| 722 | report = 1 |
| 723 | continue |
| 724 | |
| 725 | if opt == "-R" or opt == "--no-report": |
| 726 | no_report = 1 |
| 727 | continue |
| 728 | |
| 729 | if opt == "-f" or opt == "--file": |
| 730 | counts_file = val |
| 731 | continue |
| 732 | |
| 733 | if opt == "-m" or opt == "--missing": |
| 734 | missing = 1 |
| 735 | continue |
| 736 | |
| 737 | if opt == "-C" or opt == "--coverdir": |
| 738 | coverdir = val |
| 739 | continue |
| 740 | |
| 741 | if opt == "-s" or opt == "--summary": |
| 742 | summary = 1 |
| 743 | continue |
| 744 | |
| 745 | if opt == "--ignore-module": |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 746 | for mod in val.split(","): |
| 747 | ignore_modules.append(mod.strip()) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 748 | continue |
| 749 | |
| 750 | if opt == "--ignore-dir": |
| 751 | for s in val.split(os.pathsep): |
| 752 | s = os.path.expandvars(s) |
| 753 | # should I also call expanduser? (after all, could use $HOME) |
| 754 | |
| 755 | s = s.replace("$prefix", |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 756 | os.path.join(sys.base_prefix, "lib", |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 757 | "python" + sys.version[:3])) |
| 758 | s = s.replace("$exec_prefix", |
Vinay Sajip | 7ded1f0 | 2012-05-26 03:45:29 +0100 | [diff] [blame] | 759 | os.path.join(sys.base_exec_prefix, "lib", |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 760 | "python" + sys.version[:3])) |
| 761 | s = os.path.normpath(s) |
| 762 | ignore_dirs.append(s) |
| 763 | continue |
| 764 | |
| 765 | assert 0, "Should never get here" |
| 766 | |
| 767 | if listfuncs and (count or trace): |
| 768 | _err_exit("cannot specify both --listfuncs and (--trace or --count)") |
| 769 | |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 770 | if not (count or trace or report or listfuncs or countcallers): |
| 771 | _err_exit("must specify one of --trace, --count, --report, " |
| 772 | "--listfuncs, or --trackcalls") |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 773 | |
| 774 | if report and no_report: |
| 775 | _err_exit("cannot specify both --report and --no-report") |
| 776 | |
| 777 | if report and not counts_file: |
| 778 | _err_exit("--report requires a --file") |
| 779 | |
| 780 | if no_report and len(prog_argv) == 0: |
| 781 | _err_exit("missing name of file to run") |
| 782 | |
| 783 | # everything is ready |
| 784 | if report: |
| 785 | results = CoverageResults(infile=counts_file, outfile=counts_file) |
| 786 | results.write_results(missing, summary=summary, coverdir=coverdir) |
| 787 | else: |
| 788 | sys.argv = prog_argv |
| 789 | progname = prog_argv[0] |
| 790 | sys.path[0] = os.path.split(progname)[0] |
| 791 | |
| 792 | t = Trace(count, trace, countfuncs=listfuncs, |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 793 | countcallers=countcallers, ignoremods=ignore_modules, |
| 794 | ignoredirs=ignore_dirs, infile=counts_file, |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 795 | outfile=counts_file, timing=timing) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 796 | try: |
Alexander Belopolsky | 3f8ecab | 2010-07-21 17:43:42 +0000 | [diff] [blame] | 797 | with open(progname) as fp: |
| 798 | code = compile(fp.read(), progname, 'exec') |
Georg Brandl | 8f9f466 | 2010-08-01 08:35:29 +0000 | [diff] [blame] | 799 | # try to emulate __main__ namespace as much as possible |
| 800 | globs = { |
| 801 | '__file__': progname, |
| 802 | '__name__': '__main__', |
| 803 | '__package__': None, |
| 804 | '__cached__': None, |
| 805 | } |
| 806 | t.runctx(code, globs, globs) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 807 | except IOError as err: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 808 | _err_exit("Cannot run file %r because: %s" % (sys.argv[0], err)) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 809 | except SystemExit: |
| 810 | pass |
| 811 | |
| 812 | results = t.results() |
| 813 | |
| 814 | if not no_report: |
| 815 | results.write_results(missing, summary=summary, coverdir=coverdir) |
| 816 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 817 | # Deprecated API |
| 818 | def usage(outfile): |
| 819 | _warn("The trace.usage() function is deprecated", |
| 820 | DeprecationWarning, 2) |
| 821 | _usage(outfile) |
| 822 | |
| 823 | class Ignore(_Ignore): |
| 824 | def __init__(self, modules=None, dirs=None): |
| 825 | _warn("The class trace.Ignore is deprecated", |
| 826 | DeprecationWarning, 2) |
| 827 | _Ignore.__init__(self, modules, dirs) |
| 828 | |
| 829 | def modname(path): |
| 830 | _warn("The trace.modname() function is deprecated", |
| 831 | DeprecationWarning, 2) |
| 832 | return _modname(path) |
| 833 | |
| 834 | def fullmodname(path): |
| 835 | _warn("The trace.fullmodname() function is deprecated", |
| 836 | DeprecationWarning, 2) |
| 837 | return _fullmodname(path) |
| 838 | |
| 839 | def find_lines_from_code(code, strs): |
| 840 | _warn("The trace.find_lines_from_code() function is deprecated", |
| 841 | DeprecationWarning, 2) |
| 842 | return _find_lines_from_code(code, strs) |
| 843 | |
| 844 | def find_lines(code, strs): |
| 845 | _warn("The trace.find_lines() function is deprecated", |
| 846 | DeprecationWarning, 2) |
| 847 | return _find_lines(code, strs) |
| 848 | |
| 849 | def find_strings(filename, encoding=None): |
| 850 | _warn("The trace.find_strings() function is deprecated", |
| 851 | DeprecationWarning, 2) |
| 852 | return _find_strings(filename, encoding=None) |
| 853 | |
| 854 | def find_executable_linenos(filename): |
| 855 | _warn("The trace.find_executable_linenos() function is deprecated", |
| 856 | DeprecationWarning, 2) |
| 857 | return _find_executable_linenos(filename) |
| 858 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 859 | if __name__=='__main__': |
| 860 | main() |