Fix a bunch of ruff errors

Author: adamtheturtle

pip_check_reqs/common.py

@@ -100,7 +100,7 @@ def _add_module(self, modname: str, lineno: int) -> None:
                 break
 
             # ... though it might not be a file, so not interesting to us
-            if not os.path.isdir(modpath):
+            if not Path(modpath).is_dir():
                 break
 
             path = [modpath]
@@ -144,14 +144,15 @@ def find_imported_modules(
                 log.info("ignoring: %s", os.path.relpath(filename))
                 continue
             log.debug("scanning: %s", os.path.relpath(filename))
-            with open(filename, encoding="utf-8") as file_obj:
-                content = file_obj.read()
+            content = filename.read_text(encoding="utf-8")
+            # with open(filename, encoding="utf-8") as file_obj:
             vis.set_location(str(filename))
             vis.visit(ast.parse(content, str(filename)))
     return vis.finalise()
 
 
 def find_required_modules(
+    *,
     ignore_requirements_function: Callable[
         [str | ParsedRequirement], bool,
     ],
@@ -199,8 +200,9 @@ def has_compatible_markers(full_requirement: str) -> bool:
 
 
 def is_package_file(path: str) -> str:
-    """Determines whether the path points to a Python package sentinel
-    file - the __init__.py or its compiled variants.
+    """Determine whether the path points to a Python package sentinel file.
+
+    A sentinel file is the __init__.py or its compiled variants.
     """
     search_result = re.search(r"(.+)/__init__\.py[co]?$", path)
     if search_result is not None:
@@ -210,7 +212,7 @@ def is_package_file(path: str) -> str:
 
 def ignorer(ignore_cfg: list[str]) -> Callable[..., bool]:
     if not ignore_cfg:
-        return lambda candidate: False
+        return lambda _: False
 
     def ignorer_function(
         candidate: str | ParsedRequirement,

pip_check_reqs/find_extra_reqs.py

@@ -77,7 +77,7 @@ def find_extra_reqs(
         )
         for package_file in package_files:
             path = os.path.realpath(
-                os.path.join(package_location, package_file),
+                Path(package_location) / package_file,
             )
             installed_files[path] = package_name
             package_path = common.is_package_file(path)
@@ -118,7 +118,7 @@ def find_extra_reqs(
 
 
 def main(arguments: list[str] | None = None) -> None:
-    """Main entry point."""
+    """pip-extra-reqs entry point."""
     usage = "usage: %prog [options] files or directories"
     parser = argparse.ArgumentParser(usage)
     parser.add_argument("paths", type=Path, nargs="*")
@@ -191,7 +191,7 @@ def main(arguments: list[str] | None = None) -> None:
     parse_result = parser.parse_args(arguments)
 
     if parse_result.version:
-        print(version_info())
+        sys.stdout.write(version_info() + "\n")
         sys.exit(0)
 
     if not parse_result.paths:

pyproject.toml

@@ -101,9 +101,20 @@ target-version = "py38"
 select = ["ALL"]
 
 ignore = [
+    # We do not annotate the type of 'self', or 'cls'.
+    "ANN101",
+    # We are missing too many docstrings to quickly fix now.
+    "D100",
+    "D103",
+    "D104",
+    "D105",
+    "D203",
+    "D213",
     # Allow 'assert' in tests as it is the standard for pytest.
     # Also, allow 'assert' in other code as it is the standard for Python type hint
     # narrowing - see
     # https://mypy.readthedocs.io/en/stable/type_narrowing.html#type-narrowing-expressions.
     "S101",
 ]
+
+line-length = 79

tests/test_common.py

@@ -3,16 +3,12 @@
 from __future__ import annotations
 
 import ast
-import builtins
 import logging
 import os.path
 import textwrap
-from copy import copy
 from pathlib import Path
-from typing import Any
 
 import pytest
-from pytest import MonkeyPatch
 
 from pip_check_reqs import __version__, common
 
@@ -116,6 +112,7 @@ def test_pyfiles_package(tmp_path: Path) -> None:
     ],
 )
 def test_find_imported_modules(
+    *,
     caplog: pytest.LogCaptureFixture,
     ignore_ham: bool,
     ignore_hashlib: bool,
@@ -188,7 +185,7 @@ def ignore_mods(module: str) -> bool:
     ],
 )
 def test_ignorer(
-    monkeypatch: MonkeyPatch,
+    monkeypatch: pytest.MonkeyPatch,
     ignore_cfg: list[str],
     candidate: str,
     result: bool,
@@ -224,31 +221,5 @@ def test_find_required_modules_env_markers(tmp_path: Path) -> None:
     assert reqs == {"ham", "eggs"}
 
 
-def test_find_imported_modules_sets_encoding_to_utf8_when_reading(
-    monkeypatch: MonkeyPatch,
-    tmp_path: Path,
-) -> None:
-    (tmp_path / "module.py").touch()
-
-    expected_encoding = "utf-8"
-    used_encoding = None
-
-    original_open = copy(builtins.open)
-
-    def mocked_open(*args: Any, **kwargs: Any) -> Any:
-        nonlocal used_encoding
-        used_encoding = kwargs.get("encoding", None)
-        return original_open(*args, **kwargs)
-
-    monkeypatch.setattr(builtins, "open", mocked_open)
-    common.find_imported_modules(
-        paths=[tmp_path],
-        ignore_files_function=common.ignorer(ignore_cfg=[]),
-        ignore_modules_function=common.ignorer(ignore_cfg=[]),
-    )
-
-    assert used_encoding == expected_encoding
-
-
 def test_version_info_shows_version_number() -> None:
     assert __version__ in common.version_info()

tests/test_find_missing_reqs.py

@@ -6,7 +6,6 @@
 import os
 import textwrap
 from pathlib import Path
-from typing import Set
 
 import black
 import pytest
@@ -97,7 +96,7 @@ def test_main_failure(
     assert excinfo.value.code == 1
 
     assert caplog.records[0].message == "Missing requirements:"
-    relative_source_file = os.path.relpath(source_file, os.getcwd())
+    relative_source_file = os.path.relpath(source_file, Path.cwd())
     assert (
         caplog.records[1].message
         == f"{relative_source_file}:1 dist=pytest module=pytest"
@@ -128,7 +127,7 @@ def test_logging_config(
     caplog: pytest.LogCaptureFixture,
     verbose_cfg: bool,
     debug_cfg: bool,
-    expected_log_levels: Set[int],
+    expected_log_levels: set[int],
     tmp_path: Path,
 ) -> None:
     source_dir = tmp_path / "source"