Since concurrency=multiprocessing uses subprocesses, options specified on
the coverage.py command line will not be communicated down to them. Only
options in the configuration file will apply to the subprocesses.
Previously, the options didn't apply to the subprocesses, but there was no
indication. Now it is an error to use --concurrency=multiprocessing and
other run-affecting options on the command line. This prevents
failures like those reported in issue 495_.
Filtering the HTML report is now faster, thanks to Ville Skyttä.
BACKWARD INCOMPATIBILITY: the coverage combine command now ignores an
existing .coverage data file. It used to include that file in its
combining. This caused confusing results, and extra tox "clean" steps. If
you want the old behavior, use the new coverage combine --append option.
The concurrency option can now take multiple values, to support programs
using multiprocessing and another library such as eventlet. This is only
possible in the configuration file, not from the command line. The
configuration file is the only way for sub-processes to all run with the same
options. Fixes issue 484_. Thanks to Josh Williams for prototyping.
Using a concurrency setting of multiprocessing now implies
--parallel so that the main program is measured similarly to the
sub-processes.
When using automatic subprocess measurement, running coverage commands
would create spurious data files. This is now fixed, thanks to diagnosis and
testing by Dan Riti. Closes issue 492.
A new configuration option, report:sort, controls what column of the
text report is used to sort the rows. Thanks to Dan Wandschneider, this
closes issue 199_.
The HTML report has a more-visible indicator for which column is being
sorted. Closes issue 298_, thanks to Josh Williams.
If the HTML report cannot find the source for a file, the message now
suggests using the -i flag to allow the report to continue. Closes
issue 231_, thanks, Nathan Land.
When reports are ignoring errors, there's now a warning if a file cannot be
parsed, rather than being silently ignored. Closes issue 396_. Thanks,
Matthew Boehm.
A new option for coverage debug is available: coverage debug config
shows the current configuration. Closes issue 454_, thanks to Matthew
Boehm.
Running coverage as a module (python -m coverage) no longer shows the
program name as __main__.py. Fixes issue 478_. Thanks, Scott Belden.
The test_helpers module has been moved into a separate pip-installable
package: unittest-mixins_.
The internal attribute Reporter.file_reporters was removed in 4.1b3. It
should have come has no surprise that there were third-party tools out there
using that attribute. It has been restored, but with a deprecation warning.
4.1b3
When running your program, execution can jump from an except X: line to
some other line when an exception other than X happens. This jump is no
longer considered a branch when measuring branch coverage.
When measuring branch coverage, yield statements that were never resumed
were incorrectly marked as missing, as reported in issue 440_. This is now
fixed.
During branch coverage of single-line callables like lambdas and generator
expressions, coverage.py can now distinguish between them never being called,
or being called but not completed. Fixes issue 90, issue 460 and
issue 475_.
The HTML report now has a map of the file along the rightmost edge of the
page, giving an overview of where the missed lines are. Thanks, Dmitry
Shishov.
The HTML report now uses different monospaced fonts, favoring Consolas over
Courier. Along the way, issue 472_ about not properly handling one-space
indents was fixed. The index page also has slightly different styling, to
try to make the clickable detail pages more apparent.
Missing branches reported with coverage report -m will now say ->exit
for missed branches to the exit of a function, rather than a negative number.
Fixes issue 469_.
coverage --help and coverage --version now mention which tracer is
installed, to help diagnose problems. The docs mention which features need
the C extension. (issue 479_)
Officially support PyPy 5.1, which required no changes, just updates to the
docs.
The Coverage.report function had two parameters with non-None defaults,
which have been changed. show_missing used to default to True, but now
defaults to None. If you had been calling Coverage.report without
specifying show_missing, you'll need to explicitly set it to True to keep
the same behavior. skip_covered used to default to False. It is now None,
which doesn't change the behavior. This fixes issue 485_.
It's never been possible to pass a namespace module to one of the analysis
functions, but now at least we raise a more specific error message, rather
than getting confused. (issue 456_)
The coverage.process_startup function now returns the Coverage instance
it creates, as suggested in issue 481_.
Make a small tweak to how we compare threads, to avoid buggy custom
comparison code in thread classes. (issue 245_)
Problems with the new branch measurement in 4.1 beta 1 were fixed:
Class docstrings were considered executable. Now they no longer are.
yield from and await were considered returns from functions, since
they could tranfer control to the caller. This produced unhelpful "missing
branch" reports in a number of circumstances. Now they no longer are
considered returns.
In unusual situations, a missing branch to a negative number was reported.
This has been fixed, closing issue 466_.
The XML report now produces correct package names for modules found in
directories specified with source=. Fixes issue 465_.
coverage report won't produce trailing whitespace.
Branch analysis has been rewritten: it used to be based on bytecode, but now
uses AST analysis. This has changed a number of things:
More code paths are now considered runnable, especially in
try/except structures. This may mean that coverage.py will
identify more code paths as uncovered. This could either raise or lower
your overall coverage number.
Python 3.5's async and await keywords are properly supported,
fixing issue 434_.
Some long-standing branch coverage bugs were fixed:
issue 129_: functions with only a docstring for a body would
incorrectly report a missing branch on the def line.
issue 212_: code in an except block could be incorrectly marked as
a missing branch.
issue 146_: context managers (with statements) in a loop or try
block could confuse the branch measurement, reporting incorrect partial
branches.
issue 422_: in Python 3.5, an actual partial branch could be marked as
complete.
Pragmas to disable coverage measurement can now be used on decorator lines,
and they will apply to the entire function or class being decorated. This
implements the feature requested in issue 131_.
Multiprocessing support is now available on Windows. Thanks, Rodrigue
Cloutier.
Files with two encoding declarations are properly supported, fixing
issue 453_. Thanks, Max Linke.
Non-ascii characters in regexes in the configuration file worked in 3.7, but
stopped working in 4.0. Now they work again, closing issue 455_.
Form-feed characters would prevent accurate determination of the beginning of
statements in the rest of the file. This is now fixed, closing issue 461_.
Fixed a mysterious problem that manifested in different ways: sometimes
hanging the process (issue 420), sometimes making database connections
fail (issue 445).
The XML report now has correct <source> elements when using a
--source= option somewhere besides the current directory. This fixes
issue 439_. Thanks, Arcady Ivanov.
Fixed an unusual edge case of detecting source encodings, described in
issue 443_.
Help messages that mention the command to use now properly use the actual
command name, which might be different than "coverage". Thanks to Ben
Finney, this closes issue 438_.
When combining data files, unreadable files will now generate a warning
instead of failing the command. This is more in line with the older
coverage.py v3.7.1 behavior, which silently ignored unreadable files.
Prompted by issue 418_.
The --skip-covered option would skip reporting on 100% covered files, but
also skipped them when calculating total coverage. This was wrong, it should
only remove lines from the report, not change the final answer. This is now
fixed, closing issue 423_.
In 4.0, the data file recorded a summary of the system on which it was run.
Combined data files would keep all of those summaries. This could lead to
enormous data files consisting of mostly repetitive useless information. That
summary is now gone, fixing issue 415_. If you want summary information,
get in touch, and we'll figure out a better way to do it.
Test suites that mocked os.path.exists would experience strange failures, due
to coverage.py using their mock inadvertently. This is now fixed, closing
issue 416_.
Importing a __init__ module explicitly would lead to an error:
AttributeError: 'module' object has no attribute '__path__', as reported
in issue 410_. This is now fixed.
Code that uses sys.settrace(sys.gettrace()) used to incur a more than 2x
speed penalty. Now there's no penalty at all. Fixes issue 397_.
Pyexpat C code will no longer be recorded as a source file, fixing
issue 419_.
The source kit now contains all of the files needed to have a complete source
tree, re-fixing issue 137 and closing issue 281.
Reporting on an unmeasured file would fail with a traceback. This is now
fixed, closing issue 403_.
The Jenkins ShiningPanda plugin looks for an obsolete file name to find the
HTML reports to publish, so it was failing under coverage.py 4.0. Now we
create that file if we are running under Jenkins, to keep things working
smoothly. issue 404_.
Kits used to include tests and docs, but didn't install them anywhere, or
provide all of the supporting tools to make them useful. Kits no longer
include tests and docs. If you were using them from the older packages, get
in touch and help me understand how.
4.0b1 broke --append creating new data files. This is now fixed, closing
issue 392_.
py.test --cov can write empty data, then touch files due to --source,
which made coverage.py mistakenly force the data file to record lines instead
of arcs. This would lead to a "Can't combine line data with arc data" error
message. This is now fixed, and changed some method names in the
CoverageData interface. Fixes issue 399_.
CoverageData.read_fileobj and CoverageData.write_fileobj replace the
.read and .write methods, and are now properly inverses of each other.
When using report --skip-covered, a message will now be included in the
report output indicating how many files were skipped, and if all files are
skipped, coverage.py won't accidentally scold you for having no data to
report. Thanks, Krystian Kichewko.
A new conversion utility has been added: python -m coverage.pickle2json
will convert v3.x pickle data files to v4.x JSON data files. Thanks,
Alexander Todorov. Closes issue 395_.
A new version identifier is available, coverage.version_info, a plain tuple
of values similar to sys.version_info_.
Coverage.py is now licensed under the Apache 2.0 license. See NOTICE.txt for
details. Closes issue 313_.
The data storage has been completely revamped. The data file is now
JSON-based instead of a pickle, closing issue 236_. The CoverageData
class is now a public supported documented API to the data file.
A new configuration option, [run] note, lets you set a note that will be
stored in the runs section of the data file. You can use this to annotate
the data file with any information you like.
Unrecognized configuration options will now print an error message and stop
coverage.py. This should help prevent configuration mistakes from passing
silently. Finishes issue 386_.
In parallel mode, coverage erase will now delete all of the data files,
fixing issue 262_.
Coverage.py now accepts a directory name for coverage run and will run a
__main__.py found there, just like Python will. Fixes issue 252_.
Thanks, Dmitry Trofimov.
The XML report now includes a missing-branches attribute. Thanks, Steve
Peak. This is not a part of the Cobertura DTD, so the XML report no longer
references the DTD.
Missing branches in the HTML report now have a bit more information in the
right-hand annotations. Hopefully this will make their meaning clearer.
All the reporting functions now behave the same if no data had been
collected, exiting with a status code of 1. Fixed fail_under to be
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.py looks for a function called coverage_init.
A file-tracing plugin can now ask to have built-in Python reporting by
returning "python" from its file_reporter() method.
Code that was executed with exec would be mis-attributed to the file that
called it. This is now fixed, closing issue 380_.
The ability to use item access on Coverage.config (introduced in 4.0a2) has
been changed to a more explicit Coverage.get_option and
Coverage.set_option API.
The Coverage.use_cache method is no longer supported.
The private method Coverage._harvest_data is now called
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_.
Combining data files with an explicit configuration file was broken in 4.0a6,
but now works again, closing issue 385_.
coverage combine now accepts files as well as directories.
The speed is back to 3.7.1 levels, after having slowed down due to plugin
support, finishing up issue 387_.
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.
The coverage combine command now accepts any number of directories as
arguments, and will combine all the data files from those directories. This
means you don't have to copy the files to one directory before combining.
Thanks, Christine Lytwynec. Finishes issue 354_.
Branch coverage couldn't properly handle certain extremely long files. This
is now fixed (issue 359_).
Branch coverage didn't understand yield statements properly. Mickie Betz
persisted in pursuing this despite Ned's pessimism. Fixes issue 308 and
issue 324.
The COVERAGE_DEBUG environment variable can be used to set the [run] debug
configuration option to control what internal operations are logged.
HTML reports were truncated at formfeed characters. This is now fixed
(issue 360). It's always fun when the problem is due to a bug in the Python standard library <http://bugs.python.org/issue19035>.
Files with incorrect encoding declaration comments are no longer ignored by
the reporting commands, fixing issue 351_.
HTML reports now include a timestamp in the footer, closing issue 299_.
Thanks, Conrad Ho.
HTML reports now begrudgingly use double-quotes rather than single quotes,
because there are "software engineers" out there writing tools that read HTML
and somehow have no idea that single quotes exist. Capitulates to the absurd
issue 361_. Thanks, Jon Chappell.
The coverage annotate command now handles non-ASCII characters properly,
closing issue 363_. Thanks, Leonardo Pistone.
Drive letters on Windows were not normalized correctly, now they are. Thanks,
Ionel Cristian MÄrieÈ.
Plugin support had some bugs fixed, closing issue 374 and issue 375.
Thanks, Stefan Behnel.
Plugin support is now implemented in the C tracer instead of the Python
tracer. This greatly improves the speed of tracing projects using plugins.
Coverage.py now always adds the current directory to sys.path, so that
plugins can import files in the current directory (issue 358_).
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
also examined, and a missing file is not considered an error (issue 357_).
Wildly experimental: support for measuring processes started by the
multiprocessing module. To use, set --concurrency=multiprocessing,
either on the command line or in the .coveragerc file (issue 117_). Thanks,
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.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
to unusual virtualenv configurations (issue 340_).
Added 3.5.0a1 to the list of supported CPython versions.
Plugins can now provide sys_info for debugging output.
Started plugins documentation.
Prepared to move the docs to readthedocs.org.
4.0a3
Reports now use file names with extensions. Previously, a report would
describe a/b/c.py as "a/b/c". Now it is shown as "a/b/c.py". This allows
for better support of non-Python files, and also fixed issue 69_.
The XML report now reports each directory as a package again. This was a bad
regression, I apologize. This was reported in issue 235_, which is now
fixed.
A new configuration option for the XML report: [xml] package_depth
controls which directories are identified as packages in the report.
Directories deeper than this depth are not reported as packages.
The default is that all directories are reported as packages.
Thanks, Lex Berezhny.
When looking for the source for a frame, check if the file exists. On
Windows, .pyw files are no longer recorded as .py files. Along the way, this
fixed issue 290_.
Empty files are now reported as 100% covered in the XML report, not 0%
covered (issue 345_).
Regexes in the configuration file are now compiled as soon as they are read,
to provide error messages earlier (issue 349_).
Officially support PyPy 2.4, and PyPy3 2.4. Drop support for
CPython 3.2 and older versions of PyPy. The code won't work on CPython 3.2.
It will probably still work on older versions of PyPy, but I'm not testing
against them.
Plugins!
The original command line switches (-x to run a program, etc) are no
longer supported.
A new option: coverage report --skip-covered will reduce the number of
files reported by skipping files with 100% coverage. Thanks, Krystian
Kichewko. This means that empty __init__.py files will be skipped, since
they are 100% covered, closing issue 315_.
You can now specify the --fail-under option in the .coveragerc file
as the [report] fail_under option. This closes issue 314_.
The COVERAGE_OPTIONS environment variable is no longer supported. It was
a hack for --timid before configuration files were available.
The HTML report now has filtering. Type text into the Filter box on the
index page, and only modules with that text in the name will be shown.
Thanks, Danny Allen.
The textual report and the HTML report used to report partial branches
differently for no good reason. Now the text report's "missing branches"
column is a "partial branches" column so that both reports show the same
numbers. This closes issue 342_.
If you specify a --rcfile that cannot be read, you will get an error
message. Fixes issue 343_.
The --debug switch can now be used on any command.
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.
The regex for matching exclusion pragmas has been fixed to allow more kinds
of whitespace, fixing issue 334_.
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.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
haven't changed is now a JSON file instead of a pickle file. This obviates
issue 287 and issue 237.
Python versions supported are now CPython 2.6, 2.7, 3.2, 3.3, and 3.4, and
PyPy 2.2.
Gevent, eventlet, and greenlet are now supported, closing issue 149_.
The concurrency setting specifies the concurrency library in use. Huge
thanks to Peter Portante for initial implementation, and to Joe Jevnik for
the final insight that completed the work.
Options are now also read from a setup.cfg file, if any. Sections are
prefixed with "coverage:", so the [run] options will be read from the
[coverage:run] section of setup.cfg. Finishes issue 304_.
The report -m command can now show missing branches when reporting on
branch coverage. Thanks, Steve Leonard. Closes issue 230_.
The XML report now contains a <source> element, fixing issue 94_. Thanks
Stan Hu.
The class defined in the coverage module is now called Coverage instead
of coverage, though the old name still works, for backward compatibility.
The fail-under value is now rounded the same as reported results,
preventing paradoxical results, fixing issue 284_.
The XML report will now create the output directory if need be, fixing
issue 285_. Thanks, Chris Rose.
HTML reports no longer raise UnicodeDecodeError if a Python file has
undecodable characters, fixing issue 303 and issue 331.
The annotate command will now annotate all files, not just ones relative to
the current directory, fixing issue 57_.
The coverage module no longer causes deprecation warnings on Python 3.4 by
importing the imp module, fixing issue 305_.
Encoding declarations in source files are only considered if they are truly
comments. Thanks, Anthony Sottile.
Omitting files within a tree specified with the source option would
cause them to be incorrectly marked as unexecuted, as described in
issue 218_. This is now fixed.
When specifying paths to alias together during data combining, you can now
specify relative paths, fixing issue 267_.
Most file paths can now be specified with username expansion (~/src, or
~build/src, for example), and with environment variable expansion
(build/$BUILDNUM/src).
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.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_.
Source files with encoding declarations, but a blank first line, were not
decoded properly. Now they are. Thanks, Roger Hu.
The source kit now includes the __main__.py file in the root coverage
directory, fixing issue 255_.
Coverage.py runs on Python 2.3 and 2.4 again. It was broken in 3.6b1.
The C extension is optionally compiled using a different more widely-used
technique, taking another stab at fixing issue 80_ once and for all.
Combining data files would create entries for phantom files if used with
source and path aliases. It no longer does.
debug sys now shows the configuration file path that was read.
If an oddly-behaved package claims that code came from an empty-string
file name, coverage.py no longer associates it with the directory name,
fixing issue 221_.
Wildcards in include= and omit= arguments were not handled properly
in reporting functions, though they were when running. Now they are handled
uniformly, closing issue 143 and issue 163. NOTE: it is possible
that your configurations may now be incorrect. If you use include or
omit during reporting, whether on the command line, through the API, or
in a configuration file, please check carefully that you were not relying on
the old broken behavior.
The report, html, and xml commands now accept a --fail-under
switch that indicates in the exit status whether the coverage percentage was
less than a particular value. Closes issue 139_.
The reporting functions coverage.report(), coverage.html_report(), and
coverage.xml_report() now all return a float, the total percentage covered
measurement.
The HTML report's title can now be set in the configuration file, with the
--title switch on the command line, or via the API.
Configuration files now support substitution of environment variables, using
syntax like ${WORD}. Closes issue 97_.
Embarrassingly, the [xml] output= setting in the .coveragerc file simply
didn't work. Now it does.
The XML report now consistently uses file names for the file name attribute,
rather than sometimes using module names. Fixes issue 67_.
Thanks, Marcus Cobden.
Coverage percentage metrics are now computed slightly differently under
branch coverage. This means that completely unexecuted files will now
correctly have 0% coverage, fixing issue 156_. This also means that your
total coverage numbers will generally now be lower if you are measuring
branch coverage.
When installing, now in addition to creating a "coverage" command, two new
aliases are also installed. A "coverage2" or "coverage3" command will be
created, depending on whether you are installing in Python 2.x or 3.x.
A "coverage-X.Y" command will also be created corresponding to your specific
version of Python. Closes issue 111_.
The coverage.py installer no longer tries to bootstrap setuptools or
Distribute. You must have one of them installed first, as issue 202_
recommended.
The coverage.py kit now includes docs (closing issue 137_) and tests.
On Windows, files are now reported in their correct case, fixing issue 89
and issue 203.
If a file is missing during reporting, the path shown in the error message
is now correct, rather than an incorrect path in the current directory.
Fixes issue 60_.
Running an HTML report in Python 3 in the same directory as an old Python 2
HTML report would fail with a UnicodeDecodeError. This issue (issue 193_)
is now fixed.
Fixed yet another error trying to parse non-Python files as Python, this
time an IndentationError, closing issue 82_ for the fourth time...
If coverage xml fails because there is no data to report, it used to
create a zero-length XML file. Now it doesn't, fixing issue 210_.
Jython files now work with the --source option, fixing issue 100_.
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,
fixing issue 214_, though this will take some time to be repackaged by the
operating systems.
Docstrings for the legacy singleton methods are more helpful. Thanks Marius
Gedminas. Closes issue 205_.
The pydoc tool can now show documentation for the class coverage.coverage.
Closes issue 206_.
Added a page to the docs about contributing to coverage.py, closing
issue 171_.
When coverage.py ended unsuccessfully, it may have reported odd errors like
'NoneType' object has no attribute 'isabs'. It no longer does,
so kiss issue 153_ goodbye.
Line numbers in the HTML report line up better with the source lines, fixing
issue 197_, thanks Marius Gedminas.
When specifying a directory as the source= option, the directory itself no
longer needs to have a __init__.py file, though its sub-directories do,
to be considered as source files.
Files encoded as UTF-8 with a BOM are now properly handled, fixing
issue 179_. Thanks, Pablo Carballo.
Fixed more cases of non-Python files being reported as Python source, and
then not being able to parse them as Python. Closes issue 82_ (again).
Thanks, Julian Berman.
The HTML report has slightly tweaked controls: the buttons at the top of
the page are color-coded to the source lines they affect.
Custom CSS can be applied to the HTML report by specifying a CSS file as
the extra_css configuration value in the [html] section.
Source files with custom encodings declared in a comment at the top are now
properly handled during reporting on Python 2. Python 3 always handled them
properly. This fixes issue 157_.
Backup files left behind by editors are no longer collected by the source=
option, fixing issue 168_.
If a file doesn't parse properly as Python, we don't report it as an error
if the file name seems like maybe it wasn't meant to be Python. This is a
pragmatic fix for issue 82_.
The -m switch on coverage report, which includes missing line numbers
in the summary report, can now be specified as show_missing in the
config file. Closes issue 173_.
When running a module with coverage run -m <modulename>, certain details
of the execution environment weren't the same as for
python -m <modulename>. This had the unfortunate side-effect of making
coverage run -m unittest discover not work if you had tests in a
directory named "test". This fixes issue 155 and issue 142.
Now the exit status of your product code is properly used as the process
status when running python -m coverage run .... Thanks, JT Olds.
When installing into pypy, we no longer attempt (and fail) to compile
the C tracer function, closing issue 166_.
The [paths] feature unfortunately didn't work in real world situations
where you wanted to, you know, report on the combined data. Now all paths
stored in the combined file are canonicalized properly.
3.5.1b1
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_.
Branch coverage for with statements is improved, fixing issue 128_.
The number of partial branches reported on the HTML summary page was
different than the number reported on the individual file pages. This is
now fixed.
An explicit include directive to measure files in the Python installation
wouldn't work because of the standard library exclusion. Now the include
directive takes precedence, and the files will be measured. Fixes
issue 138_.
The HTML report now handles Unicode characters in Python source files
properly. This fixes issue 124 and issue 144. Thanks, Devin
Jeanpierre.
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.py code before anything else in the process.
See the coverage/fullcoverage directory if you are interested.
The HTML report hotkeys now behave slightly differently when the current
chunk isn't visible at all: a chunk on the screen will be selected,
instead of the old behavior of jumping to the literal next chunk.
The hotkeys now work in Google Chrome. Thanks, Guido van Rossum.
3.5b1
The HTML report now has hotkeys. Try n, s, m, x, b,
p, and c on the overview page to change the column sorting.
On a file page, r, m, x, and p toggle the run, missing,
excluded, and partial line markings. You can navigate the highlighted
sections of code by using the j and k keys for next and previous.
The 1 (one) key jumps to the first highlighted section in the file,
and 0 (zero) scrolls to the top of the file.
The --omit and --include switches now interpret their values more
usefully. If the value starts with a wildcard character, it is used as-is.
If it does not, it is interpreted relative to the current directory.
Closes issue 121_.
Partial branch warnings can now be pragma'd away. The configuration option
partial_branches is a list of regular expressions. Lines matching any of
those expressions will never be marked as a partial branch. In addition,
there's a built-in list of regular expressions marking statements which should
never be marked as partial. This list includes while True:, while 1:,
if 1:, and if 0:.
The coverage() constructor accepts single strings for the omit= and
include= arguments, adapting to a common error in programmatic use.
Modules can now be run directly using coverage run -m modulename, to
mirror Python's -m flag. Closes issue 95_, thanks, Brandon Rhodes.
coverage run didn't emulate Python accurately in one small detail: the
current directory inserted into sys.path was relative rather than
absolute. This is now fixed.
HTML reporting is now incremental: a record is kept of the data that
produced the HTML reports, and only files whose data has changed will
be generated. This should make most HTML reporting faster.
Pathological code execution could disable the trace function behind our
backs, leading to incorrect code measurement. Now if this happens,
coverage.py will issue a warning, at least alerting you to the problem.
Closes issue 93_. Thanks to Marius Gedminas for the idea.
The C-based trace function now behaves properly when saved and restored
with sys.gettrace() and sys.settrace(). This fixes issue 125
and issue 123. Thanks, Devin Jeanpierre.
Source files are now opened with Python 3.2's tokenize.open() where
possible, to get the best handling of Python source files with encodings.
Closes issue 107_, thanks, Brett Cannon.
Syntax errors in supposed Python files can now be ignored during reporting
with the -i switch just like other source errors. Closes issue 115_.
Installation from source now succeeds on machines without a C compiler,
closing issue 80_.
Coverage.py can now be run directly from a working tree by specifying
the directory name to python: python coverage_py_working_dir run ....
Thanks, Brett Cannon.
A little bit of Jython support: coverage run can now measure Jython
execution by adapting when $py.class files are traced. Thanks, Adi Roiban.
Jython still doesn't provide the Python libraries needed to make
coverage reporting work, unfortunately.
Internally, files are now closed explicitly, fixing issue 104_. Thanks,
Brett Cannon.
Completely unexecuted files can now be included in coverage results, reported
as 0% covered. This only happens if the --source option is specified, since
coverage.py needs guidance about where to look for source files.
The XML report output now properly includes a percentage for branch coverage,
fixing issue 65 and issue 81.
Coverage percentages are now displayed uniformly across reporting methods.
Previously, different reports could round percentages differently. Also,
percentages are only reported as 0% or 100% if they are truly 0 or 100, and
are rounded otherwise. Fixes issue 41 and issue 70.
The precision of reported coverage percentages can be set with the
[report] precision config file setting. Completes issue 16_.
Threads derived from threading.Thread with an overridden run method
would report no coverage for the run method. This is now fixed, closing
issue 85_.
BACKWARD INCOMPATIBILITY: the --omit and --include switches now take
file patterns rather than file prefixes, closing issue 34 and issue 36.
BACKWARD INCOMPATIBILITY: the omit_prefixes argument is gone throughout
coverage.py, replaced with omit, a list of file name patterns suitable for
fnmatch. A parallel argument include controls what files are included.
The run command now has a --source switch, a list of directories or
module names. If provided, coverage.py will only measure execution in those
source files.
Various warnings are printed to stderr for problems encountered during data
measurement: if a --source module has no Python source to measure, or is
never encountered at all, or if no data is collected.
The reporting commands (report, annotate, html, and xml) now have an
--include switch to restrict reporting to modules matching those file
patterns, similar to the existing --omit switch. Thanks, Zooko.
The run command now supports --include and --omit to control what
modules it measures. This can speed execution and reduce the amount of data
during reporting. Thanks Zooko.
Since coverage.py 3.1, using the Python trace function has been slower than
it needs to be. A cache of tracing decisions was broken, but has now been
fixed.
Python 2.7 and 3.2 have introduced new opcodes that are now supported.
Python files with no statements, for example, empty __init__.py files,
are now reported as having zero statements instead of one. Fixes issue 1_.
Reports now have a column of missed line counts rather than executed line
counts, since developers should focus on reducing the missed lines to zero,
rather than increasing the executed lines to varying targets. Once
suggested, this seemed blindingly obvious.
Line numbers in HTML source pages are clickable, linking directly to that
line, which is highlighted on arrival. Added a link back to the index page
at the bottom of each HTML page.
Programs that call os.fork will properly collect data from both the child
and parent processes. Use coverage run -p to get two data files that can
be combined with coverage combine. Fixes issue 56_.
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
being measured when it shouldn't have been. This is now fixed.
Doctest text files are no longer recorded in the coverage data, since they
can't be reported anyway. Fixes issue 52 and issue 61.
Jinja HTML templates compile into Python code using the HTML file name,
which confused coverage.py. Now these files are no longer traced, fixing
issue 82_.
Source files can have more than one dot in them (foo.test.py), and will be
treated properly while reporting. Fixes issue 46_.
Source files with DOS line endings are now properly tokenized for syntax
coloring on non-DOS machines. Fixes issue 53_.
Unusual code structure that confused exits from methods with exits from
classes is now properly analyzed. See issue 62_.
Asking for an HTML report with no files now shows a nice error message rather
than a cryptic failure ('int' object is unsubscriptable). Fixes issue 59_.
Settings are now read from a .coveragerc file. A specific file can be
specified on the command line with --rcfile=FILE. The name of the file can
be programmatically set with the config_file argument to the coverage()
constructor, or reading a config file can be disabled with
config_file=False.
Fixed a problem with nested loops having their branch possibilities
mischaracterized: issue 39_.
Added coverage.process_start to enable coverage measurement when Python
starts.
Parallel data file names now have a random number appended to them in
addition to the machine name and process id.
Parallel data files combined with "coverage combine" are deleted after
they're combined, to clean up unneeded files. Fixes issue 40_.
Exceptions thrown from product code run with "coverage run" are now displayed
without internal coverage.py frames, so the output is the same as when the
code is run without coverage.py.
The data_suffix argument to the coverage constructor is now appended with
an added dot rather than simply appended, so that .coveragerc files will not
be confused for data files.
Python source files that don't end with a newline can now be executed, fixing
issue 47_.
Click-to-sort HTML report columns are now persisted in a cookie. Viewing
a report will sort it first the way you last had a coverage report sorted.
Thanks, Chris Adams_.
On Python 3.x, setuptools has been replaced by Distribute_.
Coverage.py has a new command line syntax with sub-commands. This expands
the possibilities for adding features and options in the future. The old
syntax is still supported. Try "coverage help" to see the new commands.
Thanks to Ben Finney for early help.
Added an experimental "coverage xml" command for producing coverage reports
in a Cobertura-compatible XML format. Thanks, Bill Hart.
Added the --timid option to enable a simpler slower trace function that works
for DecoratorTools projects, including TurboGears. Fixed issue 12 and
issue 13.
HTML reports show modules from other directories. Fixed issue 11_.
HTML reports now display syntax-colored Python source.
Programs that change directory will still write .coverage files in the
directory where execution started. Fixed issue 24_.
Added a "coverage debug" command for getting diagnostic information about the
coverage.py installation.
Removed the recursion limit in the tracer function. Previously, code that
ran more than 500 frames deep would crash. Fixed issue 9_.
Fixed a bizarre problem involving pyexpat, whereby lines following XML parser
invocations could be overlooked. Fixed issue 10_.
On Python 2.3, coverage.py could mis-measure code with exceptions being
raised. This is now fixed.
The coverage.py code itself will now not be measured by coverage.py, and no
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
example.
Added parameters to coverage.init for options that had been set on the
coverage object itself.
Added clear_exclude() and get_exclude_list() methods for programmatic
manipulation of the exclude regexes.
Added coverage.load() to read previously-saved data from the data file.
Improved the finding of code files. For example, .pyc files that have been
installed after compiling are now located correctly. Thanks, Detlev
Offenbach.
When using the object API (that is, constructing a coverage() object), data
is no longer saved automatically on process exit. You can re-enable it with
the auto_data=True parameter on the coverage() constructor. The module-level
interface still uses automatic saving.
3.0b1
Major overhaul.
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.py runs are now
much faster. Thanks to David Christian for productive micro-sprints and
other encouragement.
Executable lines are identified by reading the line number tables in the
compiled code, removing a great deal of complicated analysis code.
Precisely which lines are considered executable has changed in some cases.
Therefore, your coverage stats may also change slightly.
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.py.
The minimum supported Python version is 2.3.
3.0b
HTML reporting, and continued refactoring.
HTML reports and annotation of source files: use the new -b (browser) switch.
Thanks to George Song for code, inspiration and guidance.
Code in the Python standard library is not measured by default. If you need
to measure standard library code, use the -L command-line switch during
execution, or the cover_pylib=True argument to the coverage() constructor.
Source annotation into a directory (-a -d) behaves differently. The
annotated files are named with their hierarchy flattened so that same-named
files from different directories no longer collide. Also, only files in the
current tree are included.
coverage.annotate_file is no longer available.
Programs executed with -x now behave more as they should, for example,
file has the correct value.
.coverage data files have a new pickle-based format designed for better
extensibility.
Removed the undocumented cache_file argument to coverage.usecache().
2.85
Add support for finding source files in eggs. Don't check for
morf's being instances of ModuleType, instead use duck typing so that
pseudo-modules can participate. Thanks, Imri Goldberg.
Use os.realpath as part of the fixing of file names so that symlinks won't
confuse things. Thanks, Patrick Mezard.
2.80
Open files in rU mode to avoid line ending craziness. Thanks, Edward Loper.
2.78
Don't try to predict whether a file is Python source based on the extension.
Extension-less files are often Pythons scripts. Instead, simply parse the file
and catch the syntax errors. Hat tip to Ben Finney.
2.77
Better packaging.
2.76
Now Python 2.5 is really fully supported: the body of the new with
statement is counted as executable.
2.75
Python 2.5 now fully supported. The method of dealing with multi-line
statements is now less sensitive to the exact line that Python reports during
execution. Pass statements are handled specially so that their disappearance
during execution won't throw off the measurement.
2.7
"pragma: nocover" is excluded by default.
Properly ignore docstrings and other constant expressions that appear in the
middle of a function, a problem reported by Tim Leslie.
coverage.erase() shouldn't clobber the exclude regex. Change how parallel
mode is invoked, and fix erase() so that it erases the cache when called
programmatically.
In reports, ignore code executed from strings, since we can't do anything
useful with it anyway.
Better file handling on Linux, thanks Guillaume Chazarain.
Better shell support on Windows, thanks Noel O'Boyle.
Python 2.2 support maintained, thanks Catherine Proulx.
Minor changes to avoid lint warnings.
2.6
Applied Joseph Tate's patch for function decorators.
Applied Sigve Tjora and Mark van der Wal's fixes for argument handling.
Applied Geoff Bache's parallel mode patch.
Refactorings to improve testability. Fixes to command-line logic for parallel
mode and collect.
2.5
Call threading.settrace so that all threads are measured. Thanks Martin
Fuzzey.
Add a file argument to report so that reports can be captured to a different
destination.
Coverage.py can now measure itself.
Adapted Greg Rogers' patch for using relative file names, and sorting and
omitting files to report on.
2.2
Allow for keyword arguments in the module global functions. Thanks, Allen.
2.1
Return 'analysis' to its original behavior and add 'analysis2'. Add a global
for 'annotate', and factor it, adding 'annotate_file'.
2.0
Significant code changes.
Finding executable statements has been rewritten so that docstrings and
other quirks of Python execution aren't mistakenly identified as missing
lines.
Lines can be excluded from consideration, even entire suites of lines.
The file system cache of covered lines can be disabled programmatically.
Modernized the code.
Earlier History
2001-12-04 GDR Created.
2001-12-06 GDR Added command-line interface and source code annotation.
2001-12-09 GDR Moved design and interface to separate documents.
2001-12-10 GDR Open cache file as binary on Windows. Allow simultaneous -e and
-x, or -a and -r.
2001-12-12 GDR Added command-line help. Cache analysis so that it only needs to
be done once when you specify -a and -r.
1.5.2
and 2.1.1.
2002-01-03 GDR Module-level functions work correctly.
2002-01-07 GDR Update sys.path when running a file with the -x option, so that
it matches the value the program would get if it were run on its own.
Got merge conflicts? Close this PR and delete the branch. I'll create a new PR for you.
coverage is not pinned to a specific version.
I'm pinning it to the latest version 4.2 for now.
These links might come in handy: PyPi | Changelog | Docs
Changelog
Got merge conflicts? Close this PR and delete the branch. I'll create a new PR for you.
Happy merging! 🤖