Add support for omitting entire modules

README.md

@@ -38,6 +38,9 @@ plugins =
   coverage_conditional_plugin
 
 [coverage:coverage_conditional_plugin]
+# Here we specify files to conditionally omit:
+omit =
+  "sys_platform == 'win32'": "my_project/omit*.py"
 # Here we specify our pragma rules:
 rules =
   "sys_version_info >= (3, 8)": py-gte-38
@@ -51,6 +54,10 @@ Or to your `pyproject.toml`:
 # Here we specify plugins for coverage to be used:
 plugins = ["coverage_conditional_plugin"]
 
+[tool.coverage.coverage_conditional_plugin.omit]
+# Here we specify files to conditionally omit:
+"my_project/omit*.py" = "sys_platform == 'win32'"
+
 [tool.coverage.coverage_conditional_plugin.rules]
 # Here we specify our pragma rules:
 py-gte-38 = "sys_version_info >= (3, 8)"
@@ -128,6 +135,27 @@ get_env_info()
 ```
 
 
+## Writing omits
+
+Omits allow entire files to be conditionally omitted from coverage measurement.
+
+The INI format for omits is:
+
+```ini
+"pragma-condition": "file-name-pattern"
+```
+
+The TOML format for omits is:
+
+```toml
+[tool.coverage.coverage_conditional_plugin.omit]
+"file-name-pattern" = "pragma-condition"
+```
+
+File name patterns should follow coverage.py's `[run] omit` syntax.
+See [coverage.py](https://coverage.readthedocs.io/en/stable/source.html).
+
+
 ## License
 
 [MIT](https://github.com/wemake.services/coverage-conditional-plugin/blob/master/LICENSE)

coverage_conditional_plugin/__init__.py

@@ -2,7 +2,7 @@
 import sys
 import traceback
 from importlib import import_module
-from typing import ClassVar, Dict, Iterable, Tuple, Union
+from typing import ClassVar, Dict, Tuple, Union
 
 from coverage import CoveragePlugin
 from coverage.config import CoverageConfig
@@ -30,6 +30,8 @@ def get_env_info() -> Dict[str, object]:
 class _ConditionalCovPlugin(CoveragePlugin):
     _rules_opt_name: ClassVar[str] = 'coverage_conditional_plugin:rules'
     _ignore_opt_name: ClassVar[str] = 'report:exclude_lines'
+    _omit_opt_name_plugin: ClassVar[str] = 'coverage_conditional_plugin:omit'
+    _omit_opt_name_coverage: ClassVar[str] = 'run:omit'
 
     def configure(self, config: CoverageConfig) -> None:
         """
@@ -38,8 +40,23 @@ def configure(self, config: CoverageConfig) -> None:
         Part of the ``coverage`` public API.
         Called right after ``coverage_init`` function.
         """
-        rules: Iterable[str]
+        self._configure_omits(config)
+        self._configure_rules(config)
 
+    def _configure_omits(self, config: CoverageConfig) -> None:
+        try:  # ini format
+            omits = filter(
+                bool,
+                config.get_option(self._omit_opt_name_plugin).splitlines(),
+            )
+        except AttributeError:  # toml format
+            omits_dict = config.get_option(self._omit_opt_name_plugin)
+            omits = omits_dict.items() if omits_dict else ()
+
+        for omit in omits:
+            self._process_omit(config, omit)
+
+    def _configure_rules(self, config: CoverageConfig) -> None:
         try:  # ini format
             rules = filter(
                 bool,
@@ -51,6 +68,21 @@ def configure(self, config: CoverageConfig) -> None:
         for rule in rules:
             self._process_rule(config, rule)
 
+    def _process_omit(
+        self, config: CoverageConfig, omit: Union[str, Tuple[str, str]],
+    ) -> None:
+        if isinstance(omit, str):
+            code, pattern = [part.strip() for part in omit.rsplit(':', 1)]
+            code = code[1:-1]  # removes quotes
+            pattern = pattern[1:-1]
+        elif isinstance(omit, tuple):
+            pattern = omit[0]
+            code = omit[1]
+        else:
+            raise ValueError("Invalid type for 'omit'.")
+        if self._should_be_applied(code):
+            self._omit_pattern(config, pattern)
+
     def _process_rule(
         self, config: CoverageConfig, rule: Union[str, Tuple[str, str]],
     ) -> None:
@@ -108,6 +140,12 @@ def _ignore_marker(self, config: CoverageConfig, marker: str) -> None:
         exclude_lines.append(marker)
         config.set_option(self._ignore_opt_name, exclude_lines)
 
+    def _omit_pattern(self, config: CoverageConfig, pattern: str) -> None:
+        """Adds a file name pattern to the omit list."""
+        omit_patterns = config.get_option(self._omit_opt_name_coverage)
+        omit_patterns.append(pattern)
+        config.set_option(self._omit_opt_name_coverage, omit_patterns)
+
 
 def _is_installed(package: str) -> bool:
     """Helper function to detect if some package is installed."""

setup.cfg

@@ -18,6 +18,7 @@ docstring-style = numpy
 # Plugins:
 max-complexity = 6
 max-line-length = 80
+max-methods = 8
 
 # wemake-python-styleguide settings:
 i-control-code = false

test_project/.coveragerc

@@ -4,6 +4,8 @@ plugins =
   coverage_conditional_plugin
 
 [coverage_conditional_plugin]
+omit =
+  "sys_version_info >= (3, 6)": "test_project/omit*.py"
 rules =
   "sys_version_info >= (3, 6)": py-gte-36
   "sys_version_info >= (3, 7)": py-gte-37

test_project/omit1.py

@@ -0,0 +1,3 @@
+def uncovered() -> str:
+    """Test function that is uncovered."""
+    return 'uncovered'

test_project/omit2.py

@@ -0,0 +1,3 @@
+def uncovered() -> str:
+    """Test function that is uncovered."""
+    return 'uncovered'

test_project/pyproject.toml

@@ -1,6 +1,9 @@
 [tool.coverage.run]
 plugins = ["coverage_conditional_plugin"]
 
+[tool.coverage.coverage_conditional_plugin.omit]
+"test_project/omit*.py" = "sys_version_info >= (3, 6)"
+
 [tool.coverage.coverage_conditional_plugin.rules]
 py-gte-36 = "sys_version_info >= (3, 6)"
 py-gte-37 = "sys_version_info >= (3, 7)"