Refer to the project consistenly as coverage.py. #275

Author: nedbat

CHANGES.txt

@@ -19,7 +19,7 @@ Latest
   applied even when the report is empty.  Thanks, Ionel Cristian Mărieș.
 
 - Plugins are now initialized differently.  Instead of looking for a class
-  called ``Plugin``, coverage looks for a function called ``coverage_init``.
+  called ``Plugin``, coverage.py looks for a function called ``coverage_init``.
 
 - Code that was executed with `exec` would be mis-attributed to the file that
   called it.  This is now fixed, closing `issue 380`_.
@@ -30,7 +30,11 @@ Latest
   ``Coverage.get_data``, and returns the ``CoverageData`` containing the
   collected data.
 
+- The project is consistently referred to as "coverage.py" throughout the code
+  and the documentation, closing `issue 275`_.
+
 .. _issue 236: https://bitbucket.org/ned/coveragepy/issues/236/pickles-are-bad-and-you-should-feel-bad
+.. _issue 275: https://bitbucket.org/ned/coveragepy/issues/275/refer-consistently-to-project-as-coverage
 .. _issue 380: https://bitbucket.org/ned/coveragepy/issues/380/code-executed-by-exec-excluded-from
 
 .. 41 issues closed in 4.0 below here
@@ -41,7 +45,7 @@ Version 4.0a6 --- 21 June 2015
 
 - Python 3.5b2 and PyPy 2.6.0 are supported.
 
-- The original module-level function interface to coverage is no longer
+- The original module-level function interface to coverage.py is no longer
   supported.  You must now create a ``coverage.Coverage`` object, and use
   methods on it.
 
@@ -116,7 +120,7 @@ Version 4.0a5 --- 16 February 2015
   Eduardo Schettino.  Currently, this does not work on Windows.
 
 - A new warning is possible, if a desired file isn't measured because it was
-  imported before coverage was started (`issue 353`_).
+  imported before coverage.py was started (`issue 353`_).
 
 - The `coverage.process_startup` function now will start coverage measurement
   only once, no matter how many times it is called.  This fixes problems due
@@ -213,8 +217,8 @@ Version 4.0a2 --- 14 January 2015
 
 - The ``--debug`` switch can now be used on any command.
 
-- You can now programmatically adjust the configuration of coverage by setting
-  items on `Coverage.config` after construction.
+- You can now programmatically adjust the configuration of coverage.py by
+  setting items on `Coverage.config` after construction.
 
 - A module run with ``-m`` can be used as the argument to ``--source``, fixing
   `issue 328`_.  Thanks, Buck Evan.
@@ -225,7 +229,7 @@ Version 4.0a2 --- 14 January 2015
 - Made some PyPy-specific tweaks to improve speed under PyPy.  Thanks, Alex
   Gaynor.
 
-- In some cases, with a source file missing a final newline, coverage would
+- In some cases, with a source file missing a final newline, coverage.py would
   count statements incorrectly.  This is now fixed, closing `issue 293`_.
 
 - The status.dat file that HTML reports use to avoid re-creating files that
@@ -317,9 +321,9 @@ Version 3.7 --- 6 October 2013
 - Running code with ``coverage run -m`` now behaves more like Python does,
   setting sys.path properly, which fixes `issue 207`_ and `issue 242`_.
 
-- Coverage can now run .pyc files directly, closing `issue 264`_.
+- Coverage.py can now run .pyc files directly, closing `issue 264`_.
 
-- Coverage properly supports .pyw files, fixing `issue 261`_.
+- Coverage.py properly supports .pyw files, fixing `issue 261`_.
 
 - Omitting files within a tree specified with the ``source`` option would
   cause them to be incorrectly marked as unexecuted, as described in
@@ -335,9 +339,10 @@ Version 3.7 --- 6 October 2013
 - Trying to create an XML report with no files to report on, would cause a
   ZeroDivideError, but no longer does, fixing `issue 250`_.
 
-- When running a threaded program under the Python tracer, coverage no longer
-  issues a spurious warning about the trace function changing: "Trace function
-  changed, measurement is likely wrong: None."  This fixes `issue 164`_.
+- When running a threaded program under the Python tracer, coverage.py no
+  longer issues a spurious warning about the trace function changing: "Trace
+  function changed, measurement is likely wrong: None."  This fixes `issue
+  164`_.
 
 - Static files necessary for HTML reports are found in system-installed places,
   to ease OS-level packaging of coverage.py.  Closes `issue 259`_.
@@ -470,8 +475,9 @@ Version 3.6b1 --- 28 November 2012
 
 - Jython files now work with the ``--source`` option, fixing `issue 100`_.
 
-- Running coverage under a debugger is unlikely to work, but it shouldn't fail
-  with "TypeError: 'NoneType' object is not iterable".  Fixes `issue 201`_.
+- Running coverage.py under a debugger is unlikely to work, but it shouldn't
+  fail with "TypeError: 'NoneType' object is not iterable".  Fixes `issue
+  201`_.
 
 - On some Linux distributions, when installed with the OS package manager,
   coverage.py would report its own code as part of the results.  Now it won't,
@@ -553,7 +559,6 @@ Version 3.5.3 --- 29 September 2012
 .. _tox: http://tox.readthedocs.org/
 
 
-
 Version 3.5.2 --- 4 May 2012
 ----------------------------
 
@@ -615,10 +620,10 @@ Version 3.5.1 --- 23 September 2011
 Version 3.5.1b1 --- 28 August 2011
 ----------------------------------
 
-- When combining data files from parallel runs, you can now instruct coverage
-  about which directories are equivalent on different machines.  A ``[paths]``
-  section in the configuration file lists paths that are to be considered
-  equivalent.  Finishes `issue 17`_.
+- When combining data files from parallel runs, you can now instruct
+  coverage.py about which directories are equivalent on different machines.  A
+  ``[paths]`` section in the configuration file lists paths that are to be
+  considered equivalent.  Finishes `issue 17`_.
 
 - for-else constructs are understood better, and don't cause erroneous partial
   branch warnings.  Fixes `issue 122`_.
@@ -640,7 +645,7 @@ Version 3.5.1b1 --- 28 August 2011
 
 - In order to help the core developers measure the test coverage of the
   standard library, Brandon Rhodes devised an aggressive hack to trick Python
-  into running some coverage code before anything else in the process.
+  into running some coverage.py code before anything else in the process.
   See the coverage/fullcoverage directory if you are interested.
 
 .. _issue 17: http://bitbucket.org/ned/coveragepy/issue/17/support-combining-coverage-data-from
@@ -828,7 +833,7 @@ Version 3.4b1 --- 21 August 2010
   and parent processes.  Use ``coverage run -p`` to get two data files that can
   be combined with ``coverage combine``.  Fixes `issue 56`_.
 
-- Coverage is now runnable as a module: ``python -m coverage``.  Thanks,
+- Coverage.py is now runnable as a module: ``python -m coverage``.  Thanks,
   Brett Cannon.
 
 - When measuring code running in a virtualenv, most of the system library was
@@ -1049,8 +1054,8 @@ Version 3.0.1 --- 7 July 2009
   raised.  This is now fixed.
 
 - The coverage.py code itself will now not be measured by coverage.py, and no
-  coverage modules will be mentioned in the nose --with-cover plug-in.  Fixed
-  `issue 8`_.
+  coverage.py modules will be mentioned in the nose --with-cover plug-in.
+  Fixed `issue 8`_.
 
 - When running source files, coverage.py now opens them in universal newline
   mode just like Python does.  This lets it run Windows files on Mac, for
@@ -1129,10 +1134,10 @@ Version 3.0b1 --- 7 March 2009
 
 Major overhaul.
 
-- Coverage is now a package rather than a module.  Functionality has been split
-  into classes.
+- Coverage.py is now a package rather than a module.  Functionality has been
+  split into classes.
 
-- The trace function is implemented in C for speed.  Coverage runs are now
+- The trace function is implemented in C for speed.  Coverage.py runs are now
   much faster.  Thanks to David Christian for productive micro-sprints and
   other encouragement.
 
@@ -1144,7 +1149,7 @@ Major overhaul.
 
 - The singleton coverage object is only created if the module-level functions
   are used.  This maintains the old interface while allowing better
-  programmatic use of Coverage.
+  programmatic use of Coverage.py.
 
 - The minimum supported Python version is 2.3.
 
@@ -1242,7 +1247,7 @@ Version 2.5 --- 4 December 2005
 - Add a file argument to report so that reports can be captured to a different
   destination.
 
-- coverage.py can now measure itself.
+- Coverage.py can now measure itself.
 
 - Adapted Greg Rogers' patch for using relative file names, and sorting and
   omitting files to report on.

TODO.txt

@@ -1,4 +1,4 @@
-Coverage TODO
+Coverage.py TODO
 
 Key:
     * Heading
@@ -126,7 +126,7 @@ x Tricky swapping of collector like figleaf, pycov, et al. (Don't need to do
         3: c = 3
     if the coverage data shows 1,2,3, it was if-then.  if it's 1,3, then the
     missing else was executed.
-- API for getting coverage data.
++ API for getting coverage data.
 - Instruction tracing instead of line tracing.
 - Path tracing (how does this even work?)
 - Count execution of lines
@@ -143,7 +143,7 @@ x Tricky swapping of collector like figleaf, pycov, et al. (Don't need to do
     directory.
 - Why can't a morf also be a string, the name of a module?
 - ignore by module as well as file?
-+ Use a .coveragerc file to control Coverage without the programmatic API.
++ Use a .coveragerc file to control coverage.py without the programmatic API.
 - Add a --data switch to explicitly control the data file on the command line.
 x Why can't you specify execute (-x) and report (-r) in the same invocation?
     Maybe just because -x needs the rest of the command line?
@@ -156,7 +156,7 @@ x Why can't you specify execute (-x) and report (-r) in the same invocation?
     class definitions, etc, when coverage is started after the class is defined.
 - Different categories of exclude pragma? So you can enable and disable them
     from the command line, to reconsider exclusions.
-+ Reporting on files never touched by coverage (package completeness)
++ Reporting on files never touched by coverage.py (package completeness)
 - A setup.py command? http://jeetworks.org/node/50
 - Deltas: indicate the change in coverage percentage from the last run.
 + Show lines missing rather than lines run in the reporting, since that's what
@@ -177,7 +177,7 @@ x Why can't you specify execute (-x) and report (-r) in the same invocation?
     + Clickable column headers on the index page.
     + Syntax coloring in HTML report.
     + Dynamic effects in HTML report.
-    + Footer in reports pointing to coverage home page.
+    + Footer in reports pointing to coverage.py home page.
     + Baseline grid for linenumber font.
     + Separate out css and HTML.
     + Does it work right with utf-8 source files? http://www.python.org/dev/peps/pep-0263/
@@ -196,10 +196,10 @@ x Why can't you specify execute (-x) and report (-r) in the same invocation?
         - ignore (files not to collect)
         - exclude (lines not to report as missed)
         - omit (files not to report)
-    - Changes from coverage 2.x:
+    - Changes from coverage.py 2.x:
         - Bare "except:" lines now count as executable code.
         - Double function decorators: all decorator lines count as executable code.
-    - Document the .coverage file format.
+    x Document the .coverage file format.
     + HTML reporting.
         - Much more detail about what's in the report.
     - References between pages are off:
@@ -220,8 +220,8 @@ x Why can't you specify execute (-x) and report (-r) in the same invocation?
 
 * Installation
 
-x How will Coverage package install over coverage.py module?
-x pip can't install it: it reads the coverage html page, and finds the kit link,
+x How will coverage.py package install over coverage.py module?
+x pip can't install it: it reads the coverage.py html page, and finds the kit link,
     but then can't handle the root-relative link.
 
 
@@ -263,13 +263,13 @@ x pip can't install it: it reads the coverage html page, and finds the kit link,
 + Switch to a real test runner, like nose.
 + Test both the C trace function and the Python trace function.
 + parser.py has no direct tests.
-- Tests about the .coverage file.
++ Tests about the .coverage file.
 + Tests about the --long-form of arguments.
 + Tests about overriding the .coverage filename.
 - Tests about parallel mode.
 + Tests about assigning a multi-line string.
 - Tests about tricky docstrings.
-+ Coverage test Coverage!
++ Coverage test coverage.py!
 - Tests that tracing stops after calling stop()
 - More intensive thread testing.
 x Tests about the "import __main__" in cmdline.py

coverage/cmdline.py

@@ -1,4 +1,4 @@
-"""Command-line support for Coverage."""
+"""Command-line support for coverage.py."""
 
 import glob
 import optparse
@@ -119,7 +119,7 @@ class Opts(object):
 
 
 class CoverageOptionParser(optparse.OptionParser, object):
-    """Base OptionParser for coverage.
+    """Base OptionParser for coverage.py.
 
     Problems don't exit the program.
     Defaults are initialized for all options.
@@ -202,7 +202,7 @@ class CmdOptionParser(CoverageOptionParser):
     def __init__(self, action, options=None, defaults=None, usage=None,
                 description=None
                 ):
-        """Create an OptionParser for a coverage command.
+        """Create an OptionParser for a coverage.py command.
 
         `action` is the slug to put into `options.action`.
         `options` is a list of Option's for the command.
@@ -340,7 +340,7 @@ def __eq__(self, other):
 
 
 class CoverageScript(object):
-    """The command-line interface to Coverage."""
+    """The command-line interface to coverage.py."""
 
     def __init__(self, _covpkg=None, _run_python_file=None,
                  _run_python_module=None, _help_fn=None):
@@ -360,7 +360,7 @@ def __init__(self, _covpkg=None, _run_python_file=None,
         self.coverage = None
 
     def command_line(self, argv):
-        """The bulk of the command line interface to Coverage.
+        """The bulk of the command line interface to coverage.py.
 
         `argv` is the argument list to process.
 
@@ -613,7 +613,7 @@ def unshell_list(s):
     if not s:
         return None
     if env.WINDOWS:
-        # When running coverage as coverage.exe, some of the behavior
+        # When running coverage.py as coverage.exe, some of the behavior
         # of the shell is emulated: wildcards are expanded into a list of
         # filenames.  So you have to single-quote patterns on the command
         # line, but (not) helpfully, the single quotes are included in the
@@ -669,7 +669,7 @@ def unglob_args(args):
 
 
 def main(argv=None):
-    """The main entry point to Coverage.
+    """The main entry point to coverage.py.
 
     This is installed as the script entry point.
 

coverage/control.py

@@ -293,13 +293,13 @@ def _init(self):
                     structseq_file = structseq_new.__code__.co_filename
                 self.pylib_dirs.add(self._canonical_dir(structseq_file))
 
-        # To avoid tracing the coverage code itself, we skip anything located
-        # where we are.
+        # To avoid tracing the coverage.py code itself, we skip anything
+        # located where we are.
         self.cover_dirs = [self._canonical_dir(__file__)]
         if env.TESTING:
             # When testing, we use PyContracts, which should be considered
-            # part of coverage, and it uses six. Exclude those directories just
-            # as we exclude ourselves.
+            # part of coverage.py, and it uses six. Exclude those directories
+            # just as we exclude ourselves.
             import contracts, six
             for mod in [contracts, six]:
                 self.cover_dirs.append(self._canonical_dir(mod))
@@ -549,8 +549,8 @@ def _check_include_omit_etc_internal(self, filename, frame):
             if self.pylib_match and self.pylib_match.match(filename):
                 return "is in the stdlib"
 
-            # We exclude the coverage code itself, since a little of it will be
-            # measured otherwise.
+            # We exclude the coverage.py code itself, since a little of it
+            # will be measured otherwise.
             if self.cover_match and self.cover_match.match(filename):
                 return "is part of coverage.py"
 
@@ -1114,15 +1114,15 @@ def process_startup():
     # because some virtualenv configurations make the same directory visible
     # twice in sys.path.  This means that the .pth file will be found twice,
     # and executed twice, executing this function twice.  We set a global
-    # flag (an attribute on this function) to indicate that coverage has
+    # flag (an attribute on this function) to indicate that coverage.py has
     # already been started, so we can avoid doing it twice.
     #
     # https://bitbucket.org/ned/coveragepy/issue/340/keyerror-subpy has more
     # details.
 
     if hasattr(process_startup, "done"):
         # We've annotated this function before, so we must have already
-        # started coverage in this process.  Nothing to do.
+        # started coverage.py in this process.  Nothing to do.
         return
 
     process_startup.done = True

coverage/fullcoverage/encodings.py

@@ -6,10 +6,10 @@
 If the directory that holds this file is placed first in the PYTHONPATH when
 using "coverage" to run Python's tests, then this file will become the very
 first module imported by the internals of Python 3.  It installs a
-coverage-compatible trace function that can watch Standard Library modules
+coverage.py-compatible trace function that can watch Standard Library modules
 execute from the very earliest stages of Python's own boot process.  This fixes
-a problem with coverage - that it starts too late to trace the coverage of many
-of the most fundamental modules in the Standard Library.
+a problem with coverage.py - that it starts too late to trace the coverage of
+many of the most fundamental modules in the Standard Library.
 
 """
 

doc/api.rst

@@ -49,8 +49,8 @@ The CoverageData class
     :special-members: __init__
 
 
-Starting coverage automatically
--------------------------------
+Starting coverage.py automatically
+----------------------------------
 
 This function is used to start coverage measurement automatically when Python
 starts.  See :ref:`subprocess` for details.