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'] |
Serhiy Storchaka | 7e4db2f | 2017-05-04 08:17:47 +0300 | [diff] [blame] | 51 | |
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 |
| 56 | import token |
| 57 | import tokenize |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 58 | import inspect |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 59 | import gc |
Alexander Belopolsky | ff09ce2 | 2010-09-24 18:03:12 +0000 | [diff] [blame] | 60 | import dis |
Guido van Rossum | 99603b0 | 2007-07-20 00:22:32 +0000 | [diff] [blame] | 61 | import pickle |
Victor Stinner | ae58649 | 2014-09-02 23:18:25 +0200 | [diff] [blame] | 62 | from time import monotonic as _time |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 63 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 64 | import threading |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 65 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 66 | def _settrace(func): |
| 67 | threading.settrace(func) |
| 68 | sys.settrace(func) |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 69 | |
Antoine Pitrou | a6a4dc8 | 2017-09-07 18:56:24 +0200 | [diff] [blame] | 70 | def _unsettrace(): |
| 71 | sys.settrace(None) |
| 72 | threading.settrace(None) |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 73 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 74 | PRAGMA_NOCOVER = "#pragma NO COVER" |
| 75 | |
| 76 | # Simple rx to find lines with no code. |
| 77 | rx_blank = re.compile(r'^\s*(#.*)?$') |
| 78 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 79 | class _Ignore: |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 80 | def __init__(self, modules=None, dirs=None): |
| 81 | self._mods = set() if not modules else set(modules) |
| 82 | self._dirs = [] if not dirs else [os.path.normpath(d) |
| 83 | for d in dirs] |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 84 | self._ignore = { '<string>': 1 } |
| 85 | |
| 86 | def names(self, filename, modulename): |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 87 | if modulename in self._ignore: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 88 | return self._ignore[modulename] |
| 89 | |
| 90 | # 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] | 91 | # on the ignore list. |
| 92 | if modulename in self._mods: # Identical names, so ignore |
| 93 | self._ignore[modulename] = 1 |
| 94 | return 1 |
| 95 | |
| 96 | # check if the module is a proper submodule of something on |
| 97 | # the ignore list |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 98 | for mod in self._mods: |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 99 | # Need to take some care since ignoring |
| 100 | # "cmp" mustn't mean ignoring "cmpcache" but ignoring |
| 101 | # "Spam" must also mean ignoring "Spam.Eggs". |
| 102 | if modulename.startswith(mod + '.'): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 103 | self._ignore[modulename] = 1 |
| 104 | return 1 |
| 105 | |
Alexander Belopolsky | 6672ea9 | 2010-11-08 18:32:40 +0000 | [diff] [blame] | 106 | # Now check that filename isn't in one of the directories |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 107 | if filename is None: |
| 108 | # must be a built-in, so we must ignore |
| 109 | self._ignore[modulename] = 1 |
| 110 | return 1 |
| 111 | |
| 112 | # Ignore a file when it contains one of the ignorable paths |
| 113 | for d in self._dirs: |
| 114 | # The '+ os.sep' is to ensure that d is a parent directory, |
| 115 | # as compared to cases like: |
| 116 | # d = "/usr/local" |
| 117 | # filename = "/usr/local.py" |
| 118 | # or |
| 119 | # d = "/usr/local.py" |
| 120 | # filename = "/usr/local.py" |
| 121 | if filename.startswith(d + os.sep): |
| 122 | self._ignore[modulename] = 1 |
| 123 | return 1 |
| 124 | |
| 125 | # Tried the different ways, so we don't ignore this module |
| 126 | self._ignore[modulename] = 0 |
| 127 | return 0 |
| 128 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 129 | def _modname(path): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 130 | """Return a plausible module name for the patch.""" |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 131 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 132 | base = os.path.basename(path) |
| 133 | filename, ext = os.path.splitext(base) |
| 134 | return filename |
| 135 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 136 | def _fullmodname(path): |
Jeremy Hylton | c8c8b94 | 2003-04-22 15:35:51 +0000 | [diff] [blame] | 137 | """Return a plausible module name for the path.""" |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 138 | |
| 139 | # If the file 'path' is part of a package, then the filename isn't |
| 140 | # enough to uniquely identify it. Try to do the right thing by |
| 141 | # looking in sys.path for the longest matching prefix. We'll |
| 142 | # assume that the rest is the package name. |
| 143 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 144 | comparepath = os.path.normcase(path) |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 145 | longest = "" |
| 146 | for dir in sys.path: |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 147 | dir = os.path.normcase(dir) |
| 148 | if comparepath.startswith(dir) and comparepath[len(dir)] == os.sep: |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 149 | if len(dir) > len(longest): |
| 150 | longest = dir |
| 151 | |
Guido van Rossum | b427c00 | 2003-10-10 23:02:01 +0000 | [diff] [blame] | 152 | if longest: |
| 153 | base = path[len(longest) + 1:] |
| 154 | else: |
| 155 | base = path |
Georg Brandl | 120d633 | 2010-08-01 14:38:17 +0000 | [diff] [blame] | 156 | # the drive letter is never part of the module name |
| 157 | drive, base = os.path.splitdrive(base) |
Guido van Rossum | bbca8da | 2004-02-19 19:16:50 +0000 | [diff] [blame] | 158 | base = base.replace(os.sep, ".") |
| 159 | if os.altsep: |
| 160 | base = base.replace(os.altsep, ".") |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 161 | filename, ext = os.path.splitext(base) |
Georg Brandl | 120d633 | 2010-08-01 14:38:17 +0000 | [diff] [blame] | 162 | return filename.lstrip(".") |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 163 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 164 | class CoverageResults: |
| 165 | def __init__(self, counts=None, calledfuncs=None, infile=None, |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 166 | callers=None, outfile=None): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 167 | self.counts = counts |
| 168 | if self.counts is None: |
| 169 | self.counts = {} |
| 170 | self.counter = self.counts.copy() # map (filename, lineno) to count |
| 171 | self.calledfuncs = calledfuncs |
| 172 | if self.calledfuncs is None: |
| 173 | self.calledfuncs = {} |
| 174 | self.calledfuncs = self.calledfuncs.copy() |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 175 | self.callers = callers |
| 176 | if self.callers is None: |
| 177 | self.callers = {} |
| 178 | self.callers = self.callers.copy() |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 179 | self.infile = infile |
| 180 | self.outfile = outfile |
| 181 | if self.infile: |
Jeremy Hylton | d7ce86d | 2003-07-07 16:08:47 +0000 | [diff] [blame] | 182 | # Try to merge existing counts file. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 183 | try: |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 184 | with open(self.infile, 'rb') as f: |
| 185 | counts, calledfuncs, callers = pickle.load(f) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 186 | self.update(self.__class__(counts, calledfuncs, callers)) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 187 | except (OSError, EOFError, ValueError) as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 188 | print(("Skipping counts file %r: %s" |
| 189 | % (self.infile, err)), file=sys.stderr) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 190 | |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 191 | def is_ignored_filename(self, filename): |
| 192 | """Return True if the filename does not refer to a file |
| 193 | we want to have reported. |
| 194 | """ |
Brett Cannon | 9fe92d1 | 2012-04-10 21:05:53 -0400 | [diff] [blame] | 195 | return filename.startswith('<') and filename.endswith('>') |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 196 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 197 | def update(self, other): |
| 198 | """Merge in the data from another CoverageResults""" |
| 199 | counts = self.counts |
| 200 | calledfuncs = self.calledfuncs |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 201 | callers = self.callers |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 202 | other_counts = other.counts |
| 203 | other_calledfuncs = other.calledfuncs |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 204 | other_callers = other.callers |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 205 | |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 206 | for key in other_counts: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 207 | counts[key] = counts.get(key, 0) + other_counts[key] |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 208 | |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 209 | for key in other_calledfuncs: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 210 | calledfuncs[key] = 1 |
| 211 | |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 212 | for key in other_callers: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 213 | callers[key] = 1 |
| 214 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 215 | def write_results(self, show_missing=True, summary=False, coverdir=None): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 216 | """ |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 217 | Write the coverage results. |
| 218 | |
| 219 | :param show_missing: Show lines that had no hits. |
| 220 | :param summary: Include coverage summary per module. |
Martin Panter | 0f29ad1 | 2016-06-04 05:06:25 +0000 | [diff] [blame] | 221 | :param coverdir: If None, the results of each module are placed in its |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 222 | directory, otherwise it is included in the directory |
| 223 | specified. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 224 | """ |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 225 | if self.calledfuncs: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 226 | print() |
| 227 | print("functions called:") |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 228 | calls = self.calledfuncs |
Alexander Belopolsky | 533a167 | 2010-07-20 19:55:18 +0000 | [diff] [blame] | 229 | for filename, modulename, funcname in sorted(calls): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 230 | print(("filename: %s, modulename: %s, funcname: %s" |
| 231 | % (filename, modulename, funcname))) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 232 | |
| 233 | if self.callers: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 234 | print() |
| 235 | print("calling relationships:") |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 236 | lastfile = lastcfile = "" |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 237 | for ((pfile, pmod, pfunc), (cfile, cmod, cfunc)) \ |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 238 | in sorted(self.callers): |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 239 | if pfile != lastfile: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 240 | print() |
| 241 | print("***", pfile, "***") |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 242 | lastfile = pfile |
| 243 | lastcfile = "" |
| 244 | if cfile != pfile and lastcfile != cfile: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 245 | print(" -->", cfile) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 246 | lastcfile = cfile |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 247 | print(" %s.%s -> %s.%s" % (pmod, pfunc, cmod, cfunc)) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 248 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 249 | # turn the counts data ("(filename, lineno) = count") into something |
| 250 | # accessible on a per-file basis |
| 251 | per_file = {} |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 252 | for filename, lineno in self.counts: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 253 | lines_hit = per_file[filename] = per_file.get(filename, {}) |
| 254 | lines_hit[lineno] = self.counts[(filename, lineno)] |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 255 | |
| 256 | # accumulate summary info, if needed |
| 257 | sums = {} |
| 258 | |
Guido van Rossum | cc2b016 | 2007-02-11 06:12:03 +0000 | [diff] [blame] | 259 | for filename, count in per_file.items(): |
Georg Brandl | 33c2881 | 2009-04-01 23:07:29 +0000 | [diff] [blame] | 260 | if self.is_ignored_filename(filename): |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 261 | continue |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 262 | |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 263 | if filename.endswith(".pyc"): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 264 | filename = filename[:-1] |
| 265 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 266 | if coverdir is None: |
| 267 | dir = os.path.dirname(os.path.abspath(filename)) |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 268 | modulename = _modname(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 269 | else: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 270 | dir = coverdir |
| 271 | if not os.path.exists(dir): |
| 272 | os.makedirs(dir) |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 273 | modulename = _fullmodname(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 274 | |
| 275 | # If desired, get a list of the line numbers which represent |
| 276 | # executable content (returned as a dict for better lookup speed) |
| 277 | if show_missing: |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 278 | lnotab = _find_executable_linenos(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 279 | else: |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 280 | lnotab = {} |
Alexander Belopolsky | f026dae | 2014-06-29 17:44:05 -0400 | [diff] [blame] | 281 | if lnotab: |
| 282 | source = linecache.getlines(filename) |
| 283 | coverpath = os.path.join(dir, modulename + ".cover") |
| 284 | with open(filename, 'rb') as fp: |
| 285 | encoding, _ = tokenize.detect_encoding(fp.readline) |
| 286 | n_hits, n_lines = self.write_results_file(coverpath, source, |
| 287 | lnotab, count, encoding) |
| 288 | if summary and n_lines: |
| 289 | percent = int(100 * n_hits / n_lines) |
| 290 | sums[modulename] = n_lines, percent, modulename, filename |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 291 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 292 | |
| 293 | if summary and sums: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 294 | print("lines cov% module (path)") |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 295 | for m in sorted(sums): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 296 | n_lines, percent, modulename, filename = sums[m] |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 297 | print("%5d %3d%% %s (%s)" % sums[m]) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 298 | |
| 299 | if self.outfile: |
| 300 | # try and store counts and module info into self.outfile |
| 301 | try: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 302 | pickle.dump((self.counts, self.calledfuncs, self.callers), |
Jeremy Hylton | d0e2705 | 2003-10-14 20:12:06 +0000 | [diff] [blame] | 303 | open(self.outfile, 'wb'), 1) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 304 | except OSError as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 305 | print("Can't save counts files because %s" % err, file=sys.stderr) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 306 | |
Victor Stinner | 64bc3b2 | 2010-11-07 15:47:36 +0000 | [diff] [blame] | 307 | def write_results_file(self, path, lines, lnotab, lines_hit, encoding=None): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 308 | """Return a coverage results file in path.""" |
| 309 | |
| 310 | try: |
Victor Stinner | 64bc3b2 | 2010-11-07 15:47:36 +0000 | [diff] [blame] | 311 | outfile = open(path, "w", encoding=encoding) |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 312 | except OSError as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 313 | print(("trace: Could not open %r for writing: %s" |
| 314 | "- skipping" % (path, err)), file=sys.stderr) |
Guido van Rossum | bbca8da | 2004-02-19 19:16:50 +0000 | [diff] [blame] | 315 | return 0, 0 |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 316 | |
| 317 | n_lines = 0 |
| 318 | n_hits = 0 |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 319 | with outfile: |
| 320 | for lineno, line in enumerate(lines, 1): |
| 321 | # do the blank/comment match to try to mark more lines |
| 322 | # (help the reader find stuff that hasn't been covered) |
| 323 | if lineno in lines_hit: |
| 324 | outfile.write("%5d: " % lines_hit[lineno]) |
| 325 | n_hits += 1 |
Jeremy Hylton | 546e34b | 2003-06-26 14:56:17 +0000 | [diff] [blame] | 326 | n_lines += 1 |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 327 | elif rx_blank.match(line): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 328 | outfile.write(" ") |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 329 | else: |
| 330 | # lines preceded by no marks weren't hit |
| 331 | # Highlight them if so indicated, unless the line contains |
| 332 | # #pragma: NO COVER |
| 333 | if lineno in lnotab and not PRAGMA_NOCOVER in line: |
| 334 | outfile.write(">>>>>> ") |
| 335 | n_lines += 1 |
| 336 | else: |
| 337 | outfile.write(" ") |
| 338 | outfile.write(line.expandtabs(8)) |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 339 | |
| 340 | return n_hits, n_lines |
| 341 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 342 | def _find_lines_from_code(code, strs): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 343 | """Return dict where keys are lines in the line number table.""" |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 344 | linenos = {} |
| 345 | |
Alexander Belopolsky | ff09ce2 | 2010-09-24 18:03:12 +0000 | [diff] [blame] | 346 | for _, lineno in dis.findlinestarts(code): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 347 | if lineno not in strs: |
| 348 | linenos[lineno] = 1 |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 349 | |
| 350 | return linenos |
| 351 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 352 | def _find_lines(code, strs): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 353 | """Return lineno dict for all code objects reachable from code.""" |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 354 | # 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] | 355 | linenos = _find_lines_from_code(code, strs) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 356 | |
| 357 | # and check the constants for references to other code objects |
| 358 | for c in code.co_consts: |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 359 | if inspect.iscode(c): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 360 | # find another code object, so recurse into it |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 361 | linenos.update(_find_lines(c, strs)) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 362 | return linenos |
| 363 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 364 | def _find_strings(filename, encoding=None): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 365 | """Return a dict of possible docstring positions. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 366 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 367 | The dict maps line numbers to strings. There is an entry for |
| 368 | line that contains only a string or a part of a triple-quoted |
| 369 | string. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 370 | """ |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 371 | d = {} |
| 372 | # If the first token is a string, then it's the module docstring. |
| 373 | # Add this special case so that the test in the loop passes. |
| 374 | prev_ttype = token.INDENT |
Benjamin Peterson | b2fda23 | 2010-10-30 23:51:34 +0000 | [diff] [blame] | 375 | with open(filename, encoding=encoding) as f: |
| 376 | tok = tokenize.generate_tokens(f.readline) |
| 377 | for ttype, tstr, start, end, line in tok: |
| 378 | if ttype == token.STRING: |
| 379 | if prev_ttype == token.INDENT: |
| 380 | sline, scol = start |
| 381 | eline, ecol = end |
| 382 | for i in range(sline, eline + 1): |
| 383 | d[i] = 1 |
| 384 | prev_ttype = ttype |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 385 | return d |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 386 | |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 387 | def _find_executable_linenos(filename): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 388 | """Return dict where keys are line numbers in the line number table.""" |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 389 | try: |
Victor Stinner | 58c0752 | 2010-11-09 01:08:59 +0000 | [diff] [blame] | 390 | with tokenize.open(filename) as f: |
Benjamin Peterson | b2fda23 | 2010-10-30 23:51:34 +0000 | [diff] [blame] | 391 | prog = f.read() |
Victor Stinner | 58c0752 | 2010-11-09 01:08:59 +0000 | [diff] [blame] | 392 | encoding = f.encoding |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 393 | except OSError as err: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 394 | print(("Not printing coverage data for %r: %s" |
| 395 | % (filename, err)), file=sys.stderr) |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 396 | return {} |
| 397 | code = compile(prog, filename, "exec") |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 398 | strs = _find_strings(filename, encoding) |
| 399 | return _find_lines(code, strs) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 400 | |
| 401 | class Trace: |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 402 | def __init__(self, count=1, trace=1, countfuncs=0, countcallers=0, |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 403 | ignoremods=(), ignoredirs=(), infile=None, outfile=None, |
| 404 | timing=False): |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 405 | """ |
| 406 | @param count true iff it should count number of times each |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 407 | line is executed |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 408 | @param trace true iff it should print out each line that is |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 409 | being counted |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 410 | @param countfuncs true iff it should just output a list of |
| 411 | (filename, modulename, funcname,) for functions |
| 412 | that were called at least once; This overrides |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 413 | `count' and `trace' |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 414 | @param ignoremods a list of the names of modules to ignore |
| 415 | @param ignoredirs a list of the names of directories to ignore |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 416 | all of the (recursive) contents of |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 417 | @param infile file from which to read stored counts to be |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 418 | added into the results |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 419 | @param outfile file in which to write the results |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 420 | @param timing true iff timing information be displayed |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 421 | """ |
| 422 | self.infile = infile |
| 423 | self.outfile = outfile |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 424 | self.ignore = _Ignore(ignoremods, ignoredirs) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 425 | self.counts = {} # keys are (filename, linenumber) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 426 | self.pathtobasename = {} # for memoizing os.path.basename |
| 427 | self.donothing = 0 |
| 428 | self.trace = trace |
| 429 | self._calledfuncs = {} |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 430 | self._callers = {} |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 431 | self._caller_cache = {} |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 432 | self.start_time = None |
| 433 | if timing: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame] | 434 | self.start_time = _time() |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 435 | if countcallers: |
| 436 | self.globaltrace = self.globaltrace_trackcallers |
| 437 | elif countfuncs: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 438 | self.globaltrace = self.globaltrace_countfuncs |
| 439 | elif trace and count: |
| 440 | self.globaltrace = self.globaltrace_lt |
| 441 | self.localtrace = self.localtrace_trace_and_count |
| 442 | elif trace: |
| 443 | self.globaltrace = self.globaltrace_lt |
| 444 | self.localtrace = self.localtrace_trace |
| 445 | elif count: |
| 446 | self.globaltrace = self.globaltrace_lt |
| 447 | self.localtrace = self.localtrace_count |
| 448 | else: |
| 449 | # Ahem -- do nothing? Okay. |
| 450 | self.donothing = 1 |
| 451 | |
| 452 | def run(self, cmd): |
| 453 | import __main__ |
| 454 | dict = __main__.__dict__ |
Alexander Belopolsky | 0ae3361 | 2010-09-27 15:49:20 +0000 | [diff] [blame] | 455 | self.runctx(cmd, dict, dict) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 456 | |
| 457 | def runctx(self, cmd, globals=None, locals=None): |
| 458 | if globals is None: globals = {} |
| 459 | if locals is None: locals = {} |
| 460 | if not self.donothing: |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 461 | _settrace(self.globaltrace) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 462 | try: |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 463 | exec(cmd, globals, locals) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 464 | finally: |
| 465 | if not self.donothing: |
Alexander Belopolsky | 25b5741 | 2010-11-06 01:31:16 +0000 | [diff] [blame] | 466 | _unsettrace() |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 467 | |
| 468 | def runfunc(self, func, *args, **kw): |
| 469 | result = None |
| 470 | if not self.donothing: |
| 471 | sys.settrace(self.globaltrace) |
| 472 | try: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 473 | result = func(*args, **kw) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 474 | finally: |
| 475 | if not self.donothing: |
| 476 | sys.settrace(None) |
| 477 | return result |
| 478 | |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 479 | def file_module_function_of(self, frame): |
| 480 | code = frame.f_code |
| 481 | filename = code.co_filename |
| 482 | if filename: |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 483 | modulename = _modname(filename) |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 484 | else: |
| 485 | modulename = None |
| 486 | |
| 487 | funcname = code.co_name |
| 488 | clsname = None |
| 489 | if code in self._caller_cache: |
| 490 | if self._caller_cache[code] is not None: |
| 491 | clsname = self._caller_cache[code] |
| 492 | else: |
| 493 | self._caller_cache[code] = None |
| 494 | ## use of gc.get_referrers() was suggested by Michael Hudson |
| 495 | # all functions which refer to this code object |
| 496 | funcs = [f for f in gc.get_referrers(code) |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 497 | if inspect.isfunction(f)] |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 498 | # require len(func) == 1 to avoid ambiguity caused by calls to |
| 499 | # new.function(): "In the face of ambiguity, refuse the |
| 500 | # temptation to guess." |
| 501 | if len(funcs) == 1: |
| 502 | dicts = [d for d in gc.get_referrers(funcs[0]) |
| 503 | if isinstance(d, dict)] |
| 504 | if len(dicts) == 1: |
| 505 | classes = [c for c in gc.get_referrers(dicts[0]) |
| 506 | if hasattr(c, "__bases__")] |
| 507 | if len(classes) == 1: |
| 508 | # ditto for new.classobj() |
Alexander Belopolsky | 4d77017 | 2010-09-13 18:14:34 +0000 | [diff] [blame] | 509 | clsname = classes[0].__name__ |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 510 | # cache the result - assumption is that new.* is |
| 511 | # not called later to disturb this relationship |
| 512 | # _caller_cache could be flushed if functions in |
| 513 | # the new module get called. |
| 514 | self._caller_cache[code] = clsname |
| 515 | if clsname is not None: |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 516 | funcname = "%s.%s" % (clsname, funcname) |
| 517 | |
| 518 | return filename, modulename, funcname |
| 519 | |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 520 | def globaltrace_trackcallers(self, frame, why, arg): |
| 521 | """Handler for call events. |
| 522 | |
| 523 | Adds information about who called who to the self._callers dict. |
| 524 | """ |
| 525 | if why == 'call': |
| 526 | # XXX Should do a better job of identifying methods |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 527 | this_func = self.file_module_function_of(frame) |
| 528 | parent_func = self.file_module_function_of(frame.f_back) |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 529 | self._callers[(parent_func, this_func)] = 1 |
| 530 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 531 | def globaltrace_countfuncs(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 532 | """Handler for call events. |
Tim Peters | 0eadaac | 2003-04-24 16:02:54 +0000 | [diff] [blame] | 533 | |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 534 | Adds (filename, modulename, funcname) to the self._calledfuncs dict. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 535 | """ |
| 536 | if why == 'call': |
Skip Montanaro | 5bfd984 | 2004-04-10 16:29:58 +0000 | [diff] [blame] | 537 | this_func = self.file_module_function_of(frame) |
| 538 | self._calledfuncs[this_func] = 1 |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 539 | |
| 540 | def globaltrace_lt(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 541 | """Handler for call events. |
| 542 | |
| 543 | If the code block being entered is to be ignored, returns `None', |
| 544 | else returns self.localtrace. |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 545 | """ |
| 546 | if why == 'call': |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 547 | code = frame.f_code |
Thomas Wouters | cf297e4 | 2007-02-23 15:07:44 +0000 | [diff] [blame] | 548 | filename = frame.f_globals.get('__file__', None) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 549 | if filename: |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 550 | # XXX _modname() doesn't work right for packages, so |
Jeremy Hylton | dfbfe73 | 2003-04-21 22:49:17 +0000 | [diff] [blame] | 551 | # the ignore support won't work right for packages |
Alexander Belopolsky | 44454af | 2010-11-20 18:21:07 +0000 | [diff] [blame] | 552 | modulename = _modname(filename) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 553 | if modulename is not None: |
| 554 | ignore_it = self.ignore.names(filename, modulename) |
| 555 | if not ignore_it: |
| 556 | if self.trace: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 557 | print((" --- modulename: %s, funcname: %s" |
| 558 | % (modulename, code.co_name))) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 559 | return self.localtrace |
| 560 | else: |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 561 | return None |
| 562 | |
| 563 | def localtrace_trace_and_count(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 564 | if why == "line": |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 565 | # record the file name and line number of every trace |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 566 | filename = frame.f_code.co_filename |
| 567 | lineno = frame.f_lineno |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 568 | key = filename, lineno |
| 569 | self.counts[key] = self.counts.get(key, 0) + 1 |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 570 | |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 571 | if self.start_time: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame] | 572 | print('%.2f' % (_time() - self.start_time), end=' ') |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 573 | bname = os.path.basename(filename) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 574 | print("%s(%d): %s" % (bname, lineno, |
Georg Brandl | dc50c69 | 2010-08-02 12:40:22 +0000 | [diff] [blame] | 575 | linecache.getline(filename, lineno)), end='') |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 576 | return self.localtrace |
| 577 | |
| 578 | def localtrace_trace(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 579 | if why == "line": |
| 580 | # record the file name and line number of every trace |
| 581 | filename = frame.f_code.co_filename |
| 582 | lineno = frame.f_lineno |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 583 | |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 584 | if self.start_time: |
Victor Stinner | 949d8c9 | 2012-05-30 13:30:32 +0200 | [diff] [blame] | 585 | print('%.2f' % (_time() - self.start_time), end=' ') |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 586 | bname = os.path.basename(filename) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 587 | print("%s(%d): %s" % (bname, lineno, |
Georg Brandl | dc50c69 | 2010-08-02 12:40:22 +0000 | [diff] [blame] | 588 | linecache.getline(filename, lineno)), end='') |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 589 | return self.localtrace |
| 590 | |
| 591 | def localtrace_count(self, frame, why, arg): |
Jeremy Hylton | 38732e1 | 2003-04-21 22:04:46 +0000 | [diff] [blame] | 592 | if why == "line": |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 593 | filename = frame.f_code.co_filename |
| 594 | lineno = frame.f_lineno |
| 595 | key = filename, lineno |
| 596 | self.counts[key] = self.counts.get(key, 0) + 1 |
| 597 | return self.localtrace |
| 598 | |
| 599 | def results(self): |
| 600 | return CoverageResults(self.counts, infile=self.infile, |
| 601 | outfile=self.outfile, |
Skip Montanaro | cafc811 | 2004-04-07 15:46:05 +0000 | [diff] [blame] | 602 | calledfuncs=self._calledfuncs, |
| 603 | callers=self._callers) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 604 | |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 605 | def main(): |
Serhiy Storchaka | 7e4db2f | 2017-05-04 08:17:47 +0300 | [diff] [blame] | 606 | import argparse |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 607 | |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 608 | parser = argparse.ArgumentParser() |
| 609 | parser.add_argument('--version', action='version', version='trace 2.0') |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 610 | |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 611 | grp = parser.add_argument_group('Main options', |
| 612 | 'One of these (or --report) must be given') |
| 613 | |
| 614 | grp.add_argument('-c', '--count', action='store_true', |
| 615 | help='Count the number of times each line is executed and write ' |
| 616 | 'the counts to <module>.cover for each module executed, in ' |
| 617 | 'the module\'s directory. See also --coverdir, --file, ' |
| 618 | '--no-report below.') |
| 619 | grp.add_argument('-t', '--trace', action='store_true', |
| 620 | help='Print each line to sys.stdout before it is executed') |
| 621 | grp.add_argument('-l', '--listfuncs', action='store_true', |
| 622 | help='Keep track of which functions are executed at least once ' |
| 623 | 'and write the results to sys.stdout after the program exits. ' |
| 624 | 'Cannot be specified alongside --trace or --count.') |
| 625 | grp.add_argument('-T', '--trackcalls', action='store_true', |
| 626 | help='Keep track of caller/called pairs and write the results to ' |
| 627 | 'sys.stdout after the program exits.') |
| 628 | |
| 629 | grp = parser.add_argument_group('Modifiers') |
| 630 | |
| 631 | _grp = grp.add_mutually_exclusive_group() |
| 632 | _grp.add_argument('-r', '--report', action='store_true', |
| 633 | help='Generate a report from a counts file; does not execute any ' |
| 634 | 'code. --file must specify the results file to read, which ' |
| 635 | 'must have been created in a previous run with --count ' |
| 636 | '--file=FILE') |
| 637 | _grp.add_argument('-R', '--no-report', action='store_true', |
| 638 | help='Do not generate the coverage report files. ' |
| 639 | 'Useful if you want to accumulate over several runs.') |
| 640 | |
| 641 | grp.add_argument('-f', '--file', |
| 642 | help='File to accumulate counts over several runs') |
| 643 | grp.add_argument('-C', '--coverdir', |
| 644 | help='Directory where the report files go. The coverage report ' |
| 645 | 'for <package>.<module> will be written to file ' |
| 646 | '<dir>/<package>/<module>.cover') |
| 647 | grp.add_argument('-m', '--missing', action='store_true', |
| 648 | help='Annotate executable lines that were not executed with ' |
| 649 | '">>>>>> "') |
| 650 | grp.add_argument('-s', '--summary', action='store_true', |
| 651 | help='Write a brief summary for each file to sys.stdout. ' |
| 652 | 'Can only be used with --count or --report') |
| 653 | grp.add_argument('-g', '--timing', action='store_true', |
| 654 | help='Prefix each line with the time since the program started. ' |
| 655 | 'Only used while tracing') |
| 656 | |
| 657 | grp = parser.add_argument_group('Filters', |
| 658 | 'Can be specified multiple times') |
| 659 | grp.add_argument('--ignore-module', action='append', default=[], |
| 660 | help='Ignore the given module(s) and its submodules' |
| 661 | '(if it is a package). Accepts comma separated list of ' |
| 662 | 'module names.') |
| 663 | grp.add_argument('--ignore-dir', action='append', default=[], |
| 664 | help='Ignore files in the given directory ' |
| 665 | '(multiple directories can be joined by os.pathsep).') |
| 666 | |
| 667 | parser.add_argument('filename', nargs='?', |
| 668 | help='file to run as main program') |
| 669 | parser.add_argument('arguments', nargs=argparse.REMAINDER, |
| 670 | help='arguments to the program') |
| 671 | |
| 672 | opts = parser.parse_args() |
| 673 | |
| 674 | if opts.ignore_dir: |
| 675 | rel_path = 'lib', 'python{0.major}.{0.minor}'.format(sys.version_info) |
| 676 | _prefix = os.path.join(sys.base_prefix, *rel_path) |
| 677 | _exec_prefix = os.path.join(sys.base_exec_prefix, *rel_path) |
| 678 | |
| 679 | def parse_ignore_dir(s): |
| 680 | s = os.path.expanduser(os.path.expandvars(s)) |
| 681 | s = s.replace('$prefix', _prefix).replace('$exec_prefix', _exec_prefix) |
| 682 | return os.path.normpath(s) |
| 683 | |
| 684 | opts.ignore_module = [mod.strip() |
| 685 | for i in opts.ignore_module for mod in i.split(',')] |
| 686 | opts.ignore_dir = [parse_ignore_dir(s) |
| 687 | for i in opts.ignore_dir for s in i.split(os.pathsep)] |
| 688 | |
| 689 | if opts.report: |
| 690 | if not opts.file: |
| 691 | parser.error('-r/--report requires -f/--file') |
| 692 | results = CoverageResults(infile=opts.file, outfile=opts.file) |
| 693 | return results.write_results(opts.missing, opts.summary, opts.coverdir) |
| 694 | |
| 695 | if not any([opts.trace, opts.count, opts.listfuncs, opts.trackcalls]): |
| 696 | parser.error('must specify one of --trace, --count, --report, ' |
| 697 | '--listfuncs, or --trackcalls') |
| 698 | |
| 699 | if opts.listfuncs and (opts.count or opts.trace): |
| 700 | parser.error('cannot specify both --listfuncs and (--trace or --count)') |
| 701 | |
| 702 | if opts.summary and not opts.count: |
| 703 | parser.error('--summary can only be used with --count or --report') |
| 704 | |
| 705 | if opts.filename is None: |
| 706 | parser.error('filename is missing: required with the main options') |
| 707 | |
| 708 | sys.argv = opts.filename, *opts.arguments |
| 709 | sys.path[0] = os.path.dirname(opts.filename) |
| 710 | |
| 711 | t = Trace(opts.count, opts.trace, countfuncs=opts.listfuncs, |
| 712 | countcallers=opts.trackcalls, ignoremods=opts.ignore_module, |
| 713 | ignoredirs=opts.ignore_dir, infile=opts.file, |
| 714 | outfile=opts.file, timing=opts.timing) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 715 | try: |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 716 | with open(opts.filename) as fp: |
| 717 | code = compile(fp.read(), opts.filename, 'exec') |
| 718 | # try to emulate __main__ namespace as much as possible |
| 719 | globs = { |
| 720 | '__file__': opts.filename, |
| 721 | '__name__': '__main__', |
| 722 | '__package__': None, |
| 723 | '__cached__': None, |
| 724 | } |
| 725 | t.runctx(code, globs, globs) |
| 726 | except OSError as err: |
| 727 | sys.exit("Cannot run file %r because: %s" % (sys.argv[0], err)) |
| 728 | except SystemExit: |
| 729 | pass |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 730 | |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 731 | results = t.results() |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 732 | |
Senthil Kumaran | 436831d | 2016-01-13 07:46:54 -0800 | [diff] [blame] | 733 | if not opts.no_report: |
| 734 | results.write_results(opts.missing, opts.summary, opts.coverdir) |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 735 | |
Jeremy Hylton | 4edaa0d | 2003-02-18 15:06:17 +0000 | [diff] [blame] | 736 | if __name__=='__main__': |
| 737 | main() |