django-unfold 0.26.0__tar.gz → 0.27.0__tar.gz

{django_unfold-0.26.0 → django_unfold-0.27.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-unfold
-Version: 0.26.0
+Version: 0.27.0
 Summary: Modern Django admin theme for seamless interface development
 Home-page: https://unfoldadmin.com
 License: MIT
@@ -52,11 +52,13 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Dependencies:** completely based only on `django.contrib.admin`
 - **Actions:** multiple ways how to define actions within different parts of admin
 - **WYSIWYG:** built-in support for WYSIWYG (Trix)
+- **Array widget:** built-in widget for `django.contrib.postgres.fields.ArrayField`
 - **Filters:** custom dropdown, numeric, datetime, and text fields
 - **Dashboard:** custom components for rapid dashboard development
 - **Model tabs:** define custom tab navigations for models
 - **Fieldset tabs:** merge several fielsets into tabs in change form
 - **Colors:** possibility to override default color scheme
+- **Changeform modes:** display fields in changeform in compressed mode
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
 - **Nonrelated inlines**: displays nonrelated model as inline in changeform
@@ -321,13 +323,17 @@ def permission_callback(request):
 
 from django import models
 from django.contrib import admin
+from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from unfold.admin import ModelAdmin
-from unfold.contrib.forms.widgets import WysiwygWidget
+from unfold.contrib.forms.widgets import ArrayWidget, WysiwygWidget
 
 
 @admin.register(MyModel)
 class CustomAdminClass(ModelAdmin):
+    # Display fields in changeform in compressed mode
+    compressed_fields = True  # Default: False
+
     # Preprocess content of readonly fields before render
     readonly_preprocess_fields = {
         "model_field_name": "html.unescape",
@@ -346,6 +352,9 @@ class CustomAdminClass(ModelAdmin):
     formfield_overrides = {
         models.TextField: {
             "widget": WysiwygWidget,
+        },
+        ArrayField: {
+            "widget": ArrayWidget,
         }
     }
 ```

{django_unfold-0.26.0 → django_unfold-0.27.0}/README.md

@@ -28,11 +28,13 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Dependencies:** completely based only on `django.contrib.admin`
 - **Actions:** multiple ways how to define actions within different parts of admin
 - **WYSIWYG:** built-in support for WYSIWYG (Trix)
+- **Array widget:** built-in widget for `django.contrib.postgres.fields.ArrayField`
 - **Filters:** custom dropdown, numeric, datetime, and text fields
 - **Dashboard:** custom components for rapid dashboard development
 - **Model tabs:** define custom tab navigations for models
 - **Fieldset tabs:** merge several fielsets into tabs in change form
 - **Colors:** possibility to override default color scheme
+- **Changeform modes:** display fields in changeform in compressed mode
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
 - **Nonrelated inlines**: displays nonrelated model as inline in changeform
@@ -297,13 +299,17 @@ def permission_callback(request):
 
 from django import models
 from django.contrib import admin
+from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from unfold.admin import ModelAdmin
-from unfold.contrib.forms.widgets import WysiwygWidget
+from unfold.contrib.forms.widgets import ArrayWidget, WysiwygWidget
 
 
 @admin.register(MyModel)
 class CustomAdminClass(ModelAdmin):
+    # Display fields in changeform in compressed mode
+    compressed_fields = True  # Default: False
+
     # Preprocess content of readonly fields before render
     readonly_preprocess_fields = {
         "model_field_name": "html.unescape",
@@ -322,6 +328,9 @@ class CustomAdminClass(ModelAdmin):
     formfield_overrides = {
         models.TextField: {
             "widget": WysiwygWidget,
+        },
+        ArrayField: {
+            "widget": ArrayWidget,
         }
     }
 ```

{django_unfold-0.26.0 → django_unfold-0.27.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-unfold"
-version = "0.26.0"
+version = "0.27.0"
 description = "Modern Django admin theme for seamless interface development"
 license = "MIT"
 readme = "README.md"

{django_unfold-0.26.0 → django_unfold-0.27.0}/src/unfold/admin.py

@@ -7,50 +7,30 @@ from django.contrib.admin import ModelAdmin as BaseModelAdmin
 from django.contrib.admin import StackedInline as BaseStackedInline
 from django.contrib.admin import TabularInline as BaseTabularInline
 from django.contrib.admin import display, helpers
-from django.contrib.admin.utils import lookup_field
 from django.contrib.admin.widgets import RelatedFieldWidgetWrapper
-from django.core.exceptions import ObjectDoesNotExist
 from django.db import models
-from django.db.models import (
-    BLANK_CHOICE_DASH,
-    ForeignObjectRel,
-    JSONField,
-    ManyToManyRel,
-    Model,
-    OneToOneField,
-)
+from django.db.models import BLANK_CHOICE_DASH, Model
 from django.db.models.fields import Field
 from django.db.models.fields.related import ForeignKey, ManyToManyField
 from django.forms import Form
 from django.forms.fields import TypedChoiceField
-from django.forms.models import (
-    ModelChoiceField,
-    ModelMultipleChoiceField,
-)
-from django.forms.utils import flatatt
+from django.forms.models import ModelChoiceField, ModelMultipleChoiceField
 from django.forms.widgets import SelectMultiple
 from django.http import HttpRequest, HttpResponse
 from django.shortcuts import redirect
-from django.template.defaultfilters import linebreaksbr
 from django.template.response import TemplateResponse
 from django.urls import URLPattern, path, reverse
-from django.utils.html import conditional_escape, format_html
-from django.utils.module_loading import import_string
-from django.utils.safestring import SafeText, mark_safe
-from django.utils.text import capfirst
+from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 from django.views import View
 
 from .checks import UnfoldModelAdminChecks
 from .dataclasses import UnfoldAction
 from .exceptions import UnfoldException
+from .fields import UnfoldAdminField, UnfoldAdminReadonlyField
 from .forms import ActionForm
-from .settings import get_config
 from .typing import FieldsetsType
-from .utils import display_for_field
 from .widgets import (
-    CHECKBOX_LABEL_CLASSES,
-    LABEL_CLASSES,
     SELECT_CLASSES,
     UnfoldAdminBigIntegerFieldWidget,
     UnfoldAdminDecimalFieldWidget,
@@ -90,8 +70,6 @@ try:
 except ImportError:
     HAS_MONEY = False
 
-checkbox = UnfoldBooleanWidget({"class": "action-select"}, lambda value: False)
-
 FORMFIELD_OVERRIDES = {
     models.DateTimeField: {
         "form_class": forms.SplitDateTimeField,
@@ -141,140 +119,10 @@ FORMFIELD_OVERRIDES_INLINE.update(
     }
 )
 
-
-class UnfoldAdminField(helpers.AdminField):
-    def label_tag(self) -> SafeText:
-        classes = []
-        if not self.field.field.widget.__class__.__name__.startswith(
-            "Unfold"
-        ) and not self.field.field.widget.template_name.startswith("unfold"):
-            return super().label_tag()
-
-        # TODO load config from current AdminSite (override Fieldline.__iter__ method)
-        for lang, flag in get_config()["EXTENSIONS"]["modeltranslation"][
-            "flags"
-        ].items():
-            if f"[{lang}]" in self.field.label:
-                self.field.label = self.field.label.replace(f"[{lang}]", flag)
-                break
-
-        contents = conditional_escape(self.field.label)
-
-        if self.is_checkbox:
-            classes.append(" ".join(CHECKBOX_LABEL_CLASSES))
-        else:
-            classes.append(" ".join(LABEL_CLASSES))
-
-        if self.field.field.required:
-            classes.append("required")
-
-        attrs = {"class": " ".join(classes)} if classes else {}
-        required = mark_safe(' <span class="text-red-600">*</span>')
-
-        return self.field.label_tag(
-            contents=mark_safe(contents),
-            attrs=attrs,
-            label_suffix=required if self.field.field.required else "",
-        )
-
+checkbox = UnfoldBooleanWidget({"class": "action-select"}, lambda value: False)
 
 helpers.AdminField = UnfoldAdminField
 
-
-class UnfoldAdminReadonlyField(helpers.AdminReadonlyField):
-    def label_tag(self) -> SafeText:
-        if not isinstance(self.model_admin, ModelAdmin) and not isinstance(
-            self.model_admin, ModelAdminMixin
-        ):
-            return super().label_tag()
-
-        attrs = {
-            "class": " ".join(LABEL_CLASSES + ["mb-2"]),
-        }
-
-        label = self.field["label"]
-
-        return format_html(
-            "<label{}>{}{}</label>",
-            flatatt(attrs),
-            capfirst(label),
-            self.form.label_suffix,
-        )
-
-    def is_json(self) -> bool:
-        field, obj, model_admin = (
-            self.field["field"],
-            self.form.instance,
-            self.model_admin,
-        )
-
-        try:
-            f, attr, value = lookup_field(field, obj, model_admin)
-        except (AttributeError, ValueError, ObjectDoesNotExist):
-            return False
-
-        return isinstance(f, JSONField)
-
-    def contents(self) -> str:
-        contents = self._get_contents()
-        contents = self._preprocess_field(contents)
-        return contents
-
-    def _get_contents(self) -> str:
-        from django.contrib.admin.templatetags.admin_list import _boolean_icon
-
-        field, obj, model_admin = (
-            self.field["field"],
-            self.form.instance,
-            self.model_admin,
-        )
-        try:
-            f, attr, value = lookup_field(field, obj, model_admin)
-        except (AttributeError, ValueError, ObjectDoesNotExist):
-            result_repr = self.empty_value_display
-        else:
-            if field in self.form.fields:
-                widget = self.form[field].field.widget
-                # This isn't elegant but suffices for contrib.auth's
-                # ReadOnlyPasswordHashWidget.
-                if getattr(widget, "read_only", False):
-                    return widget.render(field, value)
-            if f is None:
-                if getattr(attr, "boolean", False):
-                    result_repr = _boolean_icon(value)
-                else:
-                    if hasattr(value, "__html__"):
-                        result_repr = value
-                    else:
-                        result_repr = linebreaksbr(value)
-            else:
-                if isinstance(f.remote_field, ManyToManyRel) and value is not None:
-                    result_repr = ", ".join(map(str, value.all()))
-                elif (
-                    isinstance(f.remote_field, (ForeignObjectRel, OneToOneField))
-                    and value is not None
-                ):
-                    result_repr = self.get_admin_url(f.remote_field, value)
-                else:
-                    result_repr = display_for_field(value, f, self.empty_value_display)
-                    return conditional_escape(result_repr)
-                result_repr = linebreaksbr(result_repr)
-        return conditional_escape(result_repr)
-
-    def _preprocess_field(self, contents: str) -> str:
-        if (
-            hasattr(self.model_admin, "readonly_preprocess_fields")
-            and self.field["field"] in self.model_admin.readonly_preprocess_fields
-        ):
-            func = self.model_admin.readonly_preprocess_fields[self.field["field"]]
-            if isinstance(func, str):
-                contents = import_string(func)(contents)
-            elif callable(func):
-                contents = func(contents)
-
-        return contents
-
-
 helpers.AdminReadonlyField = UnfoldAdminReadonlyField
 
 

django_unfold-0.27.0/src/unfold/contrib/forms/templates/unfold/forms/array.html

@@ -0,0 +1,31 @@
+{% load i18n %}
+
+<div class="flex flex-col gap-4" x-data="{items: []}">
+    {% for subwidget in widget.subwidgets %}
+        <div class="flex flex-row">
+            {% with widget=subwidget %}
+                {% include widget.template_name %}
+            {% endwith %}
+
+            <a x-on:click="$el.parentElement.remove()" class="bg-white border cursor-pointer flex items-center h-9.5 justify-center ml-2 rounded shadow-sm shrink-0 text-red-600 text-sm w-9.5 dark:bg-gray-900 dark:border-gray-700 dark:text-red-500">
+                <span class="material-symbols-outlined text-sm">delete</span>
+            </a>
+        </div>
+    {% endfor %}
+
+    <template x-for="(item, index) in items" :key="item.key">
+        <div class="flex flex-row">
+            {% include template.template_name with widget=template %}
+
+            <a x-on:click="items.splice(index, 1)" class="bg-white border cursor-pointer flex items-center h-9.5 justify-center ml-2 rounded shadow-sm shrink-0 text-red-600 text-sm w-9.5 dark:bg-gray-900 dark:border-gray-700 dark:text-red-500">
+                <span class="material-symbols-outlined text-sm">delete</span>
+            </a>
+        </div>
+    </template>
+
+    <div class="flex flex-row">
+        <div x-on:click="items.push({ key: new Date().getTime()})" class="bg-primary-600 border border-transparent cursor-pointer font-medium inline-block px-3 py-2 rounded-md text-sm text-white w-full lg:w-auto">
+            {% trans "Add new item" %}
+        </div>
+    </div>
+</div>

django_unfold-0.27.0/src/unfold/contrib/forms/widgets.py

@@ -0,0 +1,97 @@
+from typing import Any, Dict, List, Optional, Union
+
+from django.core.validators import EMPTY_VALUES
+from django.forms import MultiWidget, Widget
+from django.http import QueryDict
+from django.utils.datastructures import MultiValueDict
+from unfold.widgets import PROSE_CLASSES, UnfoldAdminTextInputWidget
+
+WYSIWYG_CLASSES = [
+    *PROSE_CLASSES,
+    "border",
+    "border-gray-200",
+    "border-t-0",
+    "group-[.errors]:border-red-600",
+    "max-w-none",
+    "p-4",
+    "rounded-b-md",
+    "rounded-t-none",
+    "text-gray-500",
+    "w-full",
+    "focus:outline-none",
+    "dark:border-gray-700",
+    "dark:text-gray-400",
+    "dark:group-[.errors]:border-red-500",
+]
+
+
+class ArrayWidget(MultiWidget):
+    template_name = "unfold/forms/array.html"
+    widget_class = UnfoldAdminTextInputWidget
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        widgets = [self.widget_class]
+        super().__init__(widgets)
+
+    def get_context(self, name: str, value: str, attrs: Dict) -> Dict:
+        self._resolve_widgets(value)
+        context = super().get_context(name, value, attrs)
+        template_widget = UnfoldAdminTextInputWidget()
+        template_widget.name = name
+
+        context.update({"template": template_widget})
+        return context
+
+    def value_from_datadict(
+        self, data: QueryDict, files: MultiValueDict, name: str
+    ) -> List:
+        values = []
+
+        for item in data.getlist(name):
+            if item not in EMPTY_VALUES:
+                values.append(item)
+
+        return values
+
+    def value_omitted_from_data(
+        self, data: QueryDict, files: MultiValueDict, name: str
+    ) -> List:
+        return data.getlist(name) not in [[""], *EMPTY_VALUES]
+
+    def decompress(self, value: Union[str, List]) -> List:
+        if isinstance(value, List):
+            return value.split(",")
+
+        return []
+
+    def _resolve_widgets(self, value: Optional[Union[List, str]]) -> None:
+        if value is None:
+            value = []
+
+        elif isinstance(value, List):
+            self.widgets = [self.widget_class for item in value]
+        else:
+            self.widgets = [self.widget_class for item in value.split(",")]
+
+        self.widgets_names = ["" for i in range(len(self.widgets))]
+        self.widgets = [w() if isinstance(w, type) else w for w in self.widgets]
+
+
+class WysiwygWidget(Widget):
+    template_name = "unfold/forms/wysiwyg.html"
+
+    class Media:
+        css = {"all": ("unfold/forms/css/trix.css",)}
+        js = (
+            "unfold/forms/js/trix.js",
+            "unfold/forms/js/trix.config.js",
+        )
+
+    def __init__(self, attrs: Optional[Dict[str, Any]] = None) -> None:
+        super().__init__(attrs)
+
+        self.attrs.update(
+            {
+                "class": " ".join(WYSIWYG_CLASSES),
+            }
+        )

{django_unfold-0.26.0 → django_unfold-0.27.0}/src/unfold/decorators.py

@@ -58,6 +58,7 @@ def display(
     function: Optional[Callable[[Model], Any]] = None,
     *,
     boolean: Optional[bool] = None,
+    image: Optional[bool] = None,
     ordering: Optional[Union[str, Combinable, BaseExpression]] = None,
     description: Optional[str] = None,
     empty_value: Optional[str] = None,
@@ -72,6 +73,8 @@ def display(
             )
         if boolean is not None:
             func.boolean = boolean
+        if image is not None:
+            func.image = image
         if ordering is not None:
             func.admin_order_field = ordering
         if description is not None:

django_unfold-0.27.0/src/unfold/fields.py

@@ -0,0 +1,200 @@
+from django.contrib.admin import helpers
+from django.contrib.admin.utils import lookup_field, quote
+from django.core.exceptions import ObjectDoesNotExist
+from django.db import models
+from django.db.models import (
+    ForeignObjectRel,
+    ImageField,
+    JSONField,
+    ManyToManyRel,
+    OneToOneField,
+)
+from django.forms.utils import flatatt
+from django.template.defaultfilters import linebreaksbr
+from django.urls import NoReverseMatch, reverse
+from django.utils.html import conditional_escape, format_html
+from django.utils.module_loading import import_string
+from django.utils.safestring import SafeText, mark_safe
+from django.utils.text import capfirst
+
+from .settings import get_config
+from .utils import display_for_field
+from .widgets import CHECKBOX_LABEL_CLASSES, LABEL_CLASSES
+
+
+class UnfoldAdminReadonlyField(helpers.AdminReadonlyField):
+    def label_tag(self) -> SafeText:
+        from .admin import ModelAdmin, ModelAdminMixin
+
+        if not isinstance(self.model_admin, ModelAdmin) and not isinstance(
+            self.model_admin, ModelAdminMixin
+        ):
+            return super().label_tag()
+
+        attrs = {
+            "class": " ".join(LABEL_CLASSES + ["mb-2"]),
+        }
+
+        label = self.field["label"]
+
+        return format_html(
+            "<label{}>{}{}</label>",
+            flatatt(attrs),
+            capfirst(label),
+            self.form.label_suffix,
+        )
+
+    def is_json(self) -> bool:
+        field, obj, model_admin = (
+            self.field["field"],
+            self.form.instance,
+            self.model_admin,
+        )
+
+        try:
+            f, attr, value = lookup_field(field, obj, model_admin)
+        except (AttributeError, ValueError, ObjectDoesNotExist):
+            return False
+
+        return isinstance(f, JSONField)
+
+    def is_image(self) -> bool:
+        field, obj, model_admin = (
+            self.field["field"],
+            self.form.instance,
+            self.model_admin,
+        )
+
+        try:
+            f, attr, value = lookup_field(field, obj, model_admin)
+        except (AttributeError, ValueError, ObjectDoesNotExist):
+            return False
+
+        if hasattr(attr, "image"):
+            return attr.image
+        elif (
+            isinstance(attr, property)
+            and hasattr(attr, "fget")
+            and hasattr(attr.fget, "image")
+        ):
+            return attr.fget.image
+
+        return isinstance(f, ImageField)
+
+    def contents(self) -> str:
+        contents = self._get_contents()
+        contents = self._preprocess_field(contents)
+        return contents
+
+    def get_admin_url(self, remote_field, remote_obj):
+        url_name = f"admin:{remote_field.model._meta.app_label}_{remote_field.model._meta.model_name}_change"
+        try:
+            url = reverse(
+                url_name,
+                args=[quote(remote_obj.pk)],
+                current_app=self.model_admin.admin_site.name,
+            )
+            return format_html(
+                '<a href="{}" class="text-primary-600 underline whitespace-nowrap">{}</a>',
+                url,
+                remote_obj,
+            )
+        except NoReverseMatch:
+            return str(remote_obj)
+
+    def _get_contents(self) -> str:
+        from django.contrib.admin.templatetags.admin_list import _boolean_icon
+
+        field, obj, model_admin = (
+            self.field["field"],
+            self.form.instance,
+            self.model_admin,
+        )
+        try:
+            f, attr, value = lookup_field(field, obj, model_admin)
+        except (AttributeError, ValueError, ObjectDoesNotExist):
+            result_repr = self.empty_value_display
+        else:
+            if field in self.form.fields:
+                widget = self.form[field].field.widget
+                # This isn't elegant but suffices for contrib.auth's
+                # ReadOnlyPasswordHashWidget.
+                if getattr(widget, "read_only", False):
+                    return widget.render(field, value)
+
+            if f is None:
+                if getattr(attr, "boolean", False):
+                    result_repr = _boolean_icon(value)
+                else:
+                    if hasattr(value, "__html__"):
+                        result_repr = value
+                    else:
+                        result_repr = linebreaksbr(value)
+            else:
+                if isinstance(f.remote_field, ManyToManyRel) and value is not None:
+                    result_repr = ", ".join(map(str, value.all()))
+                elif (
+                    isinstance(f.remote_field, (ForeignObjectRel, OneToOneField))
+                    and value is not None
+                ):
+                    result_repr = self.get_admin_url(f.remote_field, value)
+                elif isinstance(f, models.URLField):
+                    return format_html(
+                        '<a href="{}" class="text-primary-600 underline whitespace-nowrap">{}</a>',
+                        value,
+                        value,
+                    )
+                else:
+                    result_repr = display_for_field(value, f, self.empty_value_display)
+                    return conditional_escape(result_repr)
+                result_repr = linebreaksbr(result_repr)
+        return conditional_escape(result_repr)
+
+    def _preprocess_field(self, contents: str) -> str:
+        if (
+            hasattr(self.model_admin, "readonly_preprocess_fields")
+            and self.field["field"] in self.model_admin.readonly_preprocess_fields
+        ):
+            func = self.model_admin.readonly_preprocess_fields[self.field["field"]]
+            if isinstance(func, str):
+                contents = import_string(func)(contents)
+            elif callable(func):
+                contents = func(contents)
+
+        return contents
+
+
+class UnfoldAdminField(helpers.AdminField):
+    def label_tag(self) -> SafeText:
+        classes = []
+        if not self.field.field.widget.__class__.__name__.startswith(
+            "Unfold"
+        ) and not self.field.field.widget.template_name.startswith("unfold"):
+            return super().label_tag()
+
+        # TODO load config from current AdminSite (override Fieldline.__iter__ method)
+        for lang, flag in get_config()["EXTENSIONS"]["modeltranslation"][
+            "flags"
+        ].items():
+            if f"[{lang}]" in self.field.label:
+                self.field.label = self.field.label.replace(f"[{lang}]", flag)
+                break
+
+        contents = conditional_escape(self.field.label)
+
+        if self.is_checkbox:
+            classes.append(" ".join(CHECKBOX_LABEL_CLASSES))
+        else:
+            classes.append(" ".join(LABEL_CLASSES))
+
+        if self.field.field.required:
+            classes.append("required")
+
+        attrs = {"class": " ".join(classes)} if classes else {}
+        required = mark_safe(' <span class="text-red-600">*</span>')
+
+        return self.field.label_tag(
+            contents=mark_safe(contents),
+            attrs=attrs,
+            label_suffix=required if self.field.field.required else "",
+        )