Update dependency coverage to v7 (!7) · Merge requests · engmark / img2scad

Victor Engmark requested to merge renovate/coverage-7.x into master Sep 04, 2023

This MR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
coverage	`==3.7.1` -> `==7.3.1`

Release Notes

nedbat/coveragepy (coverage)

`v7.3.1`

Compare Source

The semantics of stars in file patterns has been clarified in the docs. A leading or trailing star matches any number of path components, like a double star would. This is different than the behavior of a star in the middle of a pattern. This discrepancy was identified by Sviatoslav Sydorenko <starbad_>*, who provided patient detailed diagnosis <pull 1650_>* and graciously agreed to a pragmatic resolution.
The API docs were missing from the last version. They are now restored <apidocs_>_.

.. _apidocs: https://coverage.readthedocs.io/en/latest/api_coverage.html .. _starbad: https://github.com/nedbat/coveragepy/issues/1407#issuecomment-1631085209 .. _pull 1650: https://github.com/nedbat/coveragepy/pull/1650

.. _changes_7-3-0:

`v7.3.0`

Compare Source

Added a :meth:.Coverage.collect context manager to start and stop coverage data collection.
Dropped support for Python 3.7.
Fix: in unusual circumstances, SQLite cannot be set to asynchronous mode. Coverage.py would fail with the error Safety level may not be changed inside a transaction. This is now avoided, closing issue 1646_. Thanks to Michael Bell for the detailed bug report.
Docs: examples of configuration files now include separate examples for the different syntaxes: .coveragerc, pyproject.toml, setup.cfg, and tox.ini.
Fix: added nosemgrep comments to our JavaScript code so that semgrep-based SAST security checks won't raise false alarms about security problems that aren't problems.
Added a CITATION.cff file, thanks to Ken Schackart <pull 1641_>_.

.. _pull 1641: https://github.com/nedbat/coveragepy/pull/1641 .. _issue 1646: https://github.com/nedbat/coveragepy/issues/1646

.. _changes_7-2-7:

`v7.2.7`

Compare Source

Fix: reverted a change from 6.4.3 <pull 1347_>_ that helped Cython, but also increased the size of data files when using dynamic contexts, as described in the now-fixed issue 1586*. The problem is now avoided due to a recent change (issue 1538*). Thanks to Anders Kaseorg <pull 1629_>_ and David Szotten for persisting with problem reports and detailed diagnoses.
Wheels are now provided for CPython 3.12.

.. _issue 1586: https://github.com/nedbat/coveragepy/issues/1586 .. _pull 1629: https://github.com/nedbat/coveragepy/pull/1629

.. _changes_7-2-6:

`v7.2.6`

Compare Source

Fix: the lcov command could raise an IndexError exception if a file is translated to Python but then executed under its own name. Jinja2 does this when rendering templates. Fixes issue 1553_.
Python 3.12 beta 1 now inlines comprehensions. Previously they were compiled as invisible functions and coverage.py would warn you if they weren't completely executed. This no longer happens under Python 3.12.
Fix: the coverage debug sys command includes some environment variables in its output. This could have included sensitive data. Those values are now hidden with asterisks, closing issue 1628_.

.. _issue 1553: https://github.com/nedbat/coveragepy/issues/1553 .. _issue 1628: https://github.com/nedbat/coveragepy/issues/1628

.. _changes_7-2-5:

`v7.2.5`

Compare Source

Fix: html_report() could fail with an AttributeError on isatty if run in an unusual environment where sys.stdout had been replaced. This is now fixed.

.. _changes_7-2-4:

`v7.2.4`

Compare Source

PyCon 2023 sprint fixes!

Fix: with relative_files = true, specifying a specific file to include or omit wouldn't work correctly (issue 1604*). This is now fixed, with testing help by Marc Gibbons <pull 1608_>*.
Fix: the XML report would have an incorrect <source> element when using relative files and the source option ended with a slash (issue 1541*). This is now fixed, thanks to Kevin Brown-Silva <pull 1608_>*.
When the HTML report location is printed to the terminal, it's now a terminal-compatible URL, so that you can click the location to open the HTML file in your browser. Finishes issue 1523_ thanks to Ricardo Newbery <pull 1613_>_.
Docs: a new :ref:Migrating page <migrating> with details about how to migrate between major versions of coverage.py. It currently covers the wildcard changes in 7.x. Thanks, Brian Grohe <pull 1610_>_.

.. _issue 1523: https://github.com/nedbat/coveragepy/issues/1523 .. _issue 1541: https://github.com/nedbat/coveragepy/issues/1541 .. _issue 1604: https://github.com/nedbat/coveragepy/issues/1604 .. _pull 1608: https://github.com/nedbat/coveragepy/pull/1608 .. _pull 1609: https://github.com/nedbat/coveragepy/pull/1609 .. _pull 1610: https://github.com/nedbat/coveragepy/pull/1610 .. _pull 1613: https://github.com/nedbat/coveragepy/pull/1613

.. _changes_7-2-3:

`v7.2.3`

Compare Source

Fix: the :ref:config_run_sigterm setting was meant to capture data if a process was terminated with a SIGTERM signal, but it didn't always. This was fixed thanks to Lewis Gaul <pull 1600_>*, closing issue 1599*.
Performance: HTML reports with context information are now much more compact. File sizes are typically as small as one-third the previous size, but can be dramatically smaller. This closes issue 1584_ thanks to Oleh Krehel <pull 1587_>_.
Development dependencies no longer use hashed pins, closing issue 1592_.

.. _issue 1584: https://github.com/nedbat/coveragepy/issues/1584 .. _pull 1587: https://github.com/nedbat/coveragepy/pull/1587 .. _issue 1592: https://github.com/nedbat/coveragepy/issues/1592 .. _issue 1599: https://github.com/nedbat/coveragepy/issues/1599 .. _pull 1600: https://github.com/nedbat/coveragepy/pull/1600

.. _changes_7-2-2:

`v7.2.2`

Compare Source

Fix: if a virtualenv was created inside a source directory, and a sourced package was installed inside the virtualenv, then all of the third-party packages inside the virtualenv would be measured. This was incorrect, but has now been fixed: only the specified packages will be measured, thanks to Manuel Jacob <pull 1560_>_.
Fix: the coverage lcov command could create a .lcov file with incorrect LF (lines found) and LH (lines hit) totals. This is now fixed, thanks to Ian Moore <pull 1583_>_.
Fix: the coverage xml command on Windows could create a .xml file with duplicate <package> elements. This is now fixed, thanks to Benjamin Parzella <pull 1574_>*, closing issue 1573*.

.. _pull 1560: https://github.com/nedbat/coveragepy/pull/1560 .. _issue 1573: https://github.com/nedbat/coveragepy/issues/1573 .. _pull 1574: https://github.com/nedbat/coveragepy/pull/1574 .. _pull 1583: https://github.com/nedbat/coveragepy/pull/1583

.. _changes_7-2-1:

`v7.2.1`

Compare Source

Fix: the PyPI page had broken links to documentation pages, but no longer does, closing issue 1566_.
Fix: public members of the coverage module are now properly indicated so that mypy will find them, fixing issue 1564_.

.. _issue 1564: https://github.com/nedbat/coveragepy/issues/1564 .. _issue 1566: https://github.com/nedbat/coveragepy/issues/1566

.. _changes_7-2-0:

`v7.2.0`

Compare Source

Added a new setting [report] exclude_also to let you add more exclusions without overwriting the defaults. Thanks, Alpha Chen <pull 1557_>*, closing issue 1391*.
Added a :meth:.CoverageData.purge_files method to remove recorded data for a particular file. Contributed by Stephan Deibel <pull 1547_>_.
Fix: when reporting commands fail, they will no longer congratulate themselves with messages like "Wrote XML report to file.xml" before spewing a traceback about their failure.
Fix: arguments in the public API that name file paths now accept pathlib.Path objects. This includes the data_file and config_file arguments to the Coverage constructor and the basename argument to CoverageData. Closes issue 1552_.
Fix: In some embedded environments, an IndexError could occur on stop() when the originating thread exits before completion. This is now fixed, thanks to Russell Keith-Magee <pull 1543_>*, closing issue 1542*.
Added a py.typed file to announce our type-hintedness. Thanks, KotlinIsland <pull 1550_>_.

.. _issue 1391: https://github.com/nedbat/coveragepy/issues/1391 .. _issue 1542: https://github.com/nedbat/coveragepy/issues/1542 .. _pull 1543: https://github.com/nedbat/coveragepy/pull/1543 .. _pull 1547: https://github.com/nedbat/coveragepy/pull/1547 .. _pull 1550: https://github.com/nedbat/coveragepy/pull/1550 .. _issue 1552: https://github.com/nedbat/coveragepy/issues/1552 .. _pull 1557: https://github.com/nedbat/coveragepy/pull/1557

.. _changes_7-1-0:

`v7.1.0`

Compare Source

Added: the debug output file can now be specified with [run] debug_file in the configuration file. Closes issue 1319_.
Performance: fixed a slowdown with dynamic contexts that's been around since 6.4.3. The fix closes issue 1538*. Thankfully this doesn't break the Cython change* that fixed issue 972_. Thanks to Mathieu Kniewallner for the deep investigative work and comprehensive issue report.
Typing: all product and test code has type annotations.

.. _Cython change: https://github.com/nedbat/coveragepy/pull/1347 .. _issue 972: https://github.com/nedbat/coveragepy/issues/972 .. _issue 1319: https://github.com/nedbat/coveragepy/issues/1319 .. _issue 1538: https://github.com/nedbat/coveragepy/issues/1538

.. _changes_7-0-5:

`v7.0.5`

Compare Source

Fix: On Python 3.7, a file with type annotations but no from __future__ import annotations would be missing statements in the coverage report. This is now fixed, closing issue 1524_.

.. _issue 1524: https://github.com/nedbat/coveragepy/issues/1524

.. _changes_7-0-4:

`v7.0.4`

Compare Source

Performance: an internal cache of file names was accidentally disabled, resulting in sometimes drastic reductions in performance. This is now fixed, closing issue 1527_. Thanks to Ivan Ciuvalschii for the reproducible test case.

.. _issue 1527: https://github.com/nedbat/coveragepy/issues/1527

.. _changes_7-0-3:

`v7.0.3`

Compare Source

Fix: when using pytest-cov or pytest-xdist, or perhaps both, the combining step could fail with assert row is not None using 7.0.2. This was due to a race condition that has always been possible and is still possible. In 7.0.1 and before, the error was silently swallowed by the combining code. Now it will produce a message "Couldn't combine data file" and ignore the data file as it used to do before 7.0.2. Closes issue 1522_.

.. _issue 1522: https://github.com/nedbat/coveragepy/issues/1522

.. _changes_7-0-2:

`v7.0.2`

Compare Source

Fix: when using the [run] relative_files = True setting, a relative [paths] pattern was still being made absolute. This is now fixed, closing issue 1519_.
Fix: if Python doesn't provide tomllib, then TOML configuration files can only be read if coverage.py is installed with the [toml] extra. Coverage.py will raise an error if TOML support is not installed when it sees your settings are in a .toml file. But it didn't understand that [tools.coverage] was a valid section header, so the error wasn't reported if you used that header, and settings were silently ignored. This is now fixed, closing issue 1516_.
Fix: adjusted how decorators are traced on PyPy 7.3.10, fixing issue 1515_.
Fix: the coverage lcov report did not properly implement the --fail-under=MIN option. This has been fixed.
Refactor: added many type annotations, including a number of refactorings. This should not affect outward behavior, but they were a bit invasive in some places, so keep your eyes peeled for oddities.
Refactor: removed the vestigial and long untested support for Jython and IronPython.

.. _issue 1515: https://github.com/nedbat/coveragepy/issues/1515 .. _issue 1516: https://github.com/nedbat/coveragepy/issues/1516 .. _issue 1519: https://github.com/nedbat/coveragepy/issues/1519

.. _changes_7-0-1:

`v7.0.1`

Compare Source

When checking if a file mapping resolved to a file that exists, we weren't considering files in .whl files. This is now fixed, closing issue 1511_.
File pattern rules were too strict, forbidding plus signs and curly braces in directory and file names. This is now fixed, closing issue 1513_.
Unusual Unicode or control characters in source files could prevent reporting. This is now fixed, closing issue 1512_.
The PyPy wheel now installs on PyPy 3.7, 3.8, and 3.9, closing issue 1510_.

.. _issue 1510: https://github.com/nedbat/coveragepy/issues/1510 .. _issue 1511: https://github.com/nedbat/coveragepy/issues/1511 .. _issue 1512: https://github.com/nedbat/coveragepy/issues/1512 .. _issue 1513: https://github.com/nedbat/coveragepy/issues/1513

.. _changes_7-0-0:

`v7.0.0`

Compare Source

Nothing new beyond 7.0.0b1.

.. _changes_7-0-0b1:

`v6.5.0`

Compare Source

The JSON report now includes details of which branches were taken, and which are missing for each file. Thanks, Christoph Blessing <pull 1438_>*. Closes issue 1425*.
Starting with coverage.py 6.2, class statements were marked as a branch. This wasn't right, and has been reverted, fixing issue 1449_. Note this will very slightly reduce your coverage total if you are measuring branch coverage.
Packaging is now compliant with PEP 517*, closing issue 1395*.
A new debug option --debug=pathmap shows details of the remapping of paths that happens during combine due to the [paths] setting.
Fix an internal problem with caching of invalid Python parsing. Found by OSS-Fuzz, fixing their bug 50381_.

.. _bug 50381: https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=50381 .. _PEP 517: https://peps.python.org/pep-0517/ .. _issue 1395: https://github.com/nedbat/coveragepy/issues/1395 .. _issue 1425: https://github.com/nedbat/coveragepy/issues/1425 .. _issue 1449: https://github.com/nedbat/coveragepy/issues/1449 .. _pull 1438: https://github.com/nedbat/coveragepy/pull/1438

.. _changes_6-4-4:

`v6.4.4`

Compare Source

Wheels are now provided for Python 3.11.

.. _changes_6-4-3:

`v6.4.3`

Compare Source

Fix a failure when combining data files if the file names contained glob-like patterns. Thanks, Michael Krebs and Benjamin Schubert <pull 1405_>_.
Fix a messaging failure when combining Windows data files on a different drive than the current directory, closing issue 1428*. Thanks, Lorenzo Micò <pull 1430_>*.
Fix path calculations when running in the root directory, as you might do in a Docker container. Thanks Arthur Rio <pull 1403_>_.
Filtering in the HTML report wouldn't work when reloading the index page. This is now fixed. Thanks, Marc Legendre <pull 1413_>_.
Fix a problem with Cython code measurement, closing issue 972*. Thanks, Matus Valo <pull 1347_>*.

.. _issue 972: https://github.com/nedbat/coveragepy/issues/972 .. _issue 1428: https://github.com/nedbat/coveragepy/issues/1428 .. _pull 1347: https://github.com/nedbat/coveragepy/pull/1347 .. _pull 1403: https://github.com/nedbat/coveragepy/issues/1403 .. _pull 1405: https://github.com/nedbat/coveragepy/issues/1405 .. _pull 1413: https://github.com/nedbat/coveragepy/issues/1413 .. _pull 1430: https://github.com/nedbat/coveragepy/pull/1430

.. _changes_6-4-2:

`v6.4.2`

Compare Source

Updated for a small change in Python 3.11.0 beta 4: modules now start with a line with line number 0, which is ignored. This line cannot be executed, so coverage totals were thrown off. This line is now ignored by coverage.py, but this also means that truly empty modules (like __init__.py) have no lines in them, rather than one phantom line. Fixes issue 1419_.
Internal debugging data added to sys.modules is now an actual module, to avoid confusing code that examines everything in sys.modules. Thanks, Yilei Yang <pull 1399_>_.

.. _issue 1419: https://github.com/nedbat/coveragepy/issues/1419 .. _pull 1399: https://github.com/nedbat/coveragepy/pull/1399

.. _changes_6-4-1:

`v6.4.1`

Compare Source

Greatly improved performance on PyPy, and other environments that need the pure Python trace function. Thanks, Carl Friedrich Bolz-Tereick (pull 1381_ and pull 1388*). Slightly improved performance when using the C trace function, as most environments do. Closes issue 1339*.
The conditions for using tomllib from the standard library have been made more precise, so that 3.11 alphas will continue to work. Closes issue 1390_.

.. _issue 1339: https://github.com/nedbat/coveragepy/issues/1339 .. _pull 1381: https://github.com/nedbat/coveragepy/pull/1381 .. _pull 1388: https://github.com/nedbat/coveragepy/pull/1388 .. _issue 1390: https://github.com/nedbat/coveragepy/issues/1390

.. _changes_64:

`v6.4`

Compare Source

Wheels are now provided for Python 3.11.

.. _changes_6-4-3:

`v6.3.3`

Compare Source

Fix: Coverage.py now builds successfully on CPython 3.11 (3.11.0b1) again. Closes issue 1367_. Some results for generators may have changed.

.. _issue 1367: https://github.com/nedbat/coveragepy/issues/1367

.. _changes_632:

`v6.3.2`

Compare Source

Fix: adapt to pypy3.9's decorator tracing behavior. It now traces function decorators like CPython 3.8: both the @-line and the def-line are traced. Fixes issue 1326_.
Debug: added pybehave to the list of :ref:coverage debug <cmd_debug> and :ref:cmd_run_debug options.
Fix: show an intelligible error message if --concurrency=multiprocessing is used without a configuration file. Closes issue 1320_.

.. _issue 1320: https://github.com/nedbat/coveragepy/issues/1320 .. _issue 1326: https://github.com/nedbat/coveragepy/issues/1326

.. _changes_631:

`v6.3.1`

Compare Source

Fix: deadlocks could occur when terminating processes. Some of these deadlocks (described in issue 1310_) are now fixed.
Fix: a signal handler was being set from multiple threads, causing an error: "ValueError: signal only works in main thread". This is now fixed, closing issue 1312_.
Fix: --precision on the command-line was being ignored while considering --fail-under. This is now fixed, thanks to Marcelo Trylesinski <pull 1317_>_.
Fix: releases no longer provide 3.11.0-alpha wheels. Coverage.py uses CPython internal fields which are moving during the alpha phase. Fixes issue 1316_.

.. _issue 1310: https://github.com/nedbat/coveragepy/issues/1310 .. _issue 1312: https://github.com/nedbat/coveragepy/issues/1312 .. _issue 1316: https://github.com/nedbat/coveragepy/issues/1316 .. _pull 1317: https://github.com/nedbat/coveragepy/pull/1317

.. _changes_63:

`v6.3`

Compare Source

Fix: Coverage.py now builds successfully on CPython 3.11 (3.11.0b1) again. Closes issue 1367_. Some results for generators may have changed.

.. _issue 1367: https://github.com/nedbat/coveragepy/issues/1367

.. _changes_632:

`v6.2`

Compare Source

Feature: Now the --concurrency setting can now have a list of values, so that threads and another lightweight threading package can be measured together, such as --concurrency=gevent,thread. Closes issue 1012_ and issue 1082_.
Fix: A module specified as the source setting is imported during startup, before the user program imports it. This could cause problems if the rest of the program isn't ready yet. For example, issue 1203_ describes a Django setting that is accessed before settings have been configured. Now the early import is wrapped in a try/except so errors then don't stop execution.
Fix: A colon in a decorator expression would cause an exclusion to end too early, preventing the exclusion of the decorated function. This is now fixed.
Fix: The HTML report now will not overwrite a .gitignore file that already exists in the HTML output directory (follow-on for issue 1244_).
API: The exceptions raised by Coverage.py have been specialized, to provide finer-grained catching of exceptions by third-party code.
API: Using suffix=False when constructing a Coverage object with multiprocessing wouldn't suppress the data file suffix (issue 989_). This is now fixed.
Debug: The coverage debug data command will now sniff out combinable data files, and report on all of them.
Debug: The coverage debug command used to accept a number of topics at a time, and show all of them, though this was never documented. This no longer works, to allow for command-line options in the future.

.. _issue 989: https://github.com/nedbat/coveragepy/issues/989 .. _issue 1012: https://github.com/nedbat/coveragepy/issues/1012 .. _issue 1082: https://github.com/nedbat/coveragepy/issues/1082 .. _issue 1203: https://github.com/nedbat/coveragepy/issues/1203

.. _changes_612:

`v6.1.2`

Compare Source

Python 3.11 is supported (tested with 3.11.0a2). One still-open issue has to do with exits through with-statements <issue 1270_>_.
Fix: When remapping file paths through the [paths] setting while combining, the [run] relative_files setting was ignored, resulting in absolute paths for remapped file names (issue 1147_). This is now fixed.
Fix: Complex conditionals over excluded lines could have incorrectly reported a missing branch (issue 1271_). This is now fixed.
Fix: More exceptions are now handled when trying to parse source files for reporting. Problems that used to terminate coverage.py can now be handled with [report] ignore_errors. This helps with plugins failing to read files (django_coverage_plugin issue 78_).
Fix: Removed another vestige of jQuery from the source tarball (issue 840_).
Fix: Added a default value for a new-to-6.x argument of an internal class. This unsupported class is being used by coveralls (issue 1273_). Although I'd rather not "fix" unsupported interfaces, it's actually nicer with a default value.

.. _django_coverage_plugin issue 78: https://github.com/nedbat/django_coverage_plugin/issues/78 .. _issue 1147: https://github.com/nedbat/coveragepy/issues/1147 .. _issue 1270: https://github.com/nedbat/coveragepy/issues/1270 .. _issue 1271: https://github.com/nedbat/coveragepy/issues/1271 .. _issue 1273: https://github.com/nedbat/coveragepy/issues/1273

.. _changes_611:

`v6.1.1`

Compare Source

Fix: The sticky header on the HTML report didn't work unless you had branch coverage enabled. This is now fixed: the sticky header works for everyone. (Do people still use coverage without branch measurement!? j/k)
Fix: When using explicitly declared namespace packages, the "already imported a file that will be measured" warning would be issued (issue 888_). This is now fixed.

.. _issue 888: https://github.com/nedbat/coveragepy/issues/888

.. _changes_61:

`v6.1`

Compare Source

Python 3.11 is supported (tested with 3.11.0a2). One still-open issue has to do with exits through with-statements <issue 1270_>_.
Fix: When remapping file paths through the [paths] setting while combining, the [run] relative_files setting was ignored, resulting in absolute paths for remapped file names (issue 1147_). This is now fixed.
Fix: Complex conditionals over excluded lines could have incorrectly reported a missing branch (issue 1271_). This is now fixed.
Fix: More exceptions are now handled when trying to parse source files for reporting. Problems that used to terminate coverage.py can now be handled with [report] ignore_errors. This helps with plugins failing to read files (django_coverage_plugin issue 78_).
Fix: Removed another vestige of jQuery from the source tarball (issue 840_).
Fix: Added a default value for a new-to-6.x argument of an internal class. This unsupported class is being used by coveralls (issue 1273_). Although I'd rather not "fix" unsupported interfaces, it's actually nicer with a default value.

.. _changes_611:

`v6.0.2`

Compare Source

Namespace packages being measured weren't properly handled by the new code that ignores third-party packages. If the namespace package was installed, it was ignored as a third-party package. That problem (issue 1231_) is now fixed.
Packages named as "source packages" (with source, or source_pkgs, or pytest-cov's --cov) might have been only partially measured. Their top-level statements could be marked as un-executed, because they were imported by coverage.py before measurement began (issue 1232_). This is now fixed, but the package will be imported twice, once by coverage.py, then again by your test suite. This could cause problems if importing the package has side effects.
The :meth:.CoverageData.contexts_by_lineno method was documented to return a dict, but was returning a defaultdict. Now it returns a plain dict. It also no longer returns negative numbered keys.

.. _issue 1231: https://github.com/nedbat/coveragepy/issues/1231 .. _issue 1232: https://github.com/nedbat/coveragepy/issues/1232

.. _changes_601:

`v6.0.1`

Compare Source

In 6.0, the coverage.py exceptions moved from coverage.misc to coverage.exceptions. These exceptions are not part of the public supported API, CoverageException is. But a number of other third-party packages were importing the exceptions from coverage.misc, so they are now available from there again (issue 1226_).
Changed an internal detail of how tomli is imported, so that tomli can use coverage.py for their own test suite (issue 1228_).
Defend against an obscure possibility under code obfuscation, where a function can have an argument called "self", but no local named "self" (pull request 1210_). Thanks, Ben Carlsson.

.. _pull request 1210: https://github.com/nedbat/coveragepy/pull/1210 .. _issue 1226: https://github.com/nedbat/coveragepy/issues/1226 .. _issue 1228: https://github.com/nedbat/coveragepy/issues/1228

.. _changes_60:

`v6.0`

Compare Source

(Note: 6.6.0 final was never released. These changes are part of 7.0.0b1 <changes_7-0-0b1_>_.)

Changes to file pattern matching, which might require updating your configuration:
- Previously, * would incorrectly match directory separators, making precise matching difficult. This is now fixed, closing issue 1407_.
- Now ** matches any number of nested directories, including none.
Improvements to combining data files when using the :ref:config_run_relative_files setting:
- During coverage combine, relative file paths are implicitly combined without needing a [paths] configuration setting. This also fixed issue 991_.
- A [paths] setting like */foo will now match foo/bar.py so that relative file paths can be combined more easily.
- The setting is properly interpreted in more places, fixing issue 1280_.
Fixed environment variable expansion in pyproject.toml files. It was overly broad, causing errors outside of coverage.py settings, as described in issue 1481_ and issue 1345_. This is now fixed, but in rare cases will require changing your pyproject.toml to quote non-string values that use environment substitution.
Fixed internal logic that prevented coverage.py from running on implementations other than CPython or PyPy (issue 1474_).

.. _issue 991: https://github.com/nedbat/coveragepy/issues/991 .. _issue 1280: https://github.com/nedbat/coveragepy/issues/1280 .. _issue 1345: https://github.com/nedbat/coveragepy/issues/1345 .. _issue 1407: https://github.com/nedbat/coveragepy/issues/1407 .. _issue 1474: https://github.com/nedbat/coveragepy/issues/1474 .. _issue 1481: https://github.com/nedbat/coveragepy/issues/1481

.. _changes_6-5-0:

`v5.5`

Compare Source

coverage combine has a new option, --keep to keep the original data files after combining them. The default is still to delete the files after they have been combined. This was requested in issue 1108_ and implemented in pull request 1110_. Thanks, Éric Larivière.
When reporting missing branches in coverage report, branches aren't reported that jump to missing lines. This adds to the long-standing behavior of not reporting branches from missing lines. Now branches are only reported if both the source and destination lines are executed. Closes both issue 1065_ and issue 955_.
Minor improvements to the HTML report:
- The state of the line visibility selector buttons is saved in local storage so you don't have to fiddle with them so often, fixing issue 1123_.
- It has a little more room for line numbers so that 4-digit numbers work well, fixing issue 1124_.
Improved the error message when combining line and branch data, so that users will be more likely to understand what's happening, closing issue 803_.

.. _issue 803: https://github.com/nedbat/coveragepy/issues/803 .. _issue 955: https://github.com/nedbat/coveragepy/issues/955 .. _issue 1065: https://github.com/nedbat/coveragepy/issues/1065 .. _issue 1108: https://github.com/nedbat/coveragepy/issues/1108 .. _pull request 1110: https://github.com/nedbat/coveragepy/pull/1110 .. _issue 1123: https://github.com/nedbat/coveragepy/issues/1123 .. _issue 1124: https://github.com/nedbat/coveragepy/issues/1124

.. _changes_54:

`v5.4`

Compare Source

The text report produced by coverage report now always outputs a TOTAL line, even if only one Python file is reported. This makes regex parsing of the output easier. Thanks, Judson Neer. This had been requested a number of times (issue 1086*, issue 922*, issue 732_).
The skip_covered and skip_empty settings in the configuration file can now be specified in the [html] section, so that text reports and HTML reports can use separate settings. The HTML report will still use the [report] settings if there isn't a value in the [html] section. Closes issue 1090_.
Combining files on Windows across drives now works properly, fixing issue 577*. Thanks, Valentin Lab <pr1080_>*.
Fix an obscure warning from deep in the decimal module, as reported in issue 1084.
Update to support Python 3.10 alphas in progress, including PEP 626: Precise line numbers for debugging and other tools <pep626_>_.

.. _issue 577: https://github.com/nedbat/coveragepy/issues/577 .. _issue 732: https://github.com/nedbat/coveragepy/issues/732 .. _issue 922: https://github.com/nedbat/coveragepy/issues/922 .. _issue 1084: https://github.com/nedbat/coveragepy/issues/1084 .. _issue 1086: https://github.com/nedbat/coveragepy/issues/1086 .. _issue 1090: https://github.com/nedbat/coveragepy/issues/1090 .. _pr1080: https://github.com/nedbat/coveragepy/pull/1080 .. _pep626: https://www.python.org/dev/peps/pep-0626/

.. _changes_531:

`v5.3.1`

Compare Source

When using --source on a large source tree, v5.x was slower than previous versions. This performance regression is now fixed, closing issue 1037_.
Mysterious SQLite errors can happen on PyPy, as reported in issue 1010_. An immediate retry seems to fix the problem, although it is an unsatisfying solution.
The HTML report now saves the sort order in a more widely supported way, fixing issue 986*. Thanks, Sebastián Ramírez (pull request 1066*).
The HTML report pages now have a :ref:Sleepy Snake <sleepy> favicon.
Wheels are now provided for manylinux2010, and for PyPy3 (pp36 and pp37).
Continuous integration has moved from Travis and AppVeyor to GitHub Actions.

.. _issue 986: https://github.com/nedbat/coveragepy/issues/986 .. _issue 1037: https://github.com/nedbat/coveragepy/issues/1037 .. _issue 1010: https://github.com/nedbat/coveragepy/issues/1010 .. _pull request 1066: https://github.com/nedbat/coveragepy/pull/1066

.. _changes_53:

`v5.3`

Compare Source

When using --source on a large source tree, v5.x was slower than previous versions. This performance regression is now fixed, closing issue 1037_.
Mysterious SQLite errors can happen on PyPy, as reported in issue 1010_. An immediate retry seems to fix the problem, although it is an unsatisfying solution.
The HTML report now saves the sort order in a more widely supported way, fixing issue 986*. Thanks, Sebastián Ramírez (pull request 1066*).
The HTML report pages now have a :ref:Sleepy Snake <sleepy> favicon.
Wheels are now provided for manylinux2010, and for PyPy3 (pp36 and pp37).
Continuous integration has moved from Travis and AppVeyor to GitHub Actions.

.. _changes_53:

`v5.2.1`

Compare Source

The dark mode HTML report still used light colors for the context listing, making them unreadable (issue 1009). This is now fixed.
The time stamp on the HTML report now includes the time zone. Thanks, Xie Yanbo (pull request 960).

`v5.2`

Compare Source

The HTML report has been redesigned by Vince Salvino. There is now a dark mode, the code text is larger, and system sans serif fonts are used, in addition to other small changes (issue 858 and pull request 931).
The coverage report and coverage html commands now accept a --precision option to control the number of decimal points displayed. Thanks, Teake Nutma (pull request 982).
The coverage report and coverage html commands now accept a --no-skip-covered option to negate --skip-covered. Thanks, Anthony Sottile (issue 779 and pull request 932).
The --skip-empty option is now available for the XML report, closing issue 976.
The coverage report command now accepts a --sort option to specify how to sort the results. Thanks, Jerin Peter George (pull request 1005).
If coverage fails due to the coverage total not reaching the --fail-under value, it will now print a message making the condition clear. Thanks, Naveen Yadav (pull request 977).
TOML configuration files with non-ASCII characters would cause errors on Windows (issue 990). This is now fixed.
The output of --debug=trace now includes information about how the --source option is being interpreted, and the module names being considered.

`v5.1`

Compare Source

The JSON report now includes counts of covered and missing branches. Thanks, Salvatore Zagaria.
On Python 3.8, try-finally-return reported wrong branch coverage with decorated async functions (issue 964). This is now fixed. Thanks, Kjell Braden.
The get_option() and set_option() methods can now manipulate the [paths] configuration setting. Thanks to Bernát Gábor for the fix for issue 967.

`v5.0.4`

Compare Source

If using the [run] relative_files setting, the XML report will use relative files in the <source> elements indicating the location of source code. Closes issue 948.
The textual summary report could report missing lines with negative line numbers on PyPy3 7.1 (issue 943). This is now fixed.
Windows wheels for Python 3.8 were incorrectly built, but are now fixed. (issue 949)
Updated Python 3.9 support to 3.9a4.
HTML reports couldn’t be sorted if localStorage wasn’t available. This is now fixed: sorting works even though the sorting setting isn’t retained. (issue 944 and pull request 945). Thanks, Abdeali Kothari.

`v5.0.3`

Compare Source

A performance improvement in 5.0.2 didn’t work for test suites that changed directory before combining data, causing “Couldn’t use data file: no such table: meta” errors (issue 916). This is now fixed.
Coverage could fail to run your program with some form of “ModuleNotFound” or “ImportError” trying to import from the current directory. This would happen if coverage had been packaged into a zip file (for example, on Windows), or was found indirectly (for example, by pyenv-virtualenv). A number of different scenarios were described in issue 862 which is now fixed. Huge thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and George-Cristian Bîrzan for protracted debugging sessions.
Added the “premain” debug option.
Added SQLite compile-time options to the “debug sys” output.

`v5.0.2`

Compare Source

Programs that used multiprocessing and changed directories would fail under coverage. This is now fixed (issue 890). A side effect is that debug information about the config files read now shows absolute paths to the files.
When running programs as modules (coverage run -m) with --source, some measured modules were imported before coverage starts. This resulted in unwanted warnings (“Already imported a file that will be measured”) and a reduction in coverage totals (issue 909). This is now fixed.
If no data was collected, an exception about “No data to report” could happen instead of a 0% report being created (issue 884). This is now fixed.
The handling of source files with non-encodable file names has changed. Previously, if a file name could not be encoded as UTF-8, an error occurred, as described in issue 891. Now, those files will not be measured, since their data would not be recordable.
A new warning (“dynamic-conflict”) is issued if two mechanisms are trying to change the dynamic context. Closes issue 901.
coverage run --debug=sys would fail with an AttributeError. This is now fixed (issue 907).

`v5.0.1`

Compare Source

If a 4.x data file is the cause of a “file is not a database” error, then use a more specific error message, “Looks like a coverage 4.x data file, are you mixing versions of coverage?” Helps diagnose the problems described in issue 886.
Measurement contexts and relative file names didn’t work together, as reported in issue 899 and issue 900. This is now fixed, thanks to David Szotten.
When using coverage run --concurrency=multiprocessing, all data files should be named with parallel-ready suffixes. 5.0 mistakenly named the main process’ file with no suffix when using --append. This is now fixed, closing issue 880.
Fixed a problem on Windows when the current directory is changed to a different drive (issue 895). Thanks, Olivier Grisel.
Updated Python 3.9 support to 3.9a2.

`v5.0`

Compare Source

The JSON report now includes details of which branches were taken, and which are missing for each file. Thanks, Christoph Blessing <pull 1438_>*. Closes issue 1425*.
Starting with coverage.py 6.2, class statements were marked as a branch. This wasn't right, and has been reverted, fixing issue 1449_. Note this will very slightly reduce your coverage total if you are measuring branch coverage.
Packaging is now compliant with PEP 517*, closing issue 1395*.
A new debug option --debug=pathmap shows details of the remapping of paths that happens during combine due to the [paths] setting.
Fix an internal problem with caching of invalid Python parsing. Found by OSS-Fuzz, fixing their bug 50381_.

.. _changes_6-4-4:

`v4.5.4`

Compare Source

Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes issue 828.

➡ PyPI page: coverage 4.5.4. ➡ To install: python3 -m pip install coverage==4.5.4

`v4.5.3`

Compare Source

Only packaging metadata changes.

`v4.5.2`

Compare Source

Namespace packages are supported on Python 3.7, where they used to cause TypeErrors about path being None. Fixes issue 700.
Python 3.8 (as of today!) passes all tests. Fixes issue 707 and issue 714.
Development moved from Bitbucket to GitHub.

`v4.5.1`

Compare Source

Now that 4.5 properly separated the [run] omit and [report] omit settings, an old bug has become apparent. If you specified a package name for [run] source, then omit patterns weren’t matched inside that package. This bug (issue 638) is now fixed.
On Python 3.7, reporting about a decorated function with no body other than a docstring would crash coverage.py with an IndexError (issue 640). This is now fixed.
Configurer plugins are now reported in the output of --debug=sys.

`v4.5`

Compare Source

A new kind of plugin is supported: configurers are invoked at start-up to allow more complex configuration than the .coveragerc file can easily do. See Plug-in classes for details. This solves the complex configuration problem described in issue 563.
The fail_under option can now be a float. Note that you must specify the [report] precision configuration option for the fractional part to be used. Thanks to Lars Hupfeldt Nielsen for help with the implementation. Fixes issue 631.
The include and omit options can be specified for both the [run] and [report] phases of execution. 4.4.2 introduced some incorrect interactions between those phases, where the options for one were confused for the other. This is now corrected, fixing issue 621 and issue 622. Thanks to Daniel Hahler for seeing more clearly than I could.
The coverage combine command used to always overwrite the data file, even when no data had been read from apparently combinable files. Now, an error is raised if we thought there were files to combine, but in fact none of them could be used. Fixes issue 629.
The coverage combine command could get confused about path separators when combining data collected on Windows with data collected on Linux, as described in issue 618. This is now fixed: the result path always uses the path separator specified in the [paths] result.
On Windows, the HTML report could fail when source trees are deeply nested, due to attempting to create HTML filenames longer than the 250-character maximum. Now filenames will never get much larger than 200 characters, fixing issue 627. Thanks to Alex Sandro for helping with the fix.

`v4.4.2`

Compare Source

Support for Python 3.7. In some cases, class and module docstrings are no longer counted in statement totals, which could slightly change your total results.
Specifying both --source and --include no longer silently ignores the include setting, instead it displays a warning. Thanks, Loïc Dachary. Closes issue 265 and issue 101.
Fixed a race condition when saving data and multiple threads are tracing (issue 581). It could produce a “dictionary changed size during iteration” RuntimeError. I believe this mostly but not entirely fixes the race condition. A true fix would likely be too expensive. Thanks, Peter Baughman for the debugging, and Olivier Grisel for the fix with tests.
Configuration values which are file paths will now apply tilde-expansion, closing issue 589.
Now secondary config files like tox.ini and setup.cfg can be specified explicitly, and prefixed sections like [coverage:run] will be read. Fixes issue 588.
Be more flexible about the command name displayed by help, fixing issue 600. Thanks, Ben Finney.

`v4.4.1`

Compare Source

No code changes: just corrected packaging for Python 2.7 Linux wheels.

`v4.4`

Compare Source

Wheels are now provided for Python 3.11.

.. _changes_6-4-3:

`v4.3.4`

Compare Source

Fixing 2.6 in version 4.3.3 broke other things, because the too-tricky exception wasn’t properly derived from Exception, described in issue 556. A newb mistake; it hasn’t been a good few days.

`v4.3.3`

Compare Source

Python 2.6 support was broken due to a testing exception imported for the benefit of the coverage.py test suite. Properly conditionalizing it fixed issue 554 so that Python 2.6 works again.

`v4.3.2`

Compare Source

Using the --skip-covered option on an HTML report with 100% coverage would cause a “No data to report” error, as reported in issue 549. This is now fixed; thanks, Loïc Dachary.
If-statements can be optimized away during compilation, for example, if 0: or if __debug__:. Coverage.py had problems properly understanding these statements which existed in the source, but not in the compiled bytecode. This problem, reported in issue 522, is now fixed.
If you specified --source as a directory, then coverage.py would look for importable Python files in that directory, and could identify ones that had never been executed at all. But if you specified it as a package name, that detection wasn’t performed. Now it is, closing issue 426. Thanks to Loïc Dachary for the fix.
If you started and stopped coverage measurement thousands of times in your process, you could crash Python with a “Fatal Python error: deallocating None” error. This is now fixed. Thanks to Alex Groce for the bug report.
On PyPy, measuring coverage in subprocesses could produce a warning: “Trace function changed, measurement is likely wrong: None”. This was spurious, and has been suppressed.
Previously, coverage.py couldn’t start on Jython, due to that implementation missing the multiprocessing module (issue 551). This problem has now been fixed. Also, issue 322 about not being able to invoke coverage conveniently, seems much better: jython -m coverage run myprog.py works properly.
Let’s say you ran the HTML report over and over again in the same output directory, with --skip-covered. And imagine due to your heroic test-writing efforts, a file just achieved the goal of 100% coverage. With coverage.py 4.3, the old HTML file with the less-than-100% coverage would be left behind. This file is now properly deleted.

`v4.3.1`

Compare Source

Some environments couldn’t install 4.3, as described in issue 540. This is now fixed.
The check for conflicting --source and --include was too simple in a few different ways, breaking a few perfectly reasonable use cases, described in issue 541. The check has been reverted while we re-think the fix for issue 265.

`v4.3`

Compare Source

Fix a failure when combining data files if the file names contained glob-like patterns. Thanks, Michael Krebs and Benjamin Schubert <pull 1405_>_.
Fix a messaging failure when combining Windows data files on a different drive than the current directory, closing issue 1428*. Thanks, Lorenzo Micò <pull 1430_>*.
Fix path calculations when running in the root directory, as you might do in a Docker container. Thanks Arthur Rio <pull 1403_>_.
Filtering in the HTML report wouldn't work when reloading the index page. This is now fixed. Thanks, Marc Legendre <pull 1413_>_.
Fix a problem with Cython code measurement, closing issue 972*. Thanks, Matus Valo <pull 1347_>*.

.. _changes_6-4-2:

`v4.2`

Compare Source

Updated for a small change in Python 3.11.0 beta 4: modules now start with a line with line number 0, which is ignored. This line cannot be executed, so coverage totals were thrown off. This line is now ignored by coverage.py, but this also means that truly empty modules (like __init__.py) have no lines in them, rather than one phantom line. Fixes issue 1419_.
Internal debugging data added to sys.modules is now an actual module, to avoid confusing code that examines everything in sys.modules. Thanks, Yilei Yang <pull 1399_>_.

.. _issue 1419: https://github.com/nedbat/coveragepy/issues/1419 .. _pull 1399: https://github.com/nedbat/coveragepy/pull/1399

.. _changes_6-4-1:

`v4.1`

Compare Source

Greatly improved performance on PyPy, and other environments that need the pure Python trace function. Thanks, Carl Friedrich Bolz-Tereick (pull 1381_ and pull 1388*). Slightly improved performance when using the C trace function, as most environments do. Closes issue 1339*.
The conditions for using tomllib from the standard library have been made more precise, so that 3.11 alphas will continue to work. Closes issue 1390_.

.. _changes_64:

`v4.0.3`

Compare Source

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, Arcadiy 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.

`v4.0.2`

Compare Source

More work on supporting unusually encoded source. Fixed issue 431.
Files or directories with non-ASCII characters are now handled properly, fixing issue 432.
Setting a trace function with sys.settrace was broken by a change in 4.0.1, as reported in issue 436. This is now fixed.
Officially support PyPy 4.0, which required no changes, just updates to the docs.

`v4.0.1`

Compare Source

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.

`v4.0`

Compare Source

No changes from 4.0b3

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited Sep 07, 2023 by Victor Engmark

Update dependency coverage to v7

Release Notes

Configuration

Merge request reports