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

unfold/contrib/inlines/forms.py

@@ -1,4 +1,5 @@
-from typing import Any, Callable, Optional
+from collections.abc import Callable
+from typing import Any
 
 from django.db.models import Model, QuerySet
 from django.forms import BaseModelFormSet, ModelForm, modelformset_factory
@@ -9,7 +10,7 @@ from unfold.forms import PaginationFormSetMixin
 class NonrelatedInlineModelFormSet(PaginationFormSetMixin, BaseModelFormSet):
     def __init__(
         self,
-        instance: Optional[Model] = None,
+        instance: Model | None = None,
         save_as_new: bool = False,
         **kwargs: Any,
     ) -> None:
@@ -33,9 +34,9 @@ class NonrelatedInlineModelFormSet(PaginationFormSetMixin, BaseModelFormSet):
 
 def nonrelated_inline_formset_factory(
     model: Model,
-    queryset: Optional[QuerySet] = None,
+    queryset: QuerySet | None = None,
     formset: BaseModelFormSet = NonrelatedInlineModelFormSet,
-    save_new_instance: Optional[Callable] = None,
+    save_new_instance: Callable | None = None,
     **kwargs: Any,
 ) -> BaseModelFormSet:
     inline_formset = modelformset_factory(model, formset=formset, **kwargs)

unfold/dataclasses.py

@@ -1,5 +1,5 @@
+from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Callable, Optional, Union
 
 from unfold.enums import ActionVariant
 
@@ -12,10 +12,10 @@ class UnfoldAction:
     method: ActionFunction
     description: str
     path: str
-    attrs: Optional[dict] = None
-    object_id: Optional[Union[int, str]] = None
-    icon: Optional[str] = None
-    variant: Optional[ActionVariant] = ActionVariant.DEFAULT
+    attrs: dict | None = None
+    object_id: int | str | None = None
+    icon: str | None = None
+    variant: ActionVariant | None = ActionVariant.DEFAULT
 
 
 @dataclass
@@ -23,20 +23,20 @@ class SearchResult:
     title: str
     description: str
     link: str
-    icon: Optional[str]
+    icon: str | None
 
 
 @dataclass
 class Favicon:
-    href: Union[str, Callable]
-    rel: Optional[str] = None
-    type: Optional[str] = None
-    sizes: Optional[str] = None
+    href: str | Callable
+    rel: str | None = None
+    type: str | None = None
+    sizes: str | None = None
 
 
 @dataclass
 class DropdownItem:
     title: str
-    link: Union[str, Callable]
-    icon: Optional[str] = None
-    attrs: Optional[dict] = None
+    link: str | Callable
+    icon: str | None = None
+    attrs: dict | None = None

unfold/datasets.py

@@ -0,0 +1,69 @@
+from typing import Any
+
+from django.contrib import admin
+from django.http import HttpRequest
+from django.template.loader import render_to_string
+
+from unfold.views import DatasetChangeList
+
+
+class BaseDataset:
+    tab = False
+
+    def __init__(
+        self, request: HttpRequest, extra_context: dict[str, Any] | None
+    ) -> None:
+        self.request = request
+        self.extra_context = extra_context
+
+        self.model_admin_instance = self.model_admin(
+            model=self.model, admin_site=admin.site
+        )
+        self.model_admin_instance.extra_context = self.extra_context
+
+    @property
+    def contents(self) -> str:
+        return render_to_string(
+            "unfold/helpers/dataset.html",
+            request=self.request,
+            context={
+                "dataset": self,
+                "cl": self.cl(),
+                "opts": self.model._meta,
+            },
+        )
+
+    def cl(self) -> DatasetChangeList:
+        list_display = self.model_admin_instance.get_list_display(self.request)
+        list_display_links = self.model_admin_instance.get_list_display_links(
+            self.request, list_display
+        )
+        sortable_by = self.model_admin_instance.get_sortable_by(self.request)
+        search_fields = self.model_admin_instance.get_search_fields(self.request)
+        cl = DatasetChangeList(
+            request=self.request,
+            model=self.model,
+            model_admin=self.model_admin_instance,
+            list_display=list_display,
+            list_display_links=list_display_links,
+            list_filter=[],
+            date_hierarchy=[],
+            search_fields=search_fields,
+            list_select_related=[],
+            list_per_page=10,
+            list_max_show_all=False,
+            list_editable=[],
+            sortable_by=sortable_by,
+            search_help_text=[],
+        )
+        cl.formset = None
+
+        return cl
+
+    @property
+    def model_name(self) -> str:
+        return self.model._meta.model_name
+
+    @property
+    def model_verbose_name(self) -> str:
+        return self.model._meta.verbose_name_plural

unfold/decorators.py

@@ -1,5 +1,5 @@
-from collections.abc import Iterable
-from typing import Any, Callable, Optional, Union
+from collections.abc import Callable, Iterable
+from typing import Any
 
 from django.contrib.admin.options import BaseModelAdmin
 from django.core.exceptions import PermissionDenied
@@ -12,14 +12,14 @@ from unfold.typing import ActionFunction
 
 
 def action(
-    function: Optional[Callable] = None,
+    function: Callable | None = None,
     *,
-    permissions: Optional[Iterable[str]] = None,
-    description: Optional[str] = None,
-    url_path: Optional[str] = None,
-    attrs: Optional[dict[str, Any]] = None,
-    icon: Optional[str] = None,
-    variant: Optional[ActionVariant] = ActionVariant.DEFAULT,
+    permissions: Iterable[str] | None = None,
+    description: str | None = None,
+    url_path: str | None = None,
+    attrs: dict[str, Any] | None = None,
+    icon: str | None = None,
+    variant: ActionVariant | None = ActionVariant.DEFAULT,
 ) -> ActionFunction:
     def decorator(func: Callable) -> ActionFunction:
         def inner(
@@ -27,7 +27,7 @@ def action(
             request: HttpRequest,
             *args: Any,
             **kwargs,
-        ) -> Optional[HttpResponse]:
+        ) -> HttpResponse | None:
             if permissions:
                 permission_rules = []
 
@@ -96,16 +96,16 @@ def action(
 
 
 def display(
-    function: Optional[Callable[[Model], Any]] = None,
+    function: Callable[[Model], Any] | None = 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,
-    dropdown: Optional[bool] = None,
-    label: Optional[Union[bool, str, dict[str, str]]] = None,
-    header: Optional[bool] = None,
+    boolean: bool | None = None,
+    image: bool | None = None,
+    ordering: str | Combinable | BaseExpression | None = None,
+    description: str | None = None,
+    empty_value: str | None = None,
+    dropdown: bool | None = None,
+    label: bool | str | dict[str, str] | None = None,
+    header: bool | None = None,
 ) -> Callable:
     def decorator(func: Callable[[Model], Any]) -> Callable:
         if boolean is not None and empty_value is not None:

unfold/fields.py

@@ -1,5 +1,3 @@
-from typing import Union
-
 from django.contrib.admin import helpers
 from django.contrib.admin.utils import lookup_field, quote
 from django.core.exceptions import ObjectDoesNotExist
@@ -40,7 +38,7 @@ class UnfoldAdminReadonlyField(helpers.AdminReadonlyField):
         return format_html("<label{}>{}</label>", flatatt(attrs), capfirst(label))
 
     @property
-    def url(self) -> Union[str, bool]:
+    def url(self) -> str | bool:
         field, obj, model_admin = (
             self.field["field"],
             self.form.instance,
@@ -112,7 +110,7 @@ class UnfoldAdminReadonlyField(helpers.AdminReadonlyField):
         except (AttributeError, ValueError, ObjectDoesNotExist):
             return False
 
-        return isinstance(f, (ImageField, FileField))
+        return isinstance(f, ImageField | FileField)
 
     def contents(self) -> str:
         contents = self._get_contents()
@@ -167,7 +165,7 @@ class UnfoldAdminReadonlyField(helpers.AdminReadonlyField):
                 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))
+                    isinstance(f.remote_field, ForeignObjectRel | OneToOneField)
                     and value is not None
                 ):
                     result_repr = self.get_admin_url(f.remote_field, value)

unfold/forms.py

@@ -1,5 +1,5 @@
 from collections.abc import Generator
-from typing import Optional, Union
+from typing import Any, Union
 
 from django import forms
 from django.contrib.admin.forms import (
@@ -8,6 +8,7 @@ from django.contrib.admin.forms import (
 from django.contrib.admin.forms import (
     AdminPasswordChangeForm as BaseAdminOwnPasswordChangeForm,
 )
+from django.contrib.admin.views.main import ChangeListSearchForm
 from django.contrib.auth.forms import (
     AdminPasswordChangeForm as BaseAdminPasswordChangeForm,
 )
@@ -85,7 +86,7 @@ class ActionForm(forms.Form):
 class AuthenticationForm(AdminAuthenticationForm):
     def __init__(
         self,
-        request: Optional[HttpRequest] = None,
+        request: HttpRequest | None = None,
         *args,
         **kwargs,
     ) -> None:
@@ -192,14 +193,14 @@ class Fieldline(BaseFieldline):
 
 
 class PaginationFormSetMixin:
-    queryset: Optional[QuerySet] = None
-    request: Optional[HttpRequest] = None
-    per_page: Optional[int] = None
+    queryset: QuerySet | None = None
+    request: HttpRequest | None = None
+    per_page: int | None = None
 
     def __init__(
         self,
-        request: Optional[HttpRequest] = None,
-        per_page: Optional[int] = None,
+        request: HttpRequest | None = None,
+        per_page: int | None = None,
         *args,
         **kwargs,
     ):
@@ -240,3 +241,14 @@ class PaginationInlineFormSet(PaginationFormSetMixin, BaseInlineFormSet):
 
 class PaginationGenericInlineFormSet(PaginationFormSetMixin, BaseGenericInlineFormSet):
     pass
+
+
+class DatasetChangeListSearchForm(ChangeListSearchForm):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+
+        from django.contrib.admin.views.main import SEARCH_VAR
+
+        self.fields = {
+            SEARCH_VAR: forms.CharField(required=False, strip=False),
+        }

unfold/mixins/action_model_admin.py

@@ -1,4 +1,5 @@
-from typing import Any, Callable, Optional, Union
+from collections.abc import Callable
+from typing import Any
 
 from django.db.models import Model
 from django.forms import Form
@@ -22,7 +23,7 @@ class ActionModelAdminMixin:
     actions_submit_line = ()  # Displayed in changeform in the submit line (form buttons)
 
     def changelist_view(
-        self, request: HttpRequest, extra_context: Optional[dict[str, str]] = None
+        self, request: HttpRequest, extra_context: dict[str, str] | None = None
     ) -> TemplateResponse:
         """
         Changelist contains `actions_list` and `actions_row` custom actions. In case of `actions_row` they
@@ -60,9 +61,9 @@ class ActionModelAdminMixin:
     def changeform_view(
         self,
         request: HttpRequest,
-        object_id: Optional[str] = None,
+        object_id: str | None = None,
         form_url: str = "",
-        extra_context: Optional[dict[str, bool]] = None,
+        extra_context: dict[str, Any] | None = None,
     ) -> Any:
         """
         Changeform contains `actions_submit_line` and `actions_detail` custom actions.
@@ -159,7 +160,7 @@ class ActionModelAdminMixin:
             request, self._get_base_actions_submit_line(), object_id
         )
 
-    def _extract_action_names(self, actions: list[Union[str, dict]]) -> list[str]:
+    def _extract_action_names(self, actions: list[str | dict]) -> list[str]:
         """
         Gets the list of only actions names from the actions structure provided in ModelAdmin
         """
@@ -228,10 +229,10 @@ class ActionModelAdminMixin:
 
     def _get_actions_navigation(
         self,
-        provided_actions: list[Union[str, dict]],
+        provided_actions: list[str | dict],
         allowed_actions: list[UnfoldAction],
-        object_id: Optional[str] = None,
-    ) -> list[Union[str, dict]]:
+        object_id: str | None = None,
+    ) -> list[str | dict]:
         """
         Builds navigation structure for the actions which is going to be provided to the template.
         """
@@ -272,7 +273,7 @@ class ActionModelAdminMixin:
                 "path": get_action_path(action),
             }
 
-        def build_dropdown(nav_item: dict) -> Optional[dict]:
+        def build_dropdown(nav_item: dict) -> dict | None:
             """
             Builds a dropdown structure for the action.
             """
@@ -304,7 +305,7 @@ class ActionModelAdminMixin:
         self,
         request: HttpRequest,
         actions: list[UnfoldAction],
-        object_id: Optional[Union[int, str]] = None,
+        object_id: int | str | None = None,
     ) -> list[UnfoldAction]:
         """
         Filters out actions that the user doesn't have access to.

unfold/mixins/base_model_admin.py

@@ -1,5 +1,5 @@
 import copy
-from typing import Any, Optional
+from typing import Any
 
 from django.contrib.admin import helpers
 from django.contrib.admin.sites import AdminSite
@@ -31,9 +31,9 @@ class BaseModelAdminMixin:
     def changeform_view(
         self,
         request: HttpRequest,
-        object_id: Optional[str] = None,
+        object_id: str | None = None,
         form_url: str = "",
-        extra_context: Optional[dict[str, Any]] = None,
+        extra_context: dict[str, Any] | None = None,
     ) -> Any:
         from unfold.forms import AdminForm, Fieldline
 
@@ -61,7 +61,7 @@ class BaseModelAdminMixin:
 
     def formfield_for_foreignkey(
         self, db_field: ForeignKey, request: HttpRequest, **kwargs
-    ) -> Optional[ModelChoiceField]:
+    ) -> ModelChoiceField | None:
         db = kwargs.get("using")
 
         # Overrides widgets for all related fields
@@ -102,7 +102,7 @@ class BaseModelAdminMixin:
 
     def formfield_for_nullboolean_field(
         self, db_field: Field, request: HttpRequest, **kwargs
-    ) -> Optional[Field]:
+    ) -> Field | None:
         if "widget" not in kwargs:
             if db_field.choices:
                 kwargs["widget"] = widgets.UnfoldAdminSelectWidget(
@@ -115,7 +115,7 @@ class BaseModelAdminMixin:
 
     def formfield_for_dbfield(
         self, db_field: Field, request: HttpRequest, **kwargs
-    ) -> Optional[Field]:
+    ) -> Field | None:
         if isinstance(db_field, models.BooleanField) and db_field.null is True:
             return self.formfield_for_nullboolean_field(db_field, request, **kwargs)
 

unfold/sites.py

@@ -1,7 +1,8 @@
 import copy
 import time
+from collections.abc import Callable
 from http import HTTPStatus
-from typing import Any, Callable, Optional, Union
+from typing import Any
 from urllib.parse import parse_qs, urlparse
 
 from django.contrib.admin import AdminSite
@@ -141,7 +142,7 @@ class UnfoldAdminSite(AdminSite):
         return context
 
     def index(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> TemplateResponse:
         app_list = self.get_app_list(request)
 
@@ -166,7 +167,7 @@ class UnfoldAdminSite(AdminSite):
         )
 
     def toggle_sidebar(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> HttpResponse:
         if "toggle_sidebar" not in request.session:
             request.session["toggle_sidebar"] = True
@@ -214,14 +215,14 @@ class UnfoldAdminSite(AdminSite):
         request: HttpRequest,
         app_list: list[dict[str, Any]],
         search_term: str,
-        allowed_models: Optional[list[str]] = None,
+        allowed_models: list[str] | None = None,
     ) -> list[SearchResult]:
         results = []
 
         for app in app_list:
             for model in app["models"]:
                 # Skip models which are not allowed
-                if isinstance(allowed_models, (list, tuple)):
+                if isinstance(allowed_models, list | tuple):
                     if model["model"]._meta.label.lower() not in [
                         m.lower() for m in allowed_models
                     ]:
@@ -263,7 +264,7 @@ class UnfoldAdminSite(AdminSite):
         return results
 
     def search(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> TemplateResponse:
         start_time = time.time()
 
@@ -302,10 +303,10 @@ class UnfoldAdminSite(AdminSite):
                     self._get_config("COMMAND", request).get("search_models"), request
                 )
 
-                if search_models is True or isinstance(search_models, (list, tuple)):
+                if search_models is True or isinstance(search_models, list | tuple):
                     allowed_models = (
                         search_models
-                        if isinstance(search_models, (list, tuple))
+                        if isinstance(search_models, list | tuple)
                         else None
                     )
 
@@ -340,7 +341,7 @@ class UnfoldAdminSite(AdminSite):
         )
 
     def password_change(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> HttpResponse:
         from django.contrib.auth.views import PasswordChangeView
 
@@ -462,7 +463,7 @@ class UnfoldAdminSite(AdminSite):
         return tabs
 
     def _call_permission_callback(
-        self, callback: Union[str, Callable, None], request: HttpRequest
+        self, callback: str | Callable | None, request: HttpRequest
     ) -> bool:
         if callback is None:
             return True
@@ -490,7 +491,7 @@ class UnfoldAdminSite(AdminSite):
         return target
 
     def _get_is_active(
-        self, request: HttpRequest, link: Union[str, Callable], is_tab: bool = False
+        self, request: HttpRequest, link: str | Callable, is_tab: bool = False
     ) -> bool:
         if not isinstance(link, str):
             link = str(link)
@@ -545,9 +546,7 @@ class UnfoldAdminSite(AdminSite):
         if key in config and config[key]:
             return self._get_value(config[key], *args)
 
-    def _get_theme_images(
-        self, key: str, *args: Any
-    ) -> Union[dict[str, str], str, None]:
+    def _get_theme_images(self, key: str, *args: Any) -> dict[str, str] | str | None:
         images = self._get_config(key, *args)
 
         if isinstance(images, dict):
@@ -613,9 +612,7 @@ class UnfoldAdminSite(AdminSite):
             for item in items
         ]
 
-    def _get_value(
-        self, value: Union[str, Callable, lazy, None], *args: Any
-    ) -> Optional[str]:
+    def _get_value(self, value: str | Callable | None, *args: Any) -> str | None:
         if value is None:
             return None