Update fawltydeps/check.py

Co-authored-by: Vince <[email protected]>

Author: mknorps

fawltydeps/check.py

@@ -3,7 +3,7 @@
 import logging
 import sys
 from itertools import groupby
-from typing import Iterable, List, Mapping, Optional, Tuple
+from typing import Iterable, List, Optional, Tuple
 
 from fawltydeps.types import (
     DeclaredDependency,
@@ -58,7 +58,12 @@ def lookup_package(self, package: str) -> Optional[Tuple[str, ...]]:
 def dependency_to_imports_mapping(
     dependency: DeclaredDependency, local_package_lookup: LocalPackageLookup
 ) -> DeclaredDependency:
-    """Map imports names exposed by a dependency."""
+    """For a single `DeclaredDependency` map the dependency name
+
+    to imports names exposed by a dependency.
+    Create a new `DeclaredDependency` object and with updated
+    names of imports and mapping type used.
+    """
     import_names = local_package_lookup.lookup_package(dependency.name)
     return (
         dependency.replace_mapping(

tests/test_compare_imports_to_dependencies.py

@@ -6,13 +6,15 @@
 
 from fawltydeps.check import compare_imports_to_dependencies
 from fawltydeps.types import (
+    DeclaredDependency,
+    DependenciesMapping,
     Location,
     ParsedImport,
     UndeclaredDependency,
     UnusedDependency,
 )
 
-from .utils import deps_factory, deps_factory_dep_to_imports_mapping
+from .utils import deps_factory
 
 
 def imports_factory(*imports: str) -> List[ParsedImport]:
@@ -146,10 +148,15 @@ def unused_factory(*deps: str) -> List[UnusedDependency]:
                 [
                     UnusedDependency(
                         name="isort",
-                        references=deps_factory_dep_to_imports_mapping(
-                            ("isort", ["isort"])
-                        ),
-                    )
+                        references=[
+                            DeclaredDependency(
+                                name="isort",
+                                source=Location(Path("foo")),
+                                import_names=("isort",),
+                                mapping=DependenciesMapping.DEPENDENCY_TO_IMPORT,
+                            )
+                        ],
+                    ),
                 ],
             ),
             id="one_ignored_import_declared_as_dep__reported_as_unused",

tests/utils.py

@@ -1,7 +1,7 @@
 """ Utilities to share among test modules """
 
 from pathlib import Path
-from typing import Any, Iterable, List, Tuple
+from typing import Any, Iterable, List
 
 from fawltydeps.types import DeclaredDependency, DependenciesMapping, Location
 
@@ -24,18 +24,3 @@ def deps_factory(*deps: str) -> List[DeclaredDependency]:
         )
         for dep in deps
     ]
-
-
-def deps_factory_dep_to_imports_mapping(
-    *deps: Tuple[str, Tuple[str, ...]]
-) -> List[DeclaredDependency]:
-    """Factory for dependencies that have non-trivial list of exposed modules"""
-    return [
-        DeclaredDependency(
-            name=dep,
-            source=Location(Path("foo")),
-            import_names=imports,
-            mapping=DependenciesMapping.DEPENDENCY_TO_IMPORT,
-        )
-        for dep, imports in deps
-    ]