🧑‍💻 Replace black/isort with ruff

sergei-maertens · sergei-maertens · commit 86415e10fca3 · 2025-07-06T18:41:42.000+02:00
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -23,8 +23,8 @@ checks:
 * Pull requests must be accompanied by tests. We use ``pytest`` and prefer using this
   testing style over Django's ``django.test.TestCase``.
 * Ideally, documentation updates are included in a pull request.
-* Imports are sorted using ``isort``, while code is formatted using ``black``. There
-  are tox environments and CI checks in place to check/enforce this.
+* Code formatting and linting is done with ``ruff``. There are tox environments and CI
+  checks in place to check/enforce this.
 * Follow Django's code style where possible.
 * Keep commits atomic - one commit should only concern one topic. Bugfixes typically
   have one commit for the regression test and one commit with the fix.
@@ -100,8 +100,8 @@ or to build the full test matrix
 
 .. code-block:: bash
 
-   black .
-   isort .
+   ruff format .
+   ruff check --fix .
 
 Should be sufficient. Consider using a pre-commit hook to automate this.
 
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Manage cookie information and let visitors give or reject consent for them.
 ![License](https://img.shields.io/pypi/l/django-cookie-consent)
 [![Build status][badge:GithubActions:CI]][GithubActions:CI]
 [![Code Quality][badge:GithubActions:CQ]][GithubActions:CQ]
-[![Code style: black][badge:black]][black]
+[![Code style: ruff][badge:ruff]][ruff]
 [![Test coverage][badge:codecov]][codecov]
 [![Documentation][badge:docs]][docs]
 
@@ -36,8 +36,8 @@ from the `docs` directory in this repository.
 [badge:GithubActions:CI]: https://github.com/django-commons/django-cookie-consent/workflows/Run%20CI/badge.svg
 [GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/actions?query=workflow%3A%22Code+quality+checks%22
 [badge:GithubActions:CQ]: https://github.com/django-commons/django-cookie-consent/workflows/Code%20quality%20checks/badge.svg
-[black]: https://github.com/psf/black
-[badge:black]: https://img.shields.io/badge/code%20style-black-000000.svg
+[ruff]: https://github.com/astral-sh/ruff
+[badge:ruff]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
 [codecov]: https://codecov.io/gh/django-commons/django-cookie-consent
 [badge:codecov]: https://codecov.io/gh/django-commons/django-cookie-consent/branch/master/graph/badge.svg
 [docs]: https://django-cookie-consent.readthedocs.io/en/latest/?badge=latest
diff --git a/cookie_consent/migrations/0001_initial.py b/cookie_consent/migrations/0001_initial.py
@@ -68,7 +68,8 @@ class Migration(migrations.Migration):
                         validators=[
                             django.core.validators.RegexValidator(
                                 re.compile("^[-_a-zA-Z0-9]+$"),
-                                "Enter a valid 'varname' consisting of letters, numbers, underscores or hyphens.",
+                                "Enter a valid 'varname' consisting of letters, "
+                                "numbers, underscores or hyphens.",
                                 "invalid",
                             )
                         ],
diff --git a/cookie_consent/migrations/0003_alter_cookiegroup_varname.py b/cookie_consent/migrations/0003_alter_cookiegroup_varname.py
@@ -7,7 +7,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("cookie_consent", "0002_auto__add_logitem"),
     ]
@@ -22,7 +21,8 @@ class Migration(migrations.Migration):
                 validators=[
                     django.core.validators.RegexValidator(
                         re.compile("^[-_a-zA-Z0-9]+$"),
-                        "Enter a valid 'varname' consisting of letters, numbers, underscores or hyphens.",
+                        "Enter a valid 'varname' consisting of letters, numbers, "
+                        "underscores or hyphens.",
                         "invalid",
                     )
                 ],
diff --git a/cookie_consent/migrations/0004_cookie_natural_key.py b/cookie_consent/migrations/0004_cookie_natural_key.py
@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("cookie_consent", "0003_alter_cookiegroup_varname"),
     ]
diff --git a/cookie_consent/templatetags/cookie_consent_tags.py b/cookie_consent/templatetags/cookie_consent_tags.py
@@ -133,8 +133,9 @@ def js_type_for_cookie_consent(request, varname, cookie=None):
         alert("Social cookie accepted");
       </script>
     """
-    # This approach doesn't work with page caches and/or strict Content-Security-Policies
-    # (unless you use nonces, which again doesn't work with aggressive page caching).
+    # This approach doesn't work with page caches and/or strict
+    # Content-Security-Policies (unless you use nonces, which again doesn't work with
+    # aggressive page caching).
     warnings.warn(
         "Template tags for use in/with JS are deprecated and will be removed "
         "in django-cookie-consent 1.0",
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,7 +14,7 @@
 
 django.setup()
 
-from cookie_consent import __version__  # isort:skip
+from cookie_consent import __version__  # noqa: E402
 
 # -- General configuration -----------------------------------------------------
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -45,16 +45,12 @@ Changelog = "https://github.com/django-commons/django-cookie-consent/blob/master
 [project.optional-dependencies]
 tests = [
     "pytest",
+    "pytest-cov",
     "pytest-django",
     "pytest-playwright",
     "hypothesis",
     "tox",
-    "isort",
-    "black",
-    "flake8",
-]
-coverage = [
-    "pytest-cov",
+    "ruff",
 ]
 docs = [
     "sphinx",
@@ -105,3 +101,30 @@ exclude_also = [
     "\\.\\.\\.",
     "\\bpass$",
 ]
+
+[tool.ruff.lint]
+extend-select = [
+    # "UP",  # pyupgrade
+    # "DJ",  # django
+    # "LOG", # logging
+    # "G",
+    "I",   # isort
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    # "PERF",# perflint
+    # "B",   # flake8-bugbear
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+section-order = [
+    "future",
+    "standard-library",
+    "django",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+
+[tool.ruff.lint.isort.sections]
+"django" = ["django"]
diff --git a/setup.cfg b/setup.cfg
diff --git a/tests/test_models.py b/tests/test_models.py
@@ -57,7 +57,8 @@ def test_bulk_delete(self):
             id=self.cookie_group.id
         ).delete()
 
-        # Deleting a CookieGroup also deletes the associated Cookies, that's why we expect a count of 2.
+        # Deleting a CookieGroup also deletes the associated Cookies, that's why we
+        # expect a count of 2.
         self.assertEqual(deleted_objs_count, 2)
         self.assertCacheNotPopulated()
 
diff --git a/tests/test_util.py b/tests/test_util.py
@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 from datetime import datetime
 
-from django.http import parse_cookie
 from django.test import TestCase
 from django.test.client import RequestFactory
 from django.test.utils import override_settings
diff --git a/tox.ini b/tox.ini
@@ -2,9 +2,7 @@
 envlist =
     py{310,311,312}-django{42,51,52}
     py{313}-django{51,52}
-    isort
-    black
-    ; flake8
+    ruff
     docs
 skip_missing_interpreters = true
 
@@ -52,20 +50,12 @@ commands =
    --cov --cov-report xml:reports/coverage-{envname}.xml \
    {posargs}
 
-[testenv:isort]
+[testenv:ruff]
 extras = tests
 skipsdist = True
-commands = isort --check-only --diff .
-
-[testenv:black]
-extras = tests
-skipsdist = True
-commands = black --check cookie_consent docs tests testapp
-
-[testenv:flake8]
-extras = tests
-skipsdist = True
-commands = flake8 .
+commands =
+    ruff check --output-format=github .
+    ruff format --check
 
 [testenv:docs]
 basepython=python

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`
`6`	`6`	`class Migration(migrations.Migration):`
`7`		`-`
`8`	`7`	`dependencies = [`
`9`	`8`	`("cookie_consent", "0003_alter_cookiegroup_varname"),`
`10`	`9`	`]`