Use ruff instead of flake8, black and isort

Author: twmr

.flake8

@@ -41,17 +41,11 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install --upgrade tox
 
-      - name: Lint (flake8)
-        run: flake8
+      - name: Ruff format
+        run: ruff format .
 
-      - name: Lint (black)
-        run: black --check .
-
-      - name: Lint (isort)
-        run: isort --check .
-
-      # - name: Lint (mypy)
-      #   run: mypy .
+      - name: Ruff format
+        run: ruff check .
 
       - name: Unit tests
         run: |

.github/workflows/test.yml

@@ -1,16 +1,10 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/psf/black
-    rev: 24.3.0
-    hooks:
-      - id: black
-  # nice but doesn't support sphinx syntax - see https://github.com/Lucas-C/pre-commit-hooks-markup/issues/13
-  # - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
-  #   rev: v1.0.1
-  #   hooks:
-  #     - id: rst-linter
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.7
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

.pre-commit-config.yaml

@@ -38,10 +38,7 @@ dependencies = [
 
 [project.optional-dependencies]
 lint = [
-    "isort >= 5",
-    "flake8",
-    "black",
-    "mypy"
+    "ruff",
 ]
 
 [project.urls]
@@ -50,13 +47,6 @@ homepage = "https://github.com/thisch/pytest-sphinx"
 [project.entry-points."pytest11"]
 "sphinx" = "pytest_sphinx"
 
-[tool.isort]
-profile = "black"
-
-[tool.mypy]
-strict = true
-warn_unused_ignores = false  # mypy#8823
-
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"

pyproject.toml

@@ -383,7 +383,6 @@ def _DocTestRunner__run(
 
         # Process each example.
         for examplenum, example in enumerate(test.examples):
-
             # If REPORT_ONLY_FIRST_FAILURE is set, then suppress
             # reporting after the first failure.
             quiet = (

setup.cfg

@@ -20,9 +20,7 @@ def test_simple(in_between_content: str) -> None:
 
     {{'3': 4,
      '5': 6}}
-""".format(
-        in_between_content
-    )
+""".format(in_between_content)
 
     examples = docstring2examples(doc)
     assert len(examples) == 1

src/pytest_sphinx.py

@@ -92,9 +92,7 @@ def test_skipif_and_text(expr: str, with_options: bool) -> None:
 
         abcedf
         abcedf
-    """.format(
-            expr
-        )
+    """.format(expr)
     )
     if with_options:
         want = "\n:options: +NORMALIZE_WHITESPACE" + want

tests/test_doc2test.py

@@ -4,7 +4,6 @@
 
 
 def test_syntax_error_in_module_doctest(testdir: Testdir) -> None:
-
     testdir.makepyfile(
         textwrap.dedent(
             """
@@ -28,7 +27,6 @@ def test_syntax_error_in_module_doctest(testdir: Testdir) -> None:
 
 
 def test_failing_module_doctest(testdir: Testdir) -> None:
-
     testdir.makepyfile(
         textwrap.dedent(
             """
@@ -82,7 +80,6 @@ def func():
 
 
 def test_working_module_doctest(testdir: Testdir) -> None:
-
     testdir.makepyfile(
         textwrap.dedent(
             """
@@ -129,7 +126,6 @@ def func():
 
 
 def test_working_module_doctest_nospaces(testdir: Testdir) -> None:
-
     testdir.makepyfile(
         textwrap.dedent(
             """
@@ -149,7 +145,6 @@ def test_working_module_doctest_nospaces(testdir: Testdir) -> None:
 
 
 def test_multiple_doctests_in_single_file(testdir: Testdir) -> None:
-
     testdir.makepyfile(
         textwrap.dedent(
             """

tests/test_options.py

@@ -1,4 +1,4 @@
-""" Run tests that call "sphinx-build -M doctest". """
+"""Run tests that call "sphinx-build -M doctest"."""
 
 import logging
 import os
@@ -72,7 +72,6 @@ def sphinx_tester(tmpdir: LocalPath) -> Iterator[SphinxDoctestRunner]:
 
 
 def test_simple_doctest_failure(sphinx_tester: SphinxDoctestRunner) -> None:
-
     output = sphinx_tester(
         """
         ===!!!
@@ -189,9 +188,7 @@ def test_skipif_true(
                 :skipif: True
 
                 NOT EVALUATED
-            """.format(
-            testcode
-        )
+            """.format(testcode)
 
         raise_in_testcode = testcode != "pass"
         sphinx_output = sphinx_tester(code, must_raise=raise_in_testcode)
@@ -222,9 +219,7 @@ def test_skipif_false(
                 :skipif: False
 
                 EVALUATED
-            """.format(
-            testcode
-        )
+            """.format(testcode)
 
         expected_failure = "EVALUATED" not in testcode
 
@@ -264,9 +259,7 @@ def test_skipif_multiple_testoutput(
                 Traceback (most recent call last):
                     ...
                 {}
-            """.format(
-            "ValueError" if wrong_output_assertion else "RuntimeError"
-        )
+            """.format("ValueError" if wrong_output_assertion else "RuntimeError")
 
         # -> ignore all skipped testoutput sections, but use the one that is
         # -> not skipped
@@ -296,9 +289,7 @@ def test_skipif_true_in_testcode(
                 :skipif: False
 
                 NOT EVALUATED
-            """.format(
-            testcode
-        )
+            """.format(testcode)
 
         sphinx_output = sphinx_tester(code, must_raise=False)
         assert "0 tests" in sphinx_output