eric: comparison DebugClients/Python/coverage/control.py

-:9513afbd57f1
+:744cd0b4b8cd
 """Core control stuff for Coverage."""
-import os, socket
+import atexit, os, socket
-from annotate import AnnotateReporter
+from coverage.annotate import AnnotateReporter
-from codeunit import code_unit_factory
+from coverage.backward import string_class          # pylint: disable-msg=W0622
-from collector import Collector
+from coverage.codeunit import code_unit_factory, CodeUnit
-from data import CoverageData
+from coverage.collector import Collector
-from files import FileLocator
+from coverage.data import CoverageData
-from html import HtmlReporter
+from coverage.files import FileLocator
-from misc import format_lines, CoverageException
+from coverage.html import HtmlReporter
-from summary import SummaryReporter
+from coverage.results import Analysis
+from coverage.summary import SummaryReporter
-class coverage:
+from coverage.xmlreport import XmlReporter
+class coverage(object):
 """Programmatic access to Coverage.
 To use::
 from coverage import coverage
 cov = coverage()
 cov.start()
-#.. blah blah (run your code) blah blah
+#.. blah blah (run your code) blah blah ..
 cov.stop()
 cov.html_report(directory='covhtml')
 """
 def __init__(self, data_file=None, data_suffix=False, cover_pylib=False,
-auto_data=False):
+auto_data=False, timid=False, branch=False):
-"""Create a new coverage measurement context.
+"""
 `data_file` is the base name of the data file to use, defaulting to
 ".coverage".  `data_suffix` is appended to `data_file` to create the
 final file name.  If `data_suffix` is simply True, then a suffix is
 created with the machine and process identity included.
 `cover_pylib` is a boolean determining whether Python code installed
 with the Python interpreter is measured.  This includes the Python
 standard library and any packages installed with the interpreter.
 If `auto_data` is true, then any existing data file will be read when
 coverage measurement starts, and data will be saved automatically when
 measurement stops.
+If `timid` is true, then a slower and simpler trace function will be
+used.  This is important for some environments where manipulation of
+tracing functions breaks the faster trace function.
+If `branch` is true, then branch coverage will be measured in addition
+to the usual statement coverage.
 """
 from coverage import __version__
 self.cover_pylib = cover_pylib
 self.auto_data = auto_data
+self.atexit_registered = False
 self.exclude_re = ""
 self.exclude_list = []
 self.file_locator = FileLocator()
-self.collector = Collector(self._should_trace)
+# Timidity: for nose users, read an environment variable.  This is a
+# cheap hack, since the rest of the command line arguments aren't
+# recognized, but it solves some users' problems.
+timid = timid or ('--timid' in os.environ.get('COVERAGE_OPTIONS', ''))
+self.collector = Collector(
+self._should_trace, timid=timid, branch=branch
+)
 # Create the data file.
 if data_suffix:
-if not isinstance(data_suffix, basestring):
+if not isinstance(data_suffix, string_class):
 # if data_suffix=True, use .machinename.pid
 data_suffix = ".%s.%s" % (socket.gethostname(), os.getpid())
 else:
 data_suffix = None
 # The default exclude pattern.
 self.exclude('# *pragma[: ]*[nN][oO] *[cC][oO][vV][eE][rR]')
 # The prefix for files considered "installed with the interpreter".
 if not self.cover_pylib:
+# Look at where the "os" module is located.  That's the indication
+# for "installed with the interpreter".
 os_file = self.file_locator.canonical_filename(os.__file__)
 self.pylib_prefix = os.path.split(os_file)[0]
+# To avoid tracing the coverage code itself, we skip anything located
+# where we are.
 here = self.file_locator.canonical_filename(__file__)
 self.cover_prefix = os.path.split(here)[0]
 def _should_trace(self, filename, frame):
 """Decide whether to trace execution in `filename`
+This function is called from the trace function.  As each new file name
+is encountered, this function determines whether it is traced or not.
 Returns a canonicalized filename if it should be traced, False if it
 should not.
 """
 if filename == '<string>':
 # There's no point in ever tracing string executions, we can't do
 # anything with the data later anyway.
 return False
 if canonical.startswith(self.cover_prefix):
 return False
 return canonical
+# To log what should_trace returns, change this to "if 1:"
+if 0:
+_real_should_trace = _should_trace
+def _should_trace(self, filename, frame):   # pylint: disable-msg=E0102
+"""A logging decorator around the real _should_trace function."""
+ret = self._real_should_trace(filename, frame)
+print("should_trace: %r -> %r" % (filename, ret))
+return ret
 def use_cache(self, usecache):
 """Control the use of a data file (incorrectly called a cache).
 `usecache` is true or false, whether to read and write data on disk.
 """
 self.data.usefile(usecache)
 def load(self):
 """Load previously-collected coverage data from the data file."""
 self.collector.reset()
 self.data.read()
 def start(self):
 """Start measuring code coverage."""
 if self.auto_data:
 self.load()
 # Save coverage data when Python exits.
-import atexit
+if not self.atexit_registered:
 atexit.register(self.save)
+self.atexit_registered = True
 self.collector.start()
 def stop(self):
 """Stop measuring code coverage."""
 self.collector.stop()
 self._harvest_data()
 def erase(self):
 """Erase previously-collected coverage data.
 This removes the in-memory data collected in this session as well as
 discarding the data file.
 """
 self.collector.reset()
 self.data.erase()
 def clear_exclude(self):
 self.exclude_list = []
 self.exclude_re = ""
 def exclude(self, regex):
 """Exclude source lines from execution consideration.
 `regex` is a regular expression.  Lines matching this expression are
 not considered executable when reporting code coverage.  A list of
 regexes is maintained; this function adds a new regex to the list.
 Matching any of the regexes excludes a source line.
 """
 self.exclude_list.append(regex)
 self.exclude_re = "(" + ")|(".join(self.exclude_list) + ")"
 def get_exclude_list(self):
 self._harvest_data()
 self.data.write()
 def combine(self):
 """Combine together a number of similarly-named coverage data files.
 All coverage data files whose name starts with `data_file` (from the
 coverage() constructor) will be read, and combined together into the
 current measurements.
 """
 self.data.combine_parallel_data()
 def _harvest_data(self):
-"""Get the collected data by filename and reset the collector."""
+"""Get the collected data and reset the collector."""
-self.data.add_line_data(self.collector.data_points())
+self.data.add_line_data(self.collector.get_line_data())
+self.data.add_arc_data(self.collector.get_arc_data())
 self.collector.reset()
 # Backward compatibility with version 1.
 def analysis(self, morf):
 """Like `analysis2` but doesn't return excluded line numbers."""
 f, s, _, m, mf = self.analysis2(morf)
 return f, s, m, mf
 def analysis2(self, morf):
 """Analyze a module.
 `morf` is a module or a filename.  It will be analyzed to determine
 its coverage statistics.  The return value is a 5-tuple:
 * The filename for the module.
 * A list of line numbers of executable statements.
 * A list of line numbers of excluded statements.
-* A list of line numbers of statements not run (missing from execution).
+* A list of line numbers of statements not run (missing from
+execution).
 * A readable formatted string of the missing line numbers.
 The analysis uses the source file itself and the current measured
 coverage data.
 """
-code_unit = code_unit_factory(morf, self.file_locator)[0]
+analysis = self._analyze(morf)
-st, ex, m, mf = self._analyze(code_unit)
+return (
-return code_unit.filename, st, ex, m, mf
+analysis.filename, analysis.statements, analysis.excluded,
+analysis.missing, analysis.missing_formatted()
-def _analyze(self, code_unit):
-"""Analyze a single code unit.
-Returns a 4-tuple: (statements, excluded, missing, missing formatted).
-"""
-from parser import CodeParser
-filename = code_unit.filename
-ext = os.path.splitext(filename)[1]
-source = None
-if ext == '.py':
-if not os.path.exists(filename):
-source = self.file_locator.get_zip_data(filename)
-if not source:
-raise CoverageException(
-"No source for code '%s'." % code_unit.filename
-)
-parser = CodeParser()
-statements, excluded, line_map = parser.parse_source(
-text=source, filename=filename, exclude=self.exclude_re
 )
-# Identify missing statements.
+def _analyze(self, it):
-missing = []
+"""Analyze a single morf or code unit.
-execed = self.data.executed_lines(filename)
-for line in statements:
+Returns an `Analysis` object.
-lines = line_map.get(line)
-if lines:
+"""
-for l in range(lines[0], lines[1]+1):
+if not isinstance(it, CodeUnit):
-if l in execed:
+it = code_unit_factory(it, self.file_locator)[0]
-break
-else:
+return Analysis(self, it)
-missing.append(line)
-else:
-if line not in execed:
-missing.append(line)
-return (
-statements, excluded, missing, format_lines(statements, missing)
-)
 def report(self, morfs=None, show_missing=True, ignore_errors=False,
 file=None, omit_prefixes=None):     # pylint: disable-msg=W0622
 """Write a summary report to `file`.
 Each module in `morfs` is listed, with counts of statements, executed
 statements, missing statements, and a list of lines missed.
 """
 reporter = SummaryReporter(self, show_missing, ignore_errors)
 reporter.report(morfs, outfile=file, omit_prefixes=omit_prefixes)
 def annotate(self, morfs=None, directory=None, ignore_errors=False,
 omit_prefixes=None):
 """Annotate a list of modules.
 Each module in `morfs` is annotated.  The source is written to a new
 file, named with a ",cover" suffix, with each line prefixed with a
 marker to indicate the coverage of the line.  Covered lines have ">",
 excluded lines have "-", and missing lines have "!".
 """
 reporter = AnnotateReporter(self, ignore_errors)
 reporter.report(
 morfs, directory=directory, omit_prefixes=omit_prefixes)
 def html_report(self, morfs=None, directory=None, ignore_errors=False,
 omit_prefixes=None):
 """Generate an HTML report.
 """
 reporter = HtmlReporter(self, ignore_errors)
 reporter.report(
 morfs, directory=directory, omit_prefixes=omit_prefixes)
+def xml_report(self, morfs=None, outfile=None, ignore_errors=False,
+omit_prefixes=None):
+"""Generate an XML report of coverage results.
+The report is compatible with Cobertura reports.
+"""
+if outfile:
+outfile = open(outfile, "w")
+try:
+reporter = XmlReporter(self, ignore_errors)
+reporter.report(
+morfs, omit_prefixes=omit_prefixes, outfile=outfile)
+finally:
+outfile.close()
+def sysinfo(self):
+"""Return a list of key,value pairs showing internal information."""
+import coverage as covmod
+import platform, re, sys
+info = [
+('version', covmod.__version__),
+('coverage', covmod.__file__),
+('cover_prefix', self.cover_prefix),
+('pylib_prefix', self.pylib_prefix),
+('tracer', self.collector.tracer_name()),
+('data_path', self.data.filename),
+('python', sys.version.replace('\n', '')),
+('platform', platform.platform()),
+('cwd', os.getcwd()),
+('path', sys.path),
+('environment', [
+("%s = %s" % (k, v)) for k, v in os.environ.items()
+if re.search("^COV|^PY", k)
+]),
+]
+return info

Mercurial Repositories > eric / file comparison

comparison: DebugClients/Python/coverage/control.py

DebugClients/Python/coverage/control.py