coverage.py: exclude files

Question:

How do I exclude entire files from coverage.py reports?

According to the documentation you can exclude code by matching lines. I want to exclude entire files, so that the reports don’t include 3rd party libraries. Am I missing something? Can it be done?

Asked By: flybywire

||
Source

Answers:

You can omit modules with the –omit flag. It takes a comma-separated list of path prefixes. So for example:

coverage run my_program.py
coverage report --omit=path/to/3rdparty
Answered By: Ned Batchelder

Omitting some files worked for me using coverage API.
Well it is the same kind what Ned suggested.

Here it is how I did it:

cov = coverage.coverage(omit='/usr/lib/python2.6/site-packages/*')

Answered By: Yogesh K

In addition to the options in the other answers, you can also configure the ignored files via setup.cfg:

[coverage:run]
omit =
    some/directory/*
    debug_*.py

See the documentation for details.

Answered By: Florian Brucker

Create a new file .coveragerc and add the following lines

[run]
branch = True
omit =
    directory/*
Answered By: muTheTechie

With pyproject.toml

[tool.coverage.run]
omit = [
    "some/directory/*",
    "other/lib.py"
]
Answered By: phi