diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2015-07-23 21:22:30 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-07-23 21:22:30 -0400 |
| commit | 080e181a8cc21b8e555fa96eaa54762eb2a76c8e (patch) | |
| tree | 2b60605f7b2d8d57255039d718d238ce4cb0c493 | |
| parent | c7d226aa8ba7c8c37fdda5f594b1fff6f073a872 (diff) | |
| download | python-coveragepy-git-080e181a8cc21b8e555fa96eaa54762eb2a76c8e.tar.gz | |
Refer to the project consistenly as coverage.py. #275
47 files changed, 188 insertions, 185 deletions
diff --git a/CHANGES.txt b/CHANGES.txt index dab85bdb..727e5a3f 100644 --- a/CHANGES.txt +++ b/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. @@ -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 diff --git a/coverage/cmdline.py b/coverage/cmdline.py index 656f1c03..c0c9a986 100644 --- a/coverage/cmdline.py +++ b/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 @@ OK, ERR, FAIL_UNDER = 0, 1, 2 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 @@ class CoverageScript(object): 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 @@ Documentation at %(__url__)s 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. diff --git a/coverage/control.py b/coverage/control.py index e1931a5b..ef9b8f11 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -293,13 +293,13 @@ class Coverage(object): 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 @@ class Coverage(object): 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,7 +1114,7 @@ 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 @@ -1122,7 +1122,7 @@ def process_startup(): 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 diff --git a/coverage/fullcoverage/encodings.py b/coverage/fullcoverage/encodings.py index 6a258d67..df83366b 100644 --- a/coverage/fullcoverage/encodings.py +++ b/coverage/fullcoverage/encodings.py @@ -6,10 +6,10 @@ instrumentation and then replaces itself with the real encodings module. 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. """ diff --git a/doc/api.rst b/doc/api.rst index 684bc2d0..bb039e9d 100644 --- a/doc/api.rst +++ b/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. diff --git a/doc/branch.rst b/doc/branch.rst index 2738447e..71367de4 100644 --- a/doc/branch.rst +++ b/doc/branch.rst @@ -13,7 +13,7 @@ Branch coverage measurement :linenothreshold: 5 -In addition to the usual statement coverage, Coverage.py also supports branch +In addition to the usual statement coverage, coverage.py also supports branch coverage measurement. Where a line in your program could jump to more than one next line, coverage.py tracks which of those destinations are actually visited, and flags lines that haven't visited all of their possible destinations. diff --git a/doc/changes.rst b/doc/changes.rst index e5aa67a2..53ea3601 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -51,7 +51,7 @@ Backward incompatibilities: - The ``COVERAGE_OPTIONS`` environment variable is no longer supported. It was a hack for ``--timid`` before configuration files were available. -- 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. @@ -126,7 +126,7 @@ Improvements: fixed. - 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 @@ -137,8 +137,8 @@ API changes: - The class defined in the coverage module is now called ``Coverage`` instead of ``coverage``, though the old name still works, for backward compatibility. -- 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. - If the `config_file` argument to the Coverage constructor is specified as ".coveragerc", it is treated as if it were True. This means setup.cfg is @@ -229,9 +229,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 @@ -247,9 +247,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`_. @@ -377,8 +378,9 @@ Fixes: - 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, @@ -500,10 +502,10 @@ Version 3.5.2 --- 4 May 2012 Version 3.5.1 --- 23 September 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`_. @@ -525,7 +527,7 @@ Version 3.5.1 --- 23 September 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 @@ -682,7 +684,7 @@ Execution and measurement: - When measuring code running in a virtualenv, most of the system library was being measured when it shouldn't have been. This is now fixed. -- Coverage can now be run as a module: ``python -m coverage``. Thanks, +- Coverage.py can now be run as a module: ``python -m coverage``. Thanks, Brett Cannon. .. _issue 1: http://bitbucket.org/ned/coveragepy/issue/1/empty-__init__py-files-are-reported-as-1-executable @@ -760,7 +762,7 @@ Version 3.2 --- 5 December 2009 - Added a ``--version`` option on the command line. -- Program execution under coverage is a few percent faster. +- Program execution under coverage.py is a few percent faster. - Some exceptions reported by the command line interface have been cleaned up so that tracebacks inside coverage.py aren't shown. Fixes `issue 23`_. @@ -821,7 +823,7 @@ 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`` plugin. + coverage.py modules will be mentioned in the nose ``--with-cover`` plugin. - 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 @@ -831,13 +833,13 @@ Version 3.0.1 --- 7 July 2009 Version 3.0 --- 13 June 2009 ---------------------------- -- 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. - HTML reports and annotation of source files: use the new ``-b`` (browser) switch. Thanks to George Song for code, inspiration and guidance. -- 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. diff --git a/doc/cmd.rst b/doc/cmd.rst index b1eeb633..b7e00e56 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1,8 +1,8 @@ .. _cmd: -=========================== -Coverage command line usage -=========================== +============================== +Coverage.py command line usage +============================== .. :history: 20090524T134300, brand new docs. .. :history: 20090613T164000, final touches for 3.0 @@ -29,7 +29,7 @@ and a ``coverage-X.Y`` alias, depending on the version of Python you're using. For example, when installing on Python 2.7, you will be able to use ``coverage``, ``coverage2``, or ``coverage-2.7`` on the command line. -Coverage has a number of commands which determine the action performed: +Coverage.py has a number of commands which determine the action performed: * **run** -- Run a Python program and collect execution data. @@ -96,9 +96,9 @@ but before the program invocation:: $ coverage run --source=dir1,dir2 my_program.py arg1 arg2 $ coverage run --source=dir1,dir2 -m packagename.modulename arg1 arg2 -Coverage can measure multi-threaded programs by default. If you are using +Coverage.py can measure multi-threaded programs by default. If you are using more exotic concurrency, with the `greenlet`_, `eventlet`_, or `gevent`_ -libraries, then coverage will get very confused. Use the ``--concurrency`` +libraries, then coverage.py will get very confused. Use the ``--concurrency`` switch to properly measure programs using these libraries. Give it a value of ``greenlet``, ``eventlet``, or ``gevent``. @@ -106,12 +106,12 @@ switch to properly measure programs using these libraries. Give it a value of .. _gevent: http://www.gevent.org/ .. _eventlet: http://eventlet.net/ -By default, coverage does not measure code installed with the Python +By default, coverage.py does not measure code installed with the Python interpreter, for example, the standard library. If you want to measure that code as well as your own, add the ``-L`` flag. If your coverage results seem to be overlooking code that you know has been -executed, try running coverage again with the ``--timid`` flag. This uses a +executed, try running coverage.py again with the ``--timid`` flag. This uses a simpler but slower trace method. Projects that use DecoratorTools, including TurboGears, will need to use ``--timid`` to get correct results. @@ -149,7 +149,7 @@ could affect the measurement process. The possible warnings include: .. _cmd_run_debug: -The ``--debug`` option instructs coverage to log internal details of its +The ``--debug`` option instructs coverage.py to log internal details of its operation, to help with diagnosing problems. It takes a comma-separated list of options, each indicating a facet of operation to log to stderr: @@ -172,8 +172,8 @@ of options, each indicating a facet of operation to log to stderr: Data file --------- -Coverage collects execution data in a file called ".coverage". If need be, you -can set a new file name with the COVERAGE_FILE environment variable. +Coverage.py collects execution data in a file called ".coverage". If need be, +you can set a new file name with the COVERAGE_FILE environment variable. By default,each run of your program starts with an empty data set. If you need to run your program multiple times to get complete data (for example, because @@ -191,9 +191,9 @@ Combining data files -------------------- If you need to collect coverage data from different machines or processes, -coverage can combine multiple files into one for reporting. Use the ``-p`` flag -during execution to append distinguishing information to the .coverage data -file name. +coverage.py can combine multiple files into one for reporting. Use the ``-p`` +flag during execution to append distinguishing information to the .coverage +data file name. Once you have created a number of these files, you can copy them all to a single directory, and use the **combine** command to combine them into one @@ -202,9 +202,9 @@ single directory, and use the **combine** command to combine them into one $ coverage combine If the different machines run your code from different places in their file -systems, coverage won't know how to combine the data. You can tell coverage -how the different locations correlate with a ``[paths]`` section in your -configuration file. See :ref:`config_paths` for details. +systems, coverage.py won't know how to combine the data. You can tell +coverage.py how the different locations correlate with a ``[paths]`` section in +your configuration file. See :ref:`config_paths` for details. If you are collecting and renaming your own data files, you'll need to name them properly for **combine** to find them. It looks for files named after @@ -222,7 +222,7 @@ Here are some examples of data files that can be combined:: Reporting --------- -Coverage provides a few styles of reporting, with the **report**, **html**, +Coverage.py provides a few styles of reporting, with the **report**, **html**, **annotate**, and **xml** commands. They share a number of common options. The command-line arguments are module or file names to report on, if you'd like @@ -307,7 +307,7 @@ Other common reporting options are described above in :ref:`cmd_reporting`. HTML annotation --------------- -Coverage can annotate your source code for which lines were executed +Coverage.py can annotate your source code for which lines were executed and which were not. The **html** command creates an HTML report similar to the **report** summary, but as an HTML file. Each module name links to the source file decorated to show the status of each line. diff --git a/doc/conf.py b/doc/conf.py index 9d55e9d5..c996bdaa 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -46,7 +46,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'coverage.py' +project = u'Coverage.py' copyright = u'2009\N{EN DASH}2015, Ned Batchelder' # The version info for the project you're documenting, acts as replacement for diff --git a/doc/config.rst b/doc/config.rst index df703ba9..7109fb88 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -15,7 +15,7 @@ Configuration files Coverage.py options can be specified in a configuration file. This makes it -easier to re-run coverage with consistent settings, and also allows for +easier to re-run coverage.py with consistent settings, and also allows for specification of options that are otherwise only available in the :ref:`API <api>`. @@ -105,7 +105,7 @@ standard library. ``concurrency`` (string, default "thread"): the name of the concurrency library in use by the product code. If your program uses `gevent`_, `greenlet`_, or `eventlet`_, you must name that library in this option, or -coverage will produce very wrong results. +coverage.py will produce very wrong results. .. _greenlet: http://greenlet.readthedocs.org/en/latest/ .. _gevent: http://www.gevent.org/ diff --git a/doc/excluding.rst b/doc/excluding.rst index 44c51f96..c306ad4d 100644 --- a/doc/excluding.rst +++ b/doc/excluding.rst @@ -1,8 +1,8 @@ .. _excluding: -============================ -Excluding code from coverage -============================ +=============================== +Excluding code from coverage.py +=============================== .. :history: 20090613T090500, brand new docs. .. :history: 20100224T200900, updated for 3.3. @@ -11,13 +11,13 @@ Excluding code from coverage You may have code in your project that you know won't be executed, and you want -to tell coverage to ignore it. For example, you may have debugging-only code -that won't be executed during your unit tests. You can tell coverage to exclude -this code during reporting so that it doesn't clutter your reports with noise -about code that you don't need to hear about. +to tell coverage.py to ignore it. For example, you may have debugging-only +code that won't be executed during your unit tests. You can tell coverage.py to +exclude this code during reporting so that it doesn't clutter your reports with +noise about code that you don't need to hear about. -Coverage will look for comments marking clauses for exclusion. In this code, -the "if debug" clause is excluded from reporting:: +Coverage.py will look for comments marking clauses for exclusion. In this +code, the "if debug" clause is excluded from reporting:: a = my_function1() if debug: # pragma: no cover @@ -39,7 +39,7 @@ function is not reported as missing:: return "<MyObject>" Excluded code is executed as usual, and its execution is recorded in the -coverage data as usual. When producing reports though, coverage excludes it +coverage data as usual. When producing reports though, coverage.py excludes it from the list of missing code. @@ -64,7 +64,7 @@ line, so it isn't considered a branch at all. Advanced exclusion ------------------ -Coverage identifies exclusions by matching lines against a list of regular +Coverage.py identifies exclusions by matching lines against a list of regular expressions. Using :ref:`configuration files <config>` or the coverage :ref:`API <api>`, you can add to that list. This is useful if you have often-used constructs to exclude that can be matched with a regex. You can diff --git a/doc/faq.rst b/doc/faq.rst index 32492532..2bae33d2 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -26,10 +26,10 @@ the :ref:`command line <cmd>` to create the reports you need from that data. **Q: Why do unexecutable lines show up as executed?** -Usually this is because you've updated your code and run coverage on it again -without erasing the old data. Coverage records line numbers executed, so the -old data may have recorded a line number which has since moved, causing -coverage to claim a line has been executed which cannot be. +Usually this is because you've updated your code and run coverage.py on it +again without erasing the old data. Coverage.py records line numbers executed, +so the old data may have recorded a line number which has since moved, causing +coverage.py to claim a line has been executed which cannot be. If you are using the ``-x`` command line action, it doesn't erase first by default. Switch to the ``coverage run`` command, or use the ``-e`` switch to @@ -39,18 +39,18 @@ erase all data before starting the next run. **Q: Why do the bodies of functions (or classes) show as executed, but the def lines do not?** -This happens because coverage is started after the functions are defined. The -definition lines are executed without coverage measurement, then coverage is -started, then the function is called. This means the body is measured, but -the definition of the function itself is not. +This happens because coverage.py is started after the functions are defined. +The definition lines are executed without coverage measurement, then +coverage.py is started, then the function is called. This means the body is +measured, but the definition of the function itself is not. -To fix this, start coverage earlier. If you use the :ref:`command line <cmd>` -to run your program with coverage, then your entire program will be monitored. -If you are using the :ref:`API <api>`, you need to call coverage.start() before -importing the modules that define your functions. +To fix this, start coverage.py earlier. If you use the :ref:`command line +<cmd>` to run your program with coverage.py, then your entire program will be +monitored. If you are using the :ref:`API <api>`, you need to call +coverage.start() before importing the modules that define your functions. -**Q: Coverage is much slower than I remember, what's going on?** +**Q: Coverage.py is much slower than I remember, what's going on?** Make sure you are using the C trace function. Coverage.py provides two implementations of the trace function. The C implementation runs much faster. diff --git a/doc/index.rst b/doc/index.rst index 49da94eb..af24493c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,5 +1,5 @@ =========== -coverage.py +Coverage.py =========== .. :history: 20090524T134300, brand new docs. @@ -65,7 +65,7 @@ Quick start Getting started is easy: -#. Install coverage.py from the `coverage page on the Python Package Index`_, +#. Install coverage.py from the `coverage.py page on the Python Package Index`_, or by using "pip install coverage". For a few more details, see :ref:`install`. @@ -105,7 +105,7 @@ Getting started is easy: Then visit htmlcov/index.html in your browser, to see a `report like this one`_. -.. _coverage page on the Python Package Index: http://pypi.python.org/pypi/coverage +.. _coverage.py page on the Python Package Index: http://pypi.python.org/pypi/coverage .. _report like this: http://nedbatchelder.com/code/coverage/sample_html/index.html .. _report like this one: http://nedbatchelder.com/code/coverage/sample_html_beta/index.html @@ -118,12 +118,12 @@ There are a few different ways to use coverage.py. The simplest is the If you need more control over how your project is measured, you can use the :ref:`API <api>`. -Some test runners provide coverage integration to make it easy to use coverage -while running tests. For example, `nose`_ has a `cover plug-in`_. +Some test runners provide coverage integration to make it easy to use +coverage.py while running tests. For example, `nose`_ has a `cover plug-in`_. -You can fine-tune coverage's view of your code by directing it to ignore parts -that you know aren't interesting. See :ref:`source` and :ref:`excluding` for -details. +You can fine-tune coverage.py's view of your code by directing it to ignore +parts that you know aren't interesting. See :ref:`source` and :ref:`excluding` +for details. .. _nose: http://somethingaboutorange.com/mrl/projects/nose .. _cover plug-in: https://nose.readthedocs.org/en/latest/plugins/cover.html @@ -173,7 +173,3 @@ More information trouble faq changes - - -.. How it works -.. .coverage file format diff --git a/doc/install.rst b/doc/install.rst index 67af7203..fa01e636 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -47,7 +47,7 @@ The alternate old-school technique is: #. Install (or already have installed) `setuptools`_ or `Distribute`_. #. Download the appropriate kit from the - `coverage page on the Python Package Index`__. + `coverage.py page on the Python Package Index`__. #. Run ``python setup.py install``. @@ -82,8 +82,8 @@ the C extension pre-compiled so there's no need to worry about compilers. Checking the installation ------------------------- -If all went well, you should be able to open a command prompt, and see coverage -installed properly: +If all went well, you should be able to open a command prompt, and see +coverage.py installed properly: .. ifconfig:: not prerelease @@ -101,7 +101,7 @@ installed properly: Coverage.py, version |release|. Documentation at https://coverage.readthedocs.org/en/|release| -You can also invoke coverage as a module: +You can also invoke coverage.py as a module: .. ifconfig:: not prerelease diff --git a/doc/subprocess.rst b/doc/subprocess.rst index cce2c0bf..92ad135a 100644 --- a/doc/subprocess.rst +++ b/doc/subprocess.rst @@ -30,7 +30,7 @@ Measuring coverage in sub-processes is a little tricky. When you spawn a sub-process, you are invoking Python to run your program. Usually, to get coverage measurement, you have to use coverage.py to run your program. Your sub-process won't be using coverage.py, so we have to convince Python to use -coverage even when not explicitly invoked. +coverage.py even when not explicitly invoked. To do that, we'll configure Python to run a little coverage.py code when it starts. That code will look for an environment variable that tells it to start diff --git a/doc/trouble.rst b/doc/trouble.rst index c54ab68b..dbb22acc 100644 --- a/doc/trouble.rst +++ b/doc/trouble.rst @@ -8,8 +8,8 @@ Things that cause trouble .. :history: 20150124T160800, remove obsolete stuff. -Coverage works well, and I want it to properly measure any Python program, but -there are some situations it can't cope with. This page details some known +Coverage.py works well, and I want it to properly measure any Python program, +but there are some situations it can't cope with. This page details some known problems, with possible courses of action, and links to coverage.py bug reports with more information. @@ -85,10 +85,10 @@ $ make metacov - This will run coverage under its own measurement. You can do this in - different environments (Linux vs. Windows, for example), then copy the - data files (.coverage.meta.*) to one machine for combination and - reporting. To combine and report: + This will run coverage.py under its own measurement. You can do this in + different environments (Linux vs. Windows, for example), then copy the data + files (.metacov.*) to one machine for combination and reporting. To + combine and report: $ make metahtml @@ -105,9 +105,9 @@ def run_tests_with_coverage(tracer, *nose_args): suffix = "%s_%s_%s" % (version, tracer, socket.gethostname()) cov = coverage.coverage(config_file="metacov.ini", data_suffix=suffix) - # Cheap trick: the coverage code itself is excluded from measurement, but - # if we clobber the cover_prefix in the coverage object, we can defeat the - # self-detection. + # Cheap trick: the coverage.py code itself is excluded from measurement, + # but if we clobber the cover_prefix in the coverage object, we can defeat + # the self-detection. cov.cover_prefix = "Please measure coverage.py!" cov._warn_unimported_source = False cov.erase() @@ -1,4 +1,4 @@ -# setup.py for coverage.py +# Distutils setup for coverage.py """Code coverage measurement for Python diff --git a/tests/farm/html/gold_a/a_py.html b/tests/farm/html/gold_a/a_py.html index 03c1fc95..6151cec4 100644 --- a/tests/farm/html/gold_a/a_py.html +++ b/tests/farm/html/gold_a/a_py.html @@ -74,7 +74,7 @@ </td> <td class='text'> -<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.</span><span class='strut'> </span></p> +<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.py.</span><span class='strut'> </span></p> <p id='t2' class='pln'><span class='strut'> </span></p> <p id='t3' class='stm run hide_run'><span class='key'>if</span> <span class='num'>1</span> <span class='op'><</span> <span class='num'>2</span><span class='op'>:</span><span class='strut'> </span></p> <p id='t4' class='pln'> <span class='com'># Needed a < to look at HTML entities.</span><span class='strut'> </span></p> diff --git a/tests/farm/html/gold_b_branch/b_py.html b/tests/farm/html/gold_b_branch/b_py.html index 15b06661..8a7fd29e 100644 --- a/tests/farm/html/gold_b_branch/b_py.html +++ b/tests/farm/html/gold_b_branch/b_py.html @@ -98,7 +98,7 @@ </td> <td class='text'> -<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.</span><span class='strut'> </span></p> +<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.py.</span><span class='strut'> </span></p> <p id='t2' class='pln'><span class='strut'> </span></p> <p id='t3' class='stm run hide_run'><span class='key'>def</span> <span class='nam'>one</span><span class='op'>(</span><span class='nam'>x</span><span class='op'>)</span><span class='op'>:</span><span class='strut'> </span></p> <p id='t4' class='pln'> <span class='com'># This will be a branch that misses the else.</span><span class='strut'> </span></p> diff --git a/tests/farm/html/gold_other/here_py.html b/tests/farm/html/gold_other/here_py.html index e091395a..2dea6d66 100644 --- a/tests/farm/html/gold_other/here_py.html +++ b/tests/farm/html/gold_other/here_py.html @@ -75,7 +75,7 @@ </td> <td class='text'> -<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.</span><span class='strut'> </span></p> +<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.py.</span><span class='strut'> </span></p> <p id='t2' class='pln'><span class='strut'> </span></p> <p id='t3' class='stm run hide_run'><span class='key'>import</span> <span class='nam'>other</span><span class='strut'> </span></p> <p id='t4' class='pln'><span class='strut'> </span></p> diff --git a/tests/farm/html/gold_styled/a_py.html b/tests/farm/html/gold_styled/a_py.html index 9fdaee17..7b4bff73 100644 --- a/tests/farm/html/gold_styled/a_py.html +++ b/tests/farm/html/gold_styled/a_py.html @@ -76,7 +76,7 @@ </td> <td class='text'> -<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.</span><span class='strut'> </span></p> +<p id='t1' class='pln'><span class='com'># A test file for HTML reporting by coverage.py.</span><span class='strut'> </span></p> <p id='t2' class='pln'><span class='strut'> </span></p> <p id='t3' class='stm run hide_run'><span class='key'>if</span> <span class='num'>1</span> <span class='op'><</span> <span class='num'>2</span><span class='op'>:</span><span class='strut'> </span></p> <p id='t4' class='pln'> <span class='com'># Needed a < to look at HTML entities.</span><span class='strut'> </span></p> diff --git a/tests/farm/html/run_a.py b/tests/farm/html/run_a.py index f510e117..1fb491da 100644 --- a/tests/farm/html/run_a.py +++ b/tests/farm/html/run_a.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for a.""" + """Run coverage.py and make an HTML report for a.""" import coverage cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_a_xml_1.py b/tests/farm/html/run_a_xml_1.py index eec66174..65306579 100644 --- a/tests/farm/html/run_a_xml_1.py +++ b/tests/farm/html/run_a_xml_1.py @@ -1,7 +1,7 @@ source_path = None def html_it(): - """Run coverage and make an XML report for a.""" + """Run coverage.py and make an XML report for a.""" import coverage, coverage.files cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_a_xml_2.py b/tests/farm/html/run_a_xml_2.py index 081c8aa3..6c92ce29 100644 --- a/tests/farm/html/run_a_xml_2.py +++ b/tests/farm/html/run_a_xml_2.py @@ -1,7 +1,7 @@ source_path = None def html_it(): - """Run coverage and make an XML report for a.""" + """Run coverage.py and make an XML report for a.""" import coverage, coverage.files cov = coverage.coverage(config_file="run_a_xml_2.ini") cov.start() diff --git a/tests/farm/html/run_b_branch.py b/tests/farm/html/run_b_branch.py index 388b5c5e..cc7783ac 100644 --- a/tests/farm/html/run_b_branch.py +++ b/tests/farm/html/run_b_branch.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage with branches and make an HTML report for b.""" + """Run coverage.py with branches and make an HTML report for b.""" import coverage cov = coverage.coverage(branch=True) cov.start() diff --git a/tests/farm/html/run_bom.py b/tests/farm/html/run_bom.py index a6e6d8b8..9ff0b585 100644 --- a/tests/farm/html/run_bom.py +++ b/tests/farm/html/run_bom.py @@ -1,7 +1,7 @@ import sys def html_it(): - """Run coverage and make an HTML report for bom.py.""" + """Run coverage.py and make an HTML report for bom.py.""" import coverage cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_isolatin1.py b/tests/farm/html/run_isolatin1.py index b03cd25c..bad31f03 100644 --- a/tests/farm/html/run_isolatin1.py +++ b/tests/farm/html/run_isolatin1.py @@ -1,7 +1,7 @@ import sys def html_it(): - """Run coverage and make an HTML report for isolatin1.py.""" + """Run coverage.py and make an HTML report for isolatin1.py.""" import coverage cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_omit_1.py b/tests/farm/html/run_omit_1.py index 102aeb2a..b2f48aba 100644 --- a/tests/farm/html/run_omit_1.py +++ b/tests/farm/html/run_omit_1.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for main.""" + """Run coverage.py and make an HTML report for main.""" import coverage cov = coverage.coverage(include=["./*"]) cov.start() diff --git a/tests/farm/html/run_omit_2.py b/tests/farm/html/run_omit_2.py index a149c518..acf560f0 100644 --- a/tests/farm/html/run_omit_2.py +++ b/tests/farm/html/run_omit_2.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for main.""" + """Run coverage.py and make an HTML report for main.""" import coverage cov = coverage.coverage(include=["./*"]) cov.start() diff --git a/tests/farm/html/run_omit_3.py b/tests/farm/html/run_omit_3.py index 07b38a8a..65df865f 100644 --- a/tests/farm/html/run_omit_3.py +++ b/tests/farm/html/run_omit_3.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for main.""" + """Run coverage.py and make an HTML report for main.""" import coverage cov = coverage.coverage(include=["./*"]) cov.start() diff --git a/tests/farm/html/run_omit_4.py b/tests/farm/html/run_omit_4.py index 8c0c789c..f60bac25 100644 --- a/tests/farm/html/run_omit_4.py +++ b/tests/farm/html/run_omit_4.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for main.""" + """Run coverage.py and make an HTML report for main.""" import coverage cov = coverage.coverage(config_file="omit4.ini", include=["./*"]) cov.start() diff --git a/tests/farm/html/run_omit_5.py b/tests/farm/html/run_omit_5.py index 4ba5e50c..6e8d3f9e 100644 --- a/tests/farm/html/run_omit_5.py +++ b/tests/farm/html/run_omit_5.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for main.""" + """Run coverage.py and make an HTML report for main.""" import coverage cov = coverage.coverage(config_file="omit5.ini", include=["./*"]) cov.start() diff --git a/tests/farm/html/run_other.py b/tests/farm/html/run_other.py index 7c7f344a..0c843694 100644 --- a/tests/farm/html/run_other.py +++ b/tests/farm/html/run_other.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for everything.""" + """Run coverage.py and make an HTML report for everything.""" import coverage cov = coverage.coverage(include=["./*", "../othersrc/*"]) cov.start() diff --git a/tests/farm/html/run_partial.py b/tests/farm/html/run_partial.py index 7330bb27..da51814d 100644 --- a/tests/farm/html/run_partial.py +++ b/tests/farm/html/run_partial.py @@ -1,7 +1,7 @@ import sys def html_it(): - """Run coverage and make an HTML report for partial.""" + """Run coverage.py and make an HTML report for partial.""" import coverage cov = coverage.coverage(branch=True) cov.start() diff --git a/tests/farm/html/run_styled.py b/tests/farm/html/run_styled.py index ebfbf3bc..0d0de70b 100644 --- a/tests/farm/html/run_styled.py +++ b/tests/farm/html/run_styled.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for a.""" + """Run coverage.py and make an HTML report for a.""" import coverage cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_tabbed.py b/tests/farm/html/run_tabbed.py index 3e8a900f..7a57169d 100644 --- a/tests/farm/html/run_tabbed.py +++ b/tests/farm/html/run_tabbed.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for tabbed.""" + """Run coverage.py and make an HTML report for tabbed.""" import coverage cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_unicode.py b/tests/farm/html/run_unicode.py index 455d0168..9cb3a0d7 100644 --- a/tests/farm/html/run_unicode.py +++ b/tests/farm/html/run_unicode.py @@ -1,5 +1,5 @@ def html_it(): - """Run coverage and make an HTML report for unicode.py.""" + """Run coverage.py and make an HTML report for unicode.py.""" import coverage cov = coverage.coverage() cov.start() diff --git a/tests/farm/html/run_y_xml_branch.py b/tests/farm/html/run_y_xml_branch.py index b26f3af8..a0def47e 100644 --- a/tests/farm/html/run_y_xml_branch.py +++ b/tests/farm/html/run_y_xml_branch.py @@ -1,7 +1,7 @@ source_path = None def xml_it(): - """Run coverage and make an XML report for y.""" + """Run coverage.py and make an XML report for y.""" import coverage, coverage.files cov = coverage.coverage(branch=True) cov.start() diff --git a/tests/farm/html/src/a.py b/tests/farm/html/src/a.py index 9e71aebd..3c1119f0 100644 --- a/tests/farm/html/src/a.py +++ b/tests/farm/html/src/a.py @@ -1,4 +1,4 @@ -# A test file for HTML reporting by coverage. +# A test file for HTML reporting by coverage.py. if 1 < 2: # Needed a < to look at HTML entities. diff --git a/tests/farm/html/src/b.py b/tests/farm/html/src/b.py index 3bf73a9f..e57ceae8 100644 --- a/tests/farm/html/src/b.py +++ b/tests/farm/html/src/b.py @@ -1,4 +1,4 @@ -# A test file for HTML reporting by coverage. +# A test file for HTML reporting by coverage.py. def one(x): # This will be a branch that misses the else. diff --git a/tests/farm/html/src/here.py b/tests/farm/html/src/here.py index d0d26ea7..87e988b3 100644 --- a/tests/farm/html/src/here.py +++ b/tests/farm/html/src/here.py @@ -1,4 +1,4 @@ -# A test file for HTML reporting by coverage. +# A test file for HTML reporting by coverage.py. import other diff --git a/tests/farm/html/src/y.py b/tests/farm/html/src/y.py index af7c9689..a5f5fc70 100644 --- a/tests/farm/html/src/y.py +++ b/tests/farm/html/src/y.py @@ -1,4 +1,4 @@ -# A test file for XML reporting by coverage. +# A test file for XML reporting by coverage.py. def choice(x): if x < 2: diff --git a/tests/test_coverage.py b/tests/test_coverage.py index 3de381f1..bff2c461 100644 --- a/tests/test_coverage.py +++ b/tests/test_coverage.py @@ -1424,7 +1424,7 @@ class ExcludeTest(CoverageTest): [1,2,3,4,5,6,9], "", excludes=['#pragma: NO COVER']) def test_excluding_if_pass(self): - # From a comment on the coverage page by Michael McNeil Forbes: + # From a comment on the coverage.py page by Michael McNeil Forbes: self.check_coverage("""\ def f(): if False: # pragma: no cover diff --git a/tests/test_html.py b/tests/test_html.py index b35c7ed4..b74e136c 100644 --- a/tests/test_html.py +++ b/tests/test_html.py @@ -33,7 +33,7 @@ class HtmlTestHelpers(CoverageTest): """) def run_coverage(self, covargs=None, htmlargs=None): - """Run coverage on main_file.py, and create an HTML report.""" + """Run coverage.py on main_file.py, and create an HTML report.""" self.clean_local_file_imports() cov = coverage.coverage(**(covargs or {})) self.start_import_stop(cov, "main_file") @@ -75,7 +75,7 @@ class HtmlDeltaTest(HtmlTestHelpers, CoverageTest): def setUp(self): super(HtmlDeltaTest, self).setUp() - # At least one of our tests monkey-patches the version of coverage, + # At least one of our tests monkey-patches the version of coverage.py, # so grab it here to restore it later. self.real_coverage_version = coverage.__version__ self.addCleanup(self.restore_coverage_version) @@ -145,8 +145,8 @@ class HtmlDeltaTest(HtmlTestHelpers, CoverageTest): def test_html_delta_from_settings_change(self): # HTML generation can create only the files that have changed. - # In this case, everything changes because the coverage settings have - # changed. + # In this case, everything changes because the coverage.py settings + # have changed. self.create_initial_files() self.run_coverage(covargs=dict(omit=[])) index1 = self.get_html_index_content() @@ -164,7 +164,7 @@ class HtmlDeltaTest(HtmlTestHelpers, CoverageTest): def test_html_delta_from_coverage_version_change(self): # HTML generation can create only the files that have changed. - # In this case, everything changes because the coverage version has + # In this case, everything changes because the coverage.py version has # changed. self.create_initial_files() self.run_coverage() |