Migrate formatting and linting to Ruff (#1145)

Author: adamchainz

.pre-commit-config.yaml

@@ -39,40 +39,23 @@ repos:
   rev: ff671d6a030a3141634793e6d1e8909ab6091830  # frozen: v1.0.0
   hooks:
   - id: sphinx-lint
-- repo: https://github.com/asottile/pyupgrade
-  rev: ce40a160603ab0e7d9c627ae33d7ef3906e2d2b2  # frozen: v3.19.1
-  hooks:
-  - id: pyupgrade
-    args: [--py39-plus]
 - repo: https://github.com/adamchainz/django-upgrade
   rev: 700530171ecf380bc829a64388f49d14ecd61c53  # frozen: 1.25.0
   hooks:
   - id: django-upgrade
     args: [--target-version, '4.2']
-- repo: https://github.com/psf/black-pre-commit-mirror
-  rev: a4920527036bb9a3f3e6055d595849d67d0da066  # frozen: 25.1.0
-  hooks:
-  - id: black
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 78a9dcbecf4f755f65d1f3dec556bc249d723600  # frozen: 1.19.1
   hooks:
   - id: blacken-docs
     additional_dependencies:
     - black==25.1.0
-- repo: https://github.com/pycqa/isort
-  rev: c8ab4a5b21bac924d106e3103dd7c979fdd0f9bc  # frozen: 6.0.1
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: 12753357c00c3fb8615100354c9fdc6ab80b044d  # frozen: v0.11.10
   hooks:
-    - id: isort
-      name: isort (python)
-- repo: https://github.com/PyCQA/flake8
-  rev: 4b5e89b4b108a6c1a000c591d334a99a80d34c7b  # frozen: 7.2.0
-  hooks:
-  - id: flake8
-    additional_dependencies:
-    - flake8-bugbear
-    - flake8-comprehensions
-    - flake8-logging
-    - flake8-tidy-imports
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: f40886d54c729f533f864ed6ce584e920feb0af7  # frozen: v1.15.0
   hooks:

docs/conf.py

@@ -6,9 +6,10 @@
 from __future__ import annotations
 
 import sys
-import tomllib
 from pathlib import Path
 
+import tomllib
+
 # -- Path setup --------------------------------------------------------------
 
 here = Path(__file__).parent.resolve()

pyproject.toml

@@ -66,12 +66,42 @@ django50 = [ "django>=5.0a1,<5.1; python_version>='3.10'" ]
 django51 = [ "django>=5.1a1,<5.2; python_version>='3.10'" ]
 django52 = [ "django>=5.2a1,<6; python_version>='3.10'" ]
 
-[tool.isort]
-add_imports = [
-  "from __future__ import annotations",
+[tool.ruff]
+lint.select = [
+  # flake8-bugbear
+  "B",
+  # flake8-comprehensions
+  "C4",
+  # pycodestyle
+  "E",
+  # Pyflakes errors
+  "F",
+  # isort
+  "I",
+  # flake8-simplify
+  "SIM",
+  # flake8-tidy-imports
+  "TID",
+  # pyupgrade
+  "UP",
+  # Pyflakes warnings
+  "W",
 ]
-force_single_line = true
-profile = "black"
+lint.ignore = [
+  # flake8-bugbear opinionated rules
+  "B9",
+  # line-too-long
+  "E501",
+  # suppressible-exception
+  "SIM105",
+  # if-else-block-instead-of-if-exp
+  "SIM108",
+]
+lint.extend-safe-fixes = [
+  # non-pep585-annotation
+  "UP006",
+]
+lint.isort.required-imports = [ "from __future__ import annotations" ]
 
 [tool.pyproject-fmt]
 max_supported_python = "3.13"

src/django_mysql/apps.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
-from typing import Any
-from typing import Callable
+from typing import Any, Callable
 
 from django.apps import AppConfig
 from django.conf import settings
@@ -10,8 +9,7 @@
 from django.utils.translation import gettext_lazy as _
 
 from django_mysql.checks import register_checks
-from django_mysql.rewrite_query import REWRITE_MARKER
-from django_mysql.rewrite_query import rewrite_query
+from django_mysql.rewrite_query import REWRITE_MARKER, rewrite_query
 from django_mysql.utils import mysql_connections
 
 
@@ -34,12 +32,9 @@ def add_database_instrumentation(self) -> None:
         connection_created.connect(install_rewrite_hook)
 
     def add_lookups(self) -> None:
-        from django.db.models import CharField
-        from django.db.models import TextField
+        from django.db.models import CharField, TextField
 
-        from django_mysql.models.lookups import CaseSensitiveExact
-        from django_mysql.models.lookups import Soundex
-        from django_mysql.models.lookups import SoundsLike
+        from django_mysql.models.lookups import CaseSensitiveExact, Soundex, SoundsLike
 
         CharField.register_lookup(CaseSensitiveExact)
         CharField.register_lookup(SoundsLike)

src/django_mysql/cache.py

@@ -8,21 +8,14 @@
 from random import random
 from textwrap import dedent
 from time import time
-from typing import Any
-from typing import Callable
-from typing import Literal
-from typing import cast
-
-from django.core.cache.backends.base import DEFAULT_TIMEOUT
-from django.core.cache.backends.base import BaseCache
-from django.core.cache.backends.base import default_key_func
-from django.db import connections
-from django.db import router
+from typing import Any, Callable, Literal, cast
+
+from django.core.cache.backends.base import DEFAULT_TIMEOUT, BaseCache, default_key_func
+from django.db import connections, router
 from django.utils.encoding import force_bytes
 from django.utils.module_loading import import_string
 
-from django_mysql.utils import collapse_spaces
-from django_mysql.utils import get_list_sql
+from django_mysql.utils import collapse_spaces, get_list_sql
 
 _EncodedKeyType = Literal["i", "p", "z"]
 
@@ -146,7 +139,7 @@ def __init__(self, table: str, params: dict[str, Any]) -> None:
                     "KEY_PREFIX."
                 )
         else:
-            reverse_key_func = params.get("REVERSE_KEY_FUNCTION", None)
+            reverse_key_func = params.get("REVERSE_KEY_FUNCTION")
             self.reverse_key_func = get_reverse_key_func(reverse_key_func)
 
     # Django API + helpers
@@ -412,7 +405,7 @@ def _base_delta(
             )
 
             if not updated:
-                raise ValueError("Key '%s' not found, or not an integer" % key)
+                raise ValueError(f"Key '{key}' not found, or not an integer")
 
             # New value stored in insert_id
             return cursor.lastrowid
@@ -549,11 +542,9 @@ def keys_with_prefix(
 
         with connections[db].cursor() as cursor:
             cursor.execute(
-                """SELECT cache_key FROM {table}
+                f"""SELECT cache_key FROM {table}
                    WHERE cache_key LIKE %s AND
-                         expires >= %s""".format(
-                    table=table
-                ),
+                         expires >= %s""",
                 (prefix, self._now()),
             )
             rows = cursor.fetchall()
@@ -584,12 +575,10 @@ def get_with_prefix(
 
         with connections[db].cursor() as cursor:
             cursor.execute(
-                """SELECT cache_key, value, value_type
+                f"""SELECT cache_key, value, value_type
                    FROM {table}
                    WHERE cache_key LIKE %s AND
-                         expires >= %s""".format(
-                    table=table
-                ),
+                         expires >= %s""",
                 (prefix, self._now()),
             )
             rows = cursor.fetchall()
@@ -612,10 +601,8 @@ def delete_with_prefix(self, prefix: str, version: int | None = None) -> int:
 
         with connections[db].cursor() as cursor:
             return cursor.execute(
-                """DELETE FROM {table}
-                   WHERE cache_key LIKE %s""".format(
-                    table=table
-                ),
+                f"""DELETE FROM {table}
+                   WHERE cache_key LIKE %s""",
                 (prefix,),
             )
 
@@ -646,19 +633,15 @@ def cull(self) -> int:
             else:
                 cull_num = num // self._cull_frequency
                 cursor.execute(
-                    """SELECT cache_key FROM {table}
+                    f"""SELECT cache_key FROM {table}
                        ORDER BY cache_key
-                       LIMIT 1 OFFSET %s""".format(
-                        table=table
-                    ),
+                       LIMIT 1 OFFSET %s""",
                     (cull_num,),
                 )
                 max_key = cursor.fetchone()[0]
                 num_deleted += cursor.execute(
-                    """DELETE FROM {table}
-                       WHERE cache_key < %s""".format(
-                        table=table
-                    ),
+                    f"""DELETE FROM {table}
+                       WHERE cache_key < %s""",
                     (max_key,),
                 )
             return num_deleted

src/django_mysql/forms.py

@@ -8,10 +8,12 @@
 from django.utils.text import format_lazy
 from django.utils.translation import gettext_lazy as _
 
-from django_mysql.validators import ListMaxLengthValidator
-from django_mysql.validators import ListMinLengthValidator
-from django_mysql.validators import SetMaxLengthValidator
-from django_mysql.validators import SetMinLengthValidator
+from django_mysql.validators import (
+    ListMaxLengthValidator,
+    ListMinLengthValidator,
+    SetMaxLengthValidator,
+    SetMinLengthValidator,
+)
 
 
 class SimpleListField(forms.CharField):
@@ -137,7 +139,7 @@ class SimpleSetField(forms.CharField):
         "item_n_invalid": _("Item %(nth)s in the set did not validate: "),
         "no_double_commas": _("No leading, trailing, or double commas."),
         "no_duplicates": _(
-            "Duplicates are not supported. " "'%(item)s' appears twice or more."
+            "Duplicates are not supported. '%(item)s' appears twice or more."
         ),
     }
 

src/django_mysql/locks.py

@@ -6,8 +6,7 @@
 from django.db import connections
 from django.db.backends.utils import CursorWrapper
 from django.db.models import Model
-from django.db.transaction import TransactionManagementError
-from django.db.transaction import atomic
+from django.db.transaction import TransactionManagementError, atomic
 from django.db.utils import DEFAULT_DB_ALIAS
 
 from django_mysql.exceptions import TimeoutError

src/django_mysql/management/commands/cull_mysql_caches.py

@@ -4,10 +4,8 @@
 from typing import Any
 
 from django.conf import settings
-from django.core.cache import InvalidCacheBackendError
-from django.core.cache import caches
-from django.core.management import BaseCommand
-from django.core.management import CommandError
+from django.core.cache import InvalidCacheBackendError, caches
+from django.core.management import BaseCommand, CommandError
 
 from django_mysql.cache import MySQLCache
 from django_mysql.utils import collapse_spaces

src/django_mysql/management/commands/dbparams.py

@@ -3,10 +3,8 @@
 import argparse
 from typing import Any
 
-from django.core.management import BaseCommand
-from django.core.management import CommandError
-from django.db import DEFAULT_DB_ALIAS
-from django.db import connections
+from django.core.management import BaseCommand, CommandError
+from django.db import DEFAULT_DB_ALIAS, connections
 from django.db.utils import ConnectionDoesNotExist
 
 from django_mysql.utils import settings_to_cmd_args
@@ -19,8 +17,8 @@ class Command(BaseCommand):
         "Outputs shell parameters representing database connection "
         "suitable for inclusion in various tools' commandlines. The "
         "connection alias should be a name from DATABASES - defaults to "
-        "'{default}'."
-    ).format(default=DEFAULT_DB_ALIAS)
+        f"'{DEFAULT_DB_ALIAS}'."
+    )
 
     requires_system_checks: list[str] = []
 
@@ -30,7 +28,7 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
             metavar="alias",
             nargs="?",
             default=DEFAULT_DB_ALIAS,
-            help="Specify the database connection alias to output " "parameters for.",
+            help="Specify the database connection alias to output parameters for.",
         )
 
         parser.add_argument(

src/django_mysql/management/commands/mysql_cache_migration.py

@@ -4,10 +4,8 @@
 from typing import Any
 
 from django.conf import settings
-from django.core.cache import InvalidCacheBackendError
-from django.core.cache import caches
-from django.core.management import BaseCommand
-from django.core.management import CommandError
+from django.core.cache import InvalidCacheBackendError, caches
+from django.core.management import BaseCommand, CommandError
 
 from django_mysql.cache import MySQLCache
 from django_mysql.utils import collapse_spaces