chore: Ignore TYPE_CHECKING in coverage by default (#3891)

Flagsmith · May 8, 2024 · b975831 · b975831
1 parent 79f4ef7
commit b975831
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 5 deletions.
diff --git a/api/integrations/launch_darkly/models.py b/api/integrations/launch_darkly/models.py
@@ -7,7 +7,7 @@
 from audit.related_object_type import RelatedObjectType
 from projects.models import Project
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from users.models import FFAdminUser
 
 

diff --git a/api/pyproject.toml b/api/pyproject.toml
@@ -24,6 +24,13 @@ exclude = '''
 )/
 '''
 
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_also = [
+  'if TYPE_CHECKING:',
+  '@(abc\\.)?abstractmethod',
+]
+
 [tool.isort]
 use_parentheses = true
 multi_line_output = 3

diff --git a/api/tests/unit/util/mappers/test_unit_mappers_dynamodb.py b/api/tests/unit/util/mappers/test_unit_mappers_dynamodb.py
@@ -8,7 +8,7 @@
 from util.mappers import dynamodb
 from util.mappers.engine import map_feature_state_to_engine
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from pytest_mock import MockerFixture
 
     from environments.identities.models import Identity

diff --git a/api/tests/unit/util/mappers/test_unit_mappers_engine.py b/api/tests/unit/util/mappers/test_unit_mappers_engine.py
@@ -40,7 +40,7 @@
 from segments.models import Segment, SegmentRule
 from util.mappers import engine
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from environments.identities import Identity, Trait
     from environments.models import EnvironmentAPIKey
     from features.models import Feature

diff --git a/api/util/mappers/dynamodb.py b/api/util/mappers/dynamodb.py
@@ -22,7 +22,7 @@
     map_identity_to_engine,
 )
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from flag_engine.identities.models import IdentityModel
 
     from environments.identities.models import Identity

diff --git a/api/util/mappers/engine.py b/api/util/mappers/engine.py
@@ -24,7 +24,7 @@
     SegmentRuleModel,
 )
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from environments.identities.models import Identity, Trait
     from environments.models import Environment, EnvironmentAPIKey
     from features.models import Feature, FeatureSegment, FeatureState