wagtail 7.0.2__py3-none-any.whl → 7.1rc1__py3-none-any.whl

wagtail/admin/widgets/button.py

@@ -1,19 +1,22 @@
+from warnings import warn
+
 from django.forms.utils import flatatt
-from django.urls import reverse
 from django.utils.functional import cached_property
-from django.utils.http import urlencode
 
 from wagtail import hooks
 from wagtail.admin.ui.components import Component
+from wagtail.admin.ui.menus import MenuItem
+from wagtail.utils.deprecation import RemovedInWagtail80Warning
 
 
-class Button(Component):
+class BaseButton(Component):
     template_name = "wagtailadmin/shared/button.html"
     show = True
     label = ""
     icon_name = None
     url = None
     attrs = {}
+    allow_in_dropdown = False
 
     def __init__(
         self, label="", url=None, classname="", icon_name=None, attrs={}, priority=1000
@@ -31,16 +34,10 @@ class Button(Component):
 
         self.attrs = self.attrs.copy()
         self.attrs.update(attrs)
-
-        # if a 'title' attribute has been passed, correct that to aria-label
-        # as that's what will be picked up in renderings that don't use button.render
-        # directly (e.g. _dropdown_items.html)
-        if "title" in self.attrs and "aria-label" not in self.attrs:
-            self.attrs["aria-label"] = self.attrs.pop("title")
         self.priority = priority
 
     def get_context_data(self, parent_context):
-        return {"button": self}
+        return {"button": self, "request": parent_context.get("request")}
 
     @property
     def base_attrs_string(self):
@@ -58,27 +55,27 @@ class Button(Component):
         return f"<Button: {self.label}>"
 
     def __lt__(self, other):
-        if not isinstance(other, Button):
+        if not isinstance(other, (BaseButton, MenuItem)):
             return NotImplemented
         return (self.priority, self.label) < (other.priority, other.label)
 
     def __le__(self, other):
-        if not isinstance(other, Button):
+        if not isinstance(other, (BaseButton, MenuItem)):
             return NotImplemented
         return (self.priority, self.label) <= (other.priority, other.label)
 
     def __gt__(self, other):
-        if not isinstance(other, Button):
+        if not isinstance(other, (BaseButton, MenuItem)):
             return NotImplemented
         return (self.priority, self.label) > (other.priority, other.label)
 
     def __ge__(self, other):
-        if not isinstance(other, Button):
+        if not isinstance(other, (BaseButton, MenuItem)):
             return NotImplemented
         return (self.priority, self.label) >= (other.priority, other.label)
 
     def __eq__(self, other):
-        if not isinstance(other, Button):
+        if not isinstance(other, (BaseButton, MenuItem)):
             return NotImplemented
         return (
             self.label == other.label
@@ -88,9 +85,29 @@ class Button(Component):
             and self.priority == other.priority
         )
 
+    @classmethod
+    def from_menu_item(cls, menu_item: MenuItem):
+        attrs = {}
+        if link_rel := getattr(menu_item, "link_rel", None):
+            attrs["rel"] = link_rel
+
+        return cls(
+            label=menu_item.label,
+            url=menu_item.url,
+            icon_name=menu_item.icon_name,
+            priority=menu_item.priority,
+            attrs=attrs,
+        )
+
 
-class HeaderButton(Button):
-    """An icon-only button to be displayed after the breadcrumbs in the header."""
+class Button(BaseButton):
+    """Plain link button with a label and optional icon."""
+
+    allow_in_dropdown = True
+
+
+class HeaderButton(BaseButton):
+    """Top-level button to be displayed after the breadcrumbs in the header."""
 
     def __init__(
         self,
@@ -123,48 +140,26 @@ class HeaderButton(Button):
 
 # Base class for all listing buttons
 # This is also used by SnippetListingButton defined in wagtail.snippets.widgets
-class ListingButton(Button):
+class ListingButton(BaseButton):
+    """Top-level button to be displayed in a listing view."""
+
     def __init__(self, label="", url=None, classname="", **kwargs):
         classname = f"{classname} button button-small button-secondary".strip()
         super().__init__(label=label, url=url, classname=classname, **kwargs)
 
 
 class PageListingButton(ListingButton):
-    aria_label_format = None
-    url_name = None
-
-    def __init__(self, *args, page=None, next_url=None, attrs={}, user=None, **kwargs):
-        self.page = page
-        self.user = user
-        self.next_url = next_url
-
-        attrs = attrs.copy()
-        if (
-            self.page
-            and self.aria_label_format is not None
-            and "aria-label" not in attrs
-        ):
-            attrs["aria-label"] = self.aria_label_format % {
-                "title": self.page.get_admin_display_title()
-            }
-        super().__init__(*args, attrs=attrs, **kwargs)
-
-    @cached_property
-    def url(self):
-        if self.page and self.url_name is not None:
-            url = reverse(self.url_name, args=[self.page.id])
-            if self.next_url:
-                url += "?" + urlencode({"next": self.next_url})
-            return url
-
-    @cached_property
-    def page_perms(self):
-        if self.page:
-            return self.page.permissions_for_user(self.user)
+    def __init__(self, *args, **kwargs):
+        warn(
+            "`PageListingButton` is deprecated. "
+            "Use `wagtail.admin.widgets.button.ListingButton` instead.",
+            category=RemovedInWagtail80Warning,
+        )
+        super().__init__(*args, **kwargs)
 
 
-class BaseDropdownMenuButton(Button):
-    template_name = "wagtailadmin/pages/listing/_button_with_dropdown.html"
+class BaseDropdownMenuButton(BaseButton):
+    template_name = "wagtailadmin/shared/button_with_dropdown.html"
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, url=None, **kwargs)
@@ -173,14 +168,28 @@ class BaseDropdownMenuButton(Button):
     def dropdown_buttons(self):
         raise NotImplementedError
 
+    @property
+    def base_attrs_string(self):
+        attrs = self.attrs.copy()
+        # For dropdowns, attrs are rendered on the wrapper `<div>`, not the
+        # toggle button. Don't render the `aria-label` on the wrapper. We'll pass
+        # it as the `title` context variable to be used as `toggle_aria_label`
+        # instead, which will be rendered on the toggle button.
+        attrs.pop("aria-label", None)
+        return flatatt(attrs)
+
     def get_context_data(self, parent_context):
-        return {
-            "buttons": sorted(self.dropdown_buttons),
-            "label": self.label,
-            "title": self.aria_label,
-            "toggle_classname": self.classname,
-            "icon_name": self.icon_name,
-        }
+        context = super().get_context_data(parent_context)
+        context.update(
+            {
+                "buttons": sorted(self.dropdown_buttons),
+                "label": self.label,
+                "title": self.aria_label,
+                "toggle_classname": self.classname,
+                "icon_name": self.icon_name,
+            }
+        )
+        return context
 
 
 class ButtonWithDropdown(BaseDropdownMenuButton):
@@ -190,6 +199,10 @@ class ButtonWithDropdown(BaseDropdownMenuButton):
 
 
 class ButtonWithDropdownFromHook(BaseDropdownMenuButton):
+    # This page-specific class and template is documented for
+    # the register_page_listing_buttons hook
+    template_name = "wagtailadmin/pages/listing/_button_with_dropdown.html"
+
     def __init__(
         self,
         label,
@@ -214,9 +227,19 @@ class ButtonWithDropdownFromHook(BaseDropdownMenuButton):
     def dropdown_buttons(self):
         button_hooks = hooks.get_hooks(self.hook_name)
 
-        buttons = []
+        hook_buttons = []
         for hook in button_hooks:
-            buttons.extend(hook(page=self.page, user=self.user, next_url=self.next_url))
+            hook_buttons.extend(
+                hook(page=self.page, user=self.user, next_url=self.next_url)
+            )
+
+        buttons = []
+        for button in hook_buttons:
+            # Allow hooks to return either Button or MenuItem instances
+            if isinstance(button, MenuItem):
+                if button.is_shown(self.user):
+                    buttons.append(Button.from_menu_item(button))
+            elif button.show:
+                buttons.append(button)
 
-        buttons = [b for b in buttons if b.show]
         return buttons

wagtail/admin/widgets/chooser.py

@@ -12,10 +12,10 @@ from django.utils.translation import gettext_lazy as _
 
 from wagtail.admin.admin_url_finder import AdminURLFinder
 from wagtail.admin.staticfiles import versioned_static
+from wagtail.admin.telepath import register
+from wagtail.admin.telepath.widgets import WidgetAdapter
 from wagtail.coreutils import resolve_model_string
 from wagtail.models import Page
-from wagtail.telepath import register
-from wagtail.widget_adapters import WidgetAdapter
 
 
 class BaseChooser(widgets.Input):

wagtail/admin/widgets/datetime.py

@@ -7,8 +7,8 @@ from django.utils.formats import get_format
 
 from wagtail.admin.datetimepicker import to_datetimepicker_format
 from wagtail.admin.staticfiles import versioned_static
-from wagtail.telepath import register
-from wagtail.widget_adapters import WidgetAdapter
+from wagtail.admin.telepath import register
+from wagtail.admin.telepath.widgets import WidgetAdapter
 
 DEFAULT_DATE_FORMAT = "%Y-%m-%d"
 DEFAULT_DATETIME_FORMAT = "%Y-%m-%d %H:%M"

wagtail/admin/widgets/slug.py

@@ -1,16 +1,35 @@
+import json
+import re
+from typing import List, Optional, Tuple, Union
+
 from django.conf import settings
 from django.forms import widgets
 
+from wagtail.coreutils import get_js_regex
+
 
 class SlugInput(widgets.TextInput):
     """
-    Associates the input field with the Stimulus w-slug (SlugController).
-    Slugifies content based on `WAGTAIL_ALLOW_UNICODE_SLUGS` and supports
-    fields syncing their value to this field (see `TitleFieldPanel`) if
-    also used.
+    Associates the input field with the Stimulus w-slug (CleanController).
+    Slugifies content based on ``WAGTAIL_ALLOW_UNICODE_SLUGS`` and supports
+    fields syncing their value to this field (see `TitleFieldPanel`) if used.
+    Allows the ability to define the ``locale`` to allow locale (language code)
+    specific transliteration, or ``formatters`` for more custom handling.
     """
 
-    def __init__(self, attrs=None):
+    def __init__(
+        self,
+        attrs: Optional[dict] = None,
+        formatters: Optional[
+            List[
+                Tuple[
+                    Union[re.Pattern, str, bytes],
+                    Optional[str],
+                ],
+            ]
+        ] = [],
+        locale: Optional[object] = None,
+    ):
         default_attrs = {
             "data-controller": "w-slug",
             "data-action": "blur->w-slug#slugify w-sync:check->w-slug#compare w-sync:apply->w-slug#urlify:prevent",
@@ -18,7 +37,38 @@ class SlugInput(widgets.TextInput):
                 settings, "WAGTAIL_ALLOW_UNICODE_SLUGS", True
             ),
             "data-w-slug-compare-as-param": "urlify",
+            "data-w-slug-trim-value": "true",
         }
+
+        if formatters:
+            # If formatters are provided, parse them into a JSON string
+            # Support flexible input of regex, replace, and flags
+            parsed_formatters = []
+            for item in formatters:
+                if isinstance(item, (list, tuple)):
+                    regex_args = [item[0]]
+                    replace = item[1] if len(item) > 1 else ""
+                    if len(item) == 3:
+                        # If base_js_flags are provided, add them to the regex_args
+                        regex_args.append(item[2])
+                else:
+                    regex_args = [item]
+                    replace = ""
+                parsed_formatters.append([get_js_regex(*regex_args), replace])
+            default_attrs["data-w-slug-formatters-value"] = json.dumps(
+                parsed_formatters,
+                separators=(",", ":"),
+            )
+
+        if locale is not None:
+            # Attempt to resolve a non-empty locale string from a `Locale` instance or the string itself.
+            # If no locale can be found, use 'und' - as per ISO639-2 standard, 'und' represents 'undetermined'.
+            # If the attribute is not set, the input will fall back to the ``ACTIVE_LOCALE`` or document lang within the CleanController.
+            default_attrs["data-w-slug-locale-value"] = (
+                getattr(locale, "language_code", locale) or "und"
+            )
+
         if attrs:
             default_attrs.update(attrs)
+
         super().__init__(default_attrs)

wagtail/api/v2/filters.py

@@ -1,4 +1,5 @@
 from django.conf import settings
+from django.core.exceptions import FieldError
 from django.db import models
 from django.shortcuts import get_object_or_404
 from rest_framework.filters import BaseFilterBackend
@@ -78,49 +79,35 @@ class OrderingFilter(BaseFilterBackend):
         And random ordering
         Eg: ?order=random
         """
-        if "order" in request.GET:
-            order_by_list = request.GET["order"].split(",")
+        order_param = request.GET.get("order")
+        if not order_param:
+            return queryset
 
-            # Random ordering
-            if "random" in order_by_list:
-                if len(order_by_list) > 1:
-                    raise BadRequestError(
-                        "random ordering cannot be combined with other fields"
-                    )
-                # Prevent ordering by random with offset
-                if "offset" in request.GET:
-                    raise BadRequestError(
-                        "random ordering with offset is not supported"
-                    )
-
-                return queryset.order_by("?")
-
-            order_by_fields = []
-            for order_by in order_by_list:
-                # Check if reverse ordering is set
-                if order_by.startswith("-"):
-                    reverse_order = True
-                    order_by = order_by[1:]
-                else:
-                    reverse_order = False
-
-                # Add ordering
-                if order_by in view.get_available_fields(queryset.model):
-                    order_by_fields.append(order_by)
-                else:
-                    # Unknown field
-                    raise BadRequestError(
-                        "cannot order by '%s' (unknown field)" % order_by
-                    )
-
-            # Apply ordering to the queryset
-            queryset = queryset.order_by(*order_by_fields)
+        order_by_list = order_param.split(",")
 
-            # Reverse order if needed
-            if reverse_order:
-                queryset = queryset.reverse()
-
-        return queryset
+        # Handle random ordering separately
+        if "random" in order_by_list:
+            if len(order_by_list) > 1:
+                raise BadRequestError(
+                    "random ordering cannot be combined with other fields"
+                )
+            if "offset" in request.GET:
+                raise BadRequestError("random ordering with offset is not supported")
+            return queryset.order_by("?")
+
+        allowed_fields = view.get_available_fields(queryset.model, db_fields_only=True)
+        validated_fields = []
+
+        for field in order_by_list:
+            field_name = field.lstrip("-")
+            if field_name not in allowed_fields:
+                raise BadRequestError(f"cannot order by '{field}' (unknown field)")
+            validated_fields.append(field)
+
+        try:
+            return queryset.order_by(*validated_fields)
+        except FieldError:
+            raise BadRequestError(f"cannot order by '{order_param}' (invalid field)")
 
 
 class SearchFilter(BaseFilterBackend):

wagtail/api/v2/tests/test_documents.py

@@ -252,7 +252,7 @@ class TestDocumentListing(TestCase):
 
         self.assertEqual(response.status_code, 400)
         self.assertEqual(
-            content, {"message": "cannot order by 'random' (unknown field)"}
+            content, {"message": "cannot order by '-random' (unknown field)"}
         )
 
     def test_ordering_by_random_with_offset_gives_error(self):

wagtail/api/v2/tests/test_images.py

@@ -255,7 +255,7 @@ class TestImageListing(TestCase):
 
         self.assertEqual(response.status_code, 400)
         self.assertEqual(
-            content, {"message": "cannot order by 'random' (unknown field)"}
+            content, {"message": "cannot order by '-random' (unknown field)"}
         )
 
     def test_ordering_by_random_with_offset_gives_error(self):

wagtail/api/v2/tests/test_pages.py

@@ -909,7 +909,7 @@ class TestPageListing(WagtailTestUtils, TestCase):
 
         self.assertEqual(response.status_code, 400)
         self.assertEqual(
-            content, {"message": "cannot order by 'random' (unknown field)"}
+            content, {"message": "cannot order by '-random' (unknown field)"}
         )
 
     def test_ordering_by_random_with_offset_gives_error(self):
@@ -994,25 +994,11 @@ class TestPageListing(WagtailTestUtils, TestCase):
 
         page_id_list = self.get_page_id_list(content)
         expected_order = [
-            15,
-            10,
-            6,
-            17,
-            20,
-            13,
-            2,
-            4,
-            9,
-            8,
-            14,
-            12,
-            18,
-            16,
-            5,
-            23,
-            19,
-            22,
             21,
+            22,
+            19,
+            23,
+            5,
         ]
         self.assertEqual(page_id_list[:5], expected_order[:5])
 
@@ -1781,6 +1767,19 @@ class TestPageFind(TestCase):
             fetch_redirect_response=False,
         )
 
+    def test_find_by_html_path_with_fields(self):
+        response = self.get_response(
+            html_path="/events-index/event-1/", fields="_,id,type"
+        )
+
+        self.assertRedirects(
+            response,
+            "http://localhost"
+            + reverse("wagtailapi_v2:pages:detail", args=[8])
+            + "?fields=_,id,type",
+            fetch_redirect_response=False,
+        )
+
     def test_find_by_html_path_nonexistent(self):
         response = self.get_response(html_path="/foo")
 

wagtail/api/v2/views.py

@@ -56,6 +56,7 @@ class BaseAPIViewSet(GenericViewSet):
             "format",
         ]
     )
+    find_query_parameters = frozenset(["id"])
     body_fields = ["id"]
     meta_fields = ["type", "detail_url"]
     listing_default_fields = ["id", "type", "detail_url"]
@@ -113,7 +114,12 @@ class BaseAPIViewSet(GenericViewSet):
                 )
             )
 
-        return redirect(url)
+        # Retain all query parameters except ones only used to find the object
+        query = request.GET.copy()
+        for param in self.find_query_parameters:
+            query.pop(param, None)
+
+        return redirect(f"{url}?{query.urlencode()}")
 
     def find_object(self, queryset, request):
         """
@@ -435,6 +441,11 @@ class PagesAPIViewSet(BaseAPIViewSet):
             "site",
         ]
     )
+    find_query_parameters = BaseAPIViewSet.find_query_parameters.union(
+        [
+            "html_path",
+        ]
+    )
     body_fields = BaseAPIViewSet.body_fields + [
         "title",
     ]

wagtail/apps.py

@@ -19,5 +19,3 @@ class WagtailAppConfig(AppConfig):
         from wagtail.signal_handlers import register_signal_handlers
 
         register_signal_handlers()
-
-        from wagtail import widget_adapters  # noqa: F401

wagtail/blocks/base.py

@@ -16,7 +16,8 @@ from django.utils.safestring import mark_safe
 from django.utils.text import capfirst
 
 from wagtail.admin.staticfiles import versioned_static
-from wagtail.telepath import JSContext
+from wagtail.admin.telepath import JSContext
+from wagtail.admin.telepath import register as register_telepath_adapter
 from wagtail.utils.templates import template_is_overridden
 
 __all__ = [
@@ -62,6 +63,7 @@ class Block(metaclass=BaseBlock):
         label = None
         icon = "placeholder"
         classname = None
+        form_attrs = None
         group = ""
 
     # Attributes of Meta which can legally be modified after the block has been instantiated.
@@ -150,15 +152,20 @@ class Block(metaclass=BaseBlock):
         """
         return BoundBlock(self, value, prefix=prefix, errors=errors)
 
+    def _evaluate_callable(self, value):
+        return value() if callable(value) else value
+
     def get_default(self):
         """
         Return this block's default value (conventionally found in self.meta.default),
-        converted to the value type expected by this block. This caters for the case
-        where that value type is not something that can be expressed statically at
+        converted to the value type expected by this block. If the default is a callable
+        (e.g. a function), it will be evaluated at runtime. This caters for
+        the case where that value type is not something that can be expressed statically at
         model definition time (e.g. something like StructValue which incorporates a
         pointer back to the block definition object).
         """
-        return self.normalize(getattr(self.meta, "default", None))
+        default = self._evaluate_callable(getattr(self.meta, "default", None))
+        return self.normalize(default)
 
     def clean(self, value):
         """
@@ -310,12 +317,13 @@ class Block(metaclass=BaseBlock):
         """
         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.
+        options if provided. If it's a callable, it will be evaluated at runtime.
+        If ``preview_value`` is not provided, the ``default`` is used as fallback.
+        This method can also be overridden to provide a dynamic preview value.
         """
         if hasattr(self.meta, "preview_value"):
-            return self.normalize(self.meta.preview_value)
+            value = self._evaluate_callable(self.meta.preview_value)
+            return self.normalize(value)
         return self.get_default()
 
     @cached_property
@@ -647,6 +655,7 @@ class DeclarativeSubBlocksMetaclass(BaseBlock):
 # ========================
 
 
+@register_telepath_adapter
 class BlockWidget(forms.Widget):
     """Wraps a block object as a widget so that it can be incorporated into a Django form"""
 
@@ -711,9 +720,8 @@ class BlockWidget(forms.Widget):
     def media(self):
         return self.js_context.media + forms.Media(
             js=[
-                # these will almost certainly be
+                # this 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"),
             ],
             css={
@@ -729,6 +737,9 @@ class BlockWidget(forms.Widget):
     def value_omitted_from_data(self, data, files, name):
         return self.block_def.value_omitted_from_data(data, files, name)
 
+    def telepath_pack(self, context):
+        return ("wagtail.widgets.BlockWidget", [])
+
 
 class BlockField(forms.Field):
     """Wraps a block object as a form field so that it can be incorporated into a Django form"""