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

wagtail/snippets/tests/test_usage.py

@@ -74,15 +74,16 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertEqual(sublabel.get_text(strip=True), "Draft-enabled Bar, In Draft")
 
     def test_usage(self):
-        # resave so that usage count gets updated
-        page = Page.objects.get(pk=2)
-        page.save()
-
-        gfk_page = GenericSnippetPage(
-            title="Foobar Title",
-            snippet_content_object=Advert.objects.get(pk=1),
-        )
-        page.add_child(instance=gfk_page)
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = Page.objects.get(pk=2)
+            page.save()
+
+            gfk_page = GenericSnippetPage(
+                title="Foobar Title",
+                snippet_content_object=Advert.objects.get(pk=1),
+            )
+            page.add_child(instance=gfk_page)
 
         response = self.client.get(
             reverse(
@@ -124,9 +125,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertRedirects(response, reverse("wagtailadmin_home"))
 
     def test_usage_without_edit_permission_on_page(self):
-        # resave so that usage count gets updated
-        page = Page.objects.get(pk=2)
-        page.save()
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = Page.objects.get(pk=2)
+            page.save()
 
         # Create a user with edit access to snippets but not pages
         user = self.create_user(
@@ -157,9 +159,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertContains(response, "<li>Advert</li>", html=True)
 
     def test_usage_with_describe_on_delete_cascade(self):
-        # resave so that usage count gets updated
-        page = Page.objects.get(pk=2)
-        page.save()
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = Page.objects.get(pk=2)
+            page.save()
 
         response = self.client.get(
             reverse("wagtailsnippets_tests_advert:usage", args=["1"])
@@ -173,9 +176,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertContains(response, ": the advert placement will also be deleted")
 
     def test_usage_with_describe_on_delete_set_null(self):
-        # resave so that usage count gets updated
-        page = EventPage.objects.first()
-        page.save()
+        with self.captureOnCommitCallbacks(execute=True):
+            # resave so that usage count gets updated
+            page = EventPage.objects.first()
+            page.save()
 
         self.assertEqual(page.feed_image.get_usage().count(), 1)
 
@@ -191,13 +195,14 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
         self.assertContains(response, ": will unset the reference")
 
     def test_usage_with_describe_on_delete_gfk(self):
-        advert = Advert.objects.get(pk=1)
+        with self.captureOnCommitCallbacks(execute=True):
+            advert = Advert.objects.get(pk=1)
 
-        gfk_page = GenericSnippetPage(
-            title="Foobar Title",
-            snippet_content_object=advert,
-        )
-        Page.objects.get(pk=1).add_child(instance=gfk_page)
+            gfk_page = GenericSnippetPage(
+                title="Foobar Title",
+                snippet_content_object=advert,
+            )
+            Page.objects.get(pk=1).add_child(instance=gfk_page)
 
         self.assertEqual(ReferenceIndex.get_grouped_references_to(advert).count(), 1)
 

wagtail/snippets/tests/test_viewset.py

@@ -95,7 +95,7 @@ class TestCustomIcon(BaseSnippetViewSetTests):
             (
                 "revisions_compare",
                 [pk, self.revision_1.id, self.revision_2.id],
-                "header.html",
+                "headers/slim_header.html",
             ),
             ("revisions_unschedule", [pk, self.revision_2.id], "header.html"),
         ]

wagtail/snippets/views/snippets.py

@@ -358,18 +358,6 @@ class PreviewRevisionView(PermissionCheckedMixin, PreviewRevision):
 class RevisionsCompareView(PermissionCheckedMixin, generic.RevisionsCompareView):
     permission_required = "change"
 
-    @property
-    def edit_label(self):
-        return _("Edit this %(model_name)s") % {
-            "model_name": self.model._meta.verbose_name
-        }
-
-    @property
-    def history_label(self):
-        return _("%(model_name)s history") % {
-            "model_name": self.model._meta.verbose_name
-        }
-
 
 class UnpublishView(PermissionCheckedMixin, generic.UnpublishView):
     permission_required = "publish"

wagtail/tasks.py

@@ -0,0 +1,41 @@
+from django.apps import apps
+from django.db import transaction
+from django.utils.module_loading import import_string
+from django_tasks import task
+from modelcluster.fields import ParentalKey
+
+from wagtail.models import ReferenceIndex
+
+
+@task()
+def update_reference_index_task(app_label, model_name, pk):
+    model = apps.get_model(app_label, model_name)
+    instance = model.objects.get(pk=pk)
+
+    # If the model is a child model, find the parent instance and index that instead
+    while True:
+        parental_keys = list(
+            filter(
+                lambda field: isinstance(field, ParentalKey),
+                instance._meta.get_fields(),
+            )
+        )
+        if not parental_keys:
+            break
+
+        instance = getattr(instance, parental_keys[0].name)
+        if instance is None:
+            # parent is null, so there is no valid object to record references against
+            return
+
+    if ReferenceIndex.is_indexed(instance._meta.model):
+        with transaction.atomic():
+            ReferenceIndex.create_or_update_for_object(instance)
+
+
+@task()
+def delete_file_from_storage_task(deconstructed_storage, path):
+    storage_module, storage_args, storage_kwargs = deconstructed_storage
+    storage = import_string(storage_module)(*storage_args, **storage_kwargs)
+
+    storage.delete(path)

wagtail/templates/wagtailcore/shared/block_preview.html

@@ -0,0 +1,29 @@
+{% load wagtailcore_tags i18n %}
+{% get_current_language as LANGUAGE_CODE %}
+{% get_current_language_bidi as LANGUAGE_BIDI %}
+<!DOCTYPE html>
+<html lang="{{ LANGUAGE_CODE }}" dir="{% if LANGUAGE_BIDI %}rtl{% else %}ltr{% endif %}">
+    <head>
+        {% block head %}
+            <meta charset="UTF-8" />
+            <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+            <meta name="robots" content="noindex" />
+            <title>{{ page_title }}</title>
+
+            {% block css %}
+            {% endblock %}
+        {% endblock %}
+    </head>
+    <body>
+        {% block body %}
+            <main>
+                {% block content %}
+                    {% include_block bound_block %}
+                {% endblock %}
+            </main>
+
+            {% block js %}
+            {% endblock %}
+        {% endblock %}
+    </body>
+</html>

wagtail/test/earlypage/migrations/0001_initial.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.1.4 on 2025-01-03 15:30
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("wagtailcore", "0094_alter_page_locale"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="EarlyPage",
+            fields=[
+                (
+                    "page_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="wagtailcore.page",
+                    ),
+                ),
+                ("intro", models.TextField(blank=True)),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail/test/earlypage/models.py

@@ -0,0 +1,14 @@
+# This module DOES NOT import from wagtail.admin -
+# this tests that we are able to define Page models before wagtail.admin is loaded.
+
+from django.db import models
+
+from wagtail.models import Page
+
+
+class EarlyPage(Page):
+    intro = models.TextField(blank=True)
+
+    content_panels = Page.content_panels + [
+        "intro",
+    ]

wagtail/test/settings.py

@@ -135,6 +135,9 @@ MIDDLEWARE = (
 )
 
 INSTALLED_APPS = [
+    # Place wagtail.test.earlypage first, to test the behaviour of page models
+    # that are defined before wagtail.admin is loaded
+    "wagtail.test.earlypage",
     # Install wagtailredirects with its appconfig
     # There's nothing special about wagtailredirects, we just need to have one
     # app which uses AppConfigs to test that hooks load properly

wagtail/test/testapp/fixtures/test.json

@@ -1027,5 +1027,12 @@
     "fields": {
       "content": "non-url-safe pk modelwithstringtypeprimarykey model"
     }
+  },
+  {
+    "pk": "web_407269_1",
+    "model": "tests.modelwithstringtypeprimarykey",
+    "fields": {
+      "content": "unquote-sensitive modelwithstringtypeprimarykey model"
+    }
   }
 ]

wagtail/test/testapp/fixtures/test_specific.json

@@ -141,7 +141,8 @@
       "audience": "public",
       "location": "The moon",
       "body": "<p>I haven't worked out the details yet, but it's going to have cake and ponies</p>",
-      "cost": "Free"
+      "cost": "Free",
+      "feed_image": 1
     }
   },
 
@@ -170,7 +171,8 @@
       "audience": "private",
       "location": "The moon",
       "body": "<p>your name's not down, you're not coming in</p>",
-      "cost": "Free (but not for you)"
+      "cost": "Free (but not for you)",
+      "feed_image": 1
     }
   },
 
@@ -246,7 +248,8 @@
       "audience": "public",
       "location": "Hobart",
       "body": "<p>Party time</p>",
-      "cost": "free"
+      "cost": "free",
+      "feed_image": 1
     }
   },
 

wagtail/test/testapp/models.py

@@ -44,7 +44,8 @@ from wagtail.blocks import (
     StreamBlock,
     StructBlock,
 )
-from wagtail.contrib.forms.forms import FormBuilder
+from wagtail.compat import HTTPMethod
+from wagtail.contrib.forms.forms import FormBuilder, WagtailAdminFormPageForm
 from wagtail.contrib.forms.models import (
     FORM_FIELD_CHOICES,
     AbstractEmailForm,
@@ -93,12 +94,7 @@ EVENT_AUDIENCE_CHOICES = (
 )
 
 
-COMMON_PANELS = (
-    FieldPanel("slug"),
-    FieldPanel("seo_title"),
-    FieldPanel("show_in_menus"),
-    FieldPanel("search_description"),
-)
+COMMON_PANELS = ("slug", "seo_title", "show_in_menus", "search_description")
 
 CUSTOM_PREVIEW_SIZES = [
     {
@@ -170,9 +166,9 @@ class CarouselItem(LinkFields):
     caption = models.CharField(max_length=255, blank=True)
 
     panels = [
-        FieldPanel("image"),
-        FieldPanel("embed_url"),
-        FieldPanel("caption"),
+        "image",
+        "embed_url",
+        "caption",
         MultiFieldPanel(LinkFields.panels, "Link"),
     ]
 
@@ -187,7 +183,7 @@ class RelatedLink(LinkFields):
     title = models.CharField(max_length=255, help_text="Link title")
 
     panels = [
-        FieldPanel("title"),
+        "title",
         MultiFieldPanel(LinkFields.panels, "Link"),
     ]
 
@@ -320,10 +316,7 @@ class EventPageSpeakerAward(TranslatableMixin, Orderable, models.Model):
     name = models.CharField("Award name", max_length=255)
     date_awarded = models.DateField(null=True, blank=True)
 
-    panels = [
-        FieldPanel("name"),
-        FieldPanel("date_awarded"),
-    ]
+    panels = ["name", "date_awarded"]
 
     class Meta(TranslatableMixin.Meta, Orderable.Meta):
         pass
@@ -351,9 +344,9 @@ class EventPageSpeaker(TranslatableMixin, Orderable, LinkFields, ClusterableMode
         return self.first_name + " " + self.last_name
 
     panels = [
-        FieldPanel("first_name"),
-        FieldPanel("last_name"),
-        FieldPanel("image"),
+        "first_name",
+        "last_name",
+        "image",
         MultiFieldPanel(LinkFields.panels, "Link"),
         InlinePanel("awards", label="Awards"),
     ]
@@ -422,24 +415,24 @@ class EventPage(Page):
 
     content_panels = [
         FieldPanel("title", classname="title"),
-        FieldPanel("date_from"),
-        FieldPanel("date_to"),
-        FieldPanel("time_from"),
-        FieldPanel("time_to"),
-        FieldPanel("location"),
+        "date_from",
+        "date_to",
+        "time_from",
+        "time_to",
+        "location",
         FieldPanel("audience", help_text="Who this event is for"),
-        FieldPanel("cost"),
-        FieldPanel("signup_link"),
+        "cost",
+        "signup_link",
         InlinePanel("carousel_items", label="Carousel items"),
-        FieldPanel("body"),
+        "body",
         InlinePanel(
             "speakers",
-            label="Speakers",
+            label="Speaker",
             heading="Speaker lineup",
             help_text="Put the keynote speaker first",
         ),
         InlinePanel("related_links", label="Related links"),
-        FieldPanel("categories"),
+        "categories",
         # InlinePanel related model uses `pk` not `id`
         InlinePanel("head_counts", label="Head Counts"),
     ]
@@ -527,6 +520,9 @@ class EventIndex(Page):
     intro = RichTextField(blank=True, max_length=50)
     ajax_template = "tests/includes/event_listing.html"
 
+    # NOTE: Using a mix of enum and string values to test handling of both
+    allowed_http_methods = [HTTPMethod.GET, "OPTIONS"]
+
     def get_events(self):
         return self.get_children().live().type(EventPage)
 
@@ -715,18 +711,37 @@ class FormPageWithRedirect(AbstractEmailForm):
 # FormPage with a custom FormSubmission
 
 
+class FormPageWithCustomSubmissionForm(WagtailAdminFormPageForm):
+    """
+    Used to validate that admin forms can validate the page's submissions via
+    extending the form class.
+    """
+
+    def clean(self):
+        cleaned_data = super().clean()
+        from_address = cleaned_data.get("from_address")
+        if from_address and "example.com" in from_address:
+            raise ValidationError("Email cannot be from example.com")
+
+        return cleaned_data
+
+
 class FormPageWithCustomSubmission(AbstractEmailForm):
     """
-    This Form page:
-        * Have custom submission model
-        * Have custom related_name (see `FormFieldWithCustomSubmission.page`)
-        * Saves reference to a user
-        * Doesn't render html form, if submission for current user is present
+    A ``FormPage`` with a custom FormSubmission and other extensive customizations:
+
+    * A custom submission model
+    * A custom related_name (see `FormFieldWithCustomSubmission.page`)
+    * Saves reference to a user
+    * Doesn't render html form, if submission for current user is present
+    * A custom clean method that does not allow the ``from_address`` to be set to anything including example.com
     """
 
     intro = RichTextField(blank=True)
     thank_you_text = RichTextField(blank=True)
 
+    base_form_class = FormPageWithCustomSubmissionForm
+
     def get_context(self, request, *args, **kwargs):
         context = super().get_context(request)
         context["greeting"] = "hello world"
@@ -1816,12 +1831,12 @@ class ImportantPagesGenericSetting(BaseGenericSetting):
         verbose_name_plural = _("Important pages settings")
 
 
-@register_setting(icon="icon-setting-tag")
+@register_setting(icon="tag")
 class IconSiteSetting(BaseSiteSetting):
     pass
 
 
-@register_setting(icon="icon-setting-tag")
+@register_setting(icon="tag")
 class IconGenericSetting(BaseGenericSetting):
     pass
 
@@ -2149,13 +2164,13 @@ class PersonPage(Page):
     content_panels = Page.content_panels + [
         MultiFieldPanel(
             [
-                FieldPanel("first_name"),
-                FieldPanel("last_name"),
+                "first_name",
+                "last_name",
             ],
             "Person",
         ),
-        InlinePanel("addresses", label="Address"),
-        InlinePanel("social_links", label="Social links"),
+        "addresses",
+        "social_links",
     ]
 
     class Meta:
@@ -2205,10 +2220,7 @@ class SocialLink(index.Indexed, ClusterableModel):
         to="tests.PersonPage", related_name="social_links", verbose_name="Person"
     )
 
-    panels = [
-        FieldPanel("url"),
-        FieldPanel("kind"),
-    ]
+    panels = ["url", "kind"]
 
     class Meta:
         verbose_name = "Social link"
@@ -2340,7 +2352,9 @@ class ModelWithNullableParentalKey(models.Model):
 
 class GalleryPage(Page):
     content_panels = Page.content_panels + [
-        MultipleChooserPanel("gallery_images", chooser_field_name="image")
+        MultipleChooserPanel(
+            "gallery_images", heading="Gallery images", chooser_field_name="image"
+        )
     ]
 
 

wagtail/test/testapp/templates/tests/custom_block_preview.html

@@ -0,0 +1,16 @@
+{% extends "wagtailcore/shared/block_preview.html" %}
+{% load static %}
+
+{% block content %}
+    <div class="my-preview-wrapper">
+        {{ block.super }}
+    </div>
+{% endblock %}
+
+{% block css %}
+    <link rel="stylesheet" href="{% static 'css/custom.css' %}">
+{% endblock %}
+
+{% block js %}
+    <script type="module" src="{% static 'js/custom.js' %}"></script>
+{% endblock %}

wagtail/test/testapp/templates/tests/static_block_preview.html

@@ -0,0 +1,5 @@
+{% extends "wagtailcore/shared/block_preview.html" %}
+{% load static %}
+{% block content %}
+    <img src="{% static image_path %}" alt="{{ image_description }}" />
+{% endblock %}

wagtail/test/testapp/wagtail_hooks.py

@@ -1,3 +1,5 @@
+import os
+
 from django import forms
 from django.http import HttpResponse
 from django.utils.safestring import mark_safe
@@ -432,3 +434,10 @@ def register_animated_advert_chooser_viewset():
 @hooks.register("register_admin_viewset")
 def register_event_page_listing_viewset():
     return event_page_listing_viewset
+
+
+@hooks.register("get_avatar_url")
+def register_avatar_intercept_url(user, size):
+    if os.environ.get("AVATAR_INTERCEPT"):
+        return "/some/avatar/fred.png"
+    return None