Update project settings

fsbraun · fsbraun · commit 5f8bd34e0d53 · 2024-11-10T17:23:23.000+01:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -12,12 +12,12 @@ repos:
       rev: v3.19.0
       hooks:
           - id: pyupgrade
-            args: ["--py37-plus"]
+            args: ["--py39-plus"]
     - repo: https://github.com/adamchainz/django-upgrade
       rev: "1.22.1"
       hooks:
           - id: django-upgrade
-            args: [--target-version, "2.2"]
+            args: [--target-version, "4.2"]
     - repo: https://github.com/pycqa/isort
       rev: 5.13.2
       hooks:
@@ -28,9 +28,9 @@ repos:
       hooks:
           - id: flake8
             additional_dependencies:
+                - flake8-pyproject
                 - flake8-bugbear
                 - flake8-builtins
                 - flake8-django
                 - flake8-length
                 - flake8-logging-format
-                - flake8-spellcheck
diff --git a/djangocms_frontend/common/__init__.py b/djangocms_frontend/common/__init__.py
@@ -5,11 +5,19 @@
 from .attributes import AttributesMixin
 from .title import TitleFormMixin, TitleMixin
 
+
 __common = {
     "background": ("BackgroundFormMixin", "BackgroundMixin"),
     "responsive": ("ResponsiveFormMixin", "ResponsiveMixin"),
     "sizing": ("SizingFormMixin", "SizingMixin"),
-    "spacing": ("SpacingFormMixin", "SpacingMixin", "MarginFormMixin", "MarginMixin", "PaddingFormMixin", "PaddingMixin"),
+    "spacing": (
+        "SpacingFormMixin",
+        "SpacingMixin",
+        "MarginFormMixin",
+        "MarginMixin",
+        "PaddingFormMixin",
+        "PaddingMixin",
+    ),
 }
 
 for module, classes in __common.items():
diff --git a/djangocms_frontend/contrib/navigation/cms_plugins.py b/djangocms_frontend/contrib/navigation/cms_plugins.py
@@ -1,6 +1,7 @@
-from cms.plugin_pool import plugin_pool
 from django.utils.translation import gettext_lazy as _
 
+from cms.plugin_pool import plugin_pool
+
 from ... import settings
 from ...cms_plugins import CMSUIPlugin
 from ...common import AttributesMixin, BackgroundMixin
@@ -9,6 +10,7 @@
 from ..link.cms_plugins import LinkPluginMixin, TextLinkPlugin
 from . import forms, models
 
+
 mixin_factory = settings.get_renderer(navigation)
 
 default_template = first_choice(settings.NAVIGATION_TEMPLATE_CHOICES)
@@ -176,7 +178,8 @@ class NavLinkPlugin(
     - `module` (str): The module where the plugin belongs, displayed in the plugin list when editing a page.
     - `model` (Model): The Django model used to store the plugin's data.
     - `form` (Form): The form used to render the plugin's settings in the admin interface.
-    - `change_form_template` (str): The path to the template used to render the plugin's change form in the admin interface.
+    - `change_form_template` (str): The path to the template used to render the plugin's change form in the admin
+      interface.
     - `allow_children` (bool): Whether the plugin allows having child plugins.
     - `parent_classes` (list): List of parent plugin classes that this plugin can be nested within.
     - `child_classes` (list): List of child plugin classes that can be nested within this plugin.
diff --git a/djangocms_frontend/helpers.py b/djangocms_frontend/helpers.py
@@ -1,9 +1,6 @@
 import copy
 import decimal
 
-from cms.constants import SLUG_REGEXP
-from cms.plugin_base import CMSPluginBase
-from cms.utils.conf import get_cms_setting
 from django.apps import apps
 from django.contrib.admin.helpers import AdminForm
 from django.db.models import ObjectDoesNotExist
@@ -15,6 +12,10 @@
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
+from cms.constants import SLUG_REGEXP
+from cms.plugin_base import CMSPluginBase
+from cms.utils.conf import get_cms_setting
+
 from djangocms_frontend import settings
 from djangocms_frontend.settings import FRAMEWORK_PLUGIN_INFO
 
@@ -33,6 +34,7 @@ def get_related_object(scope, field_name):
 
 class get_related:
     """Descriptor lazily getting related objects from the config dict."""
+
     def __init__(self, key):
         self.key = key
 
@@ -74,12 +76,12 @@ def insert_fields(fieldsets, new_fields, block=None, position=-1, blockname=None
         modify[1]["fields"] = (
             list(fields[: position + 1] if position != -1 else fields)
             + list(new_fields)
-            + list(fields[position + 1 :] if position != -1 else [])
+            + list(fields[position + 1:] if position != -1 else [])
         )
     fs = (
         list(fieldsets[:block] if block != -1 else fieldsets)
         + [modify]
-        + list(fieldsets[block + 1 :] if block != -1 else [])
+        + list(fieldsets[block + 1:] if block != -1 else [])
     )
     return fs
 
@@ -165,6 +167,7 @@ class FrontendEditableAdminMixin:
     in the frontend by double-clicking on fields rendered with the ``render_model`` template
     tag.
     """
+
     frontend_editable_fields = []
 
     def get_urls(self):  # pragma: no cover
@@ -177,7 +180,7 @@ def pat(regex, fn):
             return re_path(regex, self.admin_site.admin_view(fn), name=f"{info}_{fn.__name__}")
 
         url_patterns = [
-            pat(r'edit-field/(%s)/([a-z\-]+)/$' % SLUG_REGEXP, self.edit_field),
+            pat(r"edit-field/(%s)/([a-z\-]+)/$" % SLUG_REGEXP, self.edit_field),
         ]
         return url_patterns + super().get_urls()
 
@@ -203,58 +206,53 @@ def edit_field(self, request, object_id, language):
         raw_fields = request.GET.get("edit_fields")
         fields = [field for field in raw_fields.split(",") if field in self.frontend_editable_fields]
         if not fields:
-            context = {
-                'opts': opts,
-                'message': _("Field %s not found") % raw_fields
-            }
-            return render(request, 'admin/cms/page/plugin/error_form.html', context)
+            context = {"opts": opts, "message": _("Field %s not found") % raw_fields}
+            return render(request, "admin/cms/page/plugin/error_form.html", context)
         if not request.user.has_perm(f"{self.model._meta.app_label}.change_{self.model._meta.model_name}"):
-            context = {
-                'opts': opts,
-                'message': _("You do not have permission to edit this item")
-            }
-            return render(request, 'admin/cms/page/plugin/error_form.html', context)
+            context = {"opts": opts, "message": _("You do not have permission to edit this item")}
+            return render(request, "admin/cms/page/plugin/error_form.html", context)
             # Dynamically creates the form class with only `field_name` field
         # enabled
         form_class = self.get_form(request, obj, fields=fields)
-        if not cancel_clicked and request.method == 'POST':
+        if not cancel_clicked and request.method == "POST":
             form = form_class(instance=obj, data=request.POST)
             if form.is_valid():
                 new_object = form.save(commit=False)
                 self.save_model(request, new_object, form, change=True)
                 saved_successfully = True
         else:
             form = form_class(instance=obj)
-        admin_form = AdminForm(form, fieldsets=[(None, {'fields': fields})], prepopulated_fields={},
-                               model_admin=self)
+        admin_form = AdminForm(form, fieldsets=[(None, {"fields": fields})], prepopulated_fields={}, model_admin=self)
         media = self.media + admin_form.media
         context = {
-            'CMS_MEDIA_URL': get_cms_setting('MEDIA_URL'),
-            'title': opts.verbose_name,
-            'plugin': None,
-            'plugin_id': None,
-            'adminform': admin_form,
-            'add': False,
-            'is_popup': True,
-            'media': media,
-            'opts': opts,
-            'change': True,
-            'save_as': False,
-            'has_add_permission': False,
-            'window_close_timeout': 10,
+            "CMS_MEDIA_URL": get_cms_setting("MEDIA_URL"),
+            "title": opts.verbose_name,
+            "plugin": None,
+            "plugin_id": None,
+            "adminform": admin_form,
+            "add": False,
+            "is_popup": True,
+            "media": media,
+            "opts": opts,
+            "change": True,
+            "save_as": False,
+            "has_add_permission": False,
+            "window_close_timeout": 10,
         }
         if cancel_clicked:
             # cancel button was clicked
-            context.update({
-                'cancel': True,
-            })
-            return render(request, 'admin/cms/page/plugin/confirm_form.html', context)
-        if not cancel_clicked and request.method == 'POST' and saved_successfully:
+            context.update(
+                {
+                    "cancel": True,
+                }
+            )
+            return render(request, "admin/cms/page/plugin/confirm_form.html", context)
+        if not cancel_clicked and request.method == "POST" and saved_successfully:
             if isinstance(self, CMSPluginBase):
-                if hasattr(obj.placeholder, 'mark_as_dirty'):
+                if hasattr(obj.placeholder, "mark_as_dirty"):
                     # Only relevant for v3: mark the placeholder as dirty so user can publish changes
                     obj.placeholder.mark_as_dirty(obj.language, clear_cache=False)
                 # Update the structure board by populating the data bridge
                 return self.render_close_frame(request, obj)
-            return render(request, 'admin/cms/page/plugin/confirm_form.html', context)
-        return render(request, 'admin/cms/page/plugin/change_form.html', context)
+            return render(request, "admin/cms/page/plugin/confirm_form.html", context)
+        return render(request, "admin/cms/page/plugin/change_form.html", context)
diff --git a/djangocms_frontend/management/bootstrap4_migration.py b/djangocms_frontend/management/bootstrap4_migration.py
@@ -1,4 +1,5 @@
 from django.conf import settings as django_setting
+
 from djangocms_bootstrap4.constants import DEVICE_SIZES
 
 from djangocms_frontend import settings
@@ -305,7 +306,7 @@ def replace(item, old, new):
 
         def replace_left(item, old, new):
             if item[: len(old)] == old:
-                return new + item[len(old) :]
+                return new + item[len(old):]
             return item
 
         classes = new_obj.attributes["class"].split()
@@ -361,7 +362,7 @@ def a001_alignment(obj, new_obj, field):
         new_obj.config[field].replace("text-right", "end")
 
 
-def m001_spacing_mixin(obj, new_obj, type):
+def m001_spacing_mixin(obj, new_obj, type):  # noqa: A002
     classes = new_obj.config["attributes"].get("class", "").split()
     if classes:
         for size, _ in list(settings.SPACER_SIZE_CHOICES) + ([("auto", "auto")] if type == "margin" else []):
@@ -404,7 +405,7 @@ def m002_responsive_mixin(obj, new_obj):
                 visible = False
                 hit = True
                 classes.remove(f"{stump}{hidden}")
-            for type in display:
+            for type in display:  # noqa: A001
                 if f"{stump}{type}" in classes and not visible:
                     visible = True
                     hit = True
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,3 +33,51 @@ lint.select = [
     "F",
     "W",
 ]
+
+[tool.isort]
+line_length = 119
+skip = [
+  "manage.py",
+  "*migrations*",
+  ".tox",
+  ".eggs",
+  ".env",
+  ".venv",
+  "data",
+]
+include_trailing_comma = true
+multi_line_output = 5
+lines_after_imports = 2
+default_section = "THIRDPARTY"
+sections = [
+  "FUTURE",
+  "STDLIB",
+  "DJANGO",
+  "CMS",
+  "THIRDPARTY",
+  "FIRSTPARTY",
+  "LOCALFOLDER",
+]
+known_first_party = "djangocms_link"
+known_cms = [ "cms", "menus" ]
+known_django = "django"
+
+[tool.flake8]
+max-line-length = 120
+exclude = [
+  "*.egg-info",
+  ".eggs",
+  ".env",
+  ".git",
+  ".settings",
+  ".tox",
+  ".venv",
+  "build",
+  "data",
+  "dist",
+  "docs",
+  "*migrations*",
+  "requirements",
+  "tmp",
+]
+
diff --git a/setup.cfg b/setup.cfg
