coverage.py: exclude files

46
votes

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?

4
pythontestingsoftware-qualitycode-coveragecoverage.py
If nobody else gives you an answer, Ned will probably be around soon to clear things up -- he's a regular around here :) - Mark Rushakoff
I don't know if it's a good thing that I'm so predictable! :) - Ned Batchelder

4 Answers

61
votes

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
14
votes

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

14
votes

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.

1
votes

Create a new file .coveragerc and add the following lines

[run]
branch = True
omit =
    directory/*