Merge pull request #15 from routablehq/DEV-9930-add-a-flake-8-rule-fo…

…r-not-allowing-imports-from-models-subpackages

[DEV-9930] Add a Flake8 rule for not allowing imports from models subpackages

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# idea files
+.idea

.pre-commit-config.yaml

@@ -37,7 +37,7 @@ repos:
         language_version: python3.8
 
 
-  - repo: https://gitlab.com/pycqa/flake8
+  - repo: https://github.com/pycqa/flake8
     rev: 4.0.1
     hooks:
       - id: flake8

flake8_routable.py

@@ -31,6 +31,7 @@
 ROU105 = "ROU105 Constants are not in order"
 ROU106 = "ROU106 Relative imports are not allowed"
 ROU107 = "ROU107 Inline function import is not at top of statement"
+ROU108 = "ROU108 Import from model module instead of sub-packages"
 
 
 @dataclass
@@ -153,6 +154,9 @@ def visit_ImportFrom(self, node: ast.ImportFrom) -> None:
         if node.level > 0:
             self.errors.append((node.lineno, node.col_offset, ROU106))
 
+        if node.module is not None and ".models." in node.module:
+            self.errors.append((node.lineno, node.col_offset, ROU108))
+
     def visit_Set(self, node: ast.Set) -> None:
         if not self._is_ordered(node.elts):
             self.errors.append((node.lineno, node.col_offset, ROU103))

tests/test_flake8_routable.py

@@ -488,6 +488,24 @@ def test_upper_imports(self, upper_import):
         assert error == set()
 
 
+class TestROU108:
+    def test_non_model_subpackage_import(self):
+        error = results("from app.constants.subpackage import ModelA, ModelB")
+        assert error == set()
+
+    def test_non_model_named_like_a_model_subpackage_import(self):
+        error = results("from app.like_a_model.subpackage import ModelA, ModelB")
+        assert error == set()
+
+    def test_model_subpackage_import(self):
+        error = results("from app.models.subpackage import ModelA, ModelB")
+        assert error == {"1:0: ROU108 Import from model module instead of sub-packages"}
+
+    def test_model_module_import(self):
+        error = results("from app.models import Model")
+        assert error == set()
+
+
 class TestVisitor:
     def test_parse_to_string_warning(self):
         visitor = Visitor()