CODEWITHSUNDEEP
pythontestingsoftware-qualitycode-coveragecoverage.py
flybywire
flybywire

Reputation: 273502

coverage.py: exclude files

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?

Upvotes: 69

Views: 52757

Answers (5)

phi
phi

Reputation: 11704

With pyproject.toml

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

Upvotes: 18

muTheTechie
muTheTechie

Reputation: 1683

Create a new file .coveragerc and add the following lines

[run]
branch = True
omit =
    directory/*

Upvotes: 12

Florian Brucker
Florian Brucker

Reputation: 10355

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.

Upvotes: 35

Yogesh K
Yogesh K

Reputation: 173

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/*')

Upvotes: 15

Ned Batchelder
Ned Batchelder

Reputation: 375574

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

Upvotes: 77

Related Questions