Fix Typing

Author: matthieucan

src/dbt_score/dbt_utils.py

@@ -9,7 +9,7 @@
 # Conditionally import dbt objects.
 try:
     DBT_INSTALLED = True
-    from dbt.cli.main import dbtRunner, dbtRunnerResult  # type: ignore
+    from dbt.cli.main import dbtRunner, dbtRunnerResult
 except ImportError:
     DBT_INSTALLED = False
 

src/dbt_score/rule.py

@@ -14,7 +14,7 @@
     overload,
 )
 
-from dbt_score.models import Evaluable, Exposure, Model, Seed, Snapshot, Source
+from dbt_score.models import Evaluable, Exposure, Macro, Model, Seed, Snapshot, Source
 from dbt_score.more_itertools import first_true
 from dbt_score.rule_filter import RuleFilter
 
@@ -68,12 +68,14 @@ class RuleViolation:
 SnapshotRuleEvaluationType: TypeAlias = Callable[[Snapshot], RuleViolation | None]
 ExposureRuleEvaluationType: TypeAlias = Callable[[Exposure], RuleViolation | None]
 SeedRuleEvaluationType: TypeAlias = Callable[[Seed], RuleViolation | None]
+MacroRuleEvaluationType: TypeAlias = Callable[[Macro], RuleViolation | None]
 RuleEvaluationType: TypeAlias = (
     ModelRuleEvaluationType
     | SourceRuleEvaluationType
     | SnapshotRuleEvaluationType
     | ExposureRuleEvaluationType
     | SeedRuleEvaluationType
+    | MacroRuleEvaluationType
 )
 
 
@@ -223,6 +225,11 @@ def rule(__func: SeedRuleEvaluationType) -> Type[Rule]:
     ...
 
 
+@overload
+def rule(__func: MacroRuleEvaluationType) -> Type[Rule]:
+    ...
+
+
 @overload
 def rule(
     *,

src/dbt_score/rule_filter.py

@@ -4,20 +4,22 @@
 import typing
 from typing import Any, Callable, Type, TypeAlias, cast, overload
 
-from dbt_score.models import Evaluable, Exposure, Model, Seed, Snapshot, Source
+from dbt_score.models import Evaluable, Exposure, Macro, Model, Seed, Snapshot, Source
 from dbt_score.more_itertools import first_true
 
 ModelFilterEvaluationType: TypeAlias = Callable[[Model], bool]
 SourceFilterEvaluationType: TypeAlias = Callable[[Source], bool]
 SnapshotFilterEvaluationType: TypeAlias = Callable[[Snapshot], bool]
 ExposureFilterEvaluationType: TypeAlias = Callable[[Exposure], bool]
 SeedRuleEvaluationType: TypeAlias = Callable[[Seed], bool]
+MacroFilterEvaluationType: TypeAlias = Callable[[Macro], bool]
 FilterEvaluationType: TypeAlias = (
     ModelFilterEvaluationType
     | SourceFilterEvaluationType
     | SnapshotFilterEvaluationType
     | ExposureFilterEvaluationType
     | SeedRuleEvaluationType
+    | MacroFilterEvaluationType
 )
 
 
@@ -101,6 +103,11 @@ def rule_filter(__func: SeedRuleEvaluationType) -> Type[RuleFilter]:
     ...
 
 
+@overload
+def rule_filter(__func: MacroFilterEvaluationType) -> Type[RuleFilter]:
+    ...
+
+
 @overload
 def rule_filter(
     *,

tests/rules_library/test_macro_rules.py

@@ -61,6 +61,7 @@ def test_macro_arguments_have_description():
     )
     violation = rule.evaluate(macro_no_docs)
     assert violation is not None
+    assert violation.message is not None
     assert "arg1" in violation.message
 
 
@@ -94,4 +95,5 @@ def test_macro_name_follows_naming_convention():
     )
     violation = rule.evaluate(macro_camel)
     assert violation is not None
+    assert violation.message is not None
     assert "snake_case" in violation.message