django-unfold 0.67.0__py3-none-any.whl → 0.68.0__py3-none-any.whl

unfold/templatetags/unfold_list.py

@@ -1,6 +1,6 @@
 import datetime
 from collections.abc import Generator
-from typing import Any, Optional, Union
+from typing import Any
 
 from django.contrib.admin.templatetags.admin_list import (
     ResultList,
@@ -11,8 +11,10 @@ from django.contrib.admin.templatetags.admin_urls import add_preserved_filters
 from django.contrib.admin.templatetags.base import InclusionAdminNode
 from django.contrib.admin.utils import label_for_field, lookup_field
 from django.contrib.admin.views.main import (
+    IS_POPUP_VAR,
     ORDER_VAR,
     PAGE_VAR,
+    SEARCH_VAR,
     ChangeList,
 )
 from django.core.exceptions import ObjectDoesNotExist
@@ -34,8 +36,15 @@ from unfold.utils import (
     display_for_label,
     display_for_value,
 )
+from unfold.views import DatasetChangeList
 from unfold.widgets import UnfoldBooleanWidget
 
+try:
+    from django.contrib.admin.views.main import IS_FACETS_VAR
+except ImportError:
+    # TODO: remove once django 4.x is not supported
+    IS_FACETS_VAR = None
+
 register = Library()
 
 LINK_CLASSES = [
@@ -99,6 +108,9 @@ def result_headers(cl):
     Generate the list column headers.
     """
     ordering_field_columns = cl.get_ordering_field_columns()
+    ordering_field = getattr(cl.model_admin, "ordering_field", None)
+    hide_ordering_field = getattr(cl.model_admin, "hide_ordering_field", False)
+
     for i, field_name in enumerate(cl.list_display):
         text, attr = label_for_field(
             field_name, cl.model, model_admin=cl.model_admin, return_attr=True
@@ -145,6 +157,10 @@ def result_headers(cl):
         order_type = ""
         new_order_type = "asc"
         sort_priority = 0
+
+        if ordering_field and field_name == ordering_field and hide_ordering_field:
+            th_classes.append("!hidden")
+
         # Is it currently being sorted on?
         is_sorted = i in ordering_field_columns
         if is_sorted:
@@ -209,6 +225,9 @@ def items_for_result(
 
     for field_index, field_name in enumerate(cl.list_display):
         empty_value_display = cl.model_admin.get_empty_value_display()
+        ordering_field = getattr(cl.model_admin, "ordering_field", None)
+        hide_ordering_field = getattr(cl.model_admin, "hide_ordering_field", False)
+
         row_classes = [
             f"field-{_coerce_field_name(field_name, field_index)}",
             *ROW_CLASSES,
@@ -241,7 +260,7 @@ def items_for_result(
                 else:
                     result_repr = display_for_value(value, empty_value_display, boolean)
 
-                if isinstance(value, (datetime.date, datetime.time)):
+                if isinstance(value, datetime.date | datetime.time):
                     row_classes.append("nowrap")
             else:
                 if isinstance(f.remote_field, models.ManyToOneRel):
@@ -253,7 +272,7 @@ def items_for_result(
                 else:
                     result_repr = display_for_field(value, f, empty_value_display)
                 if isinstance(
-                    f, (models.DateField, models.TimeField, models.ForeignKey)
+                    f, models.DateField | models.TimeField | models.ForeignKey
                 ):
                     row_classes.append("nowrap")
 
@@ -321,6 +340,9 @@ def items_for_result(
                 if bf.errors:
                     row_classes += ["group", "errors"]
 
+            if ordering_field and field_name == ordering_field and hide_ordering_field:
+                row_classes.append("!hidden")
+
             row_class = mark_safe(f' class="{" ".join(row_classes)}"')
 
             if field_index != 0:
@@ -346,7 +368,7 @@ class UnfoldResultList(ResultList):
     def __init__(
         self,
         instance: Model,
-        form: Optional[Form],
+        form: Form | None,
         *items: Any,
     ) -> None:
         self.instance = instance
@@ -395,23 +417,57 @@ def result_list_tag(parser: Parser, token: Token) -> InclusionAdminNode:
 
 
 @register.simple_tag
-def paginator_number(cl: ChangeList, i: Union[str, int]) -> Union[str, SafeText]:
+def paginator_number(cl: ChangeList, i: str | int) -> str | SafeText:
     """
     Generate an individual page index link in a paginated list.
     """
     if i == cl.paginator.ELLIPSIS:
         return render_to_string(
             "unfold/helpers/pagination_ellipsis.html",
-            {"ellipsis": cl.paginator.ELLIPSIS},
+            {
+                "ellipsis": cl.paginator.ELLIPSIS,
+            },
         )
     elif i == cl.page_num:
         return render_to_string(
             "unfold/helpers/pagination_current_item.html", {"number": i}
         )
     else:
+        page_param = PAGE_VAR
+
+        if isinstance(cl, DatasetChangeList):
+            page_param = f"{cl.model._meta.model_name}-p"
+
         return format_html(
-            '<a href="{}"{}>{}</a> ',
-            cl.get_query_string({PAGE_VAR: i}),
+            '<a href="{}"{} x-data x-on:click.prevent="window.location.href = $el.href + window.location.hash">{}</a> ',
+            cl.get_query_string(
+                {
+                    page_param: i,
+                }
+            ),
             mark_safe(' class="end"' if i == cl.paginator.num_pages else ""),
             i,
         )
+
+
+def unfold_search_form(cl):
+    model_name = cl.model_admin.model._meta.model_name
+
+    return {
+        "cl": cl,
+        "show_result_count": cl.result_count != cl.full_result_count,
+        "search_var": f"{model_name}-{SEARCH_VAR}",
+        "is_popup_var": IS_POPUP_VAR,
+        "is_facets_var": IS_FACETS_VAR,
+    }
+
+
+@register.tag(name="unfold_search_form")
+def unfold_search_form_tag(parser, token):
+    return InclusionAdminNode(
+        parser,
+        token,
+        func=unfold_search_form,
+        template_name="search_form.html",
+        takes_context=False,
+    )

unfold/typing.py

@@ -1,5 +1,5 @@
 from collections.abc import Iterable
-from typing import Any, Optional, Protocol, Union
+from typing import Any, Protocol
 
 
 class ActionFunction(Protocol):
@@ -13,13 +13,12 @@ class ActionFunction(Protocol):
     short_description: str
     url_path: str
     attrs: dict[str, Any]
-    icon: Optional[str] = None
+    icon: str | None = None
 
     def __call__(self, *args, **kwargs):
         pass
 
 
-FieldsetsType = Union[
-    list[tuple[Union[str, None], dict[str, Any]]],
-    tuple[tuple[Union[str, None], dict[str, Any]]],
-]
+FieldsetsType = (
+    list[tuple[str | None, dict[str, Any]]] | tuple[tuple[str | None, dict[str, Any]]]
+)

unfold/utils.py

@@ -2,7 +2,7 @@ import datetime
 import decimal
 import json
 from collections.abc import Iterable
-from typing import Any, Optional
+from typing import Any
 
 from django.conf import settings
 from django.db import models
@@ -94,13 +94,13 @@ def display_for_value(
         return str(value)
     elif isinstance(value, datetime.datetime):
         return formats.localize(timezone.template_localtime(value))
-    elif isinstance(value, (datetime.date, datetime.time)):
+    elif isinstance(value, datetime.date | datetime.time):
         return formats.localize(value)
     elif Money is not None and isinstance(value, Money):
         return str(value)
-    elif isinstance(value, (int, decimal.Decimal, float)):
+    elif isinstance(value, int | decimal.Decimal | float):
         return formats.number_format(value)
-    elif isinstance(value, (list, tuple)):
+    elif isinstance(value, list | tuple):
         return ", ".join(str(v) for v in value)
     else:
         return str(value)
@@ -121,13 +121,13 @@ def display_for_field(value: Any, field: Any, empty_value_display: str) -> str:
         return empty_value_display
     elif isinstance(field, models.DateTimeField):
         return formats.localize(timezone.template_localtime(value))
-    elif isinstance(field, (models.DateField, models.TimeField)):
+    elif isinstance(field, models.DateField | models.TimeField):
         return formats.localize(value)
     elif MoneyField is not None and isinstance(field, MoneyField):
         return str(value)
     elif isinstance(field, models.DecimalField):
         return formats.number_format(value, field.decimal_places)
-    elif isinstance(field, (models.IntegerField, models.FloatField)):
+    elif isinstance(field, models.IntegerField | models.FloatField):
         return formats.number_format(value)
     elif isinstance(field, models.FileField) and value:
         return format_html('<a href="{}">{}</a>', value.url, value)
@@ -140,7 +140,7 @@ def display_for_field(value: Any, field: Any, empty_value_display: str) -> str:
         return display_for_value(value, empty_value_display)
 
 
-def prettify_json(data: Any, encoder: Any) -> Optional[str]:
+def prettify_json(data: Any, encoder: Any) -> str | None:
     try:
         from pygments import highlight
         from pygments.formatters import HtmlFormatter
@@ -165,7 +165,7 @@ def prettify_json(data: Any, encoder: Any) -> Optional[str]:
     )
 
 
-def parse_date_str(value: str) -> Optional[datetime.date]:
+def parse_date_str(value: str) -> datetime.date | None:
     for format in settings.DATE_INPUT_FORMATS:
         try:
             return datetime.datetime.strptime(value, format).date()
@@ -173,7 +173,7 @@ def parse_date_str(value: str) -> Optional[datetime.date]:
             continue
 
 
-def parse_datetime_str(value: str) -> Optional[datetime.datetime]:
+def parse_datetime_str(value: str) -> datetime.datetime | None:
     for format in settings.DATETIME_INPUT_FORMATS:
         try:
             return datetime.datetime.strptime(value, format)

unfold/views.py

@@ -1,15 +1,18 @@
 from typing import Any
 
 import django
+from django.contrib.admin.views import main
 from django.contrib.admin.views.main import ERROR_FLAG, PAGE_VAR
 from django.contrib.admin.views.main import ChangeList as BaseChangeList
 from django.contrib.auth.mixins import PermissionRequiredMixin
+from django.http import HttpRequest
 
 from unfold.exceptions import UnfoldException
+from unfold.forms import DatasetChangeListSearchForm
 
 
 class ChangeList(BaseChangeList):
-    def __init__(self, request, *args, **kwargs):
+    def __init__(self, request: HttpRequest, *args: Any, **kwargs: Any) -> None:
         super().__init__(request, *args, **kwargs)
 
         if django.VERSION < (5, 0):
@@ -18,6 +21,17 @@ class ChangeList(BaseChangeList):
             self.filter_params.pop(ERROR_FLAG, None)
 
 
+class DatasetChangeList(ChangeList):
+    is_dataset = True
+    search_form_class = DatasetChangeListSearchForm
+
+    def __init__(self, request: HttpRequest, *args: Any, **kwargs: Any) -> None:
+        # Monkeypatch SEARCH_VAR and PAGE_VAR for custom datasets
+        main.SEARCH_VAR = f"{kwargs.get('model')._meta.model_name}-q"
+        main.PAGE_VAR = f"{kwargs.get('model')._meta.model_name}-p"
+        super().__init__(request, *args, **kwargs)
+
+
 class UnfoldModelAdminViewMixin(PermissionRequiredMixin):
     """
     Prepares views to be displayed in admin

unfold/widgets.py

@@ -1,4 +1,5 @@
-from typing import Any, Callable, Optional, Union
+from collections.abc import Callable
+from typing import Any
 
 from django.contrib.admin.options import VERTICAL
 from django.contrib.admin.sites import AdminSite
@@ -337,7 +338,7 @@ class UnfoldPrefixSuffixMixin:
 class UnfoldAdminTextInputWidget(UnfoldPrefixSuffixMixin, AdminTextInputWidget):
     template_name = "unfold/widgets/text.html"
 
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -351,7 +352,7 @@ class UnfoldAdminTextInputWidget(UnfoldPrefixSuffixMixin, AdminTextInputWidget):
 class UnfoldAdminURLInputWidget(AdminURLFieldWidget):
     template_name = "unfold/widgets/url.html"
 
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -363,7 +364,7 @@ class UnfoldAdminURLInputWidget(AdminURLFieldWidget):
 
 
 class UnfoldAdminColorInputWidget(AdminTextInputWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -376,7 +377,7 @@ class UnfoldAdminColorInputWidget(AdminTextInputWidget):
 
 
 class UnfoldAdminUUIDInputWidget(AdminUUIDInputWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -390,7 +391,7 @@ class UnfoldAdminUUIDInputWidget(AdminUUIDInputWidget):
 class UnfoldAdminIntegerRangeWidget(MultiWidget):
     template_name = "unfold/widgets/range.html"
 
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         if attrs is None:
             attrs = {}
 
@@ -402,14 +403,14 @@ class UnfoldAdminIntegerRangeWidget(MultiWidget):
 
         super().__init__(_widgets, attrs)
 
-    def decompress(self, value: Union[str, None]) -> tuple[Optional[Callable], ...]:
+    def decompress(self, value: str | None) -> tuple[Callable | None, ...]:
         if value:
             return value.lower, value.upper
         return None, None
 
 
 class UnfoldAdminEmailInputWidget(AdminEmailInputWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -459,7 +460,7 @@ class UnfoldAdminDateWidget(AdminDateWidget):
     template_name = "unfold/widgets/date.html"
 
     def __init__(
-        self, attrs: Optional[dict[str, Any]] = None, format: Optional[str] = None
+        self, attrs: dict[str, Any] | None = None, format: str | None = None
     ) -> None:
         attrs = {
             **(attrs or {}),
@@ -486,7 +487,7 @@ class UnfoldAdminSingleDateWidget(AdminDateWidget):
     template_name = "unfold/widgets/date.html"
 
     def __init__(
-        self, attrs: Optional[dict[str, Any]] = None, format: Optional[str] = None
+        self, attrs: dict[str, Any] | None = None, format: str | None = None
     ) -> None:
         attrs = {
             **(attrs or {}),
@@ -506,7 +507,7 @@ class UnfoldAdminTimeWidget(AdminTimeWidget):
     template_name = "unfold/widgets/time.html"
 
     def __init__(
-        self, attrs: Optional[dict[str, Any]] = None, format: Optional[str] = None
+        self, attrs: dict[str, Any] | None = None, format: str | None = None
     ) -> None:
         attrs = {
             **(attrs or {}),
@@ -533,7 +534,7 @@ class UnfoldAdminSingleTimeWidget(AdminTimeWidget):
     template_name = "unfold/widgets/time.html"
 
     def __init__(
-        self, attrs: Optional[dict[str, Any]] = None, format: Optional[str] = None
+        self, attrs: dict[str, Any] | None = None, format: str | None = None
     ) -> None:
         attrs = {
             **(attrs or {}),
@@ -552,7 +553,7 @@ class UnfoldAdminSingleTimeWidget(AdminTimeWidget):
 class UnfoldAdminTextareaWidget(AdminTextareaWidget):
     template_name = "unfold/widgets/textarea.html"
 
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         attrs = attrs or {}
 
         super().__init__(
@@ -570,7 +571,7 @@ class UnfoldAdminTextareaWidget(AdminTextareaWidget):
 
 
 class UnfoldAdminExpandableTextareaWidget(UnfoldAdminTextareaWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         attrs = attrs or {}
 
         attrs.update({"rows": 2})
@@ -593,7 +594,7 @@ class UnfoldAdminExpandableTextareaWidget(UnfoldAdminTextareaWidget):
 class UnfoldAdminSplitDateTimeWidget(AdminSplitDateTime):
     template_name = "unfold/widgets/split_datetime.html"
 
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         widgets = [
             UnfoldAdminDateWidget(attrs={"placeholder": _("Date")}),
             UnfoldAdminTimeWidget(attrs={"placeholder": _("Time")}),
@@ -613,11 +614,11 @@ class UnfoldAdminSplitDateTimeVerticalWidget(AdminSplitDateTime):
 
     def __init__(
         self,
-        attrs: Optional[dict[str, Any]] = None,
-        date_attrs: Optional[dict[str, Any]] = None,
-        time_attrs: Optional[dict[str, Any]] = None,
-        date_label: Optional[str] = None,
-        time_label: Optional[str] = None,
+        attrs: dict[str, Any] | None = None,
+        date_attrs: dict[str, Any] | None = None,
+        time_attrs: dict[str, Any] | None = None,
+        date_label: str | None = None,
+        time_label: str | None = None,
     ) -> None:
         self.date_label = date_label
         self.time_label = time_label
@@ -629,7 +630,7 @@ class UnfoldAdminSplitDateTimeVerticalWidget(AdminSplitDateTime):
         MultiWidget.__init__(self, widgets, attrs)
 
     def get_context(
-        self, name: str, value: Any, attrs: Optional[dict[str, Any]]
+        self, name: str, value: Any, attrs: dict[str, Any] | None
     ) -> dict[str, Any]:
         context = super().get_context(name, value, attrs)
 
@@ -647,7 +648,7 @@ class UnfoldAdminSplitDateTimeVerticalWidget(AdminSplitDateTime):
 
 
 class UnfoldAdminIntegerFieldWidget(AdminIntegerFieldWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -659,7 +660,7 @@ class UnfoldAdminIntegerFieldWidget(AdminIntegerFieldWidget):
 
 
 class UnfoldAdminDecimalFieldWidget(AdminIntegerFieldWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -671,7 +672,7 @@ class UnfoldAdminDecimalFieldWidget(AdminIntegerFieldWidget):
 
 
 class UnfoldAdminBigIntegerFieldWidget(AdminBigIntegerFieldWidget):
-    def __init__(self, attrs: Optional[dict[str, Any]] = None) -> None:
+    def __init__(self, attrs: dict[str, Any] | None = None) -> None:
         super().__init__(
             attrs={
                 **(attrs or {}),
@@ -773,7 +774,7 @@ class UnfoldAdminRadioSelectWidget(AdminRadioSelect):
     template_name = "unfold/widgets/radio.html"
     option_template_name = "unfold/widgets/radio_option.html"
 
-    def __init__(self, radio_style: Optional[int] = None, *args, **kwargs):
+    def __init__(self, radio_style: int | None = None, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
         if radio_style is None:
@@ -832,7 +833,7 @@ except ImportError:
 
 class UnfoldBooleanWidget(CheckboxInput):
     def __init__(
-        self, attrs: Optional[dict[str, Any]] = None, check_test: Callable = None
+        self, attrs: dict[str, Any] | None = None, check_test: Callable = None
     ) -> None:
         if attrs is None:
             attrs = {}
@@ -850,7 +851,7 @@ class UnfoldBooleanWidget(CheckboxInput):
 
 class UnfoldBooleanSwitchWidget(CheckboxInput):
     def __init__(
-        self, attrs: Optional[dict[str, Any]] = None, check_test: Callable = None
+        self, attrs: dict[str, Any] | None = None, check_test: Callable = None
     ) -> None:
         super().__init__(
             attrs={
@@ -874,8 +875,8 @@ class UnfoldForeignKeyRawIdWidget(ForeignKeyRawIdWidget):
         self,
         rel: ForeignObjectRel,
         admin_site: AdminSite,
-        attrs: Optional[dict] = None,
-        using: Optional[Any] = None,
+        attrs: dict | None = None,
+        using: Any | None = None,
     ) -> None:
         attrs = {
             **(attrs or {}),