wagtail 6.4rc1__py3-none-any.whl → 7.0__py3-none-any.whl

wagtail/admin/viewsets/model.py

@@ -1,11 +1,8 @@
-from warnings import warn
-
 from django.contrib.auth import get_permission_codename
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ImproperlyConfigured
 from django.forms.models import modelform_factory
-from django.shortcuts import redirect
 from django.urls import path
 from django.utils.functional import cached_property
 from django.utils.text import capfirst
@@ -20,7 +17,6 @@ from wagtail.admin.views import generic
 from wagtail.admin.views.generic import history, usage
 from wagtail.models import ReferenceIndex
 from wagtail.permissions import ModelPermissionPolicy
-from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 from .base import ViewSet, ViewSetGroup
 
@@ -236,36 +232,6 @@ class ModelViewSet(ViewSet):
             self.delete_view_class, **self.get_delete_view_kwargs()
         )
 
-    @property
-    def redirect_to_edit_view(self):
-        def redirect_to_edit(request, pk):
-            warn(
-                (
-                    "%s's `/<pk>/` edit view URL pattern has been "
-                    "deprecated in favour of /edit/<pk>/."
-                )
-                % (self.__class__.__name__),
-                category=RemovedInWagtail70Warning,
-            )
-            return redirect(self.get_url_name("edit"), pk, permanent=True)
-
-        return redirect_to_edit
-
-    @property
-    def redirect_to_delete_view(self):
-        def redirect_to_delete(request, pk):
-            warn(
-                (
-                    "%s's `/<pk>/delete/` delete view URL pattern has been "
-                    "deprecated in favour of /delete/<pk>/."
-                )
-                % (self.__class__.__name__),
-                category=RemovedInWagtail70Warning,
-            )
-            return redirect(self.get_url_name("delete"), pk, permanent=True)
-
-        return redirect_to_delete
-
     @property
     def history_view(self):
         return self.construct_view(
@@ -427,7 +393,7 @@ class ModelViewSet(ViewSet):
         - An instance of the ``wagtail.admin.ui.tables.Column`` class.
 
         If the name refers to a database field, the ability to sort the listing
-        by the database column will be offerred and the field's verbose name
+        by the database column will be offered and the field's verbose name
         will be used as the column header.
 
         If the name refers to a callable or property, an ``admin_order_field``
@@ -438,9 +404,11 @@ class ModelViewSet(ViewSet):
         This list will be passed to the ``list_display`` attribute of the index
         view. If left unset, the ``list_display`` attribute of the index view
         will be used instead, which by default is defined as
-        ``["__str__", wagtail.admin.ui.tables.UpdatedAtColumn()]``.
+        ``["__str__", wagtail.admin.ui.tables.LocaleColumn(), wagtail.admin.ui.tables.UpdatedAtColumn()]``.
+
+        Note that the ``LocaleColumn`` is only included if the model is translatable.
         """
-        return self.index_view_class.list_display
+        return self.UNDEFINED
 
     @cached_property
     def list_filter(self):
@@ -661,19 +629,8 @@ class ModelViewSet(ViewSet):
         if self.copy_view_enabled:
             urlpatterns.append(path("copy/<str:pk>/", self.copy_view, name="copy"))
 
-        # RemovedInWagtail70Warning: Remove legacy URL patterns
-        urlpatterns += self._legacy_urlpatterns
-
         return urlpatterns
 
-    @cached_property
-    def _legacy_urlpatterns(self):
-        # RemovedInWagtail70Warning: Remove legacy URL patterns
-        return [
-            path("<str:pk>/", self.redirect_to_edit_view),
-            path("<str:pk>/delete/", self.redirect_to_delete_view),
-        ]
-
     def on_register(self):
         super().on_register()
         self.register_admin_url_finder()

wagtail/admin/wagtail_hooks.py

@@ -3,7 +3,6 @@ from django.contrib.auth.models import Permission
 from django.urls import reverse, reverse_lazy
 from django.utils.functional import cached_property
 from django.utils.http import urlencode
-from django.utils.translation import gettext
 from django.utils.translation import gettext_lazy as _
 from draftjs_exporter.dom import DOM
 
@@ -495,7 +494,7 @@ def register_core_features(features):
             {
                 "icon": "h1",
                 "type": "header-one",
-                "description": gettext("Heading %(level)d") % {"level": 1},
+                "description": _("Heading 1"),
             }
         ),
     )
@@ -516,7 +515,7 @@ def register_core_features(features):
             {
                 "icon": "h2",
                 "type": "header-two",
-                "description": gettext("Heading %(level)d") % {"level": 2},
+                "description": _("Heading 2"),
             }
         ),
     )
@@ -537,7 +536,7 @@ def register_core_features(features):
             {
                 "icon": "h3",
                 "type": "header-three",
-                "description": gettext("Heading %(level)d") % {"level": 3},
+                "description": _("Heading 3"),
             }
         ),
     )
@@ -558,7 +557,7 @@ def register_core_features(features):
             {
                 "icon": "h4",
                 "type": "header-four",
-                "description": gettext("Heading %(level)d") % {"level": 4},
+                "description": _("Heading 4"),
             }
         ),
     )
@@ -579,7 +578,7 @@ def register_core_features(features):
             {
                 "icon": "h5",
                 "type": "header-five",
-                "description": gettext("Heading %(level)d") % {"level": 5},
+                "description": _("Heading 5"),
             }
         ),
     )
@@ -600,7 +599,7 @@ def register_core_features(features):
             {
                 "icon": "h6",
                 "type": "header-six",
-                "description": gettext("Heading %(level)d") % {"level": 6},
+                "description": _("Heading 6"),
             }
         ),
     )
@@ -621,7 +620,7 @@ def register_core_features(features):
             {
                 "type": "unordered-list-item",
                 "icon": "list-ul",
-                "description": gettext("Bulleted list"),
+                "description": _("Bulleted list"),
             }
         ),
     )
@@ -645,7 +644,7 @@ def register_core_features(features):
             {
                 "type": "ordered-list-item",
                 "icon": "list-ol",
-                "description": gettext("Numbered list"),
+                "description": _("Numbered list"),
             }
         ),
     )
@@ -669,7 +668,7 @@ def register_core_features(features):
             {
                 "type": "blockquote",
                 "icon": "openquote",
-                "description": gettext("Blockquote"),
+                "description": _("Blockquote"),
             }
         ),
     )
@@ -691,7 +690,7 @@ def register_core_features(features):
             {
                 "type": "BOLD",
                 "icon": "bold",
-                "description": gettext("Bold"),
+                "description": _("Bold"),
             }
         ),
     )
@@ -713,7 +712,7 @@ def register_core_features(features):
             {
                 "type": "ITALIC",
                 "icon": "italic",
-                "description": gettext("Italic"),
+                "description": _("Italic"),
             }
         ),
     )
@@ -736,7 +735,7 @@ def register_core_features(features):
             {
                 "type": "LINK",
                 "icon": "link",
-                "description": gettext("Link"),
+                "description": _("Link"),
                 # We want to enforce constraints on which links can be pasted into rich text.
                 # Keep only the attributes Wagtail needs.
                 "attributes": ["url", "id", "parentId"],
@@ -783,7 +782,7 @@ def register_core_features(features):
             {
                 "type": "SUPERSCRIPT",
                 "icon": "superscript",
-                "description": gettext("Superscript"),
+                "description": _("Superscript"),
             }
         ),
     )
@@ -804,7 +803,7 @@ def register_core_features(features):
             {
                 "type": "SUBSCRIPT",
                 "icon": "subscript",
-                "description": gettext("Subscript"),
+                "description": _("Subscript"),
             }
         ),
     )
@@ -825,7 +824,7 @@ def register_core_features(features):
             {
                 "type": "STRIKETHROUGH",
                 "icon": "strikethrough",
-                "description": gettext("Strikethrough"),
+                "description": _("Strikethrough"),
             }
         ),
     )
@@ -846,7 +845,7 @@ def register_core_features(features):
             {
                 "type": "CODE",
                 "icon": "code",
-                "description": gettext("Code"),
+                "description": _("Code"),
             }
         ),
     )

wagtail/admin/widgets/button.py

@@ -1,5 +1,3 @@
-from warnings import warn
-
 from django.forms.utils import flatatt
 from django.urls import reverse
 from django.utils.functional import cached_property
@@ -7,8 +5,6 @@ from django.utils.http import urlencode
 
 from wagtail import hooks
 from wagtail.admin.ui.components import Component
-from wagtail.coreutils import accepts_kwarg
-from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 
 class Button(Component):
@@ -199,27 +195,13 @@ class ButtonWithDropdownFromHook(BaseDropdownMenuButton):
         label,
         hook_name,
         page,
-        user=None,
-        page_perms=None,
+        user,
         next_url=None,
         **kwargs,
     ):
         self.hook_name = hook_name
         self.page = page
-
-        if user is None:
-            if page_perms is not None:
-                warn(
-                    "ButtonWithDropdownFromHook should be passed a `user` argument instead of `page_perms`",
-                    category=RemovedInWagtail70Warning,
-                    stacklevel=2,
-                )
-                self.user = page_perms.user
-            else:
-                raise TypeError("ButtonWithDropdownFromHook requires a `user` argument")
-        else:
-            self.user = user
-
+        self.user = user
         self.next_url = next_url
 
         super().__init__(label, **kwargs)
@@ -234,19 +216,7 @@ class ButtonWithDropdownFromHook(BaseDropdownMenuButton):
 
         buttons = []
         for hook in button_hooks:
-            if accepts_kwarg(hook, "user"):
-                buttons.extend(
-                    hook(page=self.page, user=self.user, next_url=self.next_url)
-                )
-            else:
-                # old-style hook that accepts page_perms instead of user
-                warn(
-                    f"`{self.hook_name}` hook functions should accept a `user` argument instead of `page_perms` -"
-                    f" {hook.__module__}.{hook.__name__} needs to be updated",
-                    category=RemovedInWagtail70Warning,
-                )
-                page_perms = self.page.permissions_for_user(self.user)
-                buttons.extend(hook(self.page, page_perms, self.next_url))
+            buttons.extend(hook(page=self.page, user=self.user, next_url=self.next_url))
 
         buttons = [b for b in buttons if b.show]
         return buttons

wagtail/admin/widgets/tags.py

@@ -1,4 +1,5 @@
 import json
+from warnings import warn
 
 from django.conf import settings
 from django.urls import reverse
@@ -6,6 +7,8 @@ from django.utils.translation import gettext_lazy as _
 from taggit.forms import TagWidget
 from taggit.models import Tag
 
+from wagtail.utils.deprecation import RemovedInWagtail80Warning
+
 
 class AdminTagWidget(TagWidget):
     template_name = "wagtailadmin/widgets/tag_widget.html"
@@ -39,7 +42,19 @@ class AdminTagWidget(TagWidget):
         else:
             free_tagging = self.free_tagging
 
-        tag_spaces_allowed = getattr(settings, "TAG_SPACES_ALLOWED", True)
+        if hasattr(settings, "TAG_SPACES_ALLOWED"):
+            warn(
+                "The setting 'TAG_SPACES_ALLOWED' is deprecated. "
+                "Please use 'WAGTAIL_TAG_SPACES_ALLOWED' instead.",
+                RemovedInWagtail80Warning,
+            )
+        tag_spaces_allowed = getattr(
+            settings,
+            "WAGTAIL_TAG_SPACES_ALLOWED",
+            # RemovedInWagtail80Warning: Remove fallback to deprecated setting
+            getattr(settings, "TAG_SPACES_ALLOWED", True),
+        )
+
         if tag_spaces_allowed:
             help_text = _(
                 'Multi-word tags with spaces will automatically be enclosed in double quotes (").'
@@ -47,13 +62,26 @@ class AdminTagWidget(TagWidget):
         else:
             help_text = _("Tags can only consist of a single word, no spaces allowed.")
 
+        if hasattr(settings, "TAG_LIMIT"):
+            warn(
+                "The setting 'TAG_LIMIT' is deprecated. "
+                "Please use 'WAGTAIL_TAG_LIMIT' instead.",
+                RemovedInWagtail80Warning,
+            )
+        tag_limit = getattr(
+            settings,
+            "WAGTAIL_TAG_LIMIT",
+            # RemovedInWagtail80Warning: Remove fallback to deprecated setting
+            getattr(settings, "TAG_LIMIT", None),
+        )
+
         context["widget"]["help_text"] = help_text
         context["widget"]["attrs"]["data-w-tag-delay-value"] = 200
         context["widget"]["attrs"]["data-w-tag-url-value"] = autocomplete_url
         context["widget"]["attrs"]["data-w-tag-options-value"] = json.dumps(
             {
-                "allowSpaces": getattr(settings, "TAG_SPACES_ALLOWED", True),
-                "tagLimit": getattr(settings, "TAG_LIMIT", None),
+                "allowSpaces": tag_spaces_allowed,
+                "tagLimit": tag_limit,
                 "autocompleteOnly": not free_tagging,
             }
         )

wagtail/api/v2/views.py

@@ -305,10 +305,10 @@ class BaseAPIViewSet(GenericViewSet):
                 child_endpoint_class = (
                     child_endpoint_class[1] if child_endpoint_class else BaseAPIViewSet
                 )
-                child_serializer_classes[
-                    field_name
-                ] = child_endpoint_class._get_serializer_class(
-                    router, child_model, child_sub_fields, nested=True
+                child_serializer_classes[field_name] = (
+                    child_endpoint_class._get_serializer_class(
+                        router, child_model, child_sub_fields, nested=True
+                    )
                 )
 
             else:

wagtail/blocks/base.py

@@ -2,7 +2,6 @@ import collections
 import itertools
 import json
 import re
-import warnings
 from functools import lru_cache
 from importlib import import_module
 
@@ -17,9 +16,7 @@ from django.utils.safestring import mark_safe
 from django.utils.text import capfirst
 
 from wagtail.admin.staticfiles import versioned_static
-from wagtail.coreutils import accepts_kwarg
 from wagtail.telepath import JSContext
-from wagtail.utils.deprecation import RemovedInWagtail70Warning
 from wagtail.utils.templates import template_is_overridden
 
 __all__ = [
@@ -224,8 +221,9 @@ class Block(metaclass=BaseBlock):
 
     def get_context(self, value, parent_context=None):
         """
-        Return a dict of context variables (derived from the block value and combined with the parent_context)
-        to be used as the template context when rendering this value through a template.
+        Return a dict of context variables (derived from the block ``value`` and combined with the
+        ``parent_context``) to be used as the template context when rendering this value through a
+        template. See :ref:`the usage example <streamfield_get_context>` for more details.
         """
 
         context = parent_context or {}
@@ -239,11 +237,9 @@ class Block(metaclass=BaseBlock):
 
     def get_template(self, value=None, context=None):
         """
-        Return the template to use for rendering the block if specified on meta class.
-        This extraction was added to make dynamic templates possible if you override this method
-
-        value contains the current value of the block, allowing overridden methods to
-        select the proper template based on the actual block value.
+        Return the template to use for rendering the block if specified.
+        This method allows for dynamic templates based on the block instance and a given ``value``.
+        See :ref:`the usage example <streamfield_get_template>` for more details.
         """
         return getattr(self.meta, "template", None)
 
@@ -253,16 +249,7 @@ class Block(metaclass=BaseBlock):
         use a template (with the passed context, supplemented by the result of get_context) if a
         'template' property is specified on the block, and fall back on render_basic otherwise.
         """
-        args = {"context": context}
-        if accepts_kwarg(self.get_template, "value"):
-            args["value"] = value
-        else:
-            warnings.warn(
-                f"{self.__class__.__name__}.get_template should accept a 'value' argument as first argument",
-                RemovedInWagtail70Warning,
-            )
-
-        template = self.get_template(**args)
+        template = self.get_template(value, context=context)
         if not template:
             return self.render_basic(value, context=context)
 
@@ -274,30 +261,67 @@ class Block(metaclass=BaseBlock):
         return mark_safe(render_to_string(template, new_context))
 
     def get_preview_context(self, value, parent_context=None):
-        # We do not fall back to `get_context` here, because the preview context
-        # will be used for a complete view, not just the block. Instead, the
-        # default preview context uses `{% include_block %}`, which will use
-        # `get_context`.
+        """
+        Return a dict of context variables to be used as the template context
+        when rendering the block's preview. The ``value`` argument is the value
+        returned by :meth:`get_preview_value`. The ``parent_context`` argument
+        contains the following variables:
+
+        - ``request``: The current request object.
+        - ``block_def``: The block instance.
+        - ``block_class``: The block class.
+        - ``bound_block``: A ``BoundBlock`` instance representing the block and its value.
+
+        If :ref:`the global preview template <streamfield_global_preview_template>`
+        is used, the block will be rendered as the main content using
+        ``{% include_block %}``, which in turn uses :meth:`get_context`. As a
+        result, the context returned by this method will be available as the
+        ``parent_context`` for ``get_context()`` when the preview is rendered.
+        """
+        # NOTE: see StreamFieldBlockPreview.base_context for the context variables
+        # that can be documented.
         return parent_context or {}
 
     def get_preview_template(self, value, context=None):
-        # We do not fall back to `get_template` here, because the template will
-        # be used for a complete view, not just the block. In most cases, the
-        # block's template cannot stand alone for the preview, as it would be
-        # missing the necessary static assets.
-        #
-        # Instead, the default preview template uses `{% include_block %}`,
-        # which will use `get_template` if a template is defined.
+        """
+        Return the template to use for rendering the block's preview. The ``value``
+        argument is the value returned by :meth:`get_preview_value`. The ``context``
+        argument contains the variables listed for the ``parent_context`` argument
+        of :meth:`get_preview_context` above (and not the context returned by that
+        method itself).
+
+        Note that the preview template is used to render a complete HTML page of
+        the preview, not just an HTML fragment for the block. The method returns
+        the ``preview_template`` attribute from the block's options if provided,
+        and falls back to
+        :ref:`the global preview template <streamfield_global_preview_template>`
+        otherwise.
+
+        If the global preview template is used, the block will be rendered as the
+        main content using ``{% include_block %}``, which in turn uses
+        :meth:`get_template`.
+        """
         return (
             getattr(self.meta, "preview_template", None)
             or self.DEFAULT_PREVIEW_TEMPLATE
         )
 
     def get_preview_value(self):
+        """
+        Return the placeholder value that will be used for rendering the block's
+        preview. By default, the value is the ``preview_value`` from the block's
+        options if provided, otherwise the ``default`` is used as fallback. This
+        method can be overridden to provide a dynamic preview value, such as
+        from the database.
+        """
         if hasattr(self.meta, "preview_value"):
             return self.normalize(self.meta.preview_value)
         return self.get_default()
 
+    @cached_property
+    def _has_default(self):
+        return getattr(self.meta, "default", None) is not None
+
     @cached_property
     def is_previewable(self):
         # To prevent showing a broken preview if the block preview has not been
@@ -314,7 +338,7 @@ class Block(metaclass=BaseBlock):
         )
         has_preview_value = (
             hasattr(self.meta, "preview_value")
-            or getattr(self.meta, "default", None) is not None
+            or self._has_default
             or self.__class__.get_preview_context is not Block.get_preview_context
             or self.__class__.get_preview_value is not Block.get_preview_value
         )
@@ -325,6 +349,11 @@ class Block(metaclass=BaseBlock):
         return has_specific_template or (has_preview_value and has_global_template)
 
     def get_description(self):
+        """
+        Return the description of the block to be shown to editors as part of the preview.
+        For :ref:`field block types <field_block_types>`, it will fall back to
+        ``help_text`` if not provided.
+        """
         return getattr(self.meta, "description", "")
 
     def get_api_representation(self, value, context=None):
@@ -682,7 +711,7 @@ class BlockWidget(forms.Widget):
     def media(self):
         return self.js_context.media + forms.Media(
             js=[
-                # needed for initBlockWidget, although these will almost certainly be
+                # these will almost certainly be
                 # pulled in by the block adapters too
                 versioned_static("wagtailadmin/js/telepath/telepath.js"),
                 versioned_static("wagtailadmin/js/telepath/blocks.js"),
@@ -715,7 +744,22 @@ class BlockField(forms.Field):
         super().__init__(**kwargs)
 
     def clean(self, value):
-        return self.block.clean(value)
+        from wagtail.blocks.stream_block import StreamBlock
+
+        if isinstance(self.block, StreamBlock):
+            # StreamBlock is the only block type that is formally-supported as the top level block
+            # of a BlockField, but it's possible that other block types could be used, so check
+            # this explicitly.
+            # self.block has a `required` attribute that is consistent with the StreamField's `blank`
+            # attribute and thus the `required` attribute of BlockField - but if the latter has been
+            # assigned dynamically (e.g. by defer_required_fields) we want this to take precedence.
+            # We do this through the `ignore_required_constraints` flag recognised by
+            # StreamBlock.clean.
+            return self.block.clean(
+                value, ignore_required_constraints=not self.required
+            )
+        else:
+            return self.block.clean(value)
 
     def has_changed(self, initial_value, data_value):
         return self.block.get_prep_value(initial_value) != self.block.get_prep_value(

wagtail/blocks/field_block.py

@@ -13,6 +13,7 @@ from django.utils.safestring import mark_safe
 from django.utils.translation import gettext as _
 
 from wagtail.admin.staticfiles import versioned_static
+from wagtail.compat import URLField
 from wagtail.coreutils import camelcase_to_underscore, resolve_model_string
 from wagtail.rich_text import (
     RichText,
@@ -318,7 +319,7 @@ class URLBlock(FieldBlock):
         validators=(),
         **kwargs,
     ):
-        self.field = forms.URLField(
+        self.field = URLField(
             required=required,
             help_text=help_text,
             max_length=max_length,

wagtail/blocks/list_block.py

@@ -147,7 +147,8 @@ class ListBlock(Block):
         else:
             self.child_block = child_block
 
-        if not hasattr(self.meta, "default"):
+        self._has_default = hasattr(self.meta, "default")
+        if not self._has_default:
             # Default to a list consisting of one empty (i.e. default-valued) child item
             self.meta.default = [self.child_block.get_default()]
 

wagtail/blocks/migrations/operations.py

@@ -153,29 +153,29 @@ class StreamChildrenToListBlockOperation(BaseBlockOperation):
         super().__init__()
         self.block_name = block_name
         self.list_block_name = list_block_name
-        self.temp_blocks = []
 
     def apply(self, block_value):
+        candidate_blocks = []
         mapped_block_value = []
         for child_block in block_value:
             if child_block["type"] == self.block_name:
-                self.temp_blocks.append(child_block)
+                candidate_blocks.append(child_block)
             else:
                 mapped_block_value.append(child_block)
 
-        self.map_temp_blocks_to_list_items()
+        list_items = self.map_temp_blocks_to_list_items(candidate_blocks)
 
-        if self.temp_blocks:
-            new_list_block = {"type": self.list_block_name, "value": self.temp_blocks}
+        if list_items:
+            new_list_block = {"type": self.list_block_name, "value": list_items}
             mapped_block_value.append(new_list_block)
 
         return mapped_block_value
 
-    def map_temp_blocks_to_list_items(self):
-        new_temp_blocks = []
-        for block in self.temp_blocks:
-            new_temp_blocks.append({**block, "type": "item"})
-        self.temp_blocks = new_temp_blocks
+    def map_temp_blocks_to_list_items(self, blocks):
+        list_items = []
+        for block in blocks:
+            list_items.append({**block, "type": "item"})
+        return list_items
 
     @property
     def operation_name_fragment(self):