fix: inline editing crashed for plugin template tags (#260)

fsbraun · web-flow · commit 1e6d2c2f69d2 · 2025-03-20T17:17:05.000+01:00
diff --git a/djangocms_frontend/common/attributes.py b/djangocms_frontend/common/attributes.py
@@ -36,4 +36,5 @@ class Meta:
                 "attributes",
             ]
         }
+
     attributes = AttributesFormField()
diff --git a/djangocms_frontend/component_base.py b/djangocms_frontend/component_base.py
@@ -50,9 +50,16 @@ class CMSFrontendComponent(forms.Form):
     _admin_form = None
     _model = None
     _plugin = None
-    META_FIELDS = ["is_local", "disable_edit", "disable_child_plugins", "show_add_form",
-                   "frontend_editable_fields", "link_fieldset_position", "require_parent",
-                   "parent_classes"]
+    META_FIELDS = [
+        "is_local",
+        "disable_edit",
+        "disable_child_plugins",
+        "show_add_form",
+        "frontend_editable_fields",
+        "link_fieldset_position",
+        "require_parent",
+        "parent_classes",
+    ]
 
     @classmethod
     def admin_form_factory(cls, **kwargs) -> type:
@@ -149,7 +156,8 @@ def plugin_factory(cls) -> type:
                     "slots": slots,
                     "save_model": cls.save_model,
                     **{
-                        field: getattr(cls._component_meta, field) for field in cls.META_FIELDS
+                        field: getattr(cls._component_meta, field)
+                        for field in cls.META_FIELDS
                         if hasattr(cls._component_meta, field)
                     },
                     **(
diff --git a/djangocms_frontend/contrib/carousel/forms.py b/djangocms_frontend/contrib/carousel/forms.py
@@ -106,14 +106,14 @@ class Meta:
         label=_("Wrap"),
         initial=True,
         required=False,
-        help_text=_("Whether the carousel should cycle continuously or have " "hard stops."),
+        help_text=_("Whether the carousel should cycle continuously or have hard stops."),
     )
     carousel_aspect_ratio = forms.ChoiceField(
         label=_("Aspect ratio"),
         choices=settings.EMPTY_CHOICE + CAROUSEL_ASPECT_RATIO_CHOICES,
         required=False,
         initial=settings.EMPTY_CHOICE[0][0],
-        help_text=_("Determines width and height of the image " "according to the selected ratio."),
+        help_text=_("Determines width and height of the image according to the selected ratio."),
     )
     carousel_transition = forms.ChoiceField(
         label=_("Transition"),
diff --git a/djangocms_frontend/contrib/content/models.py b/djangocms_frontend/contrib/content/models.py
@@ -15,7 +15,7 @@ class Meta:
         verbose_name = _("Code block")
 
     def get_short_description(self):
-        return f'<{self.config.get("code_type", CODE_TYPE_CHOICES[0][0])}>'
+        return f"<{self.config.get('code_type', CODE_TYPE_CHOICES[0][0])}>"
 
 
 class Blockquote(FrontendUIItem):
diff --git a/djangocms_frontend/contrib/grid/forms.py b/djangocms_frontend/contrib/grid/forms.py
@@ -179,7 +179,7 @@ def clean(self):
                     self.cleaned_data[f"{size}_col"] = int(self.cleaned_data[f"{size}_col"])
             else:
                 raise ValidationError(
-                    _('Column size needs to be empty, "auto", or a ' "number between 1 and %(cols)d"),
+                    _('Column size needs to be empty, "auto", or a number between 1 and %(cols)d'),
                     params=dict(cols=GRID_SIZE),
                     code="invalid_column",
                 )
diff --git a/djangocms_frontend/contrib/grid/models.py b/djangocms_frontend/contrib/grid/models.py
@@ -68,7 +68,7 @@ class Meta:
     def get_short_description(self):
         text = self.config.get("plugin_title", {}).get("title", "") or self.config.get("attributes", {}).get("id", "")
 
-        if self.config.get('xs_col'):
+        if self.config.get("xs_col"):
             text += f" (col-{self.xs_col}) "
         else:
             text += " (auto) "
diff --git a/djangocms_frontend/contrib/image/forms.py b/djangocms_frontend/contrib/image/forms.py
@@ -120,13 +120,13 @@ class Meta:
         label=_("Width"),
         required=False,
         min_value=1,
-        help_text=_("The image width as number in pixels. " 'Example: "720" and not "720px".'),
+        help_text=_('The image width as number in pixels. Example: "720" and not "720px".'),
     )
     height = forms.IntegerField(
         label=_("Height"),
         required=False,
         min_value=1,
-        help_text=_("The image height as number in pixels. " 'Example: "720" and not "720px".'),
+        help_text=_('The image height as number in pixels. Example: "720" and not "720px".'),
     )
     alignment = forms.ChoiceField(
         label=_("Alignment"),
@@ -210,9 +210,7 @@ def clean(self):
         data = self.cleaned_data
         # you shall only set one image kind
         if not data.get("picture", False) and not data.get("external_picture", False):
-            raise forms.ValidationError(
-                _("You need to add either an image, " "or a URL linking to an external image.")
-            )
+            raise forms.ValidationError(_("You need to add either an image, or a URL linking to an external image."))
 
         # certain cropping options do not work together, the following
         # list defines the disallowed options used in the ``clean`` method
@@ -234,7 +232,7 @@ def clean(self):
                 break
 
         if invalid_option_pair:
-            message = _("Invalid cropping settings. " 'You cannot combine "{field_a}" with "{field_b}".')
+            message = _('Invalid cropping settings. You cannot combine "{field_a}" with "{field_b}".')
             message = message.format(
                 field_a=self.fields[invalid_option_pair[0]].label,
                 field_b=self.fields[invalid_option_pair[0]].label,
diff --git a/djangocms_frontend/contrib/link/cms_plugins.py b/djangocms_frontend/contrib/link/cms_plugins.py
@@ -37,11 +37,7 @@
 
 class LinkPluginMixin:
     link_fieldset_position = None
-    link_fields = (
-        (("site", "url_grouper"),)
-        if apps.is_installed("djangocms_url_manager")
-        else ("link", "target")
-    )
+    link_fields = (("site", "url_grouper"),) if apps.is_installed("djangocms_url_manager") else ("link", "target")
 
     def render(self, context, instance, placeholder):
         if "request" in context:
diff --git a/djangocms_frontend/contrib/link/helpers.py b/djangocms_frontend/contrib/link/helpers.py
@@ -27,10 +27,12 @@ def get_link(self) -> str:
             if not url_grouper:
                 return ""
             from djangocms_url_manager.models import Url
+
             url = Url.objects.filter(url_grouper=url_grouper).order_by("pk").last()
             if not url:  # pragma: no cover
                 return ""
             return url.get_absolute_url() or ""
 
         from djangocms_link.helpers import get_link as djangocms_link_get_link
+
         return djangocms_link_get_link(self.config.get("link", {}), Site.objects.get_current().pk) or ""
diff --git a/djangocms_frontend/contrib/navigation/models.py b/djangocms_frontend/contrib/navigation/models.py
@@ -15,7 +15,7 @@ class Meta:
         verbose_name = _("Navigation")
 
     def get_short_description(self):
-        return f'({self.config.get("navbar_design", "-")})'
+        return f"({self.config.get('navbar_design', '-')})"
 
 
 class NavContainer(FrontendUIItem):
diff --git a/djangocms_frontend/contrib/utilities/forms.py b/djangocms_frontend/contrib/utilities/forms.py
@@ -62,7 +62,7 @@ def clean(self):
             raise ValidationError(
                 {
                     "space_property": _(
-                        "Padding does not have an auto spacing. Either " "switch to margin or a defined size."
+                        "Padding does not have an auto spacing. Either switch to margin or a defined size."
                     ),
                     "space_size": _(
                         "Padding does not have an auto spacing. Either "
diff --git a/djangocms_frontend/management/commands/subcommands/migrate.py b/djangocms_frontend/management/commands/subcommands/migrate.py
@@ -167,7 +167,7 @@ def handle(self, *args, **options):
         if "djangocms_frontend_frontenduiitem" not in tables:
             self.stdout.write(
                 self.style.ERROR(
-                    "I cannot find djangocms-frontend's tables in the database. Did you run\n" "./manage.py migrate ?"
+                    "I cannot find djangocms-frontend's tables in the database. Did you run\n./manage.py migrate ?"
                 )
             )
             return
diff --git a/djangocms_frontend/management/icon_migration.py b/djangocms_frontend/management/icon_migration.py
@@ -85,7 +85,7 @@ def i001_icon(obj, new_obj):
         "libraryName": "fontAwesome",
         "iconHtml": f'<i class="{library} {" ".join(classes)}"></i>',
         "iconMarkup": "&",
-        "iconClass": f'{library} {" ".join(classes)}',
+        "iconClass": f"{library} {' '.join(classes)}",
         "iconText": "",
         "library": "font-awesome",
     }
diff --git a/djangocms_frontend/plugin_tag.py b/djangocms_frontend/plugin_tag.py
@@ -91,7 +91,9 @@ def setup():
                 }
             else:  # pragma: no cover
                 warnings.warn(
-                    f"Duplicate candidates for {{% plugin \"{tag_name}\" %}} found. "
-                    f"Only registered {plugin_tag_pool[tag_name]['class'].__name__}.", stacklevel=1)
+                    f'Duplicate candidates for {{% plugin "{tag_name}" %}} found. '
+                    f"Only registered {plugin_tag_pool[tag_name]['class'].__name__}.",
+                    stacklevel=1,
+                )
         except Exception as exc:  # pragma: no cover
             warnings.warn(f"{plugin.__name__}: \n{str(exc)}", stacklevel=1)
diff --git a/djangocms_frontend/templatetags/frontend.py b/djangocms_frontend/templatetags/frontend.py
@@ -165,8 +165,10 @@ def get_value(self, context, name, kwargs, nodelist):
         from djangocms_frontend.plugin_tag import plugin_tag_pool
 
         if name not in plugin_tag_pool:
-            return self.message(f'To use "{name}" with the {{% plugin %}} template tag, add its plugin class to '
-                                f'the CMS_COMPONENT_PLUGINS setting')
+            return self.message(
+                f'To use "{name}" with the {{% plugin %}} template tag, add its plugin class to '
+                f"the CMS_COMPONENT_PLUGINS setting"
+            )
         context.push()
         instance = plugin_tag_pool[name]["defaults"]
         plugin_class = plugin_tag_pool[name]["class"]
@@ -179,8 +181,8 @@ def get_value(self, context, name, kwargs, nodelist):
                         if isinstance(value, models.Model):
                             # Correctly encode references
                             value = {
-                                'model': f'{value._meta.app_label}.{value._meta.model_name}',
-                                'pk': value.pk,
+                                "model": f"{value._meta.app_label}.{value._meta.model_name}",
+                                "pk": value.pk,
                             }
                         instance[container][field] = value
                         break
@@ -255,29 +257,34 @@ def render_tag(self, context, instance, plugin_type, nodelist):
 
 
 class InlineField(CMSEditableObject):
-    name = 'inline_field'
+    name = "inline_field"
     options = Options(
-        Argument('instance'),
-        Argument('attribute'),
-        Argument('language', default=None, required=False),
-        Argument('filters', default=None, required=False),
-        Argument('view_url', default=None, required=False),
-        Argument('view_method', default=None, required=False),
-        'as',
-        Argument('varname', required=False, resolve=False),
+        Argument("instance"),
+        Argument("attribute"),
+        Argument("language", default=None, required=False),
+        Argument("filters", default=None, required=False),
+        Argument("view_url", default=None, required=False),
+        Argument("view_method", default=None, required=False),
+        "as",
+        Argument("varname", required=False, resolve=False),
     )
 
     def render_tag(self, context, **kwargs):
-        if context["request"].session.get("inline_editing", True) and isinstance(kwargs["instance"], CMSPlugin):
+        if (
+            context["request"].session.get("inline_editing", True)
+            and isinstance(kwargs["instance"], CMSPlugin)
+            and kwargs["instance"].pk
+        ):
             # Only allow inline field to be rendered if inline editing is active and the instance is a CMSPlugin
-            # DummyPlugins of the ``plugin`` tag are cannot be edited
+            # DummyPlugins of the ``plugin`` tag are cannot be edited (they have no pk in their model class)
             kwargs["edit_fields"] = kwargs["attribute"]
             return super().render_tag(context, **kwargs)
         else:
             return getattr(kwargs["instance"], kwargs["attribute"], "")
 
-    def _get_editable_context(self, context, instance, language, edit_fields,
-                              view_method, view_url, querystring, editmode=True):
+    def _get_editable_context(
+        self, context, instance, language, edit_fields, view_method, view_url, querystring, editmode=True
+    ):
         # Fix a not-so-clean solution in django CMS' core: While the template engine checks if an attribute is
         # callable, python expects get_plugin_name to be a method. This is a workaround to make it a method.
         context = super()._get_editable_context(
diff --git a/djangocms_frontend/ui_plugin_base.py b/djangocms_frontend/ui_plugin_base.py
@@ -48,7 +48,7 @@ def pat(regex, fn):
                 return re_path(regex, fn, name=f"{info}_{fn.__name__}")
 
             return [
-                pat(r'edit-field/([0-9]+)/([a-z\-]+)/$', self.edit_field),
+                pat(r"edit-field/([0-9]+)/([a-z\-]+)/$", self.edit_field),
             ] + super().get_plugin_urls()
 
         def _get_object_for_single_field(self, object_id, language):
diff --git a/docs/source/how-to/use-frontend-as-component.rst b/docs/source/how-to/use-frontend-as-component.rst
@@ -98,3 +98,32 @@ use the ``{% plugin %}`` template tag with each plugin.
     Currently, ``{% placeholder %}`` template tags are not supported inside
     a ``{% plugin %}`` tag. This is because the ``{% plugin %}`` tag does
     preprocess the content and placeholders are not recognized by django CMS.
+
+Multi-line tags
+===============
+
+Multi-line tags are not supported in Django templates. For components with many
+parameters this can lead to long lines of code. To make the code more readable
+you can use the following patch (to be executed, for example during your project's
+``AppConfig.ready()`` method):
+
+.. code-block:: python
+
+    import re
+    from django.template import base
+
+    base.tag_re = re.compile(base.tag_re.pattern, re.DOTALL)
+
+This will patch the Django template engine **for all templates rendered by it
+within your project.** It will however allow templates like this:
+
+.. code-block:: django
+
+    {% plugin "card"
+        card_alignment="center"
+        card_outline="info"
+        card_text_color="primary"
+        card_full_height=True %}
+        ...
+    {% endplugin %}
+

Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,5 @@ class Meta:`
`36`	`36`	`"attributes",`
`37`	`37`	`]`
`38`	`38`	`}`
	`39`	`+`
`39`	`40`	`attributes = AttributesFormField()`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ def clean(self):`
`179`	`179`	`self.cleaned_data[f"{size}_col"] = int(self.cleaned_data[f"{size}_col"])`
`180`	`180`	`else:`
`181`	`181`	`raise ValidationError(`
`182`		`- _('Column size needs to be empty, "auto", or a ' "number between 1 and %(cols)d"),`
	`182`	`+ _('Column size needs to be empty, "auto", or a number between 1 and %(cols)d'),`
`183`	`183`	`params=dict(cols=GRID_SIZE),`
`184`	`184`	`code="invalid_column",`
`185`	`185`	`)`