LogicOverhaul: Default to full_depth in parse_requirements

Signed-off-by: Gabe Goodhart <[email protected]>

import_tracker/setup_tools.py

@@ -22,6 +22,7 @@ def parse_requirements(
     requirements: Union[List[str], str],
     library_name: str,
     extras_modules: Optional[List[str]] = None,
+    full_depth: bool = True,
     **kwargs,
 ) -> Tuple[List[str], Dict[str, List[str]]]:
     """This helper uses the lists of required modules and parameters for the
@@ -36,6 +37,10 @@ def parse_requirements(
         extras_modules:  Optional[List[str]]
             List of module names that should be used to generate extras_require
             sets
+        full_depth:  bool
+            Passthrough to track_module. The default here is switched to True so
+            that modules which are both direct and transitive dependencies of
+            the library are correctly allocated.
         **kwargs:
             Additional keyword arguments to pass through to track_module
 
@@ -68,6 +73,7 @@ def parse_requirements(
         library_name,
         submodules=True,
         detect_transitive=True,
+        full_depth=full_depth,
         **kwargs,
     )
     log.debug4("Library Import Mapping:\n%s", library_import_mapping)

test/sample_libs/full_depth_direct_and_transitive/__init__.py

@@ -0,0 +1,2 @@
+# Local
+from . import bar, foo

test/sample_libs/full_depth_direct_and_transitive/bar.py

@@ -0,0 +1,3 @@
+# Import single_extra to get alog transitively
+# Third Party
+import single_extra

test/sample_libs/full_depth_direct_and_transitive/foo.py

@@ -0,0 +1,3 @@
+# Depend on alog directly
+# First Party
+import alog

test/test_setup_tools.py

@@ -192,3 +192,46 @@ def test_nested_deps():
         "direct_dep_nested.nested": sorted(["PyYaml"]),
         "direct_dep_nested.nested2": sorted(["alchemy-logging"]),
     }
+
+
+def test_full_depth_direct_and_transitive():
+    """Make sure that a library which holds a dependency as both a direct import
+    dependency and also requires it transitively through another third party
+    library correclty allocates the dependency to places where the intermediate
+    third party library is required.
+    """
+    # Run without full_depth and ensure that alog is only allocated to foo and
+    # is not in the base requirements
+    requirements, extras_require = parse_requirements(
+        ["single_extra", "alchemy-logging"],
+        "full_depth_direct_and_transitive",
+        [
+            "full_depth_direct_and_transitive.foo",
+            "full_depth_direct_and_transitive.bar",
+        ],
+        full_depth=False,
+    )
+    assert requirements == []
+    assert extras_require == {
+        "all": sorted(["single_extra", "alchemy-logging"]),
+        "full_depth_direct_and_transitive.foo": ["alchemy-logging"],
+        "full_depth_direct_and_transitive.bar": ["single_extra"],
+    }
+
+    # Run without overriding full_depth (defaults to True) and ensure that alog
+    # is found transitively via single_extra so it ends up in the base
+    # requirements
+    requirements, extras_require = parse_requirements(
+        ["single_extra", "alchemy-logging"],
+        "full_depth_direct_and_transitive",
+        [
+            "full_depth_direct_and_transitive.foo",
+            "full_depth_direct_and_transitive.bar",
+        ],
+    )
+    assert requirements == ["alchemy-logging"]
+    assert extras_require == {
+        "all": sorted(["single_extra", "alchemy-logging"]),
+        "full_depth_direct_and_transitive.foo": [],
+        "full_depth_direct_and_transitive.bar": ["single_extra"],
+    }