Migrate from several linters to Ruff (#229)

* Move coverage configs to pyproject.toml

* Replace sevral linters with ruff

.pre-commit-config.yaml

@@ -1,16 +1,4 @@
 repos:
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: "24.4.2"
-    hooks:
-      - id: black
-        language_version: python3.8
-
-  - repo: https://github.com/PyCQA/isort
-    rev: "5.13.2"
-    hooks:
-      - id: isort
-        files: \.py$
-
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: "v1.10.0"
     hooks:
@@ -19,12 +7,6 @@ repos:
           - httpx
         exclude: docs/.*|tests/.*|noxfile.py
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v4.0.0-alpha.8"
-    hooks:
-      - id: prettier
-        args: [--prose-wrap, always]
-
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "v4.6.0"
     hooks:
@@ -38,19 +20,8 @@ repos:
       - id: forbid-new-submodules
       - id: trailing-whitespace
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: "7.0.0"
-    hooks:
-      - id: flake8
-
-  - repo: https://github.com/PyCQA/pydocstyle.git
-    rev: "6.3.0"
-    hooks:
-      - id: pydocstyle
-        files: src/.*\.py$
-
-  - repo: https://github.com/asottile/blacken-docs
-    rev: "1.16.0"
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: "1.18.0"
     hooks:
       - id: blacken-docs
 
@@ -59,3 +30,9 @@ repos:
     hooks:
       - id: pyproject-fmt
         args: [--indent, "4"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.0
+    hooks:
+      - id: ruff
+      - id: ruff-format

CONTRIBUTING.md

@@ -52,8 +52,7 @@ development.
 
 This codebase uses the following tools for enforcing a code convention:
 
-- [black] for code formatting
-- [isort] for import sorting
+- [ruff] for code formatting and linting
 - [mypy] for static type checking
 - [pre-commit] for managing all the linters
 
@@ -63,8 +62,7 @@ To run all the linters:
 $ nox -s lint
 ```
 
-[black]: https://github.com/psf/black
-[isort]: https://github.com/timothycrosley/isort
+[ruff]: https://github.com/astral-sh/ruff
 [mypy]: https://github.com/python/mypy
 [pre-commit]: https://pre-commit.com/
 

pyproject.toml

@@ -27,6 +27,40 @@ dynamic = [
 [project.urls]
 "GitHub" = "https://github.com/pypa/installer"
 
+[tool.ruff]
+fix = true
+src = ["src"]
+extend-exclude = [
+    "noxfile.py",
+    "docs/*"
+]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "I",
+    "D",
+]
+ignore = [
+    "D105", "D203", "D213", "E501"
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D"]
+"tools/*" = ["D"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["src"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if TYPE_CHECKING:",
+]
+
 [tool.mypy]
 files = "src,tools"
 strict = true

src/installer/records.py

@@ -19,9 +19,9 @@
 class InvalidRecordEntry(Exception):
     """Raised when a RecordEntry is not valid, due to improper element values or count."""
 
-    def __init__(
+    def __init__(  # noqa: D107
         self, elements: Iterable[str], issues: Iterable[str]
-    ) -> None:  # noqa: D107
+    ) -> None:
         super().__init__(", ".join(issues))
         self.issues = issues
         self.elements = elements

tests/test_utils.py

@@ -1,5 +1,4 @@
-"""Tests for installer.utils
-"""
+"""Tests for installer.utils"""
 
 import base64
 import hashlib