fastadmin 0.4.4__tar.gz → 0.4.6__tar.gz

{fastadmin-0.4.4 → fastadmin-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastadmin
-Version: 0.4.4
+Version: 0.4.6
 Summary: FastAdmin is an easy-to-use Admin Dashboard App for FastAPI/Flask/Django inspired by Django Admin.
 License: MIT
 License-File: LICENSE

{fastadmin-0.4.4 → fastadmin-0.4.6}/fastadmin/__init__.py

@@ -43,10 +43,12 @@ from fastadmin.models.schemas import (  # noqa: F401
     ActionInputSchema,
     ActionResponseSchema,
     ActionResponseType,
+    ModelWidgetAction,
     WidgetActionArgumentProps,
     WidgetActionChartProps,
     WidgetActionFilter,
     WidgetActionInputSchema,
+    WidgetActionParentArgumentProps,
     WidgetActionProps,
     WidgetActionQuerySchema,
     WidgetActionResponseSchema,

{fastadmin-0.4.4 → fastadmin-0.4.6}/fastadmin/models/base.py

@@ -243,6 +243,12 @@ class BaseModelAdmin:
         """
         raise NotImplementedError
 
+    async def pre_generate_models_schema(self) -> None:
+        """This method is used to pre-generate models schema.
+
+        :return: None.
+        """
+
     async def orm_get_list(
         self,
         offset: int | None = None,
@@ -660,6 +666,10 @@ class InlineModelAdmin(BaseModelAdmin):
 class ModelAdmin(BaseModelAdmin):
     """This class is used to create admin model class."""
 
+    # Optional section name for grouping models in the left menu.
+    # Example of usage: menu_section = "Users"
+    menu_section: str | None = None
+
     # Normally, objects have three save options: “Save”, “Save and continue editing”, and “Save and add another”.
     # If save_as is True, “Save and add another” will be replaced
     # by a “Save as new” button that creates a new object (with a new ID) rather than updating the existing object.

{fastadmin-0.4.4 → fastadmin-0.4.6}/fastadmin/models/decorators.py

@@ -1,4 +1,6 @@
 import typing as tp
+from functools import wraps
+from inspect import iscoroutinefunction
 
 from fastadmin.models.schemas import (
     WidgetActionChartProps,
@@ -8,6 +10,22 @@ from fastadmin.models.schemas import (
 )
 
 
+def _wrap_callable(func):
+    if iscoroutinefunction(func):
+
+        @wraps(func)
+        async def wrapped(*args, **kwargs):
+            return await func(*args, **kwargs)
+
+    else:
+
+        @wraps(func)
+        def wrapped(*args, **kwargs):
+            return func(*args, **kwargs)
+
+    return wrapped
+
+
 def action(
     function=None,
     *,
@@ -27,10 +45,12 @@ def action(
     """
 
     def decorator(func):
-        func.is_action = True
+        wrapped = _wrap_callable(func)
+
+        wrapped.is_action = True
         if description is not None:
-            func.short_description = description
-        return func
+            wrapped.short_description = description
+        return wrapped
 
     if function is None:
         return decorator
@@ -49,6 +69,7 @@ def widget_action(
     width: (
         tp.Literal[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24] | None
     ) = None,  # width in 1-24 grid system
+    max_height: int | None = None,
 ):
     """Conveniently add attributes to a widget action function:
 
@@ -103,16 +124,19 @@ def widget_action(
     """
 
     def decorator(func):
-        func.is_widget_action = True
-        func.widget_action_type = widget_action_type
-        func.widget_action_props = widget_action_props
-        func.widget_action_filters = widget_action_filters
-        func.tab = tab
-        func.title = title
-        func.width = width
+        wrapped = _wrap_callable(func)
+
+        wrapped.is_widget_action = True
+        wrapped.widget_action_type = widget_action_type
+        wrapped.widget_action_props = widget_action_props
+        wrapped.widget_action_filters = widget_action_filters
+        wrapped.tab = tab
+        wrapped.title = title
+        wrapped.width = width
+        wrapped.max_height = max_height
         if description is not None:
-            func.short_description = description
-        return func
+            wrapped.short_description = description
+        return wrapped
 
     if function is None:
         return decorator
@@ -137,9 +161,11 @@ def display(function=None, *, sorter: bool | str = False):
     """
 
     def decorator(func):
-        func.is_display = True
-        func.sorter = sorter
-        return func
+        wrapped = _wrap_callable(func)
+
+        wrapped.is_display = True
+        wrapped.sorter = sorter
+        return wrapped
 
     if function is None:
         return decorator

{fastadmin-0.4.4 → fastadmin-0.4.6}/fastadmin/models/helpers.py

@@ -115,6 +115,9 @@ async def generate_models_schema(
     for orm_model_cls, admin_model_obj in admin_models.items():
         if hasattr(admin_model_obj, "set_context"):
             admin_model_obj.set_context(request=request, user=user)
+        pre_generate_models_schema = getattr(admin_model_obj, "pre_generate_models_schema", None)
+        if callable(pre_generate_models_schema):
+            await pre_generate_models_schema()
         orm_model_fields = admin_model_obj.get_model_fields_with_widget_types()
         orm_model_fields_for_serialize = admin_model_obj.get_fields_for_serialize()
 
@@ -242,6 +245,7 @@ async def generate_models_schema(
                     title=widget_action_function.title,
                     tab=widget_action_function.tab,
                     width=widget_action_function.width,
+                    max_height=getattr(widget_action_function, "max_height", None),
                     description=getattr(widget_action_function, "short_description", None),
                     widget_action_type=widget_action_function.widget_action_type,
                     widget_action_props=widget_action_function.widget_action_props,
@@ -272,6 +276,7 @@ async def generate_models_schema(
                     show_full_result_count=admin_model_obj.show_full_result_count,
                     verbose_name=admin_model_obj.verbose_name,
                     verbose_name_plural=admin_model_obj.verbose_name_plural,
+                    menu_section=getattr(admin_model_obj, "menu_section", None),
                     # specific model fields
                     fieldsets=admin_model_obj.fieldsets,
                     save_on_top=admin_model_obj.save_on_top,

{fastadmin-0.4.4 → fastadmin-0.4.6}/fastadmin/models/schemas.py

@@ -70,6 +70,14 @@ class WidgetActionChartProps:
     series_color: list[str] | dict[str, str] | None = None
 
 
+@dataclass
+class WidgetActionParentArgumentProps:
+    """Widget action parent argument props"""
+
+    name: str
+    value: tp.Any
+
+
 @dataclass
 class WidgetActionArgumentProps:
     """Widget action chart props"""
@@ -78,6 +86,10 @@ class WidgetActionArgumentProps:
     widget_type: WidgetType
     widget_props: dict | None = None
 
+    # if None, show always
+    # if not None, show only if parent selected/input value is equal to the parent_argument.value
+    parent_argument: WidgetActionParentArgumentProps | None = None
+
 
 @dataclass
 class WidgetActionProps:
@@ -112,6 +124,7 @@ class ModelWidgetAction:
     description: str | None
     tab: str
     width: int | None
+    max_height: int | None
     widget_action_type: WidgetActionType
     widget_action_props: WidgetActionChartProps | WidgetActionProps | None = None
     widget_action_filters: list[WidgetActionFilter] | None = None
@@ -199,6 +212,7 @@ class InlineModelSchema(BaseModelSchema):
 class ModelSchema(BaseModelSchema):
     """Model schema"""
 
+    menu_section: str | None
     fieldsets: Sequence[tuple[str | None, dict[str, Sequence[str]]]] | None
     save_on_top: bool | None
     save_as: bool | None