Merge pull request #121 from r1chardj0n3s/pathlib

Switch a few `str` representations of paths to `pathlib.Path`

Author: adamtheturtle

pip_check_reqs/common.py

@@ -124,20 +124,19 @@ def finalise(self) -> Dict[str, FoundModule]:
         return result
 
 
-def pyfiles(root: str) -> Generator[str, None, None]:
-    root_path = Path(root)
-    if root_path.is_file():
-        if root_path.suffix == ".py":
-            yield str(root_path.absolute())
+def pyfiles(root: Path) -> Generator[str, None, None]:
+    if root.is_file():
+        if root.suffix == ".py":
+            yield str(root.absolute())
         else:
-            raise ValueError(f"{root_path} is not a python file or directory")
-    elif root_path.is_dir():
-        for item in root_path.rglob("*.py"):
+            raise ValueError(f"{root} is not a python file or directory")
+    elif root.is_dir():
+        for item in root.rglob("*.py"):
             yield str(item.absolute())
 
 
 def find_imported_modules(
-    paths: Iterable[str],
+    paths: Iterable[Path],
     ignore_files_function: Callable[[str], bool],
     ignore_modules_function: Callable[[str], bool],
 ) -> Dict[str, FoundModule]:
@@ -160,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

@@ -5,8 +5,8 @@
 import importlib.metadata
 import logging
 import os
-import pathlib
 import sys
+from pathlib import Path
 from typing import Callable, Iterable, List, Optional, Union
 
 from packaging.utils import canonicalize_name
@@ -20,8 +20,8 @@
 
 
 def find_extra_reqs(
-    requirements_filename: str,
-    paths: Iterable[str],
+    requirements_filename: Path,
+    paths: Iterable[Path],
     ignore_files_function: Callable[[str], bool],
     ignore_modules_function: Callable[[str], bool],
     ignore_requirements_function: Callable[
@@ -48,8 +48,8 @@ def find_extra_reqs(
         package_location = package.location
         package_files = []
         for item in package.files or []:
-            here = pathlib.Path(".").resolve()
-            item_location_rel = pathlib.Path(package_location) / item
+            here = Path(".").resolve()
+            item_location_rel = Path(package_location) / item
             item_location = item_location_rel.resolve()
             try:
                 relative_item_location = item_location.relative_to(here)
@@ -109,12 +109,13 @@ def main(arguments: Optional[List[str]] = None) -> None:
     """Main entry point."""
     usage = "usage: %prog [options] files or directories"
     parser = argparse.ArgumentParser(usage)
-    parser.add_argument("paths", nargs="*")
+    parser.add_argument("paths", type=Path, nargs="*")
     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

@@ -5,8 +5,8 @@
 import importlib.metadata
 import logging
 import os
-import pathlib
 import sys
+from pathlib import Path
 from typing import Callable, Iterable, List, Optional, Tuple
 
 from packaging.utils import NormalizedName, canonicalize_name
@@ -22,8 +22,8 @@
 
 
 def find_missing_reqs(
-    requirements_filename: str,
-    paths: Iterable[str],
+    requirements_filename: Path,
+    paths: Iterable[Path],
     ignore_files_function: Callable[[str], bool],
     ignore_modules_function: Callable[[str], bool],
 ) -> List[Tuple[NormalizedName, List[FoundModule]]]:
@@ -46,8 +46,8 @@ def find_missing_reqs(
         package_location = package.location
         package_files = []
         for item in package.files or []:
-            here = pathlib.Path(".").resolve()
-            item_location_rel = pathlib.Path(package_location) / item
+            here = Path(".").resolve()
+            item_location_rel = Path(package_location) / item
             item_location = item_location_rel.resolve()
             try:
                 relative_item_location = item_location.relative_to(here)
@@ -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(
@@ -113,11 +113,12 @@ def find_missing_reqs(
 def main(arguments: Optional[List[str]] = None) -> None:
     usage = "usage: %prog [options] files or directories"
     parser = argparse.ArgumentParser(usage)
-    parser.add_argument("paths", nargs="*")
+    parser.add_argument("paths", type=Path, nargs="*")
     parser.add_argument(
         "--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

@@ -36,7 +36,7 @@ def test_is_package_file(path: str, result: str) -> None:
 def test_found_module() -> None:
     found_module = common.FoundModule("spam", "ham")
     assert found_module.modname == "spam"
-    assert found_module.filename == os.path.realpath("ham")
+    assert found_module.filename == str(Path("ham").resolve())
     assert found_module.locations == []
 
 
@@ -66,15 +66,15 @@ def test_import_visitor(stmt: str, result: List[str]) -> None:
 def test_pyfiles_file(tmp_path: Path) -> None:
     python_file = tmp_path / "example.py"
     python_file.touch()
-    assert list(common.pyfiles(root=str(python_file))) == [str(python_file)]
+    assert list(common.pyfiles(root=python_file)) == [str(python_file)]
 
 
 def test_pyfiles_file_no_dice(tmp_path: Path) -> None:
     not_python_file = tmp_path / "example"
     not_python_file.touch()
 
     with pytest.raises(ValueError):
-        list(common.pyfiles(root=str(not_python_file)))
+        list(common.pyfiles(root=not_python_file))
 
 
 def test_pyfiles_package(tmp_path: Path) -> None:
@@ -88,7 +88,7 @@ def test_pyfiles_package(tmp_path: Path) -> None:
 
     not_python_file.touch()
 
-    assert list(common.pyfiles(root=str(tmp_path))) == [
+    assert list(common.pyfiles(root=tmp_path)) == [
         str(python_file),
         str(nested_python_file),
     ]
@@ -156,7 +156,7 @@ def ignore_mods(module: str) -> bool:
         return False
 
     result = common.find_imported_modules(
-        paths=[str(root)],
+        paths=[root],
         ignore_files_function=ignore_files,
         ignore_modules_function=ignore_mods,
     )
@@ -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"}
 
@@ -241,7 +241,7 @@ def mocked_open(*args: Any, **kwargs: Any) -> Any:
 
     monkeypatch.setattr(builtins, "open", mocked_open)
     common.find_imported_modules(
-        paths=[str(tmp_path)],
+        paths=[tmp_path],
         ignore_files_function=common.ignorer(ignore_cfg=[]),
         ignore_modules_function=common.ignorer(ignore_cfg=[]),
     )

tests/test_find_extra_reqs.py

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

tests/test_find_missing_reqs.py

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