fix: Properly annotate check_dependencies's selector_method arg (#287)

Author: sdn4z

README.md

@@ -207,10 +207,10 @@ To clear the cache, run:
 ```python
 from twyn import check_dependencies
 
-typos = check_dependencies("all")
+typos = check_dependencies()
 
 for typo in typos.errors:
   print(f"Dependency:{typo.dependency}")
   print(f"Did you mean any of [{','.join(typo.similars)}]")
 
-```
+```

src/twyn/cli.py

@@ -117,10 +117,10 @@ def run(
 
     try:
         possible_typos = check_dependencies(
+            selector_method=selector_method,
             dependencies=set(dependency) or None,
             config_file=config,
             dependency_file=dependency_file,
-            selector_method=selector_method,
             verbosity=verbosity,
             use_cache=not no_cache,
             use_track=False if json else not no_track,

src/twyn/main.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Optional
+from typing import Optional, Union
 
 from rich.progress import track
 
@@ -26,7 +26,7 @@
 
 
 def check_dependencies(
-    selector_method: SelectorMethod,
+    selector_method: Union[SelectorMethod, None] = None,
     config_file: Optional[str] = None,
     dependency_file: Optional[str] = None,
     dependencies: Optional[set[str]] = None,

tests/conftest.py

@@ -8,6 +8,7 @@
 
 @contextmanager
 def create_tmp_file(path: Path, data: str) -> Iterator[str]:
+    path.parent.mkdir(parents=True, exist_ok=True)
     path.write_text(data)
     yield str(path)
 

tests/main/test_main.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+from typing import Any, Union
 from unittest.mock import Mock, patch
 
 import pytest
@@ -93,10 +95,10 @@ class TestCheckDependencies:
     )
     def test_options_priorities_assignation(
         self,
-        cli_config,
-        file_config,
-        expected_resolved_config,
-    ):
+        cli_config: dict[str, Any],
+        file_config: dict[str, Any],
+        expected_resolved_config: TwynConfiguration,
+    ) -> None:
         """
         Checks that the configuration values are picked accordingly to the priority they have.
 
@@ -133,7 +135,12 @@ def test_options_priorities_assignation(
             (AvailableLoggingLevels.none, "debug", AvailableLoggingLevels.debug),
         ],
     )
-    def test_logging_level(self, passed_logging_level, config, logging_level):
+    def test_logging_level(
+        self,
+        passed_logging_level: AvailableLoggingLevels,
+        config: Union[str, None],
+        logging_level: AvailableLoggingLevels,
+    ) -> None:
         log_level = _get_logging_level(
             cli_verbosity=passed_logging_level,
             config_logging_level=config,
@@ -143,8 +150,8 @@ def test_logging_level(self, passed_logging_level, config, logging_level):
     @patch("twyn.main.get_parsed_dependencies_from_file")
     @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache")
     def test_check_dependencies_detects_typosquats(
-        self, mock_get_packages_from_cache, mock_get_parsed_dependencies_from_file
-    ):
+        self, mock_get_packages_from_cache: Mock, mock_get_parsed_dependencies_from_file: Mock
+    ) -> None:
         mock_get_parsed_dependencies_from_file.return_value = {"my-package"}
         mock_get_packages_from_cache.return_value = {"mypackage"}
         error = check_dependencies(
@@ -159,7 +166,9 @@ def test_check_dependencies_detects_typosquats(
         )
 
     @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache")
-    def test_check_dependencies_with_input_from_cli_detects_typosquats(self, mock_get_packages_from_cache):
+    def test_check_dependencies_with_input_from_cli_detects_typosquats(
+        self, mock_get_packages_from_cache: Mock
+    ) -> None:
         mock_get_packages_from_cache.return_value = {"mypackage"}
         error = check_dependencies(
             config_file=None,
@@ -174,10 +183,9 @@ def test_check_dependencies_with_input_from_cli_detects_typosquats(self, mock_ge
 
     @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache")
     def test_check_dependencies_with_input_loads_file_from_different_location(
-        self, mock_get_packages_from_cache, tmp_path, tmpdir
+        self, mock_get_packages_from_cache: Mock, tmp_path: Path
     ) -> None:
         mock_get_packages_from_cache.return_value = {"mypackage"}
-        tmpdir.mkdir("fake-dir")
         tmp_file = tmp_path / "fake-dir" / "requirements.txt"
         with create_tmp_file(tmp_file, "mypackag"):
             error = check_dependencies(
@@ -192,7 +200,9 @@ def test_check_dependencies_with_input_loads_file_from_different_location(
         )
 
     @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache")
-    def test_check_dependencies_with_input_from_cli_accepts_multiple_dependencies(self, mock_get_packages_from_cache):
+    def test_check_dependencies_with_input_from_cli_accepts_multiple_dependencies(
+        self, mock_get_packages_from_cache: Mock
+    ) -> None:
         mock_get_packages_from_cache.return_value = {"requests", "mypackage"}
 
         error = check_dependencies(
@@ -209,8 +219,8 @@ def test_check_dependencies_with_input_from_cli_accepts_multiple_dependencies(se
     @patch("twyn.main.TopPyPiReference")
     @patch("twyn.main.get_parsed_dependencies_from_file")
     def test_check_dependencies_ignores_package_in_allowlist(
-        self, mock_get_parsed_dependencies_from_file, mock_top_pypi_reference
-    ):
+        self, mock_get_parsed_dependencies_from_file: Mock, mock_top_pypi_reference: Mock
+    ) -> None:
         mock_top_pypi_reference.return_value.get_packages.return_value = {"mypackage"}
         mock_get_parsed_dependencies_from_file.return_value = {"my-package"}
 
@@ -255,7 +265,7 @@ def test_check_dependencies_ignores_package_in_allowlist(
         ],
     )
     @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache")
-    def test_normalize_package(self, mock_get_packages_from_cache, package_name):
+    def test_normalize_package(self, mock_get_packages_from_cache: Mock, package_name: Mock) -> None:
         mock_get_packages_from_cache.return_value = {"requests", "mypackage"}
         error = check_dependencies(
             config_file=None,
@@ -274,8 +284,8 @@ def test_normalize_package(self, mock_get_packages_from_cache, package_name):
     @patch("twyn.main.get_parsed_dependencies_from_file")
     @patch("twyn.trusted_packages.references.TopPyPiReference._get_packages_from_cache")
     def test_check_dependencies_does_not_error_on_same_package(
-        self, mock_get_packages_from_cache, mock_get_parsed_dependencies_from_file, package_name
-    ):
+        self, mock_get_packages_from_cache: Mock, mock_get_parsed_dependencies_from_file: Mock, package_name: Mock
+    ) -> None:
         mock_get_parsed_dependencies_from_file.return_value = {package_name}
         mock_get_packages_from_cache.return_value = {"my-package"}
         error = check_dependencies(
@@ -289,7 +299,7 @@ def test_check_dependencies_does_not_error_on_same_package(
 
     @patch("twyn.dependency_parser.dependency_selector.DependencySelector.get_dependency_parser")
     @patch("twyn.dependency_parser.requirements_txt_parser.RequirementsTxtParser.parse")
-    def test_get_parsed_dependencies_from_file(self, mock_parse: Mock, mock_get_dependency_parser: Mock):
+    def test_get_parsed_dependencies_from_file(self, mock_parse: Mock, mock_get_dependency_parser: Mock) -> None:
         mock_get_dependency_parser.return_value = RequirementsTxtParser()
         mock_parse.return_value = {"boto3"}
         assert get_parsed_dependencies_from_file() == {"boto3"}
@@ -302,14 +312,16 @@ def test_track_is_disabled_by_default_when_used_as_package(
         mock_top_pypi_reference.return_value.get_packages.return_value = {"mypackage"}
         mock_get_parsed_dependencies_from_file.return_value = {"my-package"}
         with patch("twyn.main.track") as m_track:
-            check_dependencies("all")
+            check_dependencies()
         assert m_track.call_count == 0
 
     @patch("twyn.main.TopPyPiReference")
     @patch("twyn.main.get_parsed_dependencies_from_file")
-    def test_track_is_shown_when_enabled(self, mock_get_parsed_dependencies_from_file, mock_top_pypi_reference) -> None:
+    def test_track_is_shown_when_enabled(
+        self, mock_get_parsed_dependencies_from_file: Mock, mock_top_pypi_reference: Mock
+    ) -> None:
         mock_top_pypi_reference.return_value.get_packages.return_value = {"mypackage"}
         mock_get_parsed_dependencies_from_file.return_value = {"my-package"}
         with patch("twyn.main.track") as m_track:
-            check_dependencies("all", use_track=True)
+            check_dependencies(use_track=True)
         assert m_track.call_count == 1