Improve i18n of success message for bulk page actions (#12453)

Previously, translations for messages such as "1 page and 3 child pages have been published" were handled with separate branches for the "one parent page" vs "multiple parent pages" cases, to work around ngettext only being able to handle pluralisation for one item in the string. This fails for languages such as Polish where the pluralisation does not follow the straightforward one/many distinction.

Instead, we can translate "N pages" and "N child pages" separately before forming the final message. We generally avoid translating sentence fragments in isolation as this can make things difficult for translators if the sentence structure does not match the English version - but this is hopefully an improvement over the current situation, as well as simplifying the code and reducing repetition.

CHANGELOG.txt

@@ -4,7 +4,7 @@ Changelog
 6.4 (xx.xx.xxxx) - IN DEVELOPMENT
 ~~~~~~~~~~~~~~~~
 
- * ...
+ * Fix: Improve handling of translations for bulk page action confirmation messages (Matt Westcott)
 
 
 6.3 LTS (xx.xx.xxxx) - IN DEVELOPMENT

docs/releases/6.4.md

@@ -18,7 +18,7 @@ depth: 1
 
 ### Bug fixes
 
- * ...
+ * Improve handling of translations for bulk page action confirmation messages (Matt Westcott)
 
 ### Documentation
 

wagtail/admin/views/pages/bulk_actions/delete.py

@@ -31,27 +31,15 @@ class DeleteBulkAction(PageBulkAction):
         return num_parent_objects, num_child_objects
 
     def get_success_message(self, num_parent_objects, num_child_objects):
-        if num_parent_objects == 1:
+        if num_child_objects > 0:
-            if num_child_objects == 0:
+            # Translators: This forms a message such as "1 page and 3 child pages have been deleted"
-                success_message = _("1 page has been deleted")
+            return _("%(parent_pages)s and %(child_pages)s have been deleted") % {
-            else:
+                "parent_pages": self.get_parent_page_text(num_parent_objects),
-                success_message = ngettext(
+                "child_pages": self.get_child_page_text(num_child_objects),
-                    "1 page and %(num_child_objects)d child page have been deleted",
+            }
-                    "1 page and %(num_child_objects)d child pages have been deleted",
-                    num_child_objects,
-                ) % {"num_child_objects": num_child_objects}
         else:
-            if num_child_objects == 0:
+            return ngettext(
-                success_message = _(
+                "%(num_parent_objects)d page has been deleted",
-                    "%(num_parent_objects)d pages have been deleted"
+                "%(num_parent_objects)d pages have been deleted",
-                ) % {"num_parent_objects": num_parent_objects}
+                num_parent_objects,
-            else:
+            ) % {"num_parent_objects": num_parent_objects}
-                success_message = ngettext(
-                    "%(num_parent_objects)d pages and %(num_child_objects)d child page have been deleted",
-                    "%(num_parent_objects)d pages and %(num_child_objects)d child pages have been deleted",
-                    num_child_objects,
-                ) % {
-                    "num_child_objects": num_child_objects,
-                    "num_parent_objects": num_parent_objects,
-                }
-        return success_message

wagtail/admin/views/pages/bulk_actions/page_bulk_action.py

@@ -1,4 +1,5 @@
 from django import forms
+from django.utils.translation import ngettext
 
 from wagtail.admin.views.bulk_action import BulkAction
 from wagtail.admin.views.pages.search import page_filter_search
@@ -55,3 +56,19 @@ class PageBulkAction(BulkAction):
 
     def get_execution_context(self):
         return {"user": self.request.user}
+
+    def get_parent_page_text(self, num_parent_objects):
+        # Translators: This appears within a message such as "2 pages and 3 child pages have been published"
+        return ngettext(
+            "%(num_parent_objects)d page",
+            "%(num_parent_objects)d pages",
+            num_parent_objects,
+        ) % {"num_parent_objects": num_parent_objects}
+
+    def get_child_page_text(self, num_child_objects):
+        # Translators: This appears within a message such as "2 pages and 3 child pages have been published"
+        return ngettext(
+            "%(num_child_objects)d child page",
+            "%(num_child_objects)d child pages",
+            num_child_objects,
+        ) % {"num_child_objects": num_child_objects}

wagtail/admin/views/pages/bulk_actions/publish.py

@@ -71,35 +71,15 @@ class PublishBulkAction(PageBulkAction):
 
     def get_success_message(self, num_parent_objects, num_child_objects):
         include_descendants = self.cleaned_form.cleaned_data["include_descendants"]
-        if num_parent_objects == 1:
+        if include_descendants and num_child_objects > 0:
-            if include_descendants:
+            # Translators: This forms a message such as "1 page and 3 child pages have been published"
-                if num_child_objects == 0:
+            return _("%(parent_pages)s and %(child_pages)s have been published") % {
-                    success_message = _("1 page has been published")
+                "parent_pages": self.get_parent_page_text(num_parent_objects),
-                else:
+                "child_pages": self.get_child_page_text(num_child_objects),
-                    success_message = ngettext(
+            }
-                        "1 page and %(num_child_objects)d child page have been published",
-                        "1 page and %(num_child_objects)d child pages have been published",
-                        num_child_objects,
-                    ) % {"num_child_objects": num_child_objects}
-            else:
-                success_message = _("1 page has been published")
         else:
-            if include_descendants:
+            return ngettext(
-                if num_child_objects == 0:
+                "%(num_parent_objects)d page has been published",
-                    success_message = _(
+                "%(num_parent_objects)d pages have been published",
-                        "%(num_parent_objects)d pages have been published"
+                num_parent_objects,
-                    ) % {"num_parent_objects": num_parent_objects}
+            ) % {"num_parent_objects": num_parent_objects}
-                else:
-                    success_message = ngettext(
-                        "%(num_parent_objects)d pages and %(num_child_objects)d child page have been published",
-                        "%(num_parent_objects)d pages and %(num_child_objects)d child pages have been published",
-                        num_child_objects,
-                    ) % {
-                        "num_child_objects": num_child_objects,
-                        "num_parent_objects": num_parent_objects,
-                    }
-            else:
-                success_message = _(
-                    "%(num_parent_objects)d pages have been published"
-                ) % {"num_parent_objects": num_parent_objects}
-        return success_message

wagtail/admin/views/pages/bulk_actions/unpublish.py

@@ -65,35 +65,15 @@ class UnpublishBulkAction(PageBulkAction):
 
     def get_success_message(self, num_parent_objects, num_child_objects):
         include_descendants = self.cleaned_form.cleaned_data["include_descendants"]
-        if num_parent_objects == 1:
+        if include_descendants and num_child_objects > 0:
-            if include_descendants:
+            # Translators: This forms a message such as "1 page and 3 child pages have been unpublished"
-                if num_child_objects == 0:
+            return _("%(parent_pages)s and %(child_pages)s have been unpublished") % {
-                    success_message = _("1 page has been unpublished")
+                "parent_pages": self.get_parent_page_text(num_parent_objects),
-                else:
+                "child_pages": self.get_child_page_text(num_child_objects),
-                    success_message = ngettext(
+            }
-                        "1 page and %(num_child_objects)d child page have been unpublished",
-                        "1 page and %(num_child_objects)d child pages have been unpublished",
-                        num_child_objects,
-                    ) % {"num_child_objects": num_child_objects}
-            else:
-                success_message = _("1 page has been unpublished")
         else:
-            if include_descendants:
+            return ngettext(
-                if num_child_objects == 0:
+                "%(num_parent_objects)d page has been unpublished",
-                    success_message = _(
+                "%(num_parent_objects)d pages have been unpublished",
-                        "%(num_parent_objects)d pages have been unpublished"
+                num_parent_objects,
-                    ) % {"num_parent_objects": num_parent_objects}
+            ) % {"num_parent_objects": num_parent_objects}
-                else:
-                    success_message = ngettext(
-                        "%(num_parent_objects)d pages and %(num_child_objects)d child page have been unpublished",
-                        "%(num_parent_objects)d pages and %(num_child_objects)d child pages have been unpublished",
-                        num_child_objects,
-                    ) % {
-                        "num_child_objects": num_child_objects,
-                        "num_parent_objects": num_parent_objects,
-                    }
-            else:
-                success_message = _(
-                    "%(num_parent_objects)d pages have been unpublished"
-                ) % {"num_parent_objects": num_parent_objects}
-        return success_message