Merge pull request #1066 from scop/chore/black-to-ruff

chore: switch Python formatting from `black` to `ruff format`

Author: scop

.dir-locals.el

@@ -2,7 +2,7 @@
 ;;; For more information see (info "(emacs) Directory Variables")
 
 ((python-mode
-  (eval add-hook 'before-save-hook 'blacken-buffer nil t))
+  (mode . ruff-format-on-save))
  (sh-mode
   (mode . shfmt-on-save)
   (shfmt-arguments "-s")

.github/renovate.json

@@ -39,11 +39,6 @@
       "commitMessageTopic": "{{depName}}",
       "semanticCommitScope": "pre-commit"
     },
-    {
-      "matchPackagePatterns": ["(^|/)black(-pre-commit-mirror)?$"],
-      "versioning": "pep440",
-      "groupName": "black"
-    },
     {
       "matchPackagePatterns": ["(^|/)gitlint$"],
       "versioning": "pep440",

.pre-commit-config.yaml

@@ -49,11 +49,7 @@ repos:
         types: [text]
         files: ^(helpers/python|.+\.py)$
         exclude: ^completions/
-
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 23.1.0
-    hooks:
-      - id: black
+      - id: ruff-format
         types: [text]
         files: ^(helpers/python|.+\.py)$
         exclude: ^completions/

doc/testing.md

@@ -11,9 +11,8 @@ and [pexpect](https://pexpect.readthedocs.io/).
 
 ## Coding style
 
-For the Python part, all of it is formatted using
-[Black](https://github.com/psf/black), and we also run
-[Ruff](https://github.com/charliermarsh/ruff) on it.
+For the Python part, all of it is checked and formatted using
+[Ruff](https://docs.astral.sh/ruff/).
 
 ## Installing dependencies
 

pyproject.toml

@@ -1,15 +1,25 @@
-[tool.black]
-line-length = 79
-target-version = ["py36", "py37", "py38", "py39", "py310"]
-
 [tool.ruff]
 line-length = 79
 target-version = "py37"
 select = ["E", "F", "B"]
 ignore = [
-    "E50", # Black
-    "E70", # Black
-
+    # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    # (keep order of ignores here same as ^there for maintainability)
+    "W191",
+    "E111",
+    "E114",
+    "E117",
+    "D206",
+    "D300",
+    "Q000",
+    "Q001",
+    "Q002",
+    "Q003",
+    "COM812",
+    "COM819",
+    "ISC001",
+    "ISC002",
+    "E501",
 ]
 fix = true
 

test/requirements-dev.txt

@@ -2,6 +2,5 @@
 
 -r requirements.txt
 
-black==23.1.0
 mypy==1.2.0
 ruff==0.1.6

test/t/conftest.py

@@ -426,20 +426,22 @@ def assert_bash_exec(
     )
     if want_output is not None:
         if output:
-            assert (
-                want_output
-            ), 'Unexpected output from "%s": exit status=%s, output="%s"' % (
-                cmd,
-                status,
-                output,
+            assert want_output, (
+                'Unexpected output from "%s": exit status=%s, output="%s"'
+                % (
+                    cmd,
+                    status,
+                    output,
+                )
             )
         else:
-            assert (
-                not want_output
-            ), 'Expected output from "%s": exit status=%s, output="%s"' % (
-                cmd,
-                status,
-                output,
+            assert not want_output, (
+                'Expected output from "%s": exit status=%s, output="%s"'
+                % (
+                    cmd,
+                    status,
+                    output,
+                )
             )
 
     return output

test/t/test_installpkg.py

@@ -12,7 +12,8 @@ def test_1(self, completion):
     @pytest.mark.complete("installpkg --")
     def test_2(self, completion):
         assert (
-            completion == "--ask --infobox --md5sum --menu "
+            completion
+            == "--ask --infobox --md5sum --menu "
             "--priority --root --tagfile --terse --warn".split()
         )
 

test/t/test_upgradepkg.py

@@ -12,8 +12,8 @@ def test_1(self, completion):
     @pytest.mark.complete("upgradepkg --")
     def test_2(self, completion):
         assert (
-            completion == "--dry-run --install-new --reinstall "
-            "--verbose".split()
+            completion
+            == "--dry-run --install-new --reinstall --verbose".split()
         )
 
     @pytest.mark.complete("upgradepkg ", cwd="slackware/home")

test/t/test_xz.py

@@ -9,8 +9,9 @@ def test_1(self, completion):
     @pytest.mark.complete("xz -d xz/")
     def test_2(self, completion):
         assert (
-            completion == "a/ bashcomp.lzma bashcomp.tar.xz "
-            "bashcomp.tlz bashcomp.xz".split()
+            completion
+            == "a/ bashcomp.lzma bashcomp.tar.xz bashcomp.tlz "
+            "bashcomp.xz".split()
         )
 
     @pytest.mark.complete("xz xz/")