Using omit flag in Python coverage.py API

Question

I'm using the python coverage.py to create a very basic test suite with coverage. Currently everything works great. However, my coverage report includes all the /usr/local/lib libraries that are called and all the __init__.py files.

Here's what my coverage report call looks like right now:

self.cov.html_report(directory='coverage', omit='*Test*, */usr/local/lib*,*__init__*')

The goal is to use the omit flag to remove all classes with the word "Test", "/usr/local/lib", or "__init__" in them. Since I can't find too much on the web about this in the API (There's plenty about how to do it on the command line), does someone know what the correct syntax to make this work would be?

user · Accepted Answer · 2021-11-21 07:18:22Z

23

Try omitting unwanted files in the coverage() call:

self.cov = coverage.coverage(omit=['*Test*', '*/usr/local/lib*','*__init__*'])

I would recommand using the coverage config file (default is .coveragerc):

# .coveragerc to control coverage.py

[run]
omit =
        *__init__*
        */usr/local/lib*
        *Test*

[html]
omit =
        *__init__*
        */usr/local/lib*
        *Test*

The coverage call takes the .coveragerc file into consideration by default, but if you want to make sure use:

self.cov = coverage.coverage(config_file=True)

Alternatively, you can change the config file name and pass it as an argument:

self.cov = coverage.coverage(config_file='/your/path/.coverage_config_file')

edited Nov 21, 2021 at 7:18

user

5,2869 gold badges54 silver badges81 bronze badges

answered Mar 11, 2015 at 22:43

Tgilgul

1,7641 gold badge20 silver badges35 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

martinarroyo Over a year ago

Apparently now the html block only allows options that specifically target the HTML report output. In order to omit certain files in a report, the omit option must be defined in the [report] block. See coverage.readthedocs.io/en/coverage-4.0.3/config.html

Hakaishin Over a year ago

Also apparently the spaces are important, you can't have different omits all starting on the first line

Marcelo Fonseca · Accepted Answer · 2019-03-29 20:51:46Z

create this .coveragerc file

# .coveragerc to control coverage.py
[run]
branch = True
omit =
        *Test*
        */usr/local/lib*
        */__init__.py


[report]
omit =
        *Test*
        */usr/local/lib*
        */__init__.py

# Regexes for lines to exclude from consideration
exclude_lines =
    # Have to re-enable the standard pragma
    pragma: no cover

    # Don't complain about missing debug-only code:
    def __repr__
    if self\.debug

    # Don't complain if tests don't hit defensive assertion code:
    raise AssertionError
    raise NotImplementedError

    # Don't complain if non-runnable code isn't run:
    if 0:
    if __name__ == .__main__.:

ignore_errors = True

[html]


directory = coverage_html_report

Trey Stout · Accepted Answer · 2011-12-06 01:05:39Z

2

From the docs at http://nedbatchelder.com/code/coverage/api.html#api

include and omit are lists of filename patterns. Files that match include will be measured, files that match omit will not. Each will also accept a single string argument.

So try it like...

self.cov.html_report(directory='coverage', omit=['*Test*', '/usr/local/lib*', '__init__*'])

answered Dec 6, 2011 at 1:05

Trey Stout

6,9413 gold badges26 silver badges30 bronze badges

Collectives™ on Stack Overflow

Using omit flag in Python coverage.py API

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related