treewide: replace flake8 with ruff (#444)

* treewide: replace flake8 with ruff

Signed-off-by: William Woodruff <[email protected]>

* treewide: add `ruff --fix` to `make reformat`, apply fixes

Signed-off-by: William Woodruff <[email protected]>

Signed-off-by: William Woodruff <[email protected]>

CONTRIBUTING.md

@@ -45,7 +45,7 @@ make lint
 
 * [`black`](https://github.com/psf/black): Code formatting
 * [`isort`](https://github.com/PyCQA/isort): Import sorting, ordering
-* [`flake8`](https://flake8.pycqa.org/en/latest/): PEP-8 linting, style enforcement
+* [`ruff`](https://github.com/charliermarsh/ruff): PEP-8 linting, style enforcement
 * [`mypy`](https://mypy.readthedocs.io/en/stable/): Static type checking
 * [`interrogate`](https://interrogate.readthedocs.io/en/latest/): Documentation coverage
 

Makefile

@@ -43,13 +43,14 @@ lint: env/pyvenv.cfg
 	. env/bin/activate && \
 		black --check $(ALL_PY_SRCS) && \
 		isort --check $(ALL_PY_SRCS) && \
-		flake8 $(ALL_PY_SRCS) && \
+		ruff $(ALL_PY_SRCS) && \
 		mypy $(PY_MODULE) && \
 		interrogate -c pyproject.toml .
 
 .PHONY: reformat
 reformat:
 	. env/bin/activate && \
+		ruff --fix $(ALL_PY_SRCS) && \
 		black $(ALL_PY_SRCS) && \
 		isort $(ALL_PY_SRCS)
 

pip_audit/_audit.py

@@ -5,7 +5,7 @@
 
 import logging
 from dataclasses import dataclass
-from typing import Iterator, Tuple
+from typing import Iterator
 
 from pip_audit._dependency_source import DependencySource
 from pip_audit._service import Dependency, VulnerabilityResult, VulnerabilityService
@@ -47,7 +47,7 @@ def __init__(
 
     def audit(
         self, source: DependencySource
-    ) -> Iterator[Tuple[Dependency, list[VulnerabilityResult]]]:
+    ) -> Iterator[tuple[Dependency, list[VulnerabilityResult]]]:
         """
         Perform the auditing step, collecting dependencies from `source`.
 

pip_audit/_cli.py

@@ -11,7 +11,7 @@
 import sys
 from contextlib import ExitStack, contextmanager
 from pathlib import Path
-from typing import IO, Iterator, NoReturn, Type, cast
+from typing import IO, Iterator, NoReturn, cast
 
 from pip_audit import __version__
 from pip_audit._audit import AuditOptions, Auditor
@@ -147,7 +147,7 @@ def __str__(self) -> str:
         return self.value
 
 
-def _enum_help(msg: str, e: Type[enum.Enum]) -> str:  # pragma: no cover
+def _enum_help(msg: str, e: type[enum.Enum]) -> str:  # pragma: no cover
     """
     Render a `--help`-style string for the given enumeration.
     """

pip_audit/_dependency_source/interface.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from typing import Iterator, Tuple
+from typing import Iterator
 
 from packaging.requirements import Requirement
 
@@ -77,7 +77,7 @@ def resolve(self, req: Requirement) -> list[Dependency]:  # pragma: no cover
 
     def resolve_all(
         self, reqs: Iterator[Requirement]
-    ) -> Iterator[Tuple[Requirement, list[Dependency]]]:
+    ) -> Iterator[tuple[Requirement, list[Dependency]]]:
         """
         Resolve a collection of `Requirement`s into their respective `Dependency` sets.
 

pip_audit/_dependency_source/requirement.py

@@ -11,7 +11,7 @@
 from contextlib import ExitStack
 from pathlib import Path
 from tempfile import NamedTemporaryFile
-from typing import IO, Iterator, Tuple, cast
+from typing import IO, Iterator, cast
 
 from packaging.requirements import Requirement
 from packaging.specifiers import SpecifierSet
@@ -241,7 +241,7 @@ def _collect_preresolved_deps(
         self,
         reqs: Iterator[InstallRequirement],
         require_hashes: bool = False,
-    ) -> Iterator[Tuple[Requirement, Dependency]]:
+    ) -> Iterator[tuple[Requirement, Dependency]]:
         """
         Collect pre-resolved (pinned) dependencies, optionally enforcing a
         hash requirement policy.
@@ -292,7 +292,7 @@ def _build_hash_options_mapping(self, hash_options: list[str]) -> dict[str, list
 
     def _collect_cached_deps(
         self, filename: Path, reqs: list[InstallRequirement]
-    ) -> Iterator[Tuple[Requirement, Dependency]]:
+    ) -> Iterator[tuple[Requirement, Dependency]]:
         """
         Collect resolved dependencies for a given requirements file, retrieving them from the
         dependency cache if possible.

pip_audit/_format/columns.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 from itertools import zip_longest
-from typing import Any, Iterable, Tuple, cast
+from typing import Any, Iterable, cast
 
 from packaging.version import Version
 
@@ -15,7 +15,7 @@
 from .interface import VulnerabilityFormat
 
 
-def tabulate(rows: Iterable[Iterable[Any]]) -> Tuple[list[str], list[int]]:
+def tabulate(rows: Iterable[Iterable[Any]]) -> tuple[list[str], list[int]]:
     """Return a list of formatted rows and a list of column sizes.
     For example::
     >>> tabulate([['foobar', 2000], [0xdeadbeef]])

pip_audit/_service/osv.py

@@ -6,7 +6,7 @@
 import json
 import logging
 from pathlib import Path
-from typing import Any, Tuple, cast
+from typing import Any, cast
 
 import requests
 from packaging.version import Version
@@ -43,7 +43,7 @@ def __init__(self, cache_dir: Path | None = None, timeout: int | None = None):
         self.session = caching_session(cache_dir, use_pip=False)
         self.timeout = timeout
 
-    def query(self, spec: Dependency) -> Tuple[Dependency, list[VulnerabilityResult]]:
+    def query(self, spec: Dependency) -> tuple[Dependency, list[VulnerabilityResult]]:
         """
         Queries OSV for the given `Dependency` specification.
 

pip_audit/_service/pypi.py

@@ -6,7 +6,7 @@
 
 import logging
 from pathlib import Path
-from typing import Tuple, cast
+from typing import cast
 
 import requests
 from packaging.version import InvalidVersion, Version
@@ -45,7 +45,7 @@ def __init__(self, cache_dir: Path | None = None, timeout: int | None = None) ->
         self.session = caching_session(cache_dir)
         self.timeout = timeout
 
-    def query(self, spec: Dependency) -> Tuple[Dependency, list[VulnerabilityResult]]:
+    def query(self, spec: Dependency) -> tuple[Dependency, list[VulnerabilityResult]]:
         """
         Queries PyPI for the given `Dependency` specification.
 

pip_audit/_virtual_env.py

@@ -8,7 +8,7 @@
 import logging
 import venv
 from types import SimpleNamespace
-from typing import Iterator, Tuple
+from typing import Iterator
 
 from packaging.version import Version
 
@@ -54,7 +54,7 @@ def __init__(self, install_args: list[str], state: AuditState = AuditState()):
         """
         super().__init__(with_pip=True)
         self._install_args = install_args
-        self._packages: list[Tuple[str, Version]] | None = None
+        self._packages: list[tuple[str, Version]] | None = None
         self._state = state
 
     def post_setup(self, context: SimpleNamespace) -> None:
@@ -124,7 +124,7 @@ def post_setup(self, context: SimpleNamespace) -> None:
             self._packages.append((package["name"], Version(package["version"])))
 
     @property
-    def installed_packages(self) -> Iterator[Tuple[str, Version]]:
+    def installed_packages(self) -> Iterator[tuple[str, Version]]:
         """
         A property to inspect the list of packages installed in the virtual environment.
 

pyproject.toml

@@ -50,7 +50,7 @@ test = [
 ]
 lint = [
     "black>=22.3.0",
-    "flake8",
+    "ruff",
     "interrogate",
     "isort",
     "mypy",
@@ -108,3 +108,8 @@ warn_unused_ignores = true
 [tool.bump]
 input = "pip_audit/__init__.py"
 reset = true
+
+[tool.ruff]
+line-length = 100
+select = ["E", "F", "W", "UP"]
+target-version = "py37"

test/dependency_source/test_pyproject.py

@@ -26,7 +26,7 @@ def _init_pyproject(filename: Path, contents: str) -> pyproject.PyProjectSource:
 
 
 def _check_file(filename: Path, expected_contents: dict) -> None:
-    with open(filename, mode="r") as f:
+    with open(filename) as f:
         assert toml.load(f) == expected_contents
 
 

test/dependency_source/test_requirement.py

@@ -178,7 +178,7 @@ def _check_fixes(
 
     # Check the requirements files
     for (expected_req, req_path) in zip(expected_reqs, req_paths):
-        with open(req_path, "r") as f:
+        with open(req_path) as f:
             # NOTE: We don't make any guarantees about non-semantic whitespace
             # preservation, hence the strip.
             assert expected_req == f.read().strip()
@@ -302,7 +302,7 @@ def test_requirement_source_fix_parse_failure(monkeypatch, req_file):
     # Check that the requirements files remain unchanged
     # If we encounter a failure while applying a fix, the fix should be rolled back from all files
     for (expected_req, req_path) in zip(input_reqs, req_paths):
-        with open(req_path, "r") as f:
+        with open(req_path) as f:
             assert expected_req == f.read().strip()
 
 
@@ -341,7 +341,7 @@ def mock_replace(*_args, **_kwargs):
     # in the process of writing it out and didn't flush.
     expected_reqs = ["flask==1.0", "flask==0.5\nrequests==2.0\nflask==0.3"]
     for (expected_req, req_path) in zip(expected_reqs, req_paths):
-        with open(req_path, "r") as f:
+        with open(req_path) as f:
             assert expected_req == f.read().strip()