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?

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, Oct 13 '09 at 10:51
I don't know if it's a good thing that I'm so predictable! :) — Ned Batchelder, Oct 13 '09 at 11:29

score 74 · Accepted Answer · answered Oct 13 '09 at 11:28

74

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 Oct 13 '09 at 11:28

Ned Batchelder

364,293
75
561
662

In the API, you provide a list of modules you want to report on, so there's not a lot of convenient control there. – Ned Batchelder Oct 13 '09 at 14:19
2

@NedBatchelder This doesn't work for me, see http://pastebin.com/YFg3fbmW . I have `coverage.py, version 3.5.2. http://nedbatchelder.com/code/coverage`. Do you know what I am doing wrong? – Martin Thoma Jul 23 '12 at 20:45
14

@moose I had the same issue. Solved it by using a wildcard. Like so: `coverage report --omit="../../django-tastypie/*"`. Note the `*` at end. – Nandeep Mali Sep 20 '12 at 09:44
What if I want to omit multiple files, can I configure it somewhere like `setup.cfg` – Vaibhav Vishal Apr 24 '19 at 13:47
1

@VaibhavVishal use commas `--omit=dir1/*,dir2/*` – Ganesh Satpute Oct 15 '19 at 12:19

score 33 · Answer 2 · answered Aug 05 '19 at 07:48

33

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 Aug 05 '19 at 07:48

Florian Brucker

9,621
3
48
81

score 15 · Answer 3 · answered Oct 30 '13 at 09:42

15

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 Oct 30 '13 at 09:42

Yogesh K

173
1
6

score 10 · Answer 4 · answered May 17 '21 at 21:16

10

Create a new file .coveragerc and add the following lines

[run]
branch = True
omit =
    directory/*

answered May 17 '21 at 21:16

muTheTechie

1,443
17
25

score 9 · Answer 5 · answered Jul 15 '22 at 08:56

9

With pyproject.toml

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

answered Jul 15 '22 at 08:56

phi

10,572
3
21
30

coverage.py: exclude files

5 Answers5

Linked