Handle include_external_packages=None

Author: seddonym

src/grimp/application/usecases.py

@@ -7,7 +7,6 @@
 
 import joblib  # type: ignore
 
-from .ports.filesystem import BasicFileSystem
 from ..application.ports import caching
 from ..application.ports.filesystem import AbstractFileSystem
 from ..application.ports.graph import ImportGraph
@@ -60,7 +59,6 @@ def build_graph(
             "mypackage", "anotherpackage", "onemore", include_external_packages=True,
         )
     """
-
     file_system: AbstractFileSystem = settings.FILE_SYSTEM
 
     found_packages = _find_packages(
@@ -265,7 +263,9 @@ def _scan_chunk(
     import_scanner: AbstractImportScanner = settings.IMPORT_SCANNER_CLASS(
         file_system=basic_file_system,
         found_packages=found_packages,
-        include_external_packages=include_external_packages,
+        # Ensure that the passed exclude_type_checking_imports is definitely a boolean,
+        # otherwise the Rust class will error.
+        include_external_packages=bool(include_external_packages),
     )
     return {
         module_file: import_scanner.scan_for_imports(
@@ -283,7 +283,9 @@ def _scan_chunks(
 ) -> Dict[ModuleFile, Set[DirectImport]]:
     number_of_processes = len(chunks)
     import_scanning_jobs = joblib.Parallel(n_jobs=number_of_processes)(
-        joblib.delayed(_scan_chunk)(found_packages, include_external_packages, exclude_type_checking_imports, chunk)
+        joblib.delayed(_scan_chunk)(
+            found_packages, include_external_packages, exclude_type_checking_imports, chunk
+        )
         for chunk in chunks
     )
 

tests/unit/application/test_usecases.py

@@ -208,3 +208,37 @@ class FakeModuleFinder(BaseFakeModuleFinder):
         [call] = mock_scan_chunks.call_args_list
         chunks = call.args[0]
         assert len(chunks) == expected_number_of_chunks
+
+    def test_forgives_wrong_type_being_passed_to_include_external_packages(self):
+        file_system = FakeFileSystem(
+            contents="""
+                /path/to/mypackage/
+                    __init__.py
+                    foo/
+                        __init__.py
+                        one.py
+                """,
+            content_map={
+                "/path/to/mypackage/foo/one.py": (
+                    "import mypackage.foo.two.green\nfrom .. import Something"
+                ),
+            },
+        )
+
+        class FakePackageFinder(BaseFakePackageFinder):
+            directory_map = {"mypackage": "/path/to/mypackage"}
+
+        with override_settings(FILE_SYSTEM=file_system, PACKAGE_FINDER=FakePackageFinder()):
+            graph = usecases.build_graph(
+                "mypackage",
+                # Note: this should be a bool, but we want to tolerate it,
+                # as Import Linter currently has a bug where it will pass it as None.
+                include_external_packages=None,
+            )
+
+        expected_modules = {
+            "mypackage",
+            "mypackage.foo",
+            "mypackage.foo.one",
+        }
+        assert expected_modules == graph.modules