Merge branch 'nedbat/contexts'

Author: nedbat

CHANGES.rst

@@ -17,6 +17,11 @@ Change history for Coverage.py
 Unreleased
 ----------
 
+- Context support: static contexts let you specify a label for a coverage run,
+  which is recorded in the data, and retained when you combine files.  See
+  :ref:`contexts` for more information.  Currently, only static contexts are
+  supported, with no reporting features.
+
 - Environment variable substitution in configuration files now supports two
   syntaxes for controlling the behavior of undefined variables: if ``VARNAME``
   is not defined, ``${VARNAME?}`` will raise an error, and ``${VARNAME-default

README.rst

@@ -19,7 +19,8 @@ library to determine which lines are executable, and which have been executed.
 
 Coverage.py runs on many versions of Python:
 
-* CPython 2.7 and 3.4 through 3.7.
+* CPython 2.7.
+* CPython 3.4 through 3.7.
 * PyPy2 6.0 and PyPy3 6.0.
 * Jython 2.7.1, though not for reporting.
 * IronPython 2.7.7, though not for reporting.
@@ -31,7 +32,8 @@ Documentation is on `Read the Docs`_.  Code repository and issue tracker are on
 .. _GitHub: https://github.com/nedbat/coveragepy
 
 
-**New in 5.0:** SQLite data storage, dropped support for Python 2.6 and 3.3.
+**New in 5.0:** SQLite data storage, contexts, dropped support for Python 2.6
+and 3.3.
 
 New in 4.5: Configurator plug-ins.
 

coverage/cmdline.py

@@ -43,6 +43,10 @@ class Opts(object):
             "Valid values are: %s."
         ) % ", ".join(CONCURRENCY_CHOICES),
     )
+    context = optparse.make_option(
+        '', '--context', action='store', metavar="LABEL",
+        help="The context label to record for this coverage run",
+    )
     debug = optparse.make_option(
         '', '--debug', action='store', metavar="OPTS",
         help="Debug options, separated by commas. [env: COVERAGE_DEBUG]",
@@ -160,6 +164,7 @@ def __init__(self, *args, **kwargs):
             append=None,
             branch=None,
             concurrency=None,
+            context=None,
             debug=None,
             directory=None,
             fail_under=None,
@@ -358,6 +363,7 @@ def get_prog_name(self):
             Opts.append,
             Opts.branch,
             Opts.concurrency,
+            Opts.context,
             Opts.include,
             Opts.module,
             Opts.omit,
@@ -482,6 +488,7 @@ def command_line(self, argv):
             debug=debug,
             concurrency=options.concurrency,
             check_preimported=True,
+            context=options.context,
             )
 
         if options.action == "debug":

coverage/collector.py

@@ -99,6 +99,9 @@ def __init__(self, should_trace, check_include, timid, branch, warn, concurrency
         self.warn = warn
         self.branch = branch
         self.threading = None
+        self.covdata = None
+
+        self.static_context = None
 
         self.origin = short_stack()
 
@@ -160,6 +163,12 @@ def __init__(self, should_trace, check_include, timid, branch, warn, concurrency
     def __repr__(self):
         return "<Collector at 0x%x: %s>" % (id(self), self.tracer_name())
 
+    def use_data(self, covdata, context):
+        """Use `covdata` for recording data."""
+        self.covdata = covdata
+        self.static_context = context
+        self.covdata.set_context(self.static_context)
+
     def tracer_name(self):
         """Return the class name of the tracer we're using."""
         return self._trace_class.__name__
@@ -378,8 +387,11 @@ def cached_abs_file(self, filename):
         except KeyError:
             return self.abs_file_cache.setdefault(key, abs_file(filename))
 
-    def save_data(self, covdata):
-        """Save the collected data to a `CoverageData`.
+    def flush_data(self):
+        """Save the collected data to our associated `CoverageData`.
+
+        Data may have also been saved along the way. This forces the
+        last of the data to be saved.
 
         Returns True if there was data to save, False if not.
         """
@@ -406,10 +418,10 @@ def abs_file_dict(d):
             return dict((self.cached_abs_file(k), v) for k, v in items)
 
         if self.branch:
-            covdata.add_arcs(abs_file_dict(self.data))
+            self.covdata.add_arcs(abs_file_dict(self.data))
         else:
-            covdata.add_lines(abs_file_dict(self.data))
-        covdata.add_file_tracers(abs_file_dict(self.file_tracers))
+            self.covdata.add_lines(abs_file_dict(self.data))
+        self.covdata.add_file_tracers(abs_file_dict(self.file_tracers))
 
         if self.wtw:
             # Just a hack, so just hack it.

coverage/config.py

@@ -175,6 +175,7 @@ def __init__(self):
         # Defaults for [run]
         self.branch = False
         self.concurrency = None
+        self.context = None
         self.cover_pylib = False
         self.data_file = ".coverage"
         self.debug = []
@@ -318,6 +319,7 @@ def from_file(self, filename, our_file):
         # [run]
         ('branch', 'run:branch', 'boolean'),
         ('concurrency', 'run:concurrency', 'list'),
+        ('context', 'run:context'),
         ('cover_pylib', 'run:cover_pylib', 'boolean'),
         ('data_file', 'run:data_file'),
         ('debug', 'run:debug', 'list'),

coverage/control.py

@@ -57,7 +57,7 @@ def __init__(
         self, data_file=None, data_suffix=None, cover_pylib=None,
         auto_data=False, timid=None, branch=None, config_file=True,
         source=None, omit=None, include=None, debug=None,
-        concurrency=None, check_preimported=False,
+        concurrency=None, check_preimported=False, context=None,
     ):
         """
         `data_file` is the base name of the data file to use, defaulting to
@@ -116,6 +116,8 @@ def __init__(
         by coverage.  Importing measured files before coverage is started can
         mean that code is missed.
 
+        `context` is a string to use as the context label for collected data.
+
         .. versionadded:: 4.0
             The `concurrency` parameter.
 
@@ -133,7 +135,7 @@ def __init__(
             branch=branch, parallel=bool_or_none(data_suffix),
             source=source, run_omit=omit, run_include=include, debug=debug,
             report_omit=omit, report_include=include,
-            concurrency=concurrency,
+            concurrency=concurrency, context=context,
             )
 
         # This is injectable by tests.
@@ -333,6 +335,7 @@ def load(self):
 
     def _init_for_start(self):
         """Initialization for start()"""
+        # Construct the collector.
         concurrency = self.config.concurrency or []
         if "multiprocessing" in concurrency:
             if not patch_multiprocessing:
@@ -363,6 +366,8 @@ def _init_for_start(self):
 
         self._init_data(suffix)
 
+        self._collector.use_data(self._data, self.config.context)
+
         # Early warning if we aren't going to be able to support plugins.
         if self._plugins.file_tracers and not self._collector.supports_plugins:
             self._warn(
@@ -562,7 +567,7 @@ def get_data(self):
         self._init_data(suffix=None)
         self._post_init()
 
-        if self._collector and self._collector.save_data(self._data):
+        if self._collector and self._collector.flush_data():
             self._post_save_work()
 
         return self._data
@@ -678,15 +683,11 @@ def _get_file_reporters(self, morfs=None):
         if not morfs:
             morfs = self._data.measured_files()
 
-        # Be sure we have a list.
-        if not isinstance(morfs, (list, tuple)):
+        # Be sure we have a collection.
+        if not isinstance(morfs, (list, tuple, set)):
             morfs = [morfs]
 
-        file_reporters = []
-        for morf in morfs:
-            file_reporter = self._get_file_reporter(morf)
-            file_reporters.append(file_reporter)
-
+        file_reporters = [self._get_file_reporter(morf) for morf in morfs]
         return file_reporters
 
     def report(

coverage/data.py

@@ -252,8 +252,8 @@ def run_infos(self):
         return self._runs
 
     def measured_files(self):
-        """A list of all files that had been measured."""
-        return list(self._arcs or self._lines or {})
+        """A set of all files that had been measured."""
+        return set(self._arcs or self._lines or {})
 
     def __nonzero__(self):
         return bool(self._lines or self._arcs)
@@ -445,6 +445,11 @@ def touch_file(self, filename, plugin_name=""):
 
         self._validate()
 
+    def set_context(self, context):
+        """Set the context. Not implemented for JSON storage."""
+        if context:
+            raise CoverageException("JSON storage doesn't support contexts")
+
     def write(self):
         """Write the collected coverage data to a file.
 
@@ -722,6 +727,8 @@ def combine_parallel_data(data, aliases=None, data_paths=None, strict=False):
 
     files_combined = 0
     for f in files_to_combine:
+        if data._debug and data._debug.should('dataio'):
+            data._debug.write("Combining data file %r" % (f,))
         try:
             new_data = CoverageData(f, debug=data._debug)
             new_data.read()