Allow excluding entire modules/packages

[nedbat]

Originally reported by Ram Rachum (Bitbucket: coolrr, GitHub: coolrr)

---

Allow excluding entire modules/packages from coverage measurement by including some identifiable string in their source, similarly to "pragma: no cover".

Here's a suggestion on how to do this, feel free to suggest alternatives: A line "pragma: no module cover" in a module will cause it not to be measured. A "pragma: no package cover" in an __init__.py file will cause the entire package, (including any submodules, subpackages, etc.) not to be measured.

---

• Bitbucket: https://bitbucket.org/ned/coveragepy/issue/118

[nedbat]

Issue #300 was marked as a duplicate of this issue.

[nedbat]

Original comment by René Fleschenberg (Bitbucket: rfleschenberg, GitHub: rfleschenberg)

---

Is there a reason why we cannot just use pragma: no cover at module level to exclude the whole module from coverage?

[nedbat]

I haven't looked into what it would take to implement this. Ram's original proposal included a new pragma for __init__.py to exclude the whole package. That would need to be different than the pragma for a single module, I think.

[nedbat]

As of commit 1fe897d, you can do this with a multi-line exclusion regex:

[report]
exclude_also =
    (?s)\A.*# pragma: exclude file.*\Z

and then put the comment # pragma: exclude file in the file somewhere.

[nedbat]

This is now released as part of coverage 7.6.0.