feat: add ability to pass multiple source directories

deptry/cli.py

@@ -104,7 +104,7 @@ def display_deptry_version(ctx: click.Context, _param: click.Parameter, value: b
 
 
 @click.command()
-@click.argument("root", type=click.Path(exists=True, path_type=Path))
+@click.argument("root", type=click.Path(exists=True, path_type=Path), nargs=-1, required=True)
 @click.option(
     "--verbose",
     "-v",
@@ -268,7 +268,7 @@ def display_deptry_version(ctx: click.Context, _param: click.Parameter, value: b
     show_default=False,
 )
 def deptry(
-    root: Path,
+    root: tuple[Path, ...],
     config: Path,
     no_ansi: bool,
     ignore_obsolete: tuple[str, ...],
@@ -290,8 +290,15 @@ def deptry(
 ) -> None:
     """Find dependency issues in your Python project.
 
-    [ROOT] is the path to the root directory of the project to be scanned.
-    All other arguments should be specified relative to [ROOT].
+    ROOT is the path to the root directory of the project to be scanned. For instance, to invoke deptry in the current
+    directory:
+
+        deptry .
+
+    If your project has multiple source directories, multiple ROOT can be specified.  For instance, to invoke deptry in
+    both 'src' and 'worker' directories:
+
+        deptry src worker
 
     """
 

deptry/core.py

@@ -33,7 +33,7 @@
 
 @dataclass
 class Core:
-    root: Path
+    root: tuple[Path, ...]
     config: Path
     no_ansi: bool
     ignore_obsolete: tuple[str, ...]
@@ -148,13 +148,15 @@ def _get_dependencies(self, dependency_management_format: DependencyManagementFo
 
     def _get_local_modules(self) -> set[str]:
         """
-        Get all local Python modules from the root directory and `known_first_party` list.
+        Get all local Python modules from the source directories and `known_first_party` list.
         A module is considered a local Python module if it matches at least one of those conditions:
         - it is a directory that contains at least one Python file
         - it is a Python file that is not named `__init__.py` (since it is a special case)
         - it is set in the `known_first_party` list
         """
-        guessed_local_modules = {path.stem for path in self.root.iterdir() if self._is_local_module(path)}
+        guessed_local_modules = {
+            path.stem for source in self.root for path in source.iterdir() if self._is_local_module(path)
+        }
 
         return guessed_local_modules | set(self.known_first_party)
 

deptry/python_file_finder.py

@@ -26,31 +26,34 @@ class PythonFileFinder:
     using_default_exclude: bool
     ignore_notebooks: bool = False
 
-    def get_all_python_files_in(self, directory: Path) -> list[Path]:
+    def get_all_python_files_in(self, directories: tuple[Path, ...]) -> list[Path]:
         logging.debug("Collecting Python files to scan...")
 
-        source_files = []
+        source_files = set()
 
         ignore_regex = re.compile("|".join(self.exclude + self.extend_exclude))
         file_lookup_suffixes = {".py"} if self.ignore_notebooks else {".py", ".ipynb"}
 
         gitignore_spec = self._generate_gitignore_pathspec(Path("."))
 
-        for root_str, dirs, files in os.walk(directory, topdown=True):
-            root = Path(root_str)
+        for directory in directories:
+            for root_str, dirs, files in os.walk(directory, topdown=True):
+                root = Path(root_str)
 
-            if self._is_directory_ignored(root, ignore_regex):
-                dirs[:] = []
-                continue
+                if self._is_directory_ignored(root, ignore_regex):
+                    dirs[:] = []
+                    continue
 
-            for file_str in files:
-                file = root / file_str
-                if not self._is_file_ignored(file, file_lookup_suffixes, ignore_regex, gitignore_spec):
-                    source_files.append(file)
+                for file_str in files:
+                    file = root / file_str
+                    if not self._is_file_ignored(file, file_lookup_suffixes, ignore_regex, gitignore_spec):
+                        source_files.add(file)
 
-        logging.debug("Python files to scan for imports:\n%s\n", "\n".join([str(file) for file in source_files]))
+        source_files_list = list(source_files)
 
-        return source_files
+        logging.debug("Python files to scan for imports:\n%s\n", "\n".join([str(file) for file in source_files_list]))
+
+        return source_files_list
 
     def _is_directory_ignored(self, directory: Path, ignore_regex: Pattern[str]) -> bool:
         return bool((self.exclude + self.extend_exclude) and ignore_regex.match(str(directory)))

docs/usage.md

@@ -8,7 +8,13 @@ _deptry_ can be run with:
 deptry .
 ```
 
-where `.` is the path to the root directory of the project to be scanned. All other arguments should be specified relative to this directory.
+where `.` is the path to the root directory of the project to be scanned.
+
+If your project has multiple source directories, multiple root directories can be provided:
+
+```shell
+deptry a_directory another_directory
+```
 
 If you want to configure _deptry_ using `pyproject.toml`, or if your dependencies are stored in `pyproject.toml`, but it is located in another location than the one _deptry_ is run from, you can specify the location to it by using `--config <path_to_pyproject.toml>` argument.
 

tests/data/project_with_multiple_source_directories/another_directory/foo.py

@@ -0,0 +1,2 @@
+import a_non_existing_dependency
+import toml

tests/data/project_with_multiple_source_directories/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+# PEP 621 project metadata
+# See https://www.python.org/dev/peps/pep-0621/
+name = "foo"
+version = "1.2.3"
+requires-python = ">=3.7"
+dependencies = ["toml"]
+
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.deptry]
+ignore_obsolete = ["pkginfo"]

tests/data/project_with_multiple_source_directories/src/foo.py

@@ -0,0 +1,3 @@
+import httpx
+
+from foobar import a_local_method

tests/data/project_with_multiple_source_directories/src/foobar.py

@@ -0,0 +1,2 @@
+def a_local_method():
+    ...

tests/data/project_with_multiple_source_directories/worker/foo.py

@@ -0,0 +1,3 @@
+import celery
+
+from foobaz import a_local_method

tests/data/project_with_multiple_source_directories/worker/foobaz.py

@@ -0,0 +1,2 @@
+def a_local_method():
+    ...

tests/functional/cli/test_cli_multiple_source_directories.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click.testing import CliRunner
+
+from deptry.cli import deptry
+from tests.utils import get_issues_report, run_within_dir
+
+if TYPE_CHECKING:
+    from tests.functional.types import ToolSpecificProjectBuilder
+
+
+def test_cli_with_multiple_source_directories(pip_project_builder: ToolSpecificProjectBuilder) -> None:
+    with run_within_dir(pip_project_builder("project_with_multiple_source_directories")):
+        result = CliRunner().invoke(deptry, "src worker -o report.json")
+
+        assert result.exit_code == 1
+        assert get_issues_report() == [
+            {
+                "error": {"code": "DEP002", "message": "'toml' defined as a dependency but not used in the codebase"},
+                "module": "toml",
+                "location": {"file": str(Path("pyproject.toml")), "line": None, "column": None},
+            },
+            {
+                "error": {"code": "DEP001", "message": "'httpx' imported but missing from the dependency definitions"},
+                "module": "httpx",
+                "location": {"file": str(Path("src/foo.py")), "line": 1, "column": 0},
+            },
+            {
+                "error": {"code": "DEP001", "message": "'celery' imported but missing from the dependency definitions"},
+                "module": "celery",
+                "location": {"file": str(Path("worker/foo.py")), "line": 1, "column": 0},
+            },
+        ]

tests/unit/test_core.py

@@ -79,7 +79,7 @@ def test__get_local_modules(
 
         assert (
             Core(
-                root=tmp_path / root_suffix,
+                root=(tmp_path / root_suffix,),
                 config=Path("pyproject.toml"),
                 no_ansi=False,
                 ignore_obsolete=(),

tests/unit/test_python_file_finder.py

@@ -24,7 +24,7 @@ def test_simple(tmp_path: Path) -> None:
 
         files = PythonFileFinder(
             exclude=(".venv",), extend_exclude=("other_dir",), using_default_exclude=False
-        ).get_all_python_files_in(Path("."))
+        ).get_all_python_files_in((Path("."),))
 
         assert sorted(files) == [
             Path("dir/subdir/file1.py"),
@@ -50,7 +50,7 @@ def test_only_matches_start(tmp_path: Path) -> None:
 
         files = PythonFileFinder(
             exclude=("subdir",), extend_exclude=(), using_default_exclude=False
-        ).get_all_python_files_in(Path("."))
+        ).get_all_python_files_in((Path("."),))
 
         assert sorted(files) == [
             Path("dir/subdir/file1.py"),
@@ -78,7 +78,7 @@ def test_matches_ipynb(ignore_notebooks: bool, expected: list[Path], tmp_path: P
 
         files = PythonFileFinder(
             exclude=(), extend_exclude=(), using_default_exclude=False, ignore_notebooks=ignore_notebooks
-        ).get_all_python_files_in(Path("."))
+        ).get_all_python_files_in((Path("."),))
 
         assert sorted(files) == expected
 
@@ -128,11 +128,65 @@ def test_regex_argument(exclude: tuple[str], expected: list[Path], tmp_path: Pat
 
         files = PythonFileFinder(
             exclude=exclude, extend_exclude=(), using_default_exclude=False
-        ).get_all_python_files_in(Path("."))
+        ).get_all_python_files_in((Path("."),))
 
         assert sorted(files) == expected
 
 
+@pytest.mark.parametrize(
+    ("exclude", "expected"),
+    [
+        (
+            (".*file1",),
+            [
+                Path("dir/subdir/file2.py"),
+                Path("dir/subdir/file3.py"),
+                Path("other_dir/subdir/file2.py"),
+            ],
+        ),
+        (
+            (".*file1|.*file2",),
+            [
+                Path("dir/subdir/file3.py"),
+            ],
+        ),
+        (
+            (".*/subdir/",),
+            [],
+        ),
+    ],
+)
+def test_multiple_source_directories(exclude: tuple[str], expected: list[Path], tmp_path: Path) -> None:
+    with run_within_dir(tmp_path):
+        create_files(
+            [
+                Path("dir/subdir/file1.py"),
+                Path("dir/subdir/file2.py"),
+                Path("dir/subdir/file3.py"),
+                Path("other_dir/subdir/file1.py"),
+                Path("other_dir/subdir/file2.py"),
+                Path("another_dir/subdir/file1.py"),
+            ]
+        )
+
+        files = PythonFileFinder(
+            exclude=exclude, extend_exclude=(), using_default_exclude=False
+        ).get_all_python_files_in((Path("dir"), Path("other_dir")))
+
+        assert sorted(files) == expected
+
+
+def test_duplicates_are_removed(tmp_path: Path) -> None:
+    with run_within_dir(tmp_path):
+        create_files([Path("dir/subdir/file1.py")])
+
+        files = PythonFileFinder(exclude=(), extend_exclude=(), using_default_exclude=False).get_all_python_files_in(
+            (Path("."), Path("."))
+        )
+
+        assert sorted(files) == [Path("dir/subdir/file1.py")]
+
+
 def test__generate_gitignore_pathspec_with_non_default_exclude(tmp_path: Path) -> None:
     gitignore_pathspec = PythonFileFinder(
         exclude=(), extend_exclude=(), using_default_exclude=False