feincms3 5.4

Author: matthiask

CHANGELOG.rst

@@ -6,6 +6,10 @@ Change log
 Next version
 ~~~~~~~~~~~~
 
+
+5.4 (2025-06-19)
+~~~~~~~~~~~~~~~~
+
 - Added Django 5.2 to the CI.
 - Undeprecated the :mod:`~feincms3.mixins.TemplateMixin`, it's useful even
   though using :mod:`~feincms3.applications.PageTypeMixin` is obviously
@@ -17,6 +21,8 @@ Next version
   Sections are a more powerful alternative or addition to subregions already
   supported by django-content-editor. The main upside of sections is that they
   can be nested.
+- Allowed passing a list of plugins to ``RegionRenderer.register``. This is
+  useful if registering several plugins with identical renderers etc.
 
 
 5.3 (2024-11-18)

feincms3/__init__.py

@@ -1 +1 @@
-__version__ = "5.3.1"
+__version__ = "5.4.0"

feincms3/renderer.py

@@ -83,7 +83,7 @@ def template_renderer(template_name, local_context=default_context, /):
 _subregion = 2
 _marks = 3
 _fetch = 4
-CLOSE_SECTION = "__close_section__"
+_CLOSE_SECTION = "_close_section"
 
 
 class RegionRenderer:
@@ -184,13 +184,17 @@ def register(
                 f"The renderer function {renderer} has less than the two required arguments."
             )
 
-        if plugin in self._plugins:
-            warnings.warn(
-                f"The plugin {plugin} has already been registered with {self.__class__} before.",
-                stacklevel=2,
-            )
+        if not isinstance(plugin, (list, tuple)):
+            plugin = [plugin]
+
+        for p in plugin:
+            if p in self._plugins:
+                warnings.warn(
+                    f"The plugin {p} has already been registered with {self.__class__} before.",
+                    stacklevel=2,
+                )
 
-        self._plugins[plugin] = (plugin, renderer, subregion, marks, fetch)
+            self._plugins[p] = (p, renderer, subregion, marks, fetch)
 
     def plugins(self, *, fetch=True):
         """
@@ -295,9 +299,6 @@ def handle_default(self, plugins, context):
         for plugin in self.takewhile_subregion(plugins, "default"):
             yield self.render_plugin(plugin, context)
 
-    def handle___close_section__(self, plugins, context):
-        yield self.render_plugin(plugins.popleft(), context)
-
     def render_region(self, *, region, contents, context):
         """
         Render one region.
@@ -334,7 +335,7 @@ def render_section_plugins(self, section, plugins, context):
         .. code-block:: python
 
             from django.utils.html import mark_safe
-            from feincms3.renderer import CLOSE_SECTION, render_in_context
+            from feincms3.renderer import render_in_context
 
             class SectionRenderer(RegionRenderer):
                 def handle_section(self, plugins, context):
@@ -348,22 +349,22 @@ def handle_section(self, plugins, context):
                     )
 
             renderer = SectionRenderer()
-            renderer.register(models.CloseSection, "", subregion=CLOSE_SECTION)
+            renderer.register_section_close(models.CloseSection)
             renderer.register(models.Accordion, "", subregion="section")
 
         This code automatically determines the template name from the class
         name, making it easier to reuse for different section types.
 
         Subregions are automatically closed when subregions change. Sections
-        only end when encountering an explicit ``CLOSE_SECTION`` subregion or
-        when there are no more plugins in the current region at all. Sections
-        can contain other sections and subregions making them quite powerful
-        when for organizing and grouping content.
+        only end when encountering an explicit section closing plugin or when
+        there are no more plugins in the current region at all. Sections can
+        contain other sections and subregions making them quite powerful when
+        for organizing and grouping content.
         """
         out = []
         while plugins:
             subregion = self.subregion(plugins[0])
-            if subregion == CLOSE_SECTION:
+            if subregion is _CLOSE_SECTION:
                 plugins.popleft()
                 break
             elif subregion is not None:
@@ -372,6 +373,14 @@ def handle_section(self, plugins, context):
                 out.append(self.render_plugin(plugins.popleft(), context))
         return out
 
+    def register_section_close(self, plugin, renderer="", **kwargs):
+        kwargs["subregion"] = _CLOSE_SECTION
+        self.register(plugin, renderer, **kwargs)
+
+    def handle__close_section(self, plugins, context):
+        plugins.popleft()
+        yield from ()
+
     # Main external rendering API
 
     def regions_from_contents(self, contents, **kwargs):

tests/testapp/test_region_renderer.py

@@ -9,7 +9,6 @@
 from pytest_django.asserts import assertHTMLEqual
 
 from feincms3.renderer import (
-    CLOSE_SECTION,
     PluginNotRegisteredError,
     RegionRenderer,
     template_renderer,
@@ -225,10 +224,10 @@ class CloseSection:
         pass
 
     renderer = SectionRenderer()
-    renderer.register(Text, "Text")
+    renderer.register([Text], "Text")  # Register as list
     renderer.register(Image, "Image", subregion="images")
     renderer.register(Section, "", subregion="section")
-    renderer.register(CloseSection, "", subregion=CLOSE_SECTION)
+    renderer.register_section_close(CloseSection)
 
     def render(plugins):
         return renderer.render_region(