Add support for omitting entire modules

[br3ndonland]

Description

This PR will enable entire modules to be conditionally omitted from test coverage measurement (#2).

Changes

Modules will be omitted using the coverage.py [run] omit configuration setting.

The syntax for omitting modules will be slightly different from the suggestion by @sobolevn (#2 (comment)) to align more closely with the file pattern syntax used by coverage.py.

[tool.coverage.run]
plugins = ["coverage_conditional_plugin"]

[tool.coverage.coverage_conditional_plugin.omit]
"my_project/omit*.py" = "sys_platform == 'win32'"

Related

• Closes Does this plugin works with module top-level pragmas. #2
• Test Gunicorn Worker encode/uvicorn#1834 (comment)
• coverage.py docs: configuration reference - [run] omit
• coverage.py docs: specifying source files

[sobolevn]

Thank you! This seems very useful!

I have just one nit to apply :)

[br3ndonland]

Thanks for the prompt review @sobolevn!

I'm happy to consider the nit you suggested, but it makes type annotations more complicated, and the for omit in omits.items(): syntax won't work for the filter returned from the INI file format.

It looks like we need to update gitpython to resolve the vulnerability reported by poetry run safety check --full-report. I've pushed that update.

[Kludex]

What's missing here?

[sobolevn]

I can work on it and finish it tomorrow.

[Kludex]

I can work on it and finish it tomorrow.

I didn't mean to give you work, I really wanted to know what was missing hahaha

...but thanks.

[codecov]

Codecov Report

Merging #221 (c8debc2) into master (1c715a8) will decrease coverage by 11.97%.
The diff coverage is 62.50%.

@@             Coverage Diff             @@
##           master     #221       +/-   ##
===========================================
- Coverage   90.90%   78.94%   -11.97%     
===========================================
  Files           1        4        +3     
  Lines          11       19        +8     
===========================================
+ Hits           10       15        +5     
- Misses          1        4        +3     

Impacted Files	Coverage Δ
test_project/compat.py	50.00% <50.00%> (ø)
test_project/omit1.py	50.00% <50.00%> (ø)
test_project/omit2.py	50.00% <50.00%> (ø)
test_project/example.py	92.30% <100.00%> (+1.39%)	⬆️

[sobolevn]

Thank you! Great idea!