Skip to content

Latest commit

 

History

History
227 lines (153 loc) · 6.65 KB

index.rst

File metadata and controls

227 lines (153 loc) · 6.65 KB
Raw

Coverage.py

Coverage.py is a tool for measuring code coverage of Python programs. It monitors your program, noting which parts of the code have been executed, then analyzes the source to identify code that could have been executed but was not.

Coverage measurement is typically used to gauge the effectiveness of tests. It can show which parts of your code are being exercised by tests, and which are not.

The latest version is coverage.py , released . It is supported on:

  • Python versions 3.7 through 3.12.0a3.
  • PyPy3 7.3.10.

prerelease

This is a pre-release build. The usual warnings about possible bugs apply. The latest stable version is coverage.py 6.5.0, described here.

For Enterprise

Tidelift

Available as part of the Tidelift Subscription. 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. <Tidelift Subscription_>

Quick start

Getting started is easy:

  1. Install coverage.py:

    $ pip install coverage

    For more details, see install.

  2. Use coverage run to run your test suite and gather data. However you normally run your test suite, you can run your test runner under coverage. If your test runner command starts with "python", just replace the initial "python" with "coverage run".

    Instructions for specific test runners:

    • pytest

      If you usually use:

      $ pytest arg1 arg2 arg3

      then you can run your tests under coverage with:

      $ coverage run -m pytest arg1 arg2 arg3

      Many people choose to use the pytest-cov plugin, but for most purposes, it is unnecessary.

    • unittest

      Change "python" to "coverage run", so this:

      $ python -m unittest discover

      becomes:

      $ coverage run -m unittest discover

    To limit coverage measurement to code in the current directory, and also find files that weren't executed at all, add the --source=. argument to your coverage command line.

  3. Use coverage report to report on the results:

    $ coverage report -m
Name                      Stmts   Miss  Cover   Missing
-------------------------------------------------------
my_program.py                20      4    80%   33-35, 39
my_other_module.py           56      6    89%   17-23
-------------------------------------------------------
TOTAL                        76     10    87%

  4. For a nicer presentation, use coverage html to get annotated HTML listings detailing missed lines:

    $ coverage html

    not prerelease

    Then open htmlcov/index.html in your browser, to see a report like this.

    prerelease

    Then open htmlcov/index.html in your browser, to see a report like this one.

Capabilities

Coverage.py can do a number of things:

  • By default it will measure line (statement) coverage.
  • It can also measure branch coverage <branch>.
  • It can tell you what tests ran which lines <dynamic_contexts>.
  • It can produce reports in a number of formats: text <cmd_report>, HTML <cmd_html>, XML <cmd_xml>, LCOV <cmd_lcov>, and JSON <cmd_json>.
  • For advanced uses, there's an API <api>, and the result data is available in a SQLite database <dbschema>.

Using coverage.py

There are a few different ways to use coverage.py. The simplest is the command line <cmd>, which lets you run your program and see the results. If you need more control over how your project is measured, you can use the API <api>.

Some test runners provide coverage integration to make it easy to use coverage.py while running tests. For example, pytest has the pytest-cov plugin.

You can fine-tune coverage.py's view of your code by directing it to ignore parts that you know aren't interesting. See source and excluding for details.

Getting help

If the FAQ <faq> doesn't answer your question, you can discuss coverage.py or get help using it on the Testing In Python mailing list.

Bug reports are gladly accepted at the GitHub issue tracker. GitHub also hosts the code repository.

Professional support for coverage.py is available as part of the Tidelift Subscription.

I can be reached in a number of ways. I'm happy to answer questions about using coverage.py.

More information

install For enterprise <https://tidelift.com/subscription/pkg/pypi-coverage?utm_source=pypi-coverage&utm_medium=referral&utm_campaign=enterprise> cmd config source excluding branch subprocess contexts api howitworks plugins contributing trouble faq Change history <changes> sleepy