Exclude a function from coverage

Question

I am using coverage.py to get the test coverage of the code.

Suppose I have two functions with the same name in two different modules

# foo/foo.py

def get_something():
    # fetch something
    # 10 line of branch code
    return "something foo/foo.py"


# bar/foo.py

def get_something():
    # fetch something
    # 20 line of branch code
    return "something bar/foo.py"

How can I exclude the bar.foo.get_something(...) function "completely" ?

you could possible comment it out... this is only if you don't need to run the function aswell — an inconspicuous semicolon, Oct 30 '20 at 15:37
Putting `# pragma: no cover` in all the lines is obviously not a good solution to the problem. — JPG, Oct 30 '20 at 15:39

score 30 · Accepted Answer · edited Jan 25 '23 at 23:59

30

We can use pragma comment on the function definition level which tells the coveragepy to exclude the function completely.

# bar/foo.py

def get_something():  # pragma: no cover
    # fetch something
    # 20 line of branch code
    return "something bar/foo.py"

Note

If we have the coveragepy config file with an exclude_lines setting in it, make sure that pragma: no cover in that setting because it overrides the default.

edited Jan 25 '23 at 23:59

Taylor D. Edmiston

12,088
6
56
76

answered Nov 01 '20 at 04:00

JPG

82,442
19
127
206

Note that this does _not_ work on code blocks in general, e.g. `if` or `with cm:` etc. – Czechnology Dec 16 '22 at 15:06
@Czechnology I don't think so, [see this](https://imgur.com/a/qr7X2Eo) – JPG Dec 16 '22 at 17:08
from the [doc](https://coverage.readthedocs.io/en/latest/excluding.html#advanced-exclusion) *"The regexes only have to match part of a line. Be careful not to over-match. A value of `...` will match any line with more than three characters in it."* – JPG Dec 16 '22 at 17:10

Exclude a function from coverage

1 Answers1

Note

Linked