Treat 'requirements_filename' as a Path, not a str

Author: adamtheturtle

pip_check_reqs/common.py

@@ -159,11 +159,11 @@ def find_required_modules(
         [Union[str, ParsedRequirement]], bool
     ],
     skip_incompatible: bool,
-    requirements_filename: str,
+    requirements_filename: Path,
 ) -> Set[NormalizedName]:
     explicit = set()
     for requirement in parse_requirements(
-        requirements_filename, session=PipSession()
+        str(requirements_filename), session=PipSession()
     ):
         requirement_name = install_req_from_line(
             requirement.requirement,

pip_check_reqs/find_extra_reqs.py

@@ -20,7 +20,7 @@
 
 
 def find_extra_reqs(
-    requirements_filename: str,
+    requirements_filename: Path,
     paths: Iterable[Path],
     ignore_files_function: Callable[[str], bool],
     ignore_modules_function: Callable[[str], bool],
@@ -113,8 +113,9 @@ def main(arguments: Optional[List[str]] = None) -> None:
     parser.add_argument(
         "--requirements-file",
         dest="requirements_filename",
+        type=Path,
         metavar="PATH",
-        default="requirements.txt",
+        default=Path("requirements.txt"),
         help="path to the requirements file "
         '(defaults to "requirements.txt")',
     )

pip_check_reqs/find_missing_reqs.py

@@ -22,7 +22,7 @@
 
 
 def find_missing_reqs(
-    requirements_filename: str,
+    requirements_filename: Path,
     paths: Iterable[Path],
     ignore_files_function: Callable[[str], bool],
     ignore_modules_function: Callable[[str], bool],
@@ -95,7 +95,7 @@ def find_missing_reqs(
     # 4. compare with requirements
     explicit = set()
     for requirement in parse_requirements(
-        requirements_filename,
+        str(requirements_filename),
         session=PipSession(),
     ):
         requirement_name = install_req_from_line(
@@ -118,6 +118,7 @@ def main(arguments: Optional[List[str]] = None) -> None:
         "--requirements-file",
         dest="requirements_filename",
         metavar="PATH",
+        type=Path,
         default="requirements.txt",
         help="path to the requirements file "
         '(defaults to "requirements.txt")',

tests/test_common.py

@@ -204,7 +204,7 @@ def test_find_required_modules(tmp_path: Path) -> None:
     reqs = common.find_required_modules(
         ignore_requirements_function=common.ignorer(ignore_cfg=["barfoo"]),
         skip_incompatible=False,
-        requirements_filename=str(fake_requirements_file),
+        requirements_filename=fake_requirements_file,
     )
     assert reqs == {"foobar"}
 
@@ -218,7 +218,7 @@ def test_find_required_modules_env_markers(tmp_path: Path) -> None:
     reqs = common.find_required_modules(
         ignore_requirements_function=common.ignorer(ignore_cfg=[]),
         skip_incompatible=True,
-        requirements_filename=str(fake_requirements_file),
+        requirements_filename=fake_requirements_file,
     )
     assert reqs == {"ham", "eggs"}
 

tests/test_find_extra_reqs.py

@@ -42,7 +42,7 @@ def test_find_extra_reqs(tmp_path: Path) -> None:
     )
 
     result = find_extra_reqs.find_extra_reqs(
-        requirements_filename=str(fake_requirements_file),
+        requirements_filename=fake_requirements_file,
         paths=[source_dir],
         ignore_files_function=common.ignorer(ignore_cfg=[]),
         ignore_modules_function=common.ignorer(ignore_cfg=[]),

tests/test_find_missing_reqs.py

@@ -43,7 +43,7 @@ def test_find_missing_reqs(tmp_path: Path) -> None:
     )
 
     result = find_missing_reqs.find_missing_reqs(
-        requirements_filename=str(fake_requirements_file),
+        requirements_filename=fake_requirements_file,
         paths=[source_dir],
         ignore_files_function=common.ignorer(ignore_cfg=[]),
         ignore_modules_function=common.ignorer(ignore_cfg=[]),