wagtail 7.2.1__py3-none-any.whl → 7.3rc1__py3-none-any.whl

wagtail/snippets/views/snippets.py

@@ -58,8 +58,8 @@ def get_snippet_model_from_url_params(app_name, model_name):
     """
     try:
         model = apps.get_model(app_name, model_name)
-    except LookupError:
-        raise Http404
+    except LookupError as e:
+        raise Http404 from e
     if model not in get_snippet_models():
         # don't allow people to hack the URL to edit content types that aren't registered as snippets
         raise Http404
@@ -235,10 +235,27 @@ class CreateView(generic.CreateEditViewOptionalFeaturesMixin, generic.CreateView
     template_name = "wagtailsnippets/snippets/create.html"
 
     def run_before_hook(self):
-        return self.run_hook("before_create_snippet", self.request, self.model)
+        response = self.run_hook("before_create_snippet", self.request, self.model)
+        if response:
+            if self.expects_json_response and not self.response_is_json(response):
+                # Hook response is not suitable for a JSON response, so construct our own error response
+                return self.json_error_response(
+                    "blocked_by_hook",
+                    _("Request to create %(model_name)s was blocked by hook.")
+                    % {"model_name": self.model._meta.verbose_name},
+                )
+            else:
+                return response
 
     def run_after_hook(self):
-        return self.run_hook("after_create_snippet", self.request, self.object)
+        response = self.run_hook("after_create_snippet", self.request, self.object)
+        if response:
+            if self.expects_json_response and not self.response_is_json(response):
+                # Hook response is not suitable for a JSON response, so ignore it and just use
+                # the standard one
+                return None
+            else:
+                return response
 
     def _get_action_menu(self):
         return SnippetActionMenu(self.request, view=self.view_name, model=self.model)
@@ -253,9 +270,15 @@ class CreateView(generic.CreateEditViewOptionalFeaturesMixin, generic.CreateView
                 ),
                 locale=self.locale,
                 translations=self.translations,
+                # Show skeleton for usage info if usage_url_name is set
+                usage_url="" if self.usage_url_name else None,
             )
         ]
-        if self.preview_enabled and self.form.instance.is_previewable():
+        if (
+            not self.expects_json_response
+            and self.preview_enabled
+            and self.form.instance.is_previewable()
+        ):
             side_panels.append(
                 PreviewSidePanel(
                     self.form.instance, self.request, preview_url=self.get_preview_url()
@@ -276,15 +299,35 @@ class CopyView(generic.CopyViewMixin, CreateView):
     pass
 
 
-class EditView(generic.CreateEditViewOptionalFeaturesMixin, generic.EditView):
+class EditView(
+    generic.CreateEditViewOptionalFeaturesMixin,
+    generic.EditView,
+):
     view_name = "edit"
     template_name = "wagtailsnippets/snippets/edit.html"
 
     def run_before_hook(self):
-        return self.run_hook("before_edit_snippet", self.request, self.object)
+        response = self.run_hook("before_edit_snippet", self.request, self.object)
+        if response:
+            if self.expects_json_response and not self.response_is_json(response):
+                # Hook response is not suitable for a JSON response, so construct our own error response
+                return self.json_error_response(
+                    "blocked_by_hook",
+                    _("Request to edit %(model_name)s was blocked by hook.")
+                    % {"model_name": self.model._meta.verbose_name},
+                )
+            else:
+                return response
 
     def run_after_hook(self):
-        return self.run_hook("after_edit_snippet", self.request, self.object)
+        response = self.run_hook("after_edit_snippet", self.request, self.object)
+        if response:
+            if self.expects_json_response and not self.response_is_json(response):
+                # Hook response is not suitable for a JSON response, so ignore it and just use
+                # the standard one
+                return None
+            else:
+                return response
 
     def _get_action_menu(self):
         return SnippetActionMenu(
@@ -313,7 +356,11 @@ class EditView(generic.CreateEditViewOptionalFeaturesMixin, generic.EditView):
                 last_updated_info=self.get_last_updated_info(),
             )
         ]
-        if self.preview_enabled and self.object.is_previewable():
+        if (
+            not self.expects_json_response
+            and self.preview_enabled
+            and self.object.is_previewable()
+        ):
             side_panels.append(
                 PreviewSidePanel(
                     self.object, self.request, preview_url=self.get_preview_url()
@@ -1044,16 +1091,17 @@ class SnippetViewSet(ModelViewSet):
         )
 
     def get_urlpatterns(self):
+        conv = self.pk_path_converter
         urlpatterns = [
             path("", self.index_view, name="list"),
             path("results/", self.index_results_view, name="list_results"),
             path("add/", self.add_view, name="add"),
-            path("edit/<str:pk>/", self.edit_view, name="edit"),
-            path("delete/<str:pk>/", self.delete_view, name="delete"),
-            path("usage/<str:pk>/", self.usage_view, name="usage"),
-            path("history/<str:pk>/", self.history_view, name="history"),
+            path(f"edit/<{conv}:pk>/", self.edit_view, name="edit"),
+            path(f"delete/<{conv}:pk>/", self.delete_view, name="delete"),
+            path(f"usage/<{conv}:pk>/", self.usage_view, name="usage"),
+            path(f"history/<{conv}:pk>/", self.history_view, name="history"),
             path(
-                "history-results/<str:pk>/",
+                f"history-results/<{conv}:pk>/",
                 self.history_results_view,
                 name="history_results",
             ),
@@ -1061,22 +1109,22 @@ class SnippetViewSet(ModelViewSet):
 
         if self.reorder_view_enabled:
             urlpatterns += [
-                path("reorder/<str:pk>/", self.reorder_view, name="reorder")
+                path(f"reorder/<{conv}:pk>/", self.reorder_view, name="reorder")
             ]
 
         if self.copy_view_enabled:
-            urlpatterns += [path("copy/<str:pk>/", self.copy_view, name="copy")]
+            urlpatterns += [path(f"copy/<{conv}:pk>/", self.copy_view, name="copy")]
 
         if self.inspect_view_enabled:
             urlpatterns += [
-                path("inspect/<str:pk>/", self.inspect_view, name="inspect")
+                path(f"inspect/<{conv}:pk>/", self.inspect_view, name="inspect")
             ]
 
         if self.preview_enabled:
             urlpatterns += [
                 path("preview/", self.preview_on_add_view, name="preview_on_add"),
                 path(
-                    "preview/<str:pk>/",
+                    f"preview/<{conv}:pk>/",
                     self.preview_on_edit_view,
                     name="preview_on_edit",
                 ),
@@ -1086,7 +1134,7 @@ class SnippetViewSet(ModelViewSet):
             if self.preview_enabled:
                 urlpatterns += [
                     path(
-                        "history/<str:pk>/revisions/<int:revision_id>/view/",
+                        f"history/<{conv}:pk>/revisions/<int:revision_id>/view/",
                         self.revisions_view,
                         name="revisions_view",
                     )
@@ -1094,7 +1142,7 @@ class SnippetViewSet(ModelViewSet):
 
             urlpatterns += [
                 path(
-                    "history/<str:pk>/revisions/<int:revision_id>/revert/",
+                    f"history/<{conv}:pk>/revisions/<int:revision_id>/revert/",
                     self.revisions_revert_view,
                     name="revisions_revert",
                 ),
@@ -1108,43 +1156,43 @@ class SnippetViewSet(ModelViewSet):
         if self.draftstate_enabled:
             urlpatterns += [
                 path(
-                    "history/<str:pk>/revisions/<int:revision_id>/unschedule/",
+                    f"history/<{conv}:pk>/revisions/<int:revision_id>/unschedule/",
                     self.revisions_unschedule_view,
                     name="revisions_unschedule",
                 ),
-                path("unpublish/<str:pk>/", self.unpublish_view, name="unpublish"),
+                path(f"unpublish/<{conv}:pk>/", self.unpublish_view, name="unpublish"),
             ]
 
         if self.locking_enabled:
             urlpatterns += [
-                path("lock/<str:pk>/", self.lock_view, name="lock"),
-                path("unlock/<str:pk>/", self.unlock_view, name="unlock"),
+                path(f"lock/<{conv}:pk>/", self.lock_view, name="lock"),
+                path(f"unlock/<{conv}:pk>/", self.unlock_view, name="unlock"),
             ]
 
         if self.workflow_enabled:
             urlpatterns += [
                 path(
-                    "workflow/action/<str:pk>/<slug:action_name>/<int:task_state_id>/",
+                    f"workflow/action/<{conv}:pk>/<slug:action_name>/<int:task_state_id>/",
                     self.workflow_action_view,
                     name="workflow_action",
                 ),
                 path(
-                    "workflow/collect_action_data/<str:pk>/<slug:action_name>/<int:task_state_id>/",
+                    f"workflow/collect_action_data/<{conv}:pk>/<slug:action_name>/<int:task_state_id>/",
                     self.collect_workflow_action_data_view,
                     name="collect_workflow_action_data",
                 ),
                 path(
-                    "workflow/confirm_cancellation/<str:pk>/",
+                    f"workflow/confirm_cancellation/<{conv}:pk>/",
                     self.confirm_workflow_cancellation_view,
                     name="confirm_workflow_cancellation",
                 ),
                 path(
-                    "workflow_history/<str:pk>/",
+                    f"workflow_history/<{conv}:pk>/",
                     self.workflow_history_view,
                     name="workflow_history",
                 ),
                 path(
-                    "workflow_history/<str:pk>/detail/<int:workflow_state_id>/",
+                    f"workflow_history/<{conv}:pk>/detail/<int:workflow_state_id>/",
                     self.workflow_history_detail_view,
                     name="workflow_history_detail",
                 ),
@@ -1153,7 +1201,7 @@ class SnippetViewSet(ModelViewSet):
             if self.preview_enabled:
                 urlpatterns += [
                     path(
-                        "workflow/preview/<str:pk>/<int:task_id>/",
+                        f"workflow/preview/<{conv}:pk>/<int:task_id>/",
                         self.workflow_preview_view,
                         name="workflow_preview",
                     ),

wagtail/snippets/widgets.py

@@ -33,7 +33,7 @@ class AdminSnippetChooser(BaseChooser):
             return reverse(
                 self.model.snippet_viewset.chooser_viewset.get_url_name("choose")
             )
-        except NoReverseMatch:
+        except NoReverseMatch as e:
             # This most likely failed because the model is not registered as a snippet.
             # Check whether this is the case, and if so, output a more helpful error message
             from .models import get_snippet_models
@@ -42,7 +42,7 @@ class AdminSnippetChooser(BaseChooser):
                 raise ImproperlyConfigured(
                     "AdminSnippetChooser cannot be used on non-snippet model %r"
                     % self.model
-                )
+                ) from e
             else:
                 raise
 

wagtail/templatetags/wagtailcore_tags.py

@@ -177,10 +177,10 @@ def include_block(parser, token):
     try:
         tag_name = tokens.pop(0)
         block_var_token = tokens.pop(0)
-    except IndexError:
+    except IndexError as e:
         raise template.TemplateSyntaxError(
             "%r tag requires at least one argument" % tag_name
-        )
+        ) from e
 
     block_var = parser.compile_filter(block_var_token)
 

wagtail/test/dummy_external_storage.py

@@ -86,4 +86,4 @@ class DummyExternalStorageFile(File):
         try:
             return super().size
         except Exception as e:  # noqa: BLE001
-            raise DummyExternalStorageError(str(e))
+            raise DummyExternalStorageError(str(e)) from e

wagtail/test/testapp/fixtures/test.json

@@ -29,6 +29,7 @@
       "content_type": ["wagtailcore", "page"],
       "path": "0001",
       "url_path": "/",
+      "locale_id": 1,
       "slug": "root"
     }
   },
@@ -46,6 +47,7 @@
       "content_type": ["wagtailcore", "page"],
       "path": "00010001",
       "url_path": "/home/",
+      "locale_id": 1,
       "slug": "home",
       "first_published_at": "2014-01-01T12:00:00.000Z",
       "last_published_at": "2014-02-01T12:00:00.000Z"
@@ -63,6 +65,7 @@
       "depth": 3,
       "content_type": ["tests", "eventindex"],
       "path": "000100010001",
+      "locale_id": 1,
       "url_path": "/home/events/",
       "slug": "events"
     }
@@ -87,6 +90,7 @@
       "depth": 4,
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010001",
+      "locale_id": 1,
       "url_path": "/home/events/christmas/",
       "slug": "christmas",
       "owner": 2
@@ -117,6 +121,7 @@
       "depth": 4,
       "content_type": ["tests", "singleeventpage"],
       "path": "0001000100010005",
+      "locale_id": 1,
       "url_path": "/home/events/saint-patrick/",
       "slug": "saint-patrick",
       "owner": 2
@@ -146,6 +151,7 @@
     "model": "tests.eventpagespeaker",
     "fields": {
       "page": 4,
+      "locale_id": 1,
       "first_name": "Father",
       "last_name": "Christmas",
       "sort_order": 0
@@ -164,6 +170,7 @@
       "depth": 4,
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010002",
+      "locale_id": 1,
       "url_path": "/home/events/tentative-unpublished-event/",
       "slug": "tentative-unpublished-event",
       "owner": 2
@@ -193,6 +200,7 @@
       "depth": 4,
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010003",
+      "locale_id": 1,
       "url_path": "/home/events/someone-elses-event/",
       "slug": "someone-elses-event",
       "owner": 3
@@ -222,6 +230,7 @@
       "depth": 3,
       "content_type": ["tests", "simplepage"],
       "path": "000100010002",
+      "locale_id": 1,
       "url_path": "/home/about-us/",
       "slug": "about-us",
       "first_published_at": "2014-01-01T12:00:00.000Z",
@@ -248,6 +257,7 @@
       "depth": 3,
       "content_type": ["tests", "formpage"],
       "path": "000100010003",
+      "locale_id": 1,
       "url_path": "/home/contact-us/",
       "slug": "contact-us"
     }
@@ -274,6 +284,7 @@
       "depth": 4,
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010004",
+      "locale_id": 1,
       "url_path": "/home/events/final-event/",
       "slug": "final-event",
       "owner": 3
@@ -349,6 +360,7 @@
       "depth": 3,
       "content_type": ["tests", "pagewitholdstyleroutemethod"],
       "path": "000100010004",
+      "locale_id": 1,
       "url_path": "/home/old-style-route/",
       "slug": "old-style-route"
     }
@@ -373,6 +385,7 @@
       "depth": 3,
       "content_type": ["tests", "simplepage"],
       "path": "000100010005",
+      "locale_id": 1,
       "url_path": "/home/secret-plans/",
       "slug": "secret-plans"
     }
@@ -397,6 +410,7 @@
       "depth": 4,
       "content_type": ["tests", "eventpage"],
       "path": "0001000100050001",
+      "locale_id": 1,
       "url_path": "/home/secret-plans/steal-underpants/",
       "slug": "steal-underpants"
     }
@@ -424,6 +438,7 @@
       "depth": 3,
       "content_type": ["wagtailcore", "page"],
       "path": "000100010006",
+      "locale_id": 1,
       "url_path": "/home/my-locked-page/",
       "slug": "my-locked-page",
       "locked": true
@@ -441,6 +456,7 @@
       "depth": 4,
       "content_type": ["tests", "businessindex"],
       "path": "0001000100010006",
+      "locale_id": 1,
       "url_path": "/home/events/businessy-events/",
       "slug": "businessy-events",
       "owner": 2
@@ -464,6 +480,7 @@
       "depth": 5,
       "content_type": ["tests", "businesssubindex"],
       "path": "00010001000100060001",
+      "locale_id": 1,
       "url_path": "/home/events/businessy-events/board-meetings/",
       "slug": "board-meetings",
       "owner": 2
@@ -487,6 +504,7 @@
       "depth": 3,
       "content_type": ["tests", "formpagewithcustomsubmission"],
       "path": "000100010007",
+      "locale_id": 1,
       "url_path": "/home/contact-us-one-more-time/",
       "slug": "contact-us-one-more-time"
     }
@@ -583,6 +601,7 @@
       "depth": 3,
       "content_type": ["tests", "simplepage"],
       "path": "000100010008",
+      "locale_id": 1,
       "url_path": "/home/secret-event-editor-plans/",
       "slug": "secret-event-editor-plans"
     }
@@ -606,6 +625,7 @@
       "depth": 3,
       "content_type": ["tests", "simplepage"],
       "path": "000100010009",
+      "locale_id": 1,
       "url_path": "/home/secret-login-plans/",
       "slug": "secret-login-plans"
     }
@@ -629,6 +649,7 @@
       "depth": 2,
       "content_type": ["wagtailcore", "page"],
       "path": "00010002",
+      "locale_id": 1,
       "url_path": "/does-not-exist/",
       "slug": "does-not-exist"
     }
@@ -645,6 +666,7 @@
       "depth": 3,
       "content_type": ["tests", "pagewithexcludedcopyfield"],
       "path": "000100010010",
+      "locale_id": 1,
       "url_path": "/home/page-with-exclude-fields-in-copy/",
       "slug": "page-with-exclude-fields-in-copy"
     }

wagtail/test/testapp/fixtures/test_empty.json

@@ -27,6 +27,7 @@
       "live": true,
       "depth": 1,
       "content_type": ["wagtailcore", "page"],
+      "locale_id": 1,
       "path": "0001",
       "url_path": "/",
       "slug": "root"
@@ -44,6 +45,7 @@
       "live": true,
       "depth": 2,
       "content_type": ["wagtailcore", "page"],
+      "locale_id": 1,
       "path": "00010001",
       "url_path": "/home/",
       "slug": "home",

wagtail/test/testapp/fixtures/test_explorable_pages.json

@@ -12,6 +12,7 @@
       "content_type": ["wagtailcore", "page"],
       "path": "0001",
       "url_path": "/",
+      "locale_id": 1,
       "slug": "root"
     }
   },
@@ -29,6 +30,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "00010001",
       "url_path": "/home/",
+      "locale_id": 1,
       "slug": "home"
     }
   },
@@ -57,6 +59,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "000100010001",
       "url_path": "/home/about-us/",
+      "locale_id": 1,
       "slug": "about-us"
     }
   },
@@ -85,6 +88,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "00010002",
       "url_path": "/example-home/",
+      "locale_id": 1,
       "slug": "example-home"
     }
   },
@@ -113,6 +117,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "000100020001",
       "url_path": "/example-home/content/",
+      "locale_id": 1,
       "slug": "content",
       "owner": 1
     }
@@ -142,6 +147,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "0001000200010001",
       "url_path": "/example-home/content/page-1/",
+      "locale_id": 1,
       "slug": "page-1",
       "owner": 1
     }
@@ -171,6 +177,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "0001000200010002",
       "url_path": "/example-home/content/page-2/",
+      "locale_id": 1,
       "slug": "page-2",
       "owner": 1
     }
@@ -200,6 +207,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "000100020002",
       "url_path": "/example-home/other-content/",
+      "locale_id": 1,
       "slug": "other-content",
       "owner": 1
     }
@@ -229,6 +237,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "00010002000100020001",
       "url_path": "/example-home/content/page-2/child-1/",
+      "locale_id": 1,
       "slug": "child-1",
       "owner": 1
     }
@@ -258,6 +267,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "00010003",
       "url_path": "/home-2/",
+      "locale_id": 1,
       "slug": "home-2"
     }
   },

wagtail/test/testapp/fixtures/test_specific.json

@@ -29,6 +29,7 @@
       "content_type": ["wagtailcore", "page"],
       "path": "0001",
       "url_path": "/",
+      "locale_id": 1,
       "slug": "root"
     }
   },
@@ -46,6 +47,7 @@
       "content_type": ["wagtailcore", "page"],
       "path": "00010001",
       "url_path": "/home/",
+      "locale_id": 1,
       "slug": "home"
     }
   },
@@ -63,6 +65,7 @@
       "content_type": ["tests", "eventindex"],
       "path": "000100010001",
       "url_path": "/home/events/",
+      "locale_id": 1,
       "slug": "events"
     }
   },
@@ -87,6 +90,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010001",
       "url_path": "/home/events/christmas/",
+      "locale_id": 1,
       "slug": "christmas",
       "owner": 1
     }
@@ -129,6 +133,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010002",
       "url_path": "/home/events/tentative-unpublished-event/",
+      "locale_id": 1,
       "slug": "tentative-unpublished-event",
       "owner": 1
     }
@@ -159,6 +164,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "0001000100010003",
       "url_path": "/home/events/someone-elses-event/",
+      "locale_id": 1,
       "slug": "someone-elses-event",
       "owner": 1
     }
@@ -189,6 +195,7 @@
       "content_type": ["tests", "simplepage"],
       "path": "000100010002",
       "url_path": "/home/about-us/",
+      "locale_id": 1,
       "slug": "about-us"
     }
   },
@@ -213,6 +220,7 @@
       "content_type": ["tests", "simplepage"],
       "path": "000100010005",
       "url_path": "/home/other/",
+      "locale_id": 1,
       "slug": "other"
     }
   },
@@ -237,6 +245,7 @@
       "content_type": ["tests", "eventpage"],
       "path": "0001000100050001",
       "url_path": "/home/other/special-event/",
+      "locale_id": 1,
       "slug": "special-event"
     }
   },

wagtail/test/testapp/migrations/0059_nopromotepage.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.2.7 on 2025-11-14 04:38
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0058_customlocktask'),
+        ('wagtailcore', '0095_groupsitepermission'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='NoPromotePage',
+            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')),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('wagtailcore.page',),
+        ),
+    ]

wagtail/test/testapp/models.py

@@ -209,6 +209,10 @@ class SimplePage(Page):
         return "%s (simple page)" % super().get_admin_display_title()
 
 
+class NoPromotePage(Page):
+    promote_panels = []
+
+
 class MultiPreviewModesPage(Page):
     preview_templates = {
         "original": "tests/simple_page.html",
@@ -1163,6 +1167,9 @@ register_snippet(ModelWithCustomManager)
 class RevisableModel(RevisionMixin, models.Model):
     text = models.TextField()
 
+    def __str__(self):
+        return self.text
+
 
 class RevisableChildModel(RevisableModel):
     secret_text = models.TextField(blank=True, default="")

wagtail/test/testapp/views.py

@@ -334,6 +334,10 @@ class EventPageFilterSet(PageListingViewSet.filterset_class):
         fields = ["audience"]
 
 
+class EventPageIndexView(PageListingViewSet.index_view_class):
+    list_export = ["pk", "title", "audience", "event_date"]
+
+
 class EventPageListingViewSet(PageListingViewSet):
     model = EventPage
     icon = "calendar"
@@ -342,6 +346,7 @@ class EventPageListingViewSet(PageListingViewSet):
     columns = PageListingViewSet.columns + [
         Column("audience", label="Audience", sort_key="audience"),
     ]
+    index_view_class = EventPageIndexView
     filterset_class = EventPageFilterSet