ProseEditorField doesn't work with TranslatedField

[bitmensch]

First, thanks for these great projects.

I am currently running the following versions in a Django project:

• django-prose-editor==0.12.0
• django-translated-fields==0.13.0

I have a model where I am trying to use ProseEditorField like this:

class Event(models.Model):
    description_prose = TranslatedField(
        ProseEditorField(
            _("description"),
            config={
                "extensions": {
                    "Bold": True,
                    "Italic": True,
                    "BulletList": True,
                    "Link": True,
                    "Heading": False,
                }
            },
            sanitize=True,
            blank=True,
        )
    )

When running Django dev server with this, it shows the following warning:

14:31:05 django | System check identified some issues:
14:31:05 django | 
14:31:05 django | WARNINGS:
14:31:05 django | core.Event.description_prose_de: (django_prose_editor.W001) This ProseEditorField is using the legacy configuration format which is deprecated and will be removed in a future version. Add the 'extensions' configuration explicitly to use the new configuration format.
14:31:05 django | core.Event.description_prose_de: (django_prose_editor.W004) This ProseEditorField doesn't have sanitization enabled. For security, it's recommended to enable sanitization.
14:31:05 django |       HINT: Consider using the newer extensions mechanism with sanitize=True for proper HTML sanitization that matches your editor capabilities.
14:31:05 django | core.Event.description_prose_en: (django_prose_editor.W001) This ProseEditorField is using the legacy configuration format which is deprecated and will be removed in a future version. Add the 'extensions' configuration explicitly to use the new configuration format.
14:31:05 django | core.Event.description_prose_en: (django_prose_editor.W004) This ProseEditorField doesn't have sanitization enabled. For security, it's recommended to enable sanitization.
14:31:05 django |       HINT: Consider using the newer extensions mechanism with sanitize=True for proper HTML sanitization that matches your editor capabilities.

Also when rendering these two fields in a form, it now shows the full editor toolbar with all buttons.

When I don't wrap this field in TranslatedField, the warning are gone and the editor toolbar doesn't contain all buttons as expected, e.g. Heading buttons are removed.

I noticed you're also the author of django-translated-fields, so maybe you have an idea/workaround how to get django-prose-editor to work with TranslatedField.

[matthiask]

Thanks! I'll have a look at it. I don't think there's an easy workaround for now, probably the field doesn't like to be copied or recreated.

[matthiask]

Something like this would fix it but I'm not sure I like all the migrations this will generate just because we changed the prose editor configuration:

diff --git i/django_prose_editor/fields.py w/django_prose_editor/fields.py
index 7d073af..d744862 100644
--- i/django_prose_editor/fields.py
+++ w/django_prose_editor/fields.py
@@ -85,6 +85,9 @@ class ProseEditorField(models.TextField):
     """
 
     def __init__(self, *args, **kwargs):
+        import copy
+        self._kw = copy.deepcopy(kwargs)
+
         self.config = kwargs.pop("config", {})
         if extensions := kwargs.pop("extensions", None):
             self.config["extensions"] = extensions
@@ -119,6 +122,9 @@ class ProseEditorField(models.TextField):
         )
 
     def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        return name, path, args, kwargs | self._kw
+
         name, _path, args, kwargs = super().deconstruct()
         return (name, "django.db.models.TextField", args, kwargs)
 

A workaround would be to (ab)use the specific mechanism to ship the same configuration to all languages by adding it as specific={"en": ... , "de": ...} etc. I haven't tested it but this would allow you to pass the configuration to the language-specific fields even though deconstruct doesn't return all the required data.

[bitmensch]

Thanks @matthiask, using your suggested workaround works for me.
Feel free to close this issue if no longer needed from your side.

[matthiask]

Thanks! I'm keeping this open for now and am looking into fixing this in django-translated-fields.

I like the .deconstruct() override hack, maybe django-translated-fields should be changed to use a different method of cloning fields.

[matthiask]

I researched the problem a bit and Field.clone() does the same deconstruct() ==> self.__class__(...) dance.

I probably have to rethink my stance on not generating annoying migrations because of changing field configurations.

[matthiask]

I'm slightly surprised but this simple thing seems to work:

from django.db import models
from django.utils.translation import gettext_lazy as _
from django_prose_editor.fields import ProseEditorField
from translated_fields import TranslatedFieldWithFallback


class RichTextEditorField(ProseEditorField):
    """ProseEditorField with default extensions for rich text editing."""

    def __init__(self, *args, **kwargs):
        # Unconditionally set extensions and sanitization
        kwargs.update({
            "extensions": {
                "Bold": True,
                "Italic": True,
                "Underline": True,
                "Strike": True,
                "Superscript": True,
                "Subscript": True,
                "Link": True,
                "BulletList": True,
                "OrderedList": True,
                "ListItem": True,
                "Blockquote": True,
                "Heading": True,
            },
            "sanitize": True,
        })
        super().__init__(*args, **kwargs)


class Stuff(models.Model):
    parent = models.ForeignKey(
        Parent,
        on_delete=models.CASCADE,
    )
    background = TranslatedFieldWithFallback(
        RichTextEditorField(
            blank=True,
            default="",
            verbose_name=_("background information"),
            help_text=_("Optional background information about the story/image"),
        )
    )