Migrate to ruff

Signed-off-by: Stephen Finucane <stephen@that.guru>

Author: stephenfin

.pre-commit-config.yaml

@@ -1,21 +1,16 @@
 ---
-default_language_version:
-  # force all unspecified python hooks to run python3
-  python: python3
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.1.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.10
     hooks:
-      - id: flake8
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
+      - id: ruff-check
+        args: ['--fix', '--unsafe-fixes']
+      - id: ruff-format

git_pw/api.py

@@ -123,8 +123,7 @@ def _handle_error(
 
     else:
         LOG.error(
-            'Failed to %s resource. Is your configuration '
-            'correct?' % operation
+            'Failed to %s resource. Is your configuration correct?' % operation
         )
         LOG.error("Use the '--debug' flag for more information")
 

git_pw/patch.py

@@ -248,7 +248,7 @@ def update_cmd(patch_ids, commit_ref, state, delegate, archived, fmt):
     """
     for patch_id in patch_ids:
         LOG.debug(
-            'Updating patch: id=%d, commit_ref=%s, state=%s, ' 'archived=%s',
+            'Updating patch: id=%d, commit_ref=%s, state=%s, archived=%s',
             patch_id,
             commit_ref,
             state,

git_pw/series.py

@@ -186,8 +186,7 @@ def _format_submission(submission):
     metavar='SUBMITTER',
     multiple=True,
     help=(
-        'Show only series by these submitters. Should be an '
-        'email, name or ID.'
+        'Show only series by these submitters. Should be an email, name or ID.'
     ),
 )
 @utils.date_options()

git_pw/shell.py

@@ -25,8 +25,7 @@
     metavar='TOKEN',
     envvar='PW_TOKEN',
     help=(
-        "Authentication token. "
-        "Defaults to the value of 'git config pw.token'."
+        "Authentication token. Defaults to the value of 'git config pw.token'."
     ),
 )
 @click.option(

pyproject.toml

@@ -1,7 +1,25 @@
 [build-system]
-requires = ["pbr>=5.7.0", "setuptools>=36.6.0"]
+requires = ["pbr>=6.1.1"]
 build-backend = "pbr.build"
 
-[tool.black]
+[tool.ruff]
 line-length = 79
-skip-string-normalization = true
+
+[tool.ruff.format]
+quote-style = "preserve"
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "S"]
+ignore = [
+    # we only use asserts for type narrowing
+    "S101",
+    # FIXME: Add timeouts to requests
+    "S113",
+    # client tool can use subprocess as they like
+    "S603",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S"]
+"examples/*" = ["S"]

tests/test_utils.py

@@ -26,7 +26,7 @@ def test_git_config(mock_subprocess):
 def test_git_config_unicode(mock_subprocess):
     value = utils.git_config('foo')
 
-    assert value == u'\U0001f937'
+    assert value == '\U0001f937'
     mock_subprocess.assert_called_once_with(['git', 'config', 'foo'])
 
 
@@ -90,7 +90,7 @@ def test_echo_via_pager_env_default(mock_inner, mock_tabulate, mock_config):
 
 
 def _test_tabulate(fmt):
-    output = [(b'foo', 'bar', u'baz', '😀', None, 1)]
+    output = [(b'foo', 'bar', 'baz', '😀', None, 1)]
     headers = ('col1', 'colb', 'colIII', 'colX', 'colY', 'colZ')
 
     result = utils._tabulate(output, headers, fmt)
@@ -136,7 +136,7 @@ def test_tabulate_yaml(mock_dump):
             {
                 'col1': b'foo',
                 'colb': 'bar',
-                'coliii': u'baz',
+                'coliii': 'baz',
                 'colx': '😀',
                 'coly': None,
                 'colz': 1,

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-minversion = 3.1
+minversion = 4.6
 envlist = pep8,mypy,clean,py{39,310,311,312,313},report
 
 [testenv]
@@ -48,13 +48,7 @@ commands =
   sphinx-build {posargs:-E -W} docs docs/_build/html
 
 [testenv:man]
-# Does not currently support Python 3.12
-# https://github.com/click-contrib/click-man/pull/64
-basepython = 3.11
 deps =
-  click-man~=0.4.0
+  click-man~=0.5.1
 commands =
   click-man git-pw
-
-[flake8]
-show-source = true