Prevent duplicated rule exception when importing rules and filters

Author: npeshkov

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to
 ## [Unreleased]
 
 - Documenting support for python 3.13. (#86)
+- Ignore imported rules and filters when building the rule registry. (#85)
 
 ## [0.8.0] - 2024-11-12
 

src/dbt_score/rule_registry.py

@@ -62,6 +62,9 @@ def _load(self, namespace_name: str) -> None:
             module = importlib.import_module(module_name)
             for obj_name in dir(module):
                 obj = module.__dict__[obj_name]
+                # skip adding objects imported from other modules
+                if type(obj) is type and module.__name__ != obj.__module__:
+                    continue
                 if type(obj) is type and issubclass(obj, Rule) and obj is not Rule:
                     self._add_rule(obj)
                 if (

tests/rules/imported/__init__.py

@@ -0,0 +1 @@
+"""Package for testing discovery of imported rules and filters."""

tests/rules/imported/imported.py

@@ -0,0 +1,6 @@
+"""Imported rules and filters."""
+
+from tests.rules.imported.original import (
+    rule_filter_to_be_imported,  # noqa: F401
+    rule_to_be_imported,  # noqa: F401
+)

tests/rules/imported/original.py

@@ -0,0 +1,14 @@
+"""Rules and filters to be imported."""
+
+
+from dbt_score import Model, RuleViolation, rule, rule_filter
+
+
+@rule
+def rule_to_be_imported(model: Model) -> RuleViolation | None:
+    """An example rule."""
+
+
+@rule_filter
+def rule_filter_to_be_imported(model: Model) -> bool:  # type: ignore[empty-body]
+    """An example filter."""

tests/test_rule_catalog.py

@@ -6,6 +6,9 @@
 def test_rule_catalog_terminal(capsys, default_config):
     """Test rule catalog with the terminal formatter."""
     default_config.overload({"rule_namespaces": ["tests.rules"]})
+    default_config.overload(
+        {"disabled_rules": ["tests.rules.imported.original.rule_to_be_imported"]}
+    )
     display_catalog(default_config, "Doc for tests.rules", "terminal")
     stdout = capsys.readouterr().out
     assert (
@@ -23,6 +26,9 @@ def test_rule_catalog_terminal(capsys, default_config):
 def test_rule_catalog_markdown(capsys, default_config):
     """Test rule catalog with the markdown formatter."""
     default_config.overload({"rule_namespaces": ["tests.rules"]})
+    default_config.overload(
+        {"disabled_rules": ["tests.rules.imported.original.rule_to_be_imported"]}
+    )
     display_catalog(default_config, "Doc for tests.rules", "markdown")
     stdout = capsys.readouterr().out
     assert (

tests/test_rule_registry.py

@@ -13,9 +13,13 @@ def test_rule_registry_discovery(default_config):
     r._load("tests.rules")
     assert sorted(r._rules.keys()) == [
         "tests.rules.example.rule_test_example",
+        "tests.rules.imported.original.rule_to_be_imported",
         "tests.rules.nested.example.rule_test_nested_example",
     ]
-    assert list(r._rule_filters.keys()) == ["tests.rules.example.skip_model1"]
+    assert list(r._rule_filters.keys()) == [
+        "tests.rules.example.skip_model1",
+        "tests.rules.imported.original.rule_filter_to_be_imported",
+    ]
 
 
 def test_disabled_rule_registry_discovery():
@@ -26,6 +30,7 @@ def test_disabled_rule_registry_discovery():
     r._load("tests.rules")
     assert sorted(r._rules.keys()) == [
         "tests.rules.example.rule_test_example",
+        "tests.rules.imported.original.rule_to_be_imported",
     ]