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

unfold/templates/unfold/helpers/inline_heading.html

@@ -0,0 +1,11 @@
+<h2 class="bg-base-100 flex flex-row font-semibold h-[38px] items-center mb-4 px-3 rounded-default text-important dark:bg-white/[.02] {% if inline_admin_formset.opts.tab %}hidden{% endif %} {% if clickable or inline_admin_formset.is_collapsible %}cursor-pointer{% endif %}" {% if inline_admin_formset %}id="{{ inline_admin_formset.formset.prefix }}-heading"{% endif %}>
+    {% if inline_admin_formset %}
+        {% if inline_admin_formset.formset.max_num == 1 %}
+            {{ inline_admin_formset.opts.verbose_name|capfirst }}
+        {% else %}
+            {{ inline_admin_formset.opts.verbose_name_plural|capfirst }}
+        {% endif %}
+    {% else %}
+        {{ title|capfirst }}
+    {% endif %}
+</h2>

unfold/templates/unfold/helpers/tab_items.html

@@ -1,7 +1,7 @@
 {% load i18n %}
 
 {% if inlines_list or tabs_list %}
-    <nav class="bg-base-100 flex flex-col font-medium gap-1 p-1 rounded-default w-full dark:border-base-700 md:flex-row md:w-auto dark:bg-white/[.04] *:flex *:flex-row *:font-medium *:items-center *:px-2.5 *:py-[5px] *:rounded-default *:transition-colors *:hover:bg-base-700/[.04] *:dark:hover:bg-white/[.04] [&>.active]:bg-white [&>.active]:shadow-xs [&>.active]:text-font-important-light [&>.active]:hover:bg-white [&>.active]:dark:bg-base-900 [&>.active]:dark:hover:bg-base-900 [&>.active]:dark:text-font-important-dark">
+    <nav class="bg-base-100 flex flex-col font-medium gap-1 p-1 rounded-default text-important w-full dark:border-base-700 md:flex-row md:w-auto dark:bg-white/[.04] *:flex *:flex-row *:font-medium *:items-center *:px-2.5 *:py-[5px] *:rounded-default *:transition-colors *:hover:bg-base-700/[.04] *:dark:hover:bg-white/[.04] [&>.active]:bg-white [&>.active]:shadow-xs [&>.active]:hover:bg-white [&>.active]:dark:bg-base-900 [&>.active]:dark:hover:bg-base-900">
         {% for item in tabs_list %}
             {% if item.has_permission %}
                 <a href="{% if item.link_callback %}{{ item.link_callback }}{% else %}{{ item.link }}{% endif %}{% if item.inline %}#{{ item.inline|slugify }}{% endif %}" class="{% if item.active and not item.inline %}active{% endif %}" {% if item.inline %}x-on:click="activeTab = '{{ item.inline|slugify }}'" x-bind:class="{'active': activeTab == '{{ item.inline|slugify }}'}"{% endif %}>
@@ -24,6 +24,14 @@
                     {% endif %}
                 </a>
             {% endfor %}
+
+            {% for dataset in datasets_list %}
+                {% if dataset.tab %}
+                    <a href="#dataset-{{ dataset.model_name }}" x-on:click="activeTab = 'dataset-{{ dataset.model_name }}'" x-bind:class="{'active': activeTab == 'dataset-{{ dataset.model_name }}'}">
+                        {{ dataset.model_verbose_name|capfirst }}
+                    </a>
+                {% endif %}
+            {% endfor %}
         {% endif %}
     </nav>
 {% endif %}

unfold/templatetags/unfold.py

@@ -1,6 +1,6 @@
 import json
 from collections.abc import Iterable, Mapping
-from typing import Any, Optional, Union
+from typing import Any
 
 from django import template
 from django.contrib.admin.helpers import AdminForm, Fieldset
@@ -27,7 +27,7 @@ register = Library()
 
 
 def _get_tabs_list(
-    context: RequestContext, page: str, opts: Optional[Options] = None
+    context: RequestContext, page: str, opts: Options | None = None
 ) -> list:
     tabs_list = []
     page_id = None
@@ -63,9 +63,9 @@ def _get_tabs_list(
 
 
 @register.simple_tag(name="tab_list", takes_context=True)
-def tab_list(context: RequestContext, page: str, opts: Optional[Options] = None) -> str:
+def tab_list(context: RequestContext, page: str, opts: Options | None = None) -> str:
     inlines_list = []
-
+    datasets_list = []
     data = {
         "nav_global": context.get("nav_global"),
         "actions_detail": context.get("actions_detail"),
@@ -85,6 +85,13 @@ def tab_list(context: RequestContext, page: str, opts: Optional[Options] = None)
         if len(inlines_list) > 0:
             data["inlines_list"] = inlines_list
 
+        for dataset in context.get("datasets", []):
+            if dataset and hasattr(dataset, "tab"):
+                datasets_list.append(dataset)
+
+        if len(datasets_list) > 0:
+            data["datasets_list"] = datasets_list
+
     return render_to_string(
         "unfold/helpers/tab_list.html",
         request=context["request"],
@@ -144,82 +151,12 @@ def tabs(adminform: AdminForm) -> list[Fieldset]:
     return result
 
 
-class CaptureNode(Node):
-    def __init__(self, nodelist: NodeList, varname: str, silent: bool) -> None:
-        self.nodelist = nodelist
-        self.varname = varname
-        self.silent = silent
-
-    def render(self, context: dict[str, Any]) -> Union[str, SafeText]:
-        output = self.nodelist.render(context)
-        context[self.varname] = output
-        if self.silent:
-            return ""
-        else:
-            return output
-
-
-@register.tag(name="capture")
-def do_capture(parser: Parser, token: Token) -> CaptureNode:
-    """
-    Capture the contents of a tag output.
-    Usage:
-    .. code-block:: html+django
-        {% capture %}..{% endcapture %}                    # output in {{ capture }}
-        {% capture silent %}..{% endcapture %}             # output in {{ capture }} only
-        {% capture as varname %}..{% endcapture %}         # output in {{ varname }}
-        {% capture as varname silent %}..{% endcapture %}  # output in {{ varname }} only
-    For example:
-    .. code-block:: html+django
-        {# Allow templates to override the page title/description #}
-        <meta name="description" content="{% capture as meta_description %}
-            {% block meta-description %}{% endblock %}{% endcapture %}" />
-        <title>{% capture as meta_title %}{% block meta-title %}Untitled{% endblock %}{% endcapture %}</title>
-        {# copy the values to the Social Media meta tags #}
-        <meta property="og:description" content="{% block og-description %}{{ meta_description }}{% endblock %}" />
-        <meta name="twitter:title" content="{% block twitter-title %}{{ meta_title }}{% endblock %}" />
-    """
-    bits = token.split_contents()
-
-    # tokens
-    t_as = "as"
-    t_silent = "silent"
-    var = "capture"
-    silent = False
-
-    num_bits = len(bits)
-    if len(bits) > 4:
-        raise TemplateSyntaxError(
-            "'capture' node supports '[as variable] [silent]' parameters."
-        )
-    elif num_bits == 4:
-        t_name, t_as, var, t_silent = bits
-        silent = True
-    elif num_bits == 3:
-        t_name, t_as, var = bits
-    elif num_bits == 2:
-        t_name, t_silent = bits
-        silent = True
-    else:
-        var = "capture"
-        silent = False
-
-    if t_silent != "silent" or t_as != "as":
-        raise TemplateSyntaxError(
-            "'capture' node expects 'as variable' or 'silent' syntax."
-        )
-
-    nodelist = parser.parse(("endcapture",))
-    parser.delete_first_token()
-    return CaptureNode(nodelist, var, silent)
-
-
 class RenderComponentNode(template.Node):
     def __init__(
         self,
         template_name: str,
         nodelist: NodeList,
-        extra_context: Optional[dict] = None,
+        extra_context: dict | None = None,
         include_context: bool = False,
         *args,
         **kwargs,
@@ -308,7 +245,7 @@ def do_component(parser: Parser, token: Token) -> str:
 
 
 @register.filter
-def add_css_class(field: Field, classes: Union[list, tuple]) -> Field:
+def add_css_class(field: Field, classes: list | tuple) -> Field:
     if type(classes) in (list, tuple):
         classes = " ".join(classes)
 
@@ -329,8 +266,8 @@ def preserve_changelist_filters(context: Context) -> dict[str, dict[str, str]]:
     """
     Generate hidden input fields to preserve filters for POST forms.
     """
-    request: Optional[HttpRequest] = context.get("request")
-    changelist: Optional[ChangeList] = context.get("cl")
+    request: HttpRequest | None = context.get("request")
+    changelist: ChangeList | None = context.get("cl")
 
     if not request or not changelist:
         return {"params": {}}
@@ -348,7 +285,7 @@ def preserve_changelist_filters(context: Context) -> dict[str, dict[str, str]]:
 @register.simple_tag(takes_context=True)
 def element_classes(context: Context, key: str) -> str:
     if key in context.get("element_classes", {}):
-        if isinstance(context["element_classes"][key], (list, tuple)):
+        if isinstance(context["element_classes"][key], list | tuple):
             return " ".join(context["element_classes"][key])
 
         return context["element_classes"][key]
@@ -585,9 +522,7 @@ def infinite_paginator_url(cl, i):
 
 
 @register.simple_tag
-def elided_page_range(
-    paginator: Paginator, number: int
-) -> Optional[list[Union[int, str]]]:
+def elided_page_range(paginator: Paginator, number: int) -> list[int | str] | None:
     if not paginator or not number:
         return None
 
@@ -794,3 +729,50 @@ def has_nested_tables(table: dict) -> bool:
     return any(
         isinstance(row, dict) and "table" in row for row in table.get("rows", [])
     )
+
+
+class RenderCaptureNode(Node):
+    def __init__(self, nodelist: NodeList, variable_name: str, silent: bool) -> None:
+        self.nodelist = nodelist
+        self.variable_name = variable_name
+        self.silent = silent
+
+    def render(self, context: dict[str, Any]) -> str | SafeText:
+        content = self.nodelist.render(context)
+
+        if not self.silent:
+            return content
+
+        context.update(
+            {
+                self.variable_name: content,
+            }
+        )
+
+        return ""
+
+
+@register.tag(name="capture")
+def do_capture(parser: Parser, token: Token) -> RenderCaptureNode:
+    parts = token.split_contents()
+    variable_name = ""
+    silent = False
+
+    if len(parts) > 4:
+        raise TemplateSyntaxError("Too many arguments for 'capture' tag.")
+
+    if len(parts) >= 3:
+        if parts[1] != "as":
+            raise TemplateSyntaxError("'as' is required for 'capture' tag.")
+
+        variable_name = parts[2]
+
+    if len(parts) == 4:
+        if parts[3] != "silent":
+            raise TemplateSyntaxError("'silent' is required for 'capture' tag.")
+
+        silent = True
+
+    nodelist = parser.parse(("endcapture",))
+    parser.delete_first_token()
+    return RenderCaptureNode(nodelist, variable_name, silent)

unfold/templatetags/unfold_list.py

@@ -1,18 +1,21 @@
 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,
     _coerce_field_name,
+    admin_actions,
     result_hidden_fields,
 )
 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 +37,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 +109,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
@@ -114,6 +127,7 @@ def result_headers(cl):
                     "text": UnfoldBooleanWidget(
                         {
                             "id": "action-toggle",
+                            "class": "action-toggle",
                             "aria-label": _(
                                 "Select all objects on this page for an action"
                             ),
@@ -145,6 +159,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 +227,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 +262,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 +274,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 +342,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 +370,7 @@ class UnfoldResultList(ResultList):
     def __init__(
         self,
         instance: Model,
-        form: Optional[Form],
+        form: Form | None,
         *items: Any,
     ) -> None:
         self.instance = instance
@@ -395,23 +419,67 @@ 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,
+    )
+
+
+@register.tag(name="unfold_admin_actions")
+def unfold_admin_actions_tag(parser, token):
+    return InclusionAdminNode(
+        parser,
+        token,
+        func=admin_actions,
+        template_name="dataset_actions.html",
+    )

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