.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt

===========
Coverage.py

Code coverage measurement for Python.

.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg
:target: https://vshymanskyy.github.io/StandWithUkraine
:alt: Stand with Ukraine

Coverage.py measures code coverage, typically during test execution. It uses
the code analysis tools and tracing hooks provided in the Python standard
library to determine which lines are executable, and which have been executed.

Coverage.py runs on these versions of Python:

.. PYVERSIONS

Python 3.9 through 3.14 rc2, including free-threading.
PyPy3 versions 3.9, 3.10, and 3.11.

Documentation is on Read the Docs. Code repository and issue tracker are on
GitHub.

.. _Read the Docs: https://coverage.readthedocs.io/en/7.10.6/
.. _GitHub: https://github.com/nedbat/coveragepy

New in 7.x:
[run] patch setting;
--save-signal option;
[run] core setting;
[run] source_dirs setting;
Coverage.branch_stats();
multi-line exclusion patterns;
function/class reporting;
experimental support for sys.monitoring;
dropped support for Python 3.7 and 3.8;
added Coverage.collect() context manager;
improved data combining;
[run] exclude_also setting;
report --format=;
type annotations.

New in 6.x:
dropped support for Python 2.7, 3.5, and 3.6;
write data on SIGTERM;
added support for 3.10 match/case statements.

For Enterprise

.. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logo_small.png
:alt: Tidelift
:target: https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme

.. list-table::
:widths: 10 100

- |tideliftlogo|
- Available as part of the Tidelift Subscription. <https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme>_
  Coverage and thousands of other packages are working with
  Tidelift to deliver one enterprise subscription that covers all of the open
  source you use. If you want the flexibility of open source and the confidence
  of commercial-grade software, this is for you.
  Learn more. <https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=readme>_

Getting Started

Looking to run coverage on your test suite? See the Quick Start section_
of the docs.

.. _Quick Start section: https://coverage.readthedocs.io/en/7.10.6/#quick-start

Change history

The complete history of changes is on the change history page_.

.. _change history page: https://coverage.readthedocs.io/en/7.10.6/changes.html

Code of Conduct

Everyone participating in the coverage.py project is expected to treat other
people with respect and to follow the guidelines articulated in the Python Community Code of Conduct_.