Package: pytest-cov
docstestspackageThis plugin produces coverage reports. Compared to just usingcoverage runthis plugin does some extras:Subprocess support: you can fork or run stuff in a subprocess and will get covered without any fuss.Xdist support: you can use all of pytest-xdist’s features and still get coverage.Consistent pytest behavior. If you runcoverage run-mpytestyou will have slightly differentsys.path(CWD will be
in it, unlike when runningpytest).All features offered by the coverage package should work, either through pytest-cov’s command line options or
through coverage’s config file.Free software: MIT licenseInstallationInstall with pip:pip install pytest-covFor distributed testing support install pytest-xdist:pip install pytest-xdistUpgrading from ancient pytest-covpytest-cov 2.0is using a new.pthfile (pytest-cov.pth). You may want to manually remove the olderinit_cov_core.pthfrom site-packages as it’s not automatically removed.UninstallingUninstall with pip:pip uninstall pytest-covUnder certain scenarios a stray.pthfile may be left around in site-packages.pytest-cov 2.0may leave apytest-cov.pthif you installed without wheels
(easy_install,setup.py installetc).pytest-cov 1.8 or olderwill leave ainit_cov_core.pth.Usagepytest --cov=myproj tests/Would produce a report like:-------------------- coverage: ... ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%Documentationhttp://pytest-cov.rtfd.org/Coverage Data FileThe data file is erased at the beginning of testing to ensure clean data for each test run. If you
need to combine the coverage of several test runs you can use the--cov-appendoption to append
this coverage data to coverage data from previous test runs.The data file is left at the end of testing so that it is possible to use normal coverage tools to
examine it.LimitationsFor distributed testing the workers must have the pytest-cov package installed.  This is needed since
the plugin must be registered through setuptools for pytest to start the plugin on the
worker.For subprocess measurement environment variables must make it from the main process to the
subprocess.  The python used by the subprocess must have pytest-cov installed.  The subprocess must
do normal site initialisation so that the environment variables can be detected and coverage
started.AcknowledgementsWhilst this plugin has been built fresh from the ground up it has been influenced by the work done
on pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and nose-cover (Jason Pellerin) which are
other coverage plugins.Ned Batchelder for coverage and its ability to combine the coverage results of parallel runs.Holger Krekel for pytest with its distributed testing support.Jason Pellerin for nose.Michael Foord for unittest2.No doubt others have contributed to these tools as well.Changelog4.1.0 (2023-05-24)Updated CI with new Pythons and dependencies.Removed rsyncdir support. This makes pytest-cov compatible with xdist 3.0.
Contributed by Sorin Sbarnea in#558.Optimized summary generation to not be performed if no reporting is active (for example,
when--cov-report=''is used without--cov-fail-under).
Contributed by Jonathan Stewmon in#589.Added support for JSON reporting.
Contributed by Matthew Gamble in#582.Refactored code to use f-strings.
Contributed by Mark Mayo in#572.Fixed a skip in the test suite for some old xdist.
Contributed by a bunch of people in#565.4.0.0 (2022-09-28)Note that this release drops support for multiprocessing.–cov-fail-underno longer causespytest –collect-onlyto fail
Contributed by Zac Hatfield-Dodds in#511.Dropped support for multiprocessing (mostly becauseissue 82408). This feature was
mostly working but very broken in certain scenarios and made the test suite very flaky and slow.There is builtin multiprocessing support in coverage and you can migrate to that. All you need is this in your.coveragerc:[run]
concurrency = multiprocessing
parallel = true
sigterm = trueFixed deprecation insetup.pyby trying to import setuptools before distutils.
Contributed by Ben Greiner in#545.Removed undesirable new lines that were displayed while reporting was disabled.
Contributed by Delgan in#540.Documentation fixes.
Contributed by Andre Brisco in#543and Colin O’Dell in#525.Added support for LCOV output format via–cov-report=lcov. Only works with coverage 6.3+.
Contributed by Christian Fetzer in#536.Modernized pytest hook implementation.
Contributed by Bruno Oliveira in#549and Ronny Pfannschmidt in#550.3.0.0 (2021-10-04)Note that this release drops support for Python 2.7 and Python 3.5.Added support for Python 3.10 and updated various test dependencies.
Contributed by Hugo van Kemenade in#500.Switched from Travis CI to GitHub Actions. Contributed by Hugo van Kemenade in#494and#495.Add a--cov-resetCLI option.
Contributed by Danilo Šegan in#459.Improved validation of--cov-fail-underCLI option.
Contributed by … Ronny Pfannschmidt’s desire for skark in#480.Dropped Python 2.7 support.
Contributed by Thomas Grainger in#488.Updated trove classifiers. Contributed by Michał Bielawski in#481.Reverted change fortomlrequirement.
Contributed by Thomas Grainger in#477.2.12.1 (2021-06-01)Changed thetomlrequirement to be always be directly required (instead of being required through a coverage extra).
This fixes issues with pip-compile (pip-tools#1300).
Contributed by Sorin Sbarnea in#472.Documentedshow_contexts.
Contributed by Brian Rutledge in#473.2.12.0 (2021-05-14)Added coverage’stomlextra to install requirements in setup.py.
Contributed by Christian Riedel in#410.Fixedpytest_cov.__version__to have the right value (string with version instead of a string
including__version__ =).Fixed license classifier insetup.py.
Contributed by Chris Sreesangkom in#467.Fixedcommits sincebadge.
Contributed by Terence Honles in#470.2.11.1 (2021-01-20)Fixed support for newer setuptools (v42+).
Contributed by Michał Górny in#451.2.11.0 (2021-01-18)Bumped minimum coverage requirement to 5.2.1. This prevents reporting issues.
Contributed by Mateus Berardo de Souza Terra in#433.Improved sample projects (from theexamplesdirectory) to support runningtox -e pyXY. Now the example configures a suffixed coverage data file,
and that makes the cleanup environment unnecessary.
Contributed by Ganden Schaffner in#435.Removed the emptyconsole_scriptsentrypoint that confused some Gentoo build script.
I didn’t ask why it was so broken cause I didn’t want to ruin my day.
Contributed by Michał Górny in#434.Fixed the missingcoverage contextwhen using subprocesses.
Contributed by Bernát Gábor in#443.Updated the config section in the docs.
Contributed by Pamela McA’Nulty in#429.Migrated CI to travis-ci.com (from .org).2.10.1 (2020-08-14)Support forpytest-xdist2.0, which breaks compatibility withpytest-xdistbefore 1.22.3 (from 2017).
Contributed by Zac Hatfield-Dodds in#412.Fixed theLocalPath has no attribute startswithfailure that occurred when using thepytesterplugin
in inline mode.2.10.0 (2020-06-12)Improved the--no-covwarning. Now it’s only shown if--no-covis present before--cov.Removed legacy pytest support. Changedsetup.pyso thatpytest>=4.6is required.2.9.0 (2020-05-22)FixedRemovedInPytest4Warningwhen using Pytest 3.10.
Contributed by Michael Manganiello in#354.Made pytest startup faster when plugin not active by lazy-importing.
Contributed by Anders Hovmöller in#339.Various CI improvements.
Contributed by Daniel Hahler in#363and#364.Various Python support updates (drop EOL 3.4, test against 3.8 final).
Contributed by Hugo van Kemenade in#336and#367.Changed--cov-appendto always enabledata_suffix(a coverage setting).
Contributed by Harm Geerts in#387.Changed--cov-appendto handle loading previous data better
(fixes various path aliasing issues).Various other testing improvements, github issue templates, example updates.Fixed internal failures that are caused by tests that change the current working directory by
ensuring a consistent working directory when coverage is called.
See#306andcoveragepy#8812.8.1 (2019-10-05)Fixed#348-
regression when only certain reports (html or xml) are used then--cov-fail-underalways fails.2.8.0 (2019-10-04)FixedRecursionErrorthat can occur when usingcleanup_on_signalorcleanup_on_sigterm.
See:#294.
The 2.7.x releases of pytest-cov should be considered broken regarding aforementioned cleanup API.Added compatibility with future xdist release that deprecates some internals
(match pytest-xdist master/worker terminology).
Contributed by Thomas Grainger in#321Fixed breakage that occurs when multiple reporting options are used.
Contributed by Thomas Grainger in#338.Changed internals to use a stub instead ofos.devnull.
Contributed by Thomas Grainger in#332.Added support for Coverage 5.0.
Contributed by Ned Batchelder in#319.Added support for float values in--cov-fail-under.
Contributed by Martín Gaitán in#311.Various documentation fixes. Contributed by
Juanjo Bazán,
Andrew Murray and
Albert Tugushev in#298,#299and#307.Various testing improvements. Contributed by
Ned Batchelder,
Daniel Hahler,
Ionel Cristian Mărieș and
Hugo van Kemenade in#313,#314,#315,#316,#325,#326,#334and#335.Added the--cov-contextCLI options that enables coverage contexts. Only works with coverage 5.0+.
Contributed by Ned Batchelder in#345.2.7.1 (2019-05-03)Fixed source distribution manifest so that garbage ain’t included in the tarball.2.7.0 (2019-05-03)FixedAttributeError: 'NoneType' object has no attribute 'configure_node'error when--no-covis used.
Contributed by Alexander Shadchin in#263.Various testing and CI improvements. Contributed by Daniel Hahler in#255,#266,#272,#271and#269.Improvedpytest_cov.embed.cleanup_on_sigtermto be reentrant (signal deliveries while signal handling is
running won’t break stuff).Addedpytest_cov.embed.cleanup_on_signalfor customized cleanup.Improved cleanup code and fixed various issues with leftover data files. All contributed in#265or#262.Improved examples. Now there are two examples for the common project layouts, complete with working coverage
configuration. The examples have CI testing. Contributed in#267.Improved help text for CLI options.2.6.1 (2019-01-07)Added support for Pytest 4.1. Contributed by Daniel Hahler and Семён Марьясин in#253and#230.Various test and docs fixes. Contributed by Daniel Hahler in#224and#223.Fixed the “Module already imported” issue (#211).
Contributed by Daniel Hahler in#228.2.6.0 (2018-09-03)Dropped support for Python 3 < 3.4, Pytest < 3.5 and Coverage < 4.4.Fixed some documentation formatting. Contributed by Jean Jordaan and Julian.Added an example withaddoptsin documentation. Contributed by Samuel Giffard in#195.FixedTypeError: 'NoneType' object is not iterablein certain xdist configurations. Contributed by Jeremy Bowman in#213.Added ano_covermarker and fixture. Fixes#78.Fixed brokenno_covercheck when running doctests. Contributed by Terence Honles in#200.Fixed various issues with path normalization in reports (when combining coverage data from parallel mode). Fixes#130.
Contributed by Ryan Hiebert & Ionel Cristian Mărieș in#178.Report generation failures don’t raise exceptions anymore. A warning will be logged instead. Fixes#161.Fixed multiprocessing issue on Windows (empty env vars are not passed). Fixes#165.2.5.1 (2017-05-11)Fixed xdist breakage (regression in2.5.0).
Fixes#157.Allow setting customdata_filename in.coveragerc.
Fixes#145.
Contributed by Jannis Leidel & Ionel Cristian Mărieș in#156.2.5.0 (2017-05-09)Always show a summary when--cov-fail-underis used. Contributed by Francis Niu inPR#141.Added--cov-branchoption. Fixes#85.Improve exception handling in subprocess setup. Fixes#144.Fixed handling when--covis used multiple times. Fixes#151.2.4.0 (2016-10-10)Added a “disarm” option:--no-cov. It will disable coverage measurements. Contributed by Zoltan Kozma inPR#135.WARNING: Do not put this in your configuration files, it’s meant to be an one-off for situations where you want to
disable coverage from command line.Fixed broken exception handling on.pthfile. See#136.2.3.1 (2016-08-07)Fixed regression causing spurious errors when xdist was used. See#124.Fixed DeprecationWarning about incorrectaddoptionuse. Contributed by Florian Bruhin inPR#127.Fixed deprecated use of funcarg fixture API. Contributed by Daniel Hahler inPR#125.2.3.0 (2016-07-05)Add support for specifying output location for html, xml, and annotate report.
Contributed by Patrick Lannigan inPR#113.Fix bug hiding test failure when cov-fail-under failed.For coverage >= 4.0, match the default behaviour ofcoverage reportand
error if coverage fails to find the source instead of just printing a warning.
Contributed by David Szotten inPR#116.Fixed bug occurred when bare--covparameter was used with xdist.
Contributed by Michael Elovskikh inPR#120.Add support forskip_coveredand added--cov-report=term-skip-coveredcommand
line options. Contributed by Saurabh Kumar inPR#115.2.2.1 (2016-01-30)Fixed incorrect merging of coverage data when xdist was used and coverage was>= 4.0.2.2.0 (2015-10-04)Added support for changing working directory in tests. Previously changing working
directory would disable coverage measurements in suprocesses.Fixed broken handling for--cov-report=annotate.2.1.0 (2015-08-23)Added support forcoverage 4.0b2.Added the--cov-appendcommand line options. Contributed by Christian Ledermann
inPR#80.2.0.0 (2015-07-28)Added--cov-fail-under, akin to the newfail_underoption incoverage-4.0(automatically activated if there’s a[report] fail_under = ...in.coveragerc).Changed--cov-report=termto automatically upgrade to--cov-report=term-missingif there’s[run] show_missing = Truein.coveragerc.Changed--covso it can be used with no path argument (in which case the source
settings from.coveragercwill be used instead).Fixed.pthinstallation to work in all cases (install, easy_install, wheels, develop etc).Fixed.pthuninstallation to work for wheel installs.Support for coverage 4.0.Data file suffixing changed to use coverage’sdata_suffix=Trueoption (instead of the
custom suffixing).Avoid warning about missing coverage data (just likecoverage.control.process_startup).Fixed a race condition when running with xdist (all the workers tried to combine the files).
It’s possible that this issue is not present inpytest-cov 1.8.X.1.8.2 (2014-11-06)N/A