Switch to using ruff

Author: zerolab

.pre-commit-config.yaml

@@ -1,8 +1,6 @@
 ci:
   autofix_prs: false
 
-default_language_version:
-  python: python3.8
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
@@ -18,22 +16,15 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.3.0
     hooks:
       - id: black
-  - repo: https://github.com/pycqa/isort
-    # isort config is in pyproject.toml
-    rev: 5.11.5
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.0.270
     hooks:
-      - id: isort
-  - repo: https://github.com/pycqa/flake8
-    # flake8 config is in setup.cfg
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear
-          - flake8-comprehensions
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/mgedmin/check-manifest
     rev: "0.49"
     hooks:
@@ -43,4 +34,4 @@ repos:
     rev: v1.12.1
     hooks:
       - id: blacken-docs
-        additional_dependencies: [black==22.8.0]
+        additional_dependencies: [black==23.3.0]

manage.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 import os
 import sys
 

pyproject.toml

@@ -1,13 +1,20 @@
 [tool.black]
 target-version = ["py38"]
 
-[tool.isort]
-profile = "black"
-known_django = "django"
-known_wagtail = "wagtail"
-known_first_party = ['wagtail-headless-preview']
-sections = ['FUTURE', 'STDLIB', 'DJANGO', 'WAGTAIL', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER']
-skip=['migrations', '.git', '__pycache__', 'venv', '.venv', '.github', '.tox', 'build', 'dist']
-blocked_extensions=["rst", "html", "js", "svg", "txt", "css", "scss", "png", "sh"]
-lines_between_types = 1
-lines_after_imports = 2
+[tool.ruff]
+target-version = "py38"
+select = [
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+    "S",  # flake8-bandit
+    "W",  # pycodestyle warnings
+    "UP", # pyupgrade
+]
+
+[tool.ruff.isort]
+known-first-party = ["wagtail-headless-preview"]
+lines-between-types = 1
+lines-after-imports = 2

setup.py

@@ -20,7 +20,7 @@
     author_email="[email protected]",
     url="https://github.com/torchbox/wagtail-headless-preview",
     project_urls={
-        "Changelog": "https://github.com/torchbox/wagtail-headless-preview/blob/main/CHANGELOG.md",  # noqa:B950
+        "Changelog": "https://github.com/torchbox/wagtail-headless-preview/blob/main/CHANGELOG.md",  # noqa:B950 E501
     },
     packages=find_packages(where="src"),
     package_dir={"": "src"},

src/wagtail_headless_preview/migrations/0001_initial.py

@@ -1,11 +1,11 @@
 # Generated by Django 2.1.5 on 2019-03-19 14:21
 
-from django.db import migrations, models
 import django.db.models.deletion
 
+from django.db import migrations, models
+
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [("contenttypes", "0002_remove_content_type_name")]

src/wagtail_headless_preview/models.py

@@ -80,8 +80,8 @@ def create_page_preview(self):
             identifier = f"id={self.pk}"
 
         token = self.get_preview_signer().sign(identifier)
-        # Note: Using update_page_preview() instead of just create() to avoid unique constraint
-        # failures if preview is clicked multiple times
+        # Note: Using update_page_preview() instead of just create() to avoid
+        # unique constraint failures if preview is clicked multiple times
         preview, _ = self.update_page_preview(token)
 
         return preview
@@ -132,8 +132,9 @@ def serve(self, request):
         Mixin overriding the default serve method with a redirect.
         The URL of the requested page is kept the same, only the host is
         overridden.
-        By default this uses the hosts defined in HEADLESS_PREVIEW_CLIENT_URLS.
-        However, you can enforce a single host using  the HEADLESS_SERVE_BASE_URL setting.
+        By default, this uses the hosts defined in HEADLESS_PREVIEW_CLIENT_URLS.
+        However, you can enforce a single host using the HEADLESS_SERVE_BASE_URL
+        setting.
         """
         if headless_preview_settings.SERVE_BASE_URL:
             base_url = headless_preview_settings.SERVE_BASE_URL

src/wagtail_headless_preview/settings.py

@@ -1,5 +1,7 @@
 """
-The wagtail_headless_preview settings are namespaced in the WAGTAIL_HEADLESS_PREVIEW setting.
+The wagtail_headless_preview settings are namespaced in the
+WAGTAIL_HEADLESS_PREVIEW setting.
+
 For example your project's `settings.py` file might look like this:
 WAGTAIL_HEADLESS_PREVIEW = {
     "CLIENT_URLS": {"default": "https://headless.site"},
@@ -30,8 +32,8 @@
 
 class WagtailHeadlessPreviewSettings:
     """
-    A settings object that allows the wagtail_headless_preview settings to be accessed as
-    properties. For example:
+    A settings object that allows the wagtail_headless_preview settings to be
+    accessed as properties. For example:
         from wagtail_headless_previews.settings import headless_preview_settings
         print(headless_preview_settings.CLIENT_URLS)
     Note:

tests/settings.py

@@ -5,7 +5,7 @@
 
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 
-SECRET_KEY = "fake_secret_key_to_run_tests"  # pragma: allowlist secret
+SECRET_KEY = "fake_secret_key_to_run_tests"  # noqa: S105
 
 INSTALLED_APPS = [
     "tests.testapp",

tests/test_frontend.py

@@ -2,21 +2,22 @@
 from django.test import TestCase, override_settings
 from django.urls import reverse
 from django.utils.http import urlencode
-
 from wagtail.models import Page
-
-from tests.testapp.models import HeadlessPage, SimplePage
 from wagtail_headless_preview.models import PagePreview
 from wagtail_headless_preview.settings import headless_preview_settings
 
+from tests.testapp.models import HeadlessPage, SimplePage
+
 
 class TestFrontendViews(TestCase):
     fixtures = ["test.json"]
 
     @classmethod
     def setUpTestData(cls):
         cls.admin_user = User.objects.create_superuser(
-            username="admin", email="[email protected]", password="password"
+            username="admin",
+            email="[email protected]",
+            password="password",  # noqa: S106
         )
 
         cls.homepage = Page.objects.get(url_path="/home/").specific
@@ -30,7 +31,9 @@ def setUpTestData(cls):
         cls.page.save_revision()
 
     def setUp(self):
-        self.client.login(username=self.admin_user.username, password="password")
+        self.client.login(
+            username=self.admin_user.username, password="password"  # noqa: S106
+        )
 
     def test_view(self):
         self.assertEqual(PagePreview.objects.count(), 0)
@@ -117,7 +120,9 @@ class TestHeadlessRedirectMixin(TestCase):
     @classmethod
     def setUpTestData(cls):
         cls.admin_user = User.objects.create_superuser(
-            username="admin", email="[email protected]", password="password"
+            username="admin",
+            email="[email protected]",
+            password="password",  # noqa: S106
         )
 
         cls.homepage = Page.objects.get(url_path="/home/").specific

tests/test_settings.py

@@ -1,7 +1,6 @@
 from unittest.mock import patch
 
 from django.test import TestCase, override_settings
-
 from wagtail_headless_preview.deprecation import pending_deprecation_warning
 from wagtail_headless_preview.settings import (
     DEFAULTS,
@@ -68,10 +67,10 @@ def test_warning_raised_on_deprecated_setting(self):
                 )
 
     def test_runtime_error_raised_on_removed_setting(self):
-
         msg = (
             "The 'HEADLESS_PREVIEW_CLIENT_URLS' setting has been removed. "
-            "Please refer to the wagtail_headless_preview documentation for available settings."
+            "Please refer to the wagtail_headless_preview documentation for "
+            "available settings."
         )
         with self.assertRaisesMessage(RuntimeError, msg):
             WagtailHeadlessPreviewSettings(