{"author":"Marc Schlaich","author_email":"marc.schlaich@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: Pytest","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: Microsoft :: Windows","Operating System :: POSIX","Operating System :: Unix","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Testing","Topic :: Utilities"],"description":"========\nOverview\n========\n\n.. start-badges\n\n.. list-table::\n :stub-columns: 1\n\n * - docs\n - |docs|\n * - tests\n - |github-actions|\n * - package\n - |version| |conda-forge| |wheel| |supported-versions| |supported-implementations| |commits-since|\n.. |docs| image:: https://readthedocs.org/projects/pytest-cov/badge/?style=flat\n :target: https://readthedocs.org/projects/pytest-cov/\n :alt: Documentation Status\n\n.. |github-actions| image:: https://github.com/pytest-dev/pytest-cov/actions/workflows/test.yml/badge.svg\n :alt: GitHub Actions Status\n :target: https://github.com/pytest-dev/pytest-cov/actions\n\n.. |version| image:: https://img.shields.io/pypi/v/pytest-cov.svg\n :alt: PyPI Package latest release\n :target: https://pypi.org/project/pytest-cov\n\n.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytest-cov.svg\n :target: https://anaconda.org/conda-forge/pytest-cov\n.. |wheel| image:: https://img.shields.io/pypi/wheel/pytest-cov.svg\n :alt: PyPI Wheel\n :target: https://pypi.org/project/pytest-cov\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/pytest-cov.svg\n :alt: Supported versions\n :target: https://pypi.org/project/pytest-cov\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/pytest-cov.svg\n :alt: Supported implementations\n :target: https://pypi.org/project/pytest-cov\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/pytest-dev/pytest-cov/v6.1.1.svg\n :alt: Commits since latest release\n :target: https://github.com/pytest-dev/pytest-cov/compare/v6.1.1...master\n\n.. end-badges\n\nThis plugin produces coverage reports. Compared to just using ``coverage run`` this plugin does some extras:\n\n* Subprocess support: you can fork or run stuff in a subprocess and will get covered without any fuss.\n* Xdist support: you can use all of pytest-xdist's features and still get coverage.\n* Consistent pytest behavior. If you run ``coverage run -m pytest`` you will have slightly different ``sys.path`` (CWD will be\n in it, unlike when running ``pytest``).\n\nAll features offered by the coverage package should work, either through pytest-cov's command line options or\nthrough coverage's config file.\n\n* Free software: MIT license\n\nInstallation\n============\n\nInstall with pip::\n\n pip install pytest-cov\n\nFor distributed testing support install pytest-xdist::\n\n pip install pytest-xdist\n\nUpgrading from ancient pytest-cov\n---------------------------------\n\n`pytest-cov 2.0` is using a new ``.pth`` file (``pytest-cov.pth``). You may want to manually remove the older\n``init_cov_core.pth`` from site-packages as it's not automatically removed.\n\nUninstalling\n------------\n\nUninstall with pip::\n\n pip uninstall pytest-cov\n\nUnder certain scenarios a stray ``.pth`` file may be left around in site-packages.\n\n* `pytest-cov 2.0` may leave a ``pytest-cov.pth`` if you installed without wheels\n (``easy_install``, ``setup.py install`` etc).\n* `pytest-cov 1.8 or older` will leave a ``init_cov_core.pth``.\n\nUsage\n=====\n\n::\n\n pytest --cov=myproj tests/\n\nWould produce a report like::\n\n -------------------- coverage: ... ---------------------\n Name Stmts Miss Cover\n ----------------------------------------\n myproj/__init__ 2 0 100%\n myproj/myproj 257 13 94%\n myproj/feature4286 94 7 92%\n ----------------------------------------\n TOTAL 353 20 94%\n\nDocumentation\n=============\n\n https://pytest-cov.readthedocs.io/en/latest/\n\n\n\n\n\n\nCoverage Data File\n==================\n\nThe data file is erased at the beginning of testing to ensure clean data for each test run. If you\nneed to combine the coverage of several test runs you can use the ``--cov-append`` option to append\nthis coverage data to coverage data from previous test runs.\n\nThe data file is left at the end of testing so that it is possible to use normal coverage tools to\nexamine it.\n\nLimitations\n===========\n\nFor distributed testing the workers must have the pytest-cov package installed. This is needed since\nthe plugin must be registered through setuptools for pytest to start the plugin on the\nworker.\n\nFor subprocess measurement environment variables must make it from the main process to the\nsubprocess. The python used by the subprocess must have pytest-cov installed. The subprocess must\ndo normal site initialisation so that the environment variables can be detected and coverage\nstarted. See the `subprocess support docs `_\nfor more details of how this works.\n\nSecurity\n========\n\nTo report a security vulnerability please use the `Tidelift security contact `_.\nTidelift will coordinate the fix and disclosure.\n\nAcknowledgements\n================\n\nWhilst this plugin has been built fresh from the ground up it has been influenced by the work done\non pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and nose-cover (Jason Pellerin) which are\nother coverage plugins.\n\nNed Batchelder for coverage and its ability to combine the coverage results of parallel runs.\n\nHolger Krekel for pytest with its distributed testing support.\n\nJason Pellerin for nose.\n\nMichael Foord for unittest2.\n\nNo doubt others have contributed to these tools as well.\n\n\nChangelog\n=========\n\n6.1.1 (2025-04-05)\n------------------\n\n* Fixed breakage that occurs when ``--cov-context`` and the ``no_cover`` marker are used together.\n\n6.1.0 (2025-04-01)\n------------------\n\n* Change terminal output to use full width lines for the coverage header.\n Contributed by Tsvika Shapira in `#678 `_.\n* Removed unnecessary CovFailUnderWarning. Fixes `#675 `_.\n* Fixed the term report not using the precision specified via ``--cov-precision``.\n\n\n6.0.0 (2024-10-29)\n------------------\n\n* Updated various documentation inaccuracies, especially on subprocess handling.\n* Changed fail under checks to use the precision set in the coverage configuration.\n Now it will perform the check just like ``coverage report`` would.\n* Added a ``--cov-precision`` cli option that can override the value set in your coverage configuration.\n* Dropped support for now EOL Python 3.8.\n\n5.0.0 (2024-03-24)\n------------------\n\n* Removed support for xdist rsync (now deprecated).\n Contributed by Matthias Reichenbach in `#623 `_.\n* Switched docs theme to Furo.\n* Various legacy Python cleanup and CI improvements.\n Contributed by Christian Clauss and Hugo van Kemenade in\n `#630 `_,\n `#631 `_,\n `#632 `_ and\n `#633 `_.\n* Added a ``pyproject.toml`` example in the docs.\n Contributed by Dawn James in `#626 `_.\n* Modernized project's pre-commit hooks to use ruff. Initial POC contributed by\n Christian Clauss in `#584 `_.\n* Dropped support for Python 3.7.\n\n4.1.0 (2023-05-24)\n------------------\n\n* Updated CI with new Pythons and dependencies.\n* Removed rsyncdir support. This makes pytest-cov compatible with xdist 3.0.\n Contributed by Sorin Sbarnea in `#558 `_.\n* Optimized summary generation to not be performed if no reporting is active (for example,\n when ``--cov-report=''`` is used without ``--cov-fail-under``).\n Contributed by Jonathan Stewmon in `#589 `_.\n* Added support for JSON reporting.\n Contributed by Matthew Gamble in `#582 `_.\n* Refactored code to use f-strings.\n Contributed by Mark Mayo in `#572 `_.\n* Fixed a skip in the test suite for some old xdist.\n Contributed by a bunch of people in `#565 `_.\n* Dropped support for Python 3.6.\n\n\n4.0.0 (2022-09-28)\n------------------\n\n**Note that this release drops support for multiprocessing.**\n\n\n* `--cov-fail-under` no longer causes `pytest --collect-only` to fail\n Contributed by Zac Hatfield-Dodds in `#511 `_.\n* Dropped support for multiprocessing (mostly because `issue 82408 `_). This feature was\n mostly working but very broken in certain scenarios and made the test suite very flaky and slow.\n\n There is builtin multiprocessing support in coverage and you can migrate to that. All you need is this in your\n ``.coveragerc``::\n\n [run]\n concurrency = multiprocessing\n parallel = true\n sigterm = true\n* Fixed deprecation in ``setup.py`` by trying to import setuptools before distutils.\n Contributed by Ben Greiner in `#545 `_.\n* Removed undesirable new lines that were displayed while reporting was disabled.\n Contributed by Delgan in `#540 `_.\n* Documentation fixes.\n Contributed by Andre Brisco in `#543 `_\n and Colin O'Dell in `#525 `_.\n* Added support for LCOV output format via `--cov-report=lcov`. Only works with coverage 6.3+.\n Contributed by Christian Fetzer in `#536 `_.\n* Modernized pytest hook implementation.\n Contributed by Bruno Oliveira in `#549 `_\n and Ronny Pfannschmidt in `#550 `_.\n\n\n3.0.0 (2021-10-04)\n-------------------\n\n**Note that this release drops support for Python 2.7 and Python 3.5.**\n\n* Added support for Python 3.10 and updated various test dependencies.\n Contributed by Hugo van Kemenade in\n `#500 `_.\n* Switched from Travis CI to GitHub Actions. Contributed by Hugo van Kemenade in\n `#494 `_ and\n `#495 `_.\n* Add a ``--cov-reset`` CLI option.\n Contributed by Danilo Šegan in\n `#459 `_.\n* Improved validation of ``--cov-fail-under`` CLI option.\n Contributed by ... Ronny Pfannschmidt's desire for skark in\n `#480 `_.\n* Dropped Python 2.7 support.\n Contributed by Thomas Grainger in\n `#488 `_.\n* Updated trove classifiers. Contributed by Michał Bielawski in\n `#481 `_.\n* Reverted change for `toml` requirement.\n Contributed by Thomas Grainger in\n `#477 `_.\n\n2.12.1 (2021-06-01)\n-------------------\n\n* Changed the `toml` requirement to be always be directly required (instead of being required through a coverage extra).\n This fixes issues with pip-compile (`pip-tools#1300 `_).\n Contributed by Sorin Sbarnea in `#472 `_.\n* Documented ``show_contexts``.\n Contributed by Brian Rutledge in `#473 `_.\n\n2.12.0 (2021-05-14)\n-------------------\n\n* Added coverage's `toml` extra to install requirements in setup.py.\n Contributed by Christian Riedel in `#410 `_.\n* Fixed ``pytest_cov.__version__`` to have the right value (string with version instead of a string\n including ``__version__ =``).\n* Fixed license classifier in ``setup.py``.\n Contributed by Chris Sreesangkom in `#467 `_.\n* Fixed *commits since* badge.\n Contributed by Terence Honles in `#470 `_.\n\n2.11.1 (2021-01-20)\n-------------------\n\n* Fixed support for newer setuptools (v42+).\n Contributed by Michał Górny in `#451 `_.\n\n2.11.0 (2021-01-18)\n-------------------\n\n* Bumped minimum coverage requirement to 5.2.1. This prevents reporting issues.\n Contributed by Mateus Berardo de Souza Terra in `#433 `_.\n* Improved sample projects (from the `examples `_\n directory) to support running `tox -e pyXY`. Now the example configures a suffixed coverage data file,\n and that makes the cleanup environment unnecessary.\n Contributed by Ganden Schaffner in `#435 `_.\n* Removed the empty `console_scripts` entrypoint that confused some Gentoo build script.\n I didn't ask why it was so broken cause I didn't want to ruin my day.\n Contributed by Michał Górny in `#434 `_.\n* Fixed the missing `coverage context `_\n when using subprocesses.\n Contributed by Bernát Gábor in `#443 `_.\n* Updated the config section in the docs.\n Contributed by Pamela McA'Nulty in `#429 `_.\n* Migrated CI to travis-ci.com (from .org).\n\n2.10.1 (2020-08-14)\n-------------------\n\n* Support for ``pytest-xdist`` 2.0, which breaks compatibility with ``pytest-xdist`` before 1.22.3 (from 2017).\n Contributed by Zac Hatfield-Dodds in `#412 `_.\n* Fixed the ``LocalPath has no attribute startswith`` failure that occurred when using the ``pytester`` plugin\n in inline mode.\n\n2.10.0 (2020-06-12)\n-------------------\n\n* Improved the ``--no-cov`` warning. Now it's only shown if ``--no-cov`` is present before ``--cov``.\n* Removed legacy pytest support. Changed ``setup.py`` so that ``pytest>=4.6`` is required.\n\n2.9.0 (2020-05-22)\n------------------\n\n* Fixed ``RemovedInPytest4Warning`` when using Pytest 3.10.\n Contributed by Michael Manganiello in `#354 `_.\n* Made pytest startup faster when plugin not active by lazy-importing.\n Contributed by Anders Hovmöller in `#339 `_.\n* Various CI improvements.\n Contributed by Daniel Hahler in `#363 `_ and\n `#364 `_.\n* Various Python support updates (drop EOL 3.4, test against 3.8 final).\n Contributed by Hugo van Kemenade in\n `#336 `_ and\n `#367 `_.\n* Changed ``--cov-append`` to always enable ``data_suffix`` (a coverage setting).\n Contributed by Harm Geerts in\n `#387 `_.\n* Changed ``--cov-append`` to handle loading previous data better\n (fixes various path aliasing issues).\n* Various other testing improvements, github issue templates, example updates.\n* Fixed internal failures that are caused by tests that change the current working directory by\n ensuring a consistent working directory when coverage is called.\n See `#306 `_ and\n `coveragepy#881 `_\n\n2.8.1 (2019-10-05)\n------------------\n\n* Fixed `#348 `_ -\n regression when only certain reports (html or xml) are used then ``--cov-fail-under`` always fails.\n\n2.8.0 (2019-10-04)\n------------------\n\n* Fixed ``RecursionError`` that can occur when using\n `cleanup_on_signal `__ or\n `cleanup_on_sigterm `__.\n See: `#294 `_.\n The 2.7.x releases of pytest-cov should be considered broken regarding aforementioned cleanup API.\n* Added compatibility with future xdist release that deprecates some internals\n (match pytest-xdist master/worker terminology).\n Contributed by Thomas Grainger in `#321 `_\n* Fixed breakage that occurs when multiple reporting options are used.\n Contributed by Thomas Grainger in `#338 `_.\n* Changed internals to use a stub instead of ``os.devnull``.\n Contributed by Thomas Grainger in `#332 `_.\n* Added support for Coverage 5.0.\n Contributed by Ned Batchelder in `#319 `_.\n* Added support for float values in ``--cov-fail-under``.\n Contributed by Martín Gaitán in `#311 `_.\n* Various documentation fixes. Contributed by\n Juanjo Bazán,\n Andrew Murray and\n Albert Tugushev in\n `#298 `_,\n `#299 `_ and\n `#307 `_.\n* Various testing improvements. Contributed by\n Ned Batchelder,\n Daniel Hahler,\n Ionel Cristian Mărieș and\n Hugo van Kemenade in\n `#313 `_,\n `#314 `_,\n `#315 `_,\n `#316 `_,\n `#325 `_,\n `#326 `_,\n `#334 `_ and\n `#335 `_.\n* Added the ``--cov-context`` CLI options that enables coverage contexts. Only works with coverage 5.0+.\n Contributed by Ned Batchelder in `#345 `_.\n\n2.7.1 (2019-05-03)\n------------------\n\n* Fixed source distribution manifest so that garbage ain't included in the tarball.\n\n2.7.0 (2019-05-03)\n------------------\n\n* Fixed ``AttributeError: 'NoneType' object has no attribute 'configure_node'`` error when ``--no-cov`` is used.\n Contributed by Alexander Shadchin in `#263 `_.\n* Various testing and CI improvements. Contributed by Daniel Hahler in\n `#255 `_,\n `#266 `_,\n `#272 `_,\n `#271 `_ and\n `#269 `_.\n* Improved ``pytest_cov.embed.cleanup_on_sigterm`` to be reentrant (signal deliveries while signal handling is\n running won't break stuff).\n* Added ``pytest_cov.embed.cleanup_on_signal`` for customized cleanup.\n* Improved cleanup code and fixed various issues with leftover data files. All contributed in\n `#265 `_ or\n `#262 `_.\n* Improved examples. Now there are two examples for the common project layouts, complete with working coverage\n configuration. The examples have CI testing. Contributed in\n `#267 `_.\n* Improved help text for CLI options.\n\n2.6.1 (2019-01-07)\n------------------\n\n* Added support for Pytest 4.1. Contributed by Daniel Hahler and Семён Марьясин in\n `#253 `_ and\n `#230 `_.\n* Various test and docs fixes. Contributed by Daniel Hahler in\n `#224 `_ and\n `#223 `_.\n* Fixed the \"Module already imported\" issue (`#211 `_).\n Contributed by Daniel Hahler in `#228 `_.\n\n2.6.0 (2018-09-03)\n------------------\n\n* Dropped support for Python 3 < 3.4, Pytest < 3.5 and Coverage < 4.4.\n* Fixed some documentation formatting. Contributed by Jean Jordaan and Julian.\n* Added an example with ``addopts`` in documentation. Contributed by Samuel Giffard in\n `#195 `_.\n* Fixed ``TypeError: 'NoneType' object is not iterable`` in certain xdist configurations. Contributed by Jeremy Bowman in\n `#213 `_.\n* Added a ``no_cover`` marker and fixture. Fixes\n `#78 `_.\n* Fixed broken ``no_cover`` check when running doctests. Contributed by Terence Honles in\n `#200 `_.\n* Fixed various issues with path normalization in reports (when combining coverage data from parallel mode). Fixes\n `#130 `_.\n Contributed by Ryan Hiebert & Ionel Cristian Mărieș in\n `#178 `_.\n* Report generation failures don't raise exceptions anymore. A warning will be logged instead. Fixes\n `#161 `_.\n* Fixed multiprocessing issue on Windows (empty env vars are not passed). Fixes\n `#165 `_.\n\n2.5.1 (2017-05-11)\n------------------\n\n* Fixed xdist breakage (regression in ``2.5.0``).\n Fixes `#157 `_.\n* Allow setting custom ``data_file`` name in ``.coveragerc``.\n Fixes `#145 `_.\n Contributed by Jannis Leidel & Ionel Cristian Mărieș in\n `#156 `_.\n\n2.5.0 (2017-05-09)\n------------------\n\n* Always show a summary when ``--cov-fail-under`` is used. Contributed by Francis Niu in `PR#141\n `_.\n* Added ``--cov-branch`` option. Fixes `#85 `_.\n* Improve exception handling in subprocess setup. Fixes `#144 `_.\n* Fixed handling when ``--cov`` is used multiple times. Fixes `#151 `_.\n\n2.4.0 (2016-10-10)\n------------------\n\n* Added a \"disarm\" option: ``--no-cov``. It will disable coverage measurements. Contributed by Zoltan Kozma in\n `PR#135 `_.\n\n **WARNING: Do not put this in your configuration files, it's meant to be an one-off for situations where you want to\n disable coverage from command line.**\n* Fixed broken exception handling on ``.pth`` file. See `#136 `_.\n\n2.3.1 (2016-08-07)\n------------------\n\n* Fixed regression causing spurious errors when xdist was used. See `#124\n `_.\n* Fixed DeprecationWarning about incorrect `addoption` use. Contributed by Florian Bruhin in `PR#127\n `_.\n* Fixed deprecated use of funcarg fixture API. Contributed by Daniel Hahler in `PR#125\n `_.\n\n2.3.0 (2016-07-05)\n------------------\n\n* Add support for specifying output location for html, xml, and annotate report.\n Contributed by Patrick Lannigan in `PR#113 `_.\n* Fix bug hiding test failure when cov-fail-under failed.\n* For coverage >= 4.0, match the default behaviour of `coverage report` and\n error if coverage fails to find the source instead of just printing a warning.\n Contributed by David Szotten in `PR#116 `_.\n* Fixed bug occurred when bare ``--cov`` parameter was used with xdist.\n Contributed by Michael Elovskikh in `PR#120 `_.\n* Add support for ``skip_covered`` and added ``--cov-report=term-skip-covered`` command\n line options. Contributed by Saurabh Kumar in `PR#115 `_.\n\n2.2.1 (2016-01-30)\n------------------\n\n* Fixed incorrect merging of coverage data when xdist was used and coverage was ``>= 4.0``.\n\n2.2.0 (2015-10-04)\n------------------\n\n* Added support for changing working directory in tests. Previously changing working\n directory would disable coverage measurements in suprocesses.\n* Fixed broken handling for ``--cov-report=annotate``.\n\n2.1.0 (2015-08-23)\n------------------\n\n* Added support for `coverage 4.0b2`.\n* Added the ``--cov-append`` command line options. Contributed by Christian Ledermann\n in `PR#80 `_.\n\n2.0.0 (2015-07-28)\n------------------\n\n* Added ``--cov-fail-under``, akin to the new ``fail_under`` option in `coverage-4.0`\n (automatically activated if there's a ``[report] fail_under = ...`` in ``.coveragerc``).\n* Changed ``--cov-report=term`` to automatically upgrade to ``--cov-report=term-missing``\n if there's ``[run] show_missing = True`` in ``.coveragerc``.\n* Changed ``--cov`` so it can be used with no path argument (in which case the source\n settings from ``.coveragerc`` will be used instead).\n* Fixed `.pth` installation to work in all cases (install, easy_install, wheels, develop etc).\n* Fixed `.pth` uninstallation to work for wheel installs.\n* Support for coverage 4.0.\n* Data file suffixing changed to use coverage's ``data_suffix=True`` option (instead of the\n custom suffixing).\n* Avoid warning about missing coverage data (just like ``coverage.control.process_startup``).\n* Fixed a race condition when running with xdist (all the workers tried to combine the files).\n It's possible that this issue is not present in `pytest-cov 1.8.X`.\n\n1.8.2 (2014-11-06)\n------------------\n\n* N/A\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Author-Email","Classifier","Description","Home-Page","Keywords","License","License-File","Project-Url","Provides-Extra","Requires-Dist","Requires-Python","Summary"],"home_page":"https://github.com/pytest-dev/pytest-cov","keywords":"cover, coverage, pytest, py.test, distributed, parallel","license":"MIT","license_expression":null,"license_files":["LICENSE","AUTHORS.rst"],"maintainer":null,"maintainer_email":null,"name":"pytest-cov","package_url":"https://pypi.org/project/pytest-cov/","platform":null,"project_url":"https://pypi.org/project/pytest-cov/","project_urls":{"Changelog":"https://pytest-cov.readthedocs.io/en/latest/changelog.html","Documentation":"https://pytest-cov.readthedocs.io/","Homepage":"https://github.com/pytest-dev/pytest-cov","Issue Tracker":"https://github.com/pytest-dev/pytest-cov/issues"},"provides_extra":["testing"],"release_url":"https://pypi.org/project/pytest-cov/6.1.1/","requires_dist":["pytest>=4.6","coverage[toml]>=7.5","fields; extra == \"testing\"","hunter; extra == \"testing\"","process-tests; extra == \"testing\"","pytest-xdist; extra == \"testing\"","virtualenv; extra == \"testing\""],"requires_python":">=3.9","summary":"Pytest plugin for measuring coverage.","version":"6.1.1","yanked":false,"yanked_reason":null}

Dependency	Optional
coverage	false
pytest	false
fields	true
hunter	true
process-tests	true
pytest-xdist	true
virtualenv	true

Package search

pytest-cov

project_urls

Dependencies

All package metadata

Releases