Replace black and flake8 with ruff (#182)

Author: ssbarnea

.flake8

@@ -22,15 +22,13 @@ repos:
     rev: 1.5.0
     hooks:
       - id: tox-ini-fmt
-
-  - repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-      - id: black
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.2.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.12
     hooks:
-      - id: flake8
+      - id: ruff-format
+        alias: ruff
+      - id: ruff-check
+        alias: ruff
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.16.0
     hooks:

.pre-commit-config.yaml

@@ -15,7 +15,6 @@ recursive-include docs *.ico
 recursive-include docs *.png
 recursive-include docs *.py
 recursive-include docs *.rst
-recursive-include src *.flake8
 recursive-include src *.j2
 recursive-include src *.json
 recursive-include src *.md

MANIFEST.in

@@ -98,6 +98,7 @@ py-version = "3.10.0"
 
 [tool.pylint."MESSAGES CONTROL"]
 disable = [
+  "line-too-long",
   # TODO(ssbarnea): remove temporary skips adding during initial adoption:
   "attribute-defined-outside-init",
   "consider-using-f-string",
@@ -126,6 +127,66 @@ filterwarnings = [
   "ignore:The frontend.*:DeprecationWarning"
 ]
 
+[tool.ruff]
+fix = true
+# Same as Black.
+line-length = 88
+preview = true
+target-version = "py310"
+
+[tool.ruff.lint]
+ignore = [
+  "E501",
+  # temporary disabled until we fix them:
+  "A001",
+  "ANN",
+  "B007",
+  "BLE001",
+  "C410",
+  "C419",
+  "C901",
+  "CPY001",
+  "D",
+  "DOC",
+  "EM102",
+  "ERA001",
+  "FBT002",
+  "FBT003",
+  "FLY002",
+  "FURB101",
+  "FURB103",
+  "INP001",
+  "PERF401",
+  "PGH003",
+  "PGH004",
+  "PLR0912",
+  "PLR0915",
+  "PLR1702",
+  "PLR6104",
+  "PLR6301",
+  "PLW2901",
+  "PT009",
+  "PTH",
+  "RUF012",
+  "RUF059",
+  "S108",
+  "SIM102",
+  "SIM103",
+  "SIM105",
+  "SIM108",
+  "SLF001",
+  "T201",
+  "TRY003",
+  "UP031"
+]
+select = ["ALL"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["src"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 [tool.setuptools]
 include-package-data = true
 # These are required in actual runtime:

pyproject.toml

@@ -1,8 +1,8 @@
 """doc8 - A docutils linter."""
 
 from __future__ import annotations
-from doc8.version import __version__
-from doc8.main import doc8  # noqa
 
+from doc8.main import doc8  # noqa
+from doc8.version import __version__
 
 __all__ = ("__version__",)

src/doc8/__init__.py

@@ -16,5 +16,4 @@
 
 from doc8 import main
 
-
 sys.exit(main.main())

src/doc8/__main__.py

@@ -21,7 +21,7 @@
 from doc8 import utils
 
 
-class ContentCheck(metaclass=abc.ABCMeta):
+class ContentCheck(abc.ABC):
     def __init__(self, cfg):
         self._cfg = cfg
 
@@ -30,7 +30,7 @@ def report_iter(self, parsed_file):
         pass
 
 
-class LineCheck(metaclass=abc.ABCMeta):
+class LineCheck(abc.ABC):
     def __init__(self, cfg):
         self._cfg = cfg
 
@@ -83,7 +83,7 @@ def report_iter(self, parsed_file):
 
 class CheckValidity(ContentCheck):
     REPORTS = frozenset(["D000"])
-    EXT_MATCHER = re.compile(r"(.*)[.]rst", re.I)
+    EXT_MATCHER = re.compile(r"(.*)[.]rst", re.IGNORECASE)
 
     # From docutils docs:
     #
@@ -104,11 +104,11 @@ class CheckValidity(ContentCheck):
             re.MULTILINE,
         ),
         re.compile(
-            r'^Error in "code-block" directive:\nunknown option: "emphasize-lines"'
+            r'^Error in "code-block" directive:\nunknown option: "emphasize-lines"',
         ),
         re.compile(r'^Error in "code-block" directive:\nunknown option: "linenos"'),
         re.compile(
-            r'^Error in "code-block" directive:\nunknown option: "lineno-start"'
+            r'^Error in "code-block" directive:\nunknown option: "lineno-start"',
         ),
         re.compile(r'^Error in "code-block" directive:\nunknown option: "dedent"'),
         re.compile(r'^Error in "code-block" directive:\nunknown option: "force"'),
@@ -119,7 +119,7 @@ class CheckValidity(ContentCheck):
             re.MULTILINE,
         ),
         re.compile(
-            r'^PEP number must be a number from 0 to 9999; "\d{1,4}#[^"]*" is invalid.'
+            r'^PEP number must be a number from 0 to 9999; "\d{1,4}#[^"]*" is invalid.',
         ),
     ]
 
@@ -218,16 +218,14 @@ def find_directive_end(start, lines):
         # for unknown directives, so we have to do it manually).
         directives = []
         for i, line in enumerate(lines):
-            if re.match(r"^\s*..\s(.*?)::\s*", line):
-                directives.append((i, find_directive_end(i, lines)))
-            elif re.match(r"^::\s*$", line):
+            if re.match(r"^\s*..\s(.*?)::\s*", line) or re.match(r"^::\s*$", line):
                 directives.append((i, find_directive_end(i, lines)))
 
         # Find definition terms in definition lists
         # This check may match the code, which is already appended
         lwhitespaces = r"^\s*"
         listspattern = r"^\s*(\* |- |#\. |\d+\. )"
-        for i in range(0, len(lines) - 1):
+        for i in range(len(lines) - 1):
             line = lines[i]
             next_line = lines[i + 1]
             # if line is a blank, line is not a definition term
@@ -237,7 +235,7 @@ def find_directive_end(start, lines):
             if re.match(listspattern, line):
                 continue
             if len(re.search(lwhitespaces, line).group()) < len(
-                re.search(lwhitespaces, next_line).group()
+                re.search(lwhitespaces, next_line).group(),
             ):
                 directives.append((i, i))
 
@@ -266,10 +264,7 @@ def find_containing_nodes(num):
             best_nodes = []
             for n, (line_min, line_max) in contained_in:
                 span = line_max - line_min
-                if smallest_span is None:
-                    smallest_span = span
-                    best_nodes = [n]
-                elif span < smallest_span:
+                if smallest_span is None or span < smallest_span:
                     smallest_span = span
                     best_nodes = [n]
                 elif span == smallest_span:

src/doc8/checks.py

@@ -35,7 +35,6 @@
 import os
 import sys
 
-
 try:
     # py3.11+
     from tomllib import load as toml_load  # type: ignore
@@ -45,10 +44,8 @@
 
 from stevedore import extension
 
-from doc8 import checks
+from doc8 import checks, utils, version
 from doc8 import parser as file_parser
-from doc8 import utils
-from doc8 import version
 
 FILE_PATTERNS = [".rst", ".txt"]
 MAX_LINE_LENGTH = 79
@@ -158,7 +155,8 @@ def extract_config(args):
         if not os.path.isfile(cfg_file):
             if args["config"]:
                 print(
-                    "Configuration file %s does not exist...ignoring" % (args["config"])
+                    "Configuration file %s does not exist...ignoring"
+                    % (args["config"]),
                 )
             continue
         if cfg_file.endswith((".ini", ".cfg")):
@@ -180,7 +178,9 @@ def fetch_checks(cfg):
         checks.CheckNewlineEndOfFile(cfg),
     ]
     mgr = extension.ExtensionManager(
-        namespace="doc8.extension.check", invoke_on_load=True, invoke_args=(cfg.copy(),)
+        namespace="doc8.extension.check",
+        invoke_on_load=True,
+        invoke_args=(cfg.copy(),),
     )
     addons = []
     for e in mgr:
@@ -194,7 +194,9 @@ def setup_logging(verbose):
     else:
         level = logging.ERROR
     logging.basicConfig(
-        level=level, format="%(levelname)s: %(message)s", stream=sys.stdout
+        level=level,
+        format="%(levelname)s: %(message)s",
+        stream=sys.stdout,
     )
 
 
@@ -205,7 +207,9 @@ def scan(cfg):
     ignored_paths = cfg.get("ignore_path", [])
     files_ignored = 0
     file_iter = utils.find_files(
-        cfg.get("paths", []), cfg.get("extension", []), ignored_paths
+        cfg.get("paths", []),
+        cfg.get("extension", []),
+        ignored_paths,
     )
     default_extension = cfg.get("default_extension")
     file_encoding = cfg.get("file_encoding")
@@ -216,7 +220,9 @@ def scan(cfg):
                 print("  Ignoring '%s'" % (filename))
         else:
             f = file_parser.parse(
-                filename, default_extension=default_extension, encoding=file_encoding
+                filename,
+                default_extension=default_extension,
+                encoding=file_encoding,
             )
             files.append(f)
             if cfg.get("verbose"):
@@ -253,7 +259,7 @@ def validate(cfg, files, result=None):
                         print(
                             "  Skipping check '%s' since it does not"
                             " understand parsing a file with extension '%s'"
-                            % (check_name, f.extension)
+                            % (check_name, f.extension),
                         )
                     continue
             try:
@@ -266,7 +272,7 @@ def validate(cfg, files, result=None):
                     if cfg.get("verbose"):
                         print(
                             "  Skipping check '%s', determined to only"
-                            " check ignoreable codes" % check_name
+                            " check ignoreable codes" % check_name,
                         )
                     continue
             if cfg.get("verbose"):
@@ -279,13 +285,11 @@ def validate(cfg, files, result=None):
                         line_num = "?"
                     if cfg.get("verbose"):
                         print(
-                            "    - {}:{}: {} {}".format(
-                                f.filename, line_num, code, message
-                            )
+                            f"    - {f.filename}:{line_num}: {code} {message}",
                         )
                     elif not result.capture:
                         print(
-                            "{}:{}: {} {}".format(f.filename, line_num, code, message)
+                            f"{f.filename}:{line_num}: {code} {message}",
                         )
                     result.error(check_name, f.filename, line_num, code, message)
                     error_counts[check_name] += 1
@@ -297,18 +301,16 @@ def validate(cfg, files, result=None):
                         if cfg.get("verbose"):
                             print(
                                 "    - %s:%s: %s %s"
-                                % (f.filename, line_num, code, message)
+                                % (f.filename, line_num, code, message),
                             )
                         elif not result.capture:
                             print(
-                                "{}:{}: {} {}".format(
-                                    f.filename, line_num, code, message
-                                )
+                                f"{f.filename}:{line_num}: {code} {message}",
                             )
                         result.error(check_name, f.filename, line_num, code, message)
                         error_counts[check_name] += 1
             else:
-                raise TypeError("Unknown check type: {}, {}".format(type(c), c))
+                raise TypeError(f"Unknown check type: {type(c)}, {c}")
     return error_counts
 
 
@@ -358,20 +360,18 @@ def report(self):
             for error in self.errors:
                 lines.append("%s:%s: %s %s" % error[1:])
 
-        lines.extend(
-            [
-                "=" * 8,
-                "Total files scanned = %s" % (self.files_selected),
-                "Total files ignored = %s" % (self.files_ignored),
-                "Total accumulated errors = %s" % (self.total_errors),
-            ]
-        )
+        lines.extend([
+            "=" * 8,
+            "Total files scanned = %s" % (self.files_selected),
+            "Total files ignored = %s" % (self.files_ignored),
+            "Total accumulated errors = %s" % (self.total_errors),
+        ])
 
         if self.error_counts:
             lines.append("Detailed error counts:")
             for check_name in sorted(self.error_counts.keys()):
                 check_errors = self.error_counts[check_name]
-                lines.append("    - {} = {}".format(check_name, check_errors))
+                lines.append(f"    - {check_name} = {check_errors}")
 
         return "\n".join(lines)