wagtail 6.2.1__py3-none-any.whl → 6.3rc1__py3-none-any.whl

wagtail/admin/tests/viewsets/test_model_viewset.py

@@ -40,8 +40,8 @@ class TestModelViewSetGroup(WagtailTestUtils, TestCase):
             response,
             '"name": "tests", "label": "Tests", "icon_name": "folder-open-inverse"',
         )
-        # Title-cased from verbose_name_plural
-        self.assertContains(response, "Json Stream Models")
+        # Capitalized-first from verbose_name_plural
+        self.assertContains(response, "JSON stream models")
         self.assertContains(response, reverse("streammodel:index"))
         self.assertEqual(reverse("streammodel:index"), "/admin/streammodel/")
         # Set on class
@@ -81,7 +81,7 @@ class TestModelViewSetGroup(WagtailTestUtils, TestCase):
         )
 
         # The menu item for the model is shown
-        self.assertContains(response, "Json Stream Models")
+        self.assertContains(response, "JSON stream models")
         self.assertContains(response, reverse("streammodel:index"))
         self.assertEqual(reverse("streammodel:index"), "/admin/streammodel/")
 
@@ -451,6 +451,7 @@ class TestSearchIndexView(WagtailTestUtils, TestCase):
 
     def test_search_disabled(self):
         response = self.get("fctoy_alt1", {"q": "ork"})
+        self.assertFalse(response.context.get("search_form"))
         self.assertContains(response, "Forky")
         self.assertContains(response, "Buzz Lightyear")
         self.assertNotContains(response, "There are 2 matches")
@@ -1043,6 +1044,11 @@ class TestHistoryView(WagtailTestUtils, TestCase):
         for rendered_row, expected_row in zip(rendered_rows, expected):
             self.assertSequenceEqual(rendered_row, expected_row)
 
+        # History view is not searchable
+        input = soup.select_one("input#id_q")
+        self.assertIsNone(input)
+        self.assertFalse(response.context.get("search_form"))
+
     def test_action_filter(self):
         response = self.client.get(self.url)
         self.assertEqual(response.status_code, 200)
@@ -1235,12 +1241,22 @@ class TestUsageView(WagtailTestUtils, TestCase):
         link = tds[0].select_one("a")
         self.assertIsNotNone(link)
         self.assertEqual(link.attrs.get("href"), tbx_edit_url)
+        content_path_link = tds[-1].select_one("a")
+        self.assertEqual(
+            content_path_link.attrs.get("href"),
+            tbx_edit_url + "#:w:contentpath=cascading_toy",
+        )
 
         # Link to referrer's edit view with parameters for the specific field
         link = tds[2].select_one("a")
         self.assertIsNotNone(link)
         self.assertIn(tbx_edit_url, link.attrs.get("href"))
 
+        # Usage view is not searchable
+        input = soup.select_one("input#id_q")
+        self.assertIsNone(input)
+        self.assertFalse(response.context.get("search_form"))
+
     def test_usage_without_permission(self):
         self.user.is_superuser = False
         self.user.save()
@@ -1817,3 +1833,39 @@ class TestDefaultMessages(WagtailTestUtils, TestCase):
             response,
             escape(f"Feature complete toy '{self.object}' deleted."),
         )
+
+
+class TestHeaderButtons(WagtailTestUtils, TestCase):
+    def setUp(self):
+        self.user = self.login()
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.object = FeatureCompleteToy.objects.create(name="Test Toy")
+        cls.edit_url = reverse(
+            "feature_complete_toy:edit", args=(quote(cls.object.pk),)
+        )
+        cls.copy_url = reverse(
+            "feature_complete_toy:copy", args=(quote(cls.object.pk),)
+        )
+        cls.delete_url = reverse(
+            "feature_complete_toy:delete", args=(quote(cls.object.pk),)
+        )
+        cls.inspect_url = reverse(
+            "feature_complete_toy:inspect", args=(quote(cls.object.pk),)
+        )
+
+    def test_header_buttons_in_edit_view(self):
+        response = self.client.get(self.edit_url)
+        self.assertEqual(response.status_code, 200)
+        soup = self.get_soup(response.content)
+        header_buttons = soup.select(".w-slim-header .w-dropdown a")
+        expected_buttons = [
+            ("Copy", self.copy_url),
+            ("Delete", self.delete_url),
+            ("Inspect", self.inspect_url),
+        ]
+        self.assertEqual(
+            [(a.text.strip(), a.get("href")) for a in header_buttons],
+            expected_buttons,
+        )

wagtail/admin/ui/editing_sessions.py

@@ -30,7 +30,7 @@ class EditingSessionsModule(Component):
             "current_session": self.current_session,
             "ping_url": self.ping_url,
             "release_url": self.release_url,
-            "ping_interval": str(ping_interval),  # avoid the need to | unlocalize
+            "ping_interval": ping_interval,
             "sessions_list": self.sessions_list,
             "revision_id": self.revision_id,
         }

wagtail/admin/ui/side_panels.py

@@ -1,3 +1,6 @@
+import warnings
+
+from django.conf import settings
 from django.urls import reverse
 from django.utils.text import capfirst
 from django.utils.translation import gettext_lazy, ngettext
@@ -6,6 +9,7 @@ from wagtail import hooks
 from wagtail.admin.ui.components import Component
 from wagtail.admin.userbar import AccessibilityItem
 from wagtail.models import DraftStateMixin, LockableMixin, Page, ReferenceIndex
+from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 
 class BaseSidePanel(Component):
@@ -350,8 +354,23 @@ class PreviewSidePanel(BaseSidePanel):
         super().__init__(object, request)
         self.preview_url = preview_url
 
+    @property
+    def auto_update_interval(self):
+        if hasattr(settings, "WAGTAIL_AUTO_UPDATE_PREVIEW"):
+            warnings.warn(
+                "`WAGTAIL_AUTO_UPDATE_PREVIEW` is deprecated. "
+                "Set `WAGTAIL_AUTO_UPDATE_PREVIEW_INTERVAL = 0` to disable "
+                "auto-update for previews.",
+                RemovedInWagtail70Warning,
+            )
+            if not settings.WAGTAIL_AUTO_UPDATE_PREVIEW:
+                return 0
+
+        return getattr(settings, "WAGTAIL_AUTO_UPDATE_PREVIEW_INTERVAL", 500)
+
     def get_context_data(self, parent_context):
         context = super().get_context_data(parent_context)
         context["preview_url"] = self.preview_url
         context["has_multiple_modes"] = len(self.object.preview_modes) > 1
+        context["auto_update_interval"] = self.auto_update_interval
         return context

wagtail/admin/ui/sidebar.py

@@ -1,4 +1,5 @@
-from typing import Any, List, Mapping
+from collections.abc import Mapping
+from typing import Any
 from warnings import warn
 
 from django import forms
@@ -152,7 +153,7 @@ class SubMenuItem(MenuItem):
         self,
         name: str,
         label: str,
-        menu_items: List[MenuItem],
+        menu_items: list[MenuItem],
         icon_name: str = "",
         classname: str = "",
         classnames: str = "",
@@ -262,7 +263,7 @@ class SearchModule:
 @adapter("wagtail.sidebar.MainMenuModule", base=BaseSidebarAdapter)
 class MainMenuModule:
     def __init__(
-        self, menu_items: List[MenuItem], account_menu_items: List[MenuItem], user
+        self, menu_items: list[MenuItem], account_menu_items: list[MenuItem], user
     ):
         self.menu_items = menu_items
         self.account_menu_items = account_menu_items

wagtail/admin/ui/tables/__init__.py

@@ -6,6 +6,7 @@ from collections.abc import Mapping
 from django.contrib.admin.utils import quote
 from django.forms import MediaDefiningClass
 from django.template.loader import get_template
+from django.templatetags.l10n import unlocalize
 from django.urls import reverse
 from django.utils.functional import cached_property
 from django.utils.text import capfirst
@@ -156,7 +157,13 @@ class Column(BaseColumn):
 
     def get_cell_context_data(self, instance, parent_context):
         context = super().get_cell_context_data(instance, parent_context)
-        context["value"] = self.get_value(instance)
+        value = self.get_value(instance)
+        if isinstance(value, int) and not isinstance(value, bool):
+            # To prevent errors arising from USE_THOUSAND_SEPARATOR, we require all numbers output
+            # on templates to be explicitly localized or unlocalized. For numeric table cells, we
+            # unlocalize them by default; developers may subclass Column to obtain formatted numbers.
+            value = unlocalize(value)
+        context["value"] = value
         return context
 
 
@@ -272,6 +279,12 @@ class BooleanColumn(Column):
 
     cell_template_name = "wagtailadmin/tables/boolean_cell.html"
 
+    def get_value(self, instance):
+        value = super().get_value(instance)
+        if value is None:
+            return None
+        return bool(value)
+
 
 class LiveStatusTagColumn(StatusTagColumn):
     """Represents a live/draft status tag"""

wagtail/admin/ui/tables/pages.py

@@ -56,6 +56,8 @@ class ParentPageColumn(Column):
     cell_template_name = "wagtailadmin/pages/listing/_parent_page_cell.html"
 
     def get_value(self, instance):
+        if parent := getattr(instance, "_parent_page", None):
+            return parent
         return instance.get_parent()
 
 
@@ -92,7 +94,10 @@ class NavigateToChildrenColumn(BaseColumn):
         return context
 
     def render_header_html(self, parent_context):
-        return mark_safe("<th></th>")
+        # This column has no header, as the cell's function will vary between "explore child pages"
+        # and "add child page", and this link provides all the signposting needed. Render it as a
+        # <td> rather than <th> as headings cannot be empty (https://dequeuniversity.com/rules/axe/4.9/empty-table-header).
+        return mark_safe("<td></td>")
 
 
 class PageTable(Table):

wagtail/admin/urls/pages.py

@@ -36,6 +36,11 @@ urlpatterns = [
         usage.ContentTypeUseView.as_view(),
         name="type_use",
     ),
+    path(
+        "usage/<slug:content_type_app_name>/<slug:content_type_model_name>/results/",
+        usage.ContentTypeUseView.as_view(results_only=True),
+        name="type_use_results",
+    ),
     path("<int:page_id>/usage/", usage.UsageView.as_view(), name="usage"),
     path("<int:page_id>/edit/", edit.EditView.as_view(), name="edit"),
     path(
@@ -53,7 +58,11 @@ urlpatterns = [
         name="convert_alias",
     ),
     path("search/", search.SearchView.as_view(), name="search"),
-    path("search/results/", search.SearchResultsView.as_view(), name="search_results"),
+    path(
+        "search/results/",
+        search.SearchView.as_view(results_only=True),
+        name="search_results",
+    ),
     path("<int:page_to_move_id>/move/", move.move_choose_destination, name="move"),
     path(
         "<int:page_to_move_id>/move/<int:destination_id>/confirm/",

wagtail/admin/urls/workflows.py

@@ -14,7 +14,12 @@ urlpatterns = [
     path("enable/<int:pk>/", workflows.enable_workflow, name="enable"),
     path("disable/<int:pk>/", workflows.Disable.as_view(), name="disable"),
     path("edit/<int:pk>/", workflows.Edit.as_view(), name="edit"),
-    path("usage/<int:pk>/", workflows.usage, name="usage"),
+    path("usage/<int:pk>/", workflows.WorkflowUsageView.as_view(), name="usage"),
+    path(
+        "usage/<int:pk>/results/",
+        workflows.WorkflowUsageView.as_view(results_only=True),
+        name="usage_results",
+    ),
     path("remove/<int:page_pk>/", workflows.remove_workflow, name="remove"),
     path(
         "remove/<int:page_pk>/<int:workflow_pk>/",

wagtail/admin/views/account.py

@@ -31,7 +31,7 @@ from wagtail.admin.localization import (
     get_available_admin_languages,
     get_available_admin_time_zones,
 )
-from wagtail.admin.views.generic import WagtailAdminTemplateMixin
+from wagtail.admin.views.generic import EditView, WagtailAdminTemplateMixin
 from wagtail.log_actions import log
 from wagtail.users.models import UserProfile
 from wagtail.utils.loading import get_custom_form
@@ -239,6 +239,10 @@ class AccountView(WagtailAdminTemplateMixin, TemplateView):
         context["menu_items"] = self.get_menu_items()
         context["media"] = self.get_media(panels)
         context["user"] = self.request.user
+        # Remove these when this view is refactored to a generic.EditView subclass.
+        # Avoid defining new translatable strings.
+        context["submit_button_label"] = EditView.submit_button_label
+        context["submit_button_active_label"] = EditView.submit_button_active_label
         return context
 
     def get_panels(self):

wagtail/admin/views/collections.py

@@ -30,7 +30,6 @@ class Index(IndexView):
             accessor="1",
         )
     ]
-    _show_breadcrumbs = True
 
     def get_queryset(self):
         return self.permission_policy.instances_user_has_any_permission_for(
@@ -76,7 +75,6 @@ class Edit(EditView):
     template_name = "wagtailadmin/collections/edit.html"
     success_message = gettext_lazy("Collection '%(object)s' updated.")
     error_message = gettext_lazy("The collection could not be saved due to errors.")
-    delete_item_label = gettext_lazy("Delete collection")
     edit_url_name = "wagtailadmin_collections:edit"
     index_url_name = "wagtailadmin_collections:index"
     delete_url_name = "wagtailadmin_collections:delete"

wagtail/admin/views/generic/base.py

@@ -1,8 +1,10 @@
+import warnings
 from collections import namedtuple
 
 from django.contrib.admin.utils import quote, unquote
 from django.core.exceptions import ImproperlyConfigured
 from django.db import models
+from django.db.models import Q
 from django.shortcuts import get_object_or_404, redirect
 from django.urls import reverse, reverse_lazy
 from django.utils.formats import date_format
@@ -20,9 +22,12 @@ from django_filters.filters import (
 )
 
 from wagtail.admin import messages
+from wagtail.admin.forms.search import SearchForm
 from wagtail.admin.ui.tables import Column, Table
 from wagtail.admin.utils import get_valid_next_url_from_request
 from wagtail.admin.widgets.button import ButtonWithDropdown
+from wagtail.search.backends import get_search_backend
+from wagtail.search.index import class_is_indexed
 from wagtail.utils.utils import flatten_choices
 
 
@@ -191,8 +196,14 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
     index_url_name = None
     index_results_url_name = None
     page_kwarg = "p"
+    is_searchable = None  # Subclasses must explicitly set this to True to enable search
+    search_kwarg = "q"
+    search_fields = None
+    search_backend_name = "default"
     default_ordering = None
     filterset_class = None
+    verbose_name_plural = None
+    _show_breadcrumbs = True
 
     def get_template_names(self):
         if self.results_only:
@@ -202,6 +213,74 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
         else:
             return super().get_template_names()
 
+    def get_breadcrumbs_items(self):
+        return self.breadcrumbs_items + [
+            {
+                "url": "",
+                "label": self.get_page_title(),
+                "sublabel": self.get_page_subtitle(),
+            },
+        ]
+
+    def get_search_form(self):
+        if not self.is_searchable:
+            return None
+
+        if self.search_kwarg in self.request.GET:
+            return SearchForm(self.request.GET)
+
+        return SearchForm()
+
+    @cached_property
+    def search_form(self):
+        return self.get_search_form()
+
+    @cached_property
+    def search_query(self):
+        if self.search_form and self.search_form.is_valid():
+            return self.search_form.cleaned_data[self.search_kwarg]
+        return ""
+
+    @cached_property
+    def is_searching(self):
+        return bool(self.search_query)
+
+    def search_queryset(self, queryset):
+        if not self.is_searching:
+            return queryset
+
+        # Use Wagtail Search if the model is indexed and a search backend is defined.
+        # Django ORM can still be used on an indexed model by unsetting
+        # search_backend_name and defining search_fields on the view.
+        if class_is_indexed(queryset.model) and self.search_backend_name:
+            search_backend = get_search_backend(self.search_backend_name)
+            if queryset.model.get_autocomplete_search_fields():
+                return search_backend.autocomplete(
+                    self.search_query,
+                    queryset,
+                    fields=self.search_fields,
+                    order_by_relevance=(not self.is_explicitly_ordered),
+                )
+            else:
+                # fall back on non-autocompleting search
+                warnings.warn(
+                    f"{queryset.model} is defined as Indexable but does not specify "
+                    "any AutocompleteFields. Searches within the admin will only "
+                    "respond to complete words.",
+                    category=RuntimeWarning,
+                )
+                return search_backend.search(
+                    self.search_query,
+                    queryset,
+                    fields=self.search_fields,
+                    order_by_relevance=(not self.is_explicitly_ordered),
+                )
+
+        query = Q()
+        for field in self.search_fields or []:
+            query |= Q(**{field + "__icontains": self.search_query})
+        return queryset.filter(query)
+
     @cached_property
     def filters(self):
         if self.filterset_class:
@@ -317,7 +396,7 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
                     ActiveFilter(
                         bound_field.auto_id,
                         filter_def.label,
-                        "%s - %s" % (start_date_display, end_date_display),
+                        f"{start_date_display} - {end_date_display}",
                         self.get_url_without_filter_param(
                             [
                                 widget.suffixed(field_name, suffix)
@@ -405,8 +484,21 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
         queryset = self.get_base_queryset()
         queryset = self.order_queryset(queryset)
         queryset = self.filter_queryset(queryset)
+        queryset = self.search_queryset(queryset)
         return queryset
 
+    def paginate_queryset(self, queryset, page_size):
+        paginator = self.get_paginator(
+            queryset,
+            page_size,
+            orphans=self.get_paginate_orphans(),
+            allow_empty_first_page=self.get_allow_empty(),
+        )
+
+        page_number = self.request.GET.get(self.page_kwarg)
+        page = paginator.get_page(page_number)
+        return (paginator, page, page.object_list, page.has_other_pages())
+
     def get_table_kwargs(self):
         return {
             "ordering": self.ordering,
@@ -437,6 +529,20 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
         if self.index_results_url_name:
             return reverse(self.index_results_url_name)
 
+    @cached_property
+    def no_results_message(self):
+        if not self.verbose_name_plural:
+            return _("There are no results.")
+
+        if self.is_searching or self.is_filtering:
+            return _("No %(model_name)s match your query.") % {
+                "model_name": self.verbose_name_plural
+            }
+
+        return _("There are no %(model_name)s to display.") % {
+            "model_name": self.verbose_name_plural
+        }
+
     def get_context_data(self, *args, **kwargs):
         context = super().get_context_data(*args, **kwargs)
 
@@ -444,6 +550,9 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
 
         context["index_url"] = self.index_url
         context["index_results_url"] = self.index_results_url
+        context["verbose_name_plural"] = self.verbose_name_plural
+        context["no_results_message"] = self.no_results_message
+        context["ordering"] = self.ordering
         context["table"] = table
         context["media"] = table.media
         # On Django's BaseListView, a listing where pagination is applied, but the results
@@ -462,6 +571,12 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
             context["is_filtering"] = self.is_filtering
             context["media"] += self.filters.form.media
 
+        if self.search_form:
+            context["search_form"] = self.search_form
+            context["is_searching"] = self.is_searching
+            context["query_string"] = self.search_query
+            context["media"] += self.search_form.media
+
         # If we're rendering the results as an HTML fragment, the caller can pass a _w_filter_fragment=1
         # URL parameter to indicate that the filters should be rendered as a <template> block so that
         # we can replace the existing filters.
@@ -470,6 +585,8 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
             and self.filters
             and self.results_only
         )
+        # Ensure that the header buttons get re-rendered for the results-only view,
+        # in case they make use of the search/filter state
         context["render_buttons_fragment"] = (
             context.get("header_buttons") and self.results_only
         )