Is it possible exclude test directories from coverage.py reports?

Question

I'm kind of a rookie with python unit testing, and particularly coverage.py. Is it desirable to have coverage reports include the coverage of your actual test files?

Here's a screenshot of my HTML report as an example.

You can see that the report includes tests/test_credit_card. At first I was trying to omit the tests/ directory from the reports, like so:

coverage html --omit=tests/ -d tests/coverage

I tried several variations of that command but I could not for the life of me get the tests/ excluded. After accepting defeat, I began to wonder if maybe the test files are supposed to be included in the report.

Can anyone shed some light on this?

I had a similar problem. I didn't want extra python files (standard lib, etc.) in the coverage report. I ended up stripping them out of the XML: http://stackoverflow.com/questions/2293647/how-do-i-generate-coverage-xml-report-for-a-single-package/2377148#2377148 — Matt Norris, Mar 05 '10 at 04:48

score 108 · Answer 1 · answered Dec 23 '13 at 07:30

108

coverage html --omit="*/test*" -d tests/coverage

answered Dec 23 '13 at 07:30

user3128809

1,099
2
7
3

22

Just to add : Multiple directories/files can be added using comma like `--omit="*/test*,config/*.conf"` – Makesh Jan 22 '19 at 06:55
6

Should be top rated answer. Aint nobody wanna create coverage config files – gabbar0x Jul 23 '20 at 19:53

score 104 · Answer 2 · edited Aug 16 '17 at 19:00

104

Create .coveragerc file in your project root folder, and include the following:

[run]
omit = *tests*

edited Aug 16 '17 at 19:00

Stephen Rauch

47,830
31
106
135

answered Jul 06 '17 at 12:10

Cynthia Simiyu

1,041
1
7
3

1

@CynthiaSimiyu, your answer was really helpful since I needed to omit multiple directories. – lmiguelvargasf Sep 13 '17 at 15:41
4

@lmiguelvargasf : The omit option is **multi-string** so you can enumerate the multiple directories to omit (see example in [doc](https://coverage.readthedocs.io/en/latest/source.html#execution)) – x0s Oct 31 '18 at 14:15
1

Alternately, add an entry to your tox.ini file `[coverage:run] omit = *tests*` which I figured out by reading http://coverage.readthedocs.io/en/latest/config.html – chrisinmtown Jan 14 '22 at 16:43

score 52 · Answer 3 · edited Jun 16 '22 at 15:31

52

Leaving this here in case if any Django developer needs a .coveragerc for their project.

[run]
source = .
omit = ./venv/*,*tests*,*apps.py,*manage.py,*__init__.py,*migrations*,*asgi*,*wsgi*,*admin.py,*urls.py

[report]
omit = ./venv/*,*tests*,*apps.py,*manage.py,*__init__.py,*migrations*,*asgi*,*wsgi*,*admin.py,*urls.py

Create a file named .coveragerc on your projects root directory, paste the above code and then just run the command:

coverage run manage.py test

In addition, if you want the tests to execute faster run this command instead.

coverage run manage.py test --keepdb --parallel

This will preserve the test DB and will run the tests in parallel.

edited Jun 16 '22 at 15:31

Saurabh

5,176
4
32
46

answered Mar 26 '20 at 10:39

Klement Omeri

521
4
4

Use this answer if you are using Django, the omit lines in the `.converagerc` removes all the boilerplates from the coverage – Ramtin Dec 02 '20 at 08:04
When you say "project root", you mean where manage.py is located or even above that? – André Fratelli Dec 09 '20 at 23:46

score 18 · Answer 4 · answered Nov 05 '20 at 20:01

You can specify the directories you want to exclude by creating a .coveragerc in the project root.

It supports wildcards (which you can use to exclude virtual environment) and comments (very useful for effective tracking).

The below code block shows how omit can be used (taken from the latest documentation) with multiple files and directories.

[run]
omit =
    # omit anything in a .local directory anywhere
    */.local/*
    # omit everything in /usr
    /usr/*
    # omit this single file
    utils/tirefire.py

In your case, you could have the following in your .coveragerc:

[run]
omit = 
    # ignore all test cases in tests/
    tests/*

For your question on coverage reports, you can think about testing and coverage in the following manner:

When you run pytest or unittest, all the test cases for your source code are executed
When you run coverage, it shows the part of the source code that isn't being used.
When you run pytest with coverage (something like pytest -v --cov), it runs all test cases and shows the part of the source code that isn't being used.

Extra:

You can also specify the location of your HTML report in the configuration file like:

[html]
directory = tests/coverage/html_report/

This is going to create html, js, css, etc. inside tests/coverage/html_report/ everytime you run coverage or pytest -v --cov

You'll have to specify in omit `**/tests/*` to ignore nested test folders. — dtasev, Oct 14 '21 at 15:40

score 4 · Answer 5 · answered Mar 02 '19 at 02:50

4

You can also explicitly specify which directory has the code you want coverage on instead of saying which things to omit. In a .coveragerc file, if the directory of interest is called demo, this looks like

[run]
source = demo

answered Mar 02 '19 at 02:50

Nathan

9,651
4
45
65

Is it possible exclude test directories from coverage.py reports?

5 Answers5

Linked