wagtail 6.2.3__py3-none-any.whl → 6.3__py3-none-any.whl

wagtail/images/blocks.py

@@ -1,8 +1,14 @@
+from django import forms
+from django.core.exceptions import ValidationError
 from django.template.loader import render_to_string
 from django.utils.functional import cached_property
+from django.utils.translation import gettext_lazy as _
 
-from wagtail.admin.compare import BlockComparison
-from wagtail.blocks import ChooserBlock
+from wagtail.admin.compare import BlockComparison, StructBlockComparison
+from wagtail.blocks import BooleanBlock, CharBlock, ChooserBlock, StructBlock
+from wagtail.blocks.struct_block import StructBlockAdapter, StructBlockValidationError
+from wagtail.images.models import AbstractImage
+from wagtail.telepath import register
 
 from .shortcuts import get_rendition_or_not_found
 
@@ -51,3 +57,222 @@ class ImageChooserBlockComparison(BlockComparison):
                 "image_b": self.val_b,
             },
         )
+
+
+class ImageBlock(StructBlock):
+    """
+    An usage of ImageChooserBlock with support for alt text.
+    For backward compatibility, this block overrides necessary methods to change
+    the StructValue to be an Image model instance, making it compatible in
+    places where ImageChooserBlock was used.
+    """
+
+    image = ImageChooserBlock(required=True)
+    decorative = BooleanBlock(
+        default=False, required=False, label=_("Image is decorative")
+    )
+    alt_text = CharBlock(required=False, label=_("Alt text"))
+
+    def __init__(self, required=True, **kwargs):
+        super().__init__(
+            [
+                ("image", ImageChooserBlock(required=required)),
+                (
+                    "decorative",
+                    BooleanBlock(
+                        default=False, required=False, label=_("Image is decorative")
+                    ),
+                ),
+                ("alt_text", CharBlock(required=False, label=_("Alt text"))),
+            ],
+            **kwargs,
+        )
+
+    def deconstruct(self):
+        """
+        For typical StructBlock subclasses, it makes sense for the deconstructed block object to be a basic StructBlock
+        with the child blocks passed to the constructor (because this is largely functionally identical to the
+        subclass, and avoids embedding a reference to a potentially-volatile custom class in migrations).
+
+        This is not the case for ImageBlock, as it overrides enough of StructBlock's behaviour that a basic StructBlock
+        is not a suitable substitute - and also has an incompatible constructor signature (as we don't want to support
+        passing child blocks to it).
+
+        Therefore, we opt out of the standard StructBlock deconstruction behaviour here, and always
+        deconstruct an ImageBlock as an ImageBlock.
+        """
+        return ("wagtail.images.blocks.ImageBlock", [], self._constructor_kwargs)
+
+    def deconstruct_with_lookup(self, lookup):
+        return self.deconstruct()
+
+    @classmethod
+    def construct_from_lookup(cls, lookup, *args, **kwargs):
+        return cls(**kwargs)
+
+    def get_searchable_content(self, value):
+        if not self.search_index or not value:
+            return []
+
+        return self.child_blocks["alt_text"].get_searchable_content(
+            value.contextual_alt_text
+        )
+
+    def _struct_value_to_image(self, struct_value):
+        image = struct_value.get("image")
+        decorative = struct_value.get("decorative")
+        if image:
+            # If the image is decorative, set alt_text to an empty string
+            image.contextual_alt_text = (
+                "" if decorative else struct_value.get("alt_text")
+            )
+            image.decorative = decorative
+        return image
+
+    def _image_to_struct_value(self, image):
+        return {
+            "image": image,
+            "alt_text": image and image.contextual_alt_text,
+            "decorative": image and image.decorative,
+        }
+
+    def to_python(self, value):
+        # For backward compatibility with ImageChooserBlock
+        if isinstance(value, int):
+            image = self.child_blocks["image"].to_python(value)
+            struct_value = {"image": image, "decorative": False, "alt_text": None}
+        else:
+            struct_value = super().to_python(value)
+        return self._struct_value_to_image(struct_value)
+
+    def bulk_to_python(self, values):
+        values = list(values)
+
+        if any(isinstance(value, int) for value in values):
+            # `values` is a list of image IDs (as we might encounter if an ImageChooserBlock has been
+            # changed to an ImageBlock with no data migration)
+            image_values = self.child_blocks["image"].bulk_to_python(values)
+
+            struct_values = [
+                {
+                    "image": image,
+                    "decorative": False,
+                    "alt_text": None,
+                }
+                for image in image_values
+            ]
+
+        else:
+            # assume `values` is a (possibly empty) list of dicts containing
+            # `image`, `decorative` and `alt_text` keys to be handled by the StructBlock superclass
+            struct_values = super().bulk_to_python(values)
+
+        return [
+            self._struct_value_to_image(struct_value) for struct_value in struct_values
+        ]
+
+    def value_from_datadict(self, data, files, prefix):
+        struct_value = super().value_from_datadict(data, files, prefix)
+        return self._struct_value_to_image(struct_value)
+
+    def clean(self, value):
+        try:
+            self.child_blocks["image"].clean(value)
+        except ValidationError as e:
+            raise StructBlockValidationError(
+                block_errors={"image": e},
+            )
+
+        if value and not value.contextual_alt_text and not value.decorative:
+            raise StructBlockValidationError(
+                block_errors={
+                    "alt_text": ValidationError(
+                        _(
+                            "Please add some alt text for your image or mark it as decorative"
+                        )
+                    )
+                }
+            )
+
+        return value
+
+    def normalize(self, value):
+        if value is None or isinstance(value, AbstractImage):
+            return value
+        else:
+            struct_value = super().normalize(value)
+            return self._struct_value_to_image(struct_value)
+
+    def get_form_context(self, value, prefix="", errors=None):
+        dict_value = {
+            "image": value,
+            "alt_text": value and value.contextual_alt_text,
+            "decorative": value and value.decorative,
+        }
+        context = super().get_form_context(dict_value, prefix=prefix, errors=errors)
+        context["suggested_alt_text"] = value
+        return context
+
+    def get_form_state(self, value):
+        return {
+            "image": self.child_blocks["image"].get_form_state(value),
+            "alt_text": value and value.contextual_alt_text,
+            "decorative": value and value.decorative,
+        }
+
+    def get_prep_value(self, value):
+        return {
+            "image": self.child_blocks["image"].get_prep_value(value),
+            "alt_text": value and value.contextual_alt_text,
+            "decorative": value and value.decorative,
+        }
+
+    def extract_references(self, value):
+        return self.child_blocks["image"].extract_references(value)
+
+    def get_comparison_class(self):
+        return ImageBlockComparison
+
+    def get_api_representation(self, value, context=None):
+        return super().get_api_representation(
+            self._image_to_struct_value(value), context=context
+        )
+
+    def render_basic(self, value, context=None):
+        return self.child_blocks["image"].render_basic(value, context=context)
+
+    class Meta:
+        icon = "image"
+        template = "wagtailimages/widgets/image.html"
+
+
+class ImageBlockAdapter(StructBlockAdapter):
+    js_constructor = "wagtail.images.blocks.ImageBlock"
+
+    @cached_property
+    def media(self):
+        structblock_media = super().media
+        return forms.Media(
+            js=structblock_media._js + ["wagtailimages/js/image-block.js"],
+            css=structblock_media._css,
+        )
+
+
+register(ImageBlockAdapter(), ImageBlock)
+
+
+class ImageBlockComparison(StructBlockComparison):
+    def __init__(self, block, exists_a, exists_b, val_a, val_b):
+        super().__init__(
+            block,
+            exists_a,
+            exists_b,
+            block._image_to_struct_value(val_a),
+            block._image_to_struct_value(val_b),
+        )
+
+    def htmlvalue(self, val):
+        if isinstance(val, AbstractImage):
+            return super().htmlvalue(self.block._image_to_struct_value(val))
+        else:
+            return super().htmlvalue(val)

wagtail/images/fields.py

@@ -6,6 +6,7 @@ from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.core.validators import FileExtensionValidator
 from django.forms.fields import FileField, ImageField
+from django.forms.widgets import FileInput
 from django.template.defaultfilters import filesizeformat
 from django.utils.translation import gettext_lazy as _
 
@@ -32,6 +33,8 @@ class WagtailImageField(ImageField):
     default_validators = [ImageFileExtensionValidator]
 
     def __init__(self, *args, **kwargs):
+        self.allowed_image_extensions = get_allowed_image_extensions()
+
         super().__init__(*args, **kwargs)
 
         # Get max upload size from settings
@@ -43,8 +46,6 @@ class WagtailImageField(ImageField):
         )
         self.max_upload_size_text = filesizeformat(self.max_upload_size)
 
-        self.allowed_image_extensions = get_allowed_image_extensions()
-
         self.supported_formats_text = ", ".join(self.allowed_image_extensions).upper()
 
         # Help text
@@ -163,7 +164,7 @@ class WagtailImageField(ImageField):
             # Annotate the python representation of the FileField with the image
             # property so subclasses can reuse it for their own validation
             f.image = willow.Image.open(file)
-            f.content_type = image_format_name_to_content_type(f.image.format_name)
+            f.content_type = f.image.mime_type
 
         except Exception as exc:  # noqa: BLE001
             # Willow doesn't recognize it as an image.
@@ -182,30 +183,17 @@ class WagtailImageField(ImageField):
 
         return f
 
+    def widget_attrs(self, widget):
+        attrs = super().widget_attrs(widget)
+
+        if (
+            isinstance(widget, FileInput)
+            and "accept" not in widget.attrs
+            and attrs.get("accept") == "image/*"
+            and "heic" in self.allowed_image_extensions
+        ):
+            # File upload dialogs (at least on Chrome / Mac) don't count heic as part of image/*, as it's not a
+            # web-safe format, so add it explicitly
+            attrs["accept"] = "image/*, image/heic"
 
-def image_format_name_to_content_type(image_format_name):
-    """
-    Convert a Willow image format name to a content type.
-    TODO: Replace once https://github.com/wagtail/Willow/pull/102 and
-          a new Willow release is out
-    """
-    if image_format_name == "svg":
-        return "image/svg+xml"
-    elif image_format_name == "jpeg":
-        return "image/jpeg"
-    elif image_format_name == "png":
-        return "image/png"
-    elif image_format_name == "gif":
-        return "image/gif"
-    elif image_format_name == "bmp":
-        return "image/bmp"
-    elif image_format_name == "tiff":
-        return "image/tiff"
-    elif image_format_name == "webp":
-        return "image/webp"
-    elif image_format_name == "avif":
-        return "image/avif"
-    elif image_format_name == "ico":
-        return "image/x-icon"
-    else:
-        raise ValueError("Unknown image format name")
+        return attrs

wagtail/images/image_operations.py

@@ -409,7 +409,7 @@ class WebPQualityOperation(FilterOperation):
 
 
 class FormatOperation(FilterOperation):
-    supported_formats = ["jpeg", "png", "gif", "webp", "avif", "ico"]
+    supported_formats = ["jpeg", "png", "gif", "webp", "avif", "ico", "heic"]
 
     def construct(self, format, *options):
         self.format = format

wagtail/images/locale/ar/LC_MESSAGES/django.po

@@ -13,7 +13,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Wagtail\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-08-07 10:06+0100\n"
+"POT-Creation-Date: 2024-10-21 17:53+0100\n"
 "PO-Revision-Date: 2014-02-20 21:05+0000\n"
 "Last-Translator: Younes Oumakhou, 2022\n"
 "Language-Team: Arabic (http://app.transifex.com/torchbox/wagtail/language/"
@@ -28,6 +28,9 @@ msgstr ""
 msgid "Wagtail images"
 msgstr "صور"
 
+msgid "Alt text"
+msgstr "نص للمساعدة"
+
 #, python-format
 msgid ""
 "Supported formats: %(supported_formats)s. Maximum filesize: "
@@ -65,9 +68,6 @@ msgstr "محاذاة لليمين"
 msgid "Collection"
 msgstr "مجموعة"
 
-msgid "Alt text"
-msgstr "نص للمساعدة"
-
 msgid "Filter"
 msgstr "ارسح"
 
@@ -119,6 +119,9 @@ msgstr "عنوان"
 msgid "file"
 msgstr "ملف"
 
+msgid "description"
+msgstr "وصف"
+
 msgid "width"
 msgstr "عرض"
 
@@ -186,21 +189,11 @@ msgstr "غير ملف الصورة"
 msgid "Add an image"
 msgstr "أضف صورة"
 
-msgid "Add image"
-msgstr "أضف صورة"
-
-msgid "Save"
-msgstr "احفظ"
-
-#, python-format
-msgid "Editing image %(title)s"
-msgstr "تحرير الصورة %(title)s"
-
-msgid "Editing"
-msgstr "تنقيح"
+msgid "Uploading…"
+msgstr "يتم الرفع…"
 
-msgid "Delete image"
-msgstr "احذف صورة"
+msgid "Upload"
+msgstr "انقل إلى الحاسوب"
 
 msgid "URL Generator"
 msgstr "مولد URL"
@@ -255,9 +248,6 @@ msgstr "الرابط"
 msgid "Add multiple images"
 msgstr "أضف صور غديدة"
 
-msgid "Add images"
-msgstr "أضف صور"
-
 msgid "Drag and drop images into this area to upload immediately."
 msgstr "اسحب صورا وأدخلها في هذه المنطقة  لإدخالها في الحاسوب فورا"
 
@@ -293,12 +283,6 @@ msgstr "إضافة إذن صورة"
 msgid "Delete"
 msgstr "احذف"
 
-msgid "Upload"
-msgstr "انقل إلى الحاسوب"
-
-msgid "Uploading…"
-msgstr "يتم الرفع…"
-
 msgid "Choose an image"
 msgstr "اختر صورة"
 
@@ -311,31 +295,34 @@ msgstr "حرر هذه الصورة"
 msgid "Images"
 msgstr "صور"
 
+msgid "The image could not be saved due to errors."
+msgstr "حفظ الصورة مستحيل بسبب أحطاء"
+
 #, python-format
 msgid "Image '%(image_title)s' updated."
 msgstr "تم تحديث الصورة %(image_title)s."
 
-msgid "Edit again"
-msgstr "أعد التحرير"
-
-msgid "The image could not be saved due to errors."
-msgstr "حفظ الصورة مستحيل بسبب أحطاء"
-
 msgid ""
 "The source image file could not be found. Please change the source or delete "
 "the image."
 msgstr "الصورة الأصلية غير موجودة..  من فضلك غير الأصل أو احذف الصورة"
 
+msgid "Delete image"
+msgstr "احذف صورة"
+
 #, python-format
 msgid "Image '%(image_title)s' deleted."
 msgstr "الصورة \"%(image_title)s\" محذوفة."
 
+msgid "The image could not be created due to errors."
+msgstr "إنشاء الصورة مستخيل بسبب أخطاء"
+
 #, python-format
 msgid "Image '%(image_title)s' added."
 msgstr "تمت إضافة صورة '%(image_title)s'."
 
-msgid "The image could not be created due to errors."
-msgstr "إنشاء الصورة مستخيل بسبب أخطاء"
+msgid "Add images"
+msgstr "أضف صور"
 
 msgid "Image"
 msgstr "صورة"

wagtail/images/locale/az_AZ/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Wagtail\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-08-07 10:06+0100\n"
+"POT-Creation-Date: 2024-10-21 17:53+0100\n"
 "PO-Revision-Date: 2014-02-20 21:05+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Azerbaijani (Azerbaijan) (http://app.transifex.com/torchbox/"
@@ -18,12 +18,6 @@ msgstr ""
 "Language: az_AZ\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-msgid "Save"
-msgstr "Yadda saxla"
-
-msgid "Editing"
-msgstr "Düzəliş edilir"
-
 msgid "URL"
 msgstr "URL"
 

wagtail/images/locale/be/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Wagtail\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-08-07 10:06+0100\n"
+"POT-Creation-Date: 2024-10-21 17:53+0100\n"
 "PO-Revision-Date: 2014-02-20 21:05+0000\n"
 "Last-Translator: Andrei Satsevich, 2023-2024\n"
 "Language-Team: Belarusian (http://app.transifex.com/torchbox/wagtail/"
@@ -24,15 +24,15 @@ msgstr ""
 msgid "Wagtail images"
 msgstr "Малявання Wagtail "
 
+msgid "Alt text"
+msgstr "Тэкст падказкі"
+
 msgid "Collection"
 msgstr "Калекцыя"
 
 msgid "Format"
 msgstr "Фармат"
 
-msgid "Alt text"
-msgstr "Тэкст падказкі"
-
 msgid "Filter"
 msgstr "Фільтр"
 
@@ -60,6 +60,9 @@ msgstr "загаловак"
 msgid "file"
 msgstr "Файл"
 
+msgid "description"
+msgstr "апісанне"
+
 msgid "width"
 msgstr "шырыня"
 
@@ -117,17 +120,11 @@ msgstr "Выбраць фармат"
 msgid "Add an image"
 msgstr "Дабавіць маляванне"
 
-msgid "Add image"
-msgstr "Дабавіць маляванне"
-
-msgid "Save"
-msgstr "Захаваць"
-
-msgid "Editing"
-msgstr "Рэдагаванне"
+msgid "Uploading…"
+msgstr "Запампоўваецца..."
 
-msgid "Delete image"
-msgstr "Выдаліць выяву"
+msgid "Upload"
+msgstr "Запампаваць"
 
 msgid "(optional)"
 msgstr "(не абавязкова)"
@@ -147,9 +144,6 @@ msgstr "Папярэдні прагляд"
 msgid "URL"
 msgstr "URL"
 
-msgid "Add images"
-msgstr "Дабавіць адлюстравання"
-
 msgid "Or choose from your computer"
 msgstr "Або абярыце на вашым кампутары"
 
@@ -165,12 +159,6 @@ msgstr "Памылка Сервера"
 msgid "Delete"
 msgstr "Выдаліць"
 
-msgid "Upload"
-msgstr "Запампаваць"
-
-msgid "Uploading…"
-msgstr "Запампоўваецца..."
-
 msgid "Choose an image"
 msgstr "Выбраць малюнак"
 
@@ -180,5 +168,11 @@ msgstr "Адрэдагаваць гэты малюнак"
 msgid "Images"
 msgstr "Малявання"
 
+msgid "Delete image"
+msgstr "Выдаліць выяву"
+
+msgid "Add images"
+msgstr "Дабавіць адлюстравання"
+
 msgid "Change image"
 msgstr "Змяніць малюнак"

wagtail/images/locale/bg/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Wagtail\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-08-07 10:06+0100\n"
+"POT-Creation-Date: 2024-10-21 17:53+0100\n"
 "PO-Revision-Date: 2014-02-20 21:05+0000\n"
 "Last-Translator: Lyuboslav  Petrov <petrov.lyuboslav@gmail.com>, 2014\n"
 "Language-Team: Bulgarian (http://app.transifex.com/torchbox/wagtail/language/"
@@ -46,21 +46,8 @@ msgstr "Вмъкни Изображение"
 msgid "Add an image"
 msgstr "Добави Изображение"
 
-msgid "Add image"
-msgstr "Добави Изображение"
-
-msgid "Save"
-msgstr "Запази"
-
-#, python-format
-msgid "Editing image %(title)s"
-msgstr "Редакция на %(title)s"
-
-msgid "Editing"
-msgstr "Редактиране"
-
-msgid "Delete image"
-msgstr "Изтрий Изображение"
+msgid "Upload"
+msgstr "Качване"
 
 msgid "Preview"
 msgstr "Преглед"
@@ -74,9 +61,6 @@ msgstr "Тагове"
 msgid "Delete"
 msgstr "Изтрий"
 
-msgid "Upload"
-msgstr "Качване"
-
 msgid "Choose an image"
 msgstr "Изберете изображение"
 
@@ -86,20 +70,23 @@ msgstr "Избери друго Изображение"
 msgid "Images"
 msgstr "Изображения"
 
+msgid "The image could not be saved due to errors."
+msgstr "Изображението не можеше да бъде запазено поради грешки."
+
 #, python-format
 msgid "Image '%(image_title)s' updated."
 msgstr "Изображение '%(image_title)s' обновено."
 
-msgid "The image could not be saved due to errors."
-msgstr "Изображението не можеше да бъде запазено поради грешки."
+msgid "Delete image"
+msgstr "Изтрий Изображение"
 
 #, python-format
 msgid "Image '%(image_title)s' deleted."
 msgstr "Изображение '%(image_title)s' изтрито."
 
+msgid "The image could not be created due to errors."
+msgstr "Изображението не можеше да бъде създадено поради грешки."
+
 #, python-format
 msgid "Image '%(image_title)s' added."
 msgstr "Изображение '%(image_title)s' добавено."
-
-msgid "The image could not be created due to errors."
-msgstr "Изображението не можеше да бъде създадено поради грешки."

wagtail/images/locale/bn/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Wagtail\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-08-07 10:06+0100\n"
+"POT-Creation-Date: 2024-10-21 17:53+0100\n"
 "PO-Revision-Date: 2014-02-20 21:05+0000\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: Bengali (http://app.transifex.com/torchbox/wagtail/language/"
@@ -27,12 +27,6 @@ msgstr "যোগ করুন"
 msgid "Edit"
 msgstr "সম্পাদনা করুন"
 
-msgid "Save"
-msgstr "সংরক্ষণ"
-
-msgid "Editing"
-msgstr "সম্পাদিত হচ্ছে"
-
 msgid "URL"
 msgstr "URL"