Add response types for actions. Fix Decimal fields handling.

Author: vsdudakov

docs/build.py

@@ -42,6 +42,13 @@ def read_cls_docstring(cls):
 
 def get_versions():
     return [
+        {
+            "version": "0.3.9",
+            "changes": [
+                "Add response types for actions.",
+                "Fix Decimal fields handling.",
+            ],
+        },
         {
             "version": "0.3.8",
             "changes": [

docs/index.html

@@ -196,6 +196,10 @@ <h4 class="title">FastAdmin</h4>
 
               <ul class="nav flex-column">
 
+                <li class="nav-item">
+                  <a class="nav-link" href="#v0_3_9">v0.3.9</a>
+                </li>
+                
                 <li class="nav-item">
                   <a class="nav-link" href="#v0_3_8">v0.3.8</a>
                 </li>
@@ -339,7 +343,7 @@ <h1>FastAdmin | Documentation</h1>
               <div class="row">
                 <div class="col-sm-6 col-lg-4">
                   <ul class="list-unstyled">
-                    <li><strong>Version:</strong> 0.3.8</li>
+                    <li><strong>Version:</strong> 0.3.9</li>
                     <li>
                       <strong>Author:</strong>
                       <a href="mailto:[email protected]" target="_blank">
@@ -2110,7 +2114,7 @@ <h3>Methods and Attributes</h3>
     # @action(
     #     description="Mark selected stories as published",
     # )
-    # async def make_published(self, objs: list[Any]) -> None:
+    # async def make_published(self, objs: list[Any]) -> ActionResponseSchema | None:
     #     ...
     actions: Sequence[str] = ()
 
@@ -2463,7 +2467,14 @@ <h3>Methods and Attributes</h3>
         :params attributes_to_serizalize: a list of attributes to serialize.
         :return: A dict of serialized attributes.
         """
-        serialized_dict = {field.name: getattr(obj, field.column_name) for field in attributes_to_serizalize}
+        serialized_dict: dict[str, Any] = {}
+        for field in attributes_to_serizalize:
+            value = getattr(obj, field.column_name)
+            if isinstance(value, Decimal):
+                # Avoid scientific notation for Decimal values in API responses,
+                # e.g. 3.75E+3 -> "3750"
+                value = format(value, "f")
+            serialized_dict[field.name] = value
         if inspect.iscoroutinefunction(obj.__str__):
             str_fn = obj.__str__
         else:
@@ -3365,6 +3376,49 @@ <h2>Changelog</h2>
 
 
 
+                <section id="v0_3_9">
+                <h3>v0.3.9</h3>
+
+                
+                  
+<p class="text-4">
+  Add response types for actions.
+</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+                
+                  
+<p class="text-4">
+  Fix Decimal fields handling.
+</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+                
+                </section>
+
+              
                 <section id="v0_3_8">
                 <h3>v0.3.8</h3>
 

fastadmin/__init__.py

@@ -32,6 +32,10 @@
 except ModuleNotFoundError:  # pragma: no cover
     logging.info("TortoiseORM is not installed")  # pragma: no cover
 
+# api
+from fastadmin.api.exceptions import AdminApiException  # noqa: F401
+from fastadmin.api.schemas import ActionResponseSchema, ActionResponseType  # noqa: F401
+
 # models
 from fastadmin.models.base import DashboardWidgetAdmin, InlineModelAdmin, ModelAdmin  # noqa: F401
 from fastadmin.models.decorators import action, display, register, register_widget  # noqa: F401

fastadmin/api/frameworks/django/app/api.py

@@ -13,7 +13,13 @@
 
 from fastadmin.api.exceptions import AdminApiException
 from fastadmin.api.helpers import is_valid_id, parse_list_filters_from_query_params
-from fastadmin.api.schemas import ActionInputSchema, ExportInputSchema, SignInInputSchema
+from fastadmin.api.schemas import (
+    ActionInputSchema,
+    ActionResponseSchema,
+    ActionResponseType,
+    ExportInputSchema,
+    SignInInputSchema,
+)
 from fastadmin.api.service import ApiService, get_user_id_from_session_id
 from fastadmin.settings import settings
 
@@ -379,21 +385,25 @@ async def action(
     :params model: a name of model.
     :params action: a name of action.
     :params payload: a payload object.
-    :return: A list of objects.
+    :return: action result.
     """
     if request.method != "POST":
         return JsonResponse({"error": "Method not allowed"}, status=405)
     try:
         payload = ActionInputSchema(**json.loads(request.body))
-        await api_service.action(
+        response = await api_service.action(
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             action,
             payload,
             request=request,
         )
-        return JsonResponse({})
-
+        if not response:
+            response = ActionResponseSchema(
+                type=ActionResponseType.MESSAGE,
+                data="Successfully applied",
+            )
+        return JsonResponse(asdict(response))
     except AdminApiException as e:
         return JsonResponse({"detail": e.detail}, status=e.status_code)
 

fastadmin/api/frameworks/fastapi/api.py

@@ -1,4 +1,5 @@
 import logging
+from dataclasses import asdict
 from typing import Any
 from uuid import UUID
 
@@ -7,7 +8,13 @@
 
 from fastadmin.api.exceptions import AdminApiException
 from fastadmin.api.helpers import parse_list_filters_from_query_params
-from fastadmin.api.schemas import ActionInputSchema, ExportInputSchema, SignInInputSchema
+from fastadmin.api.schemas import (
+    ActionInputSchema,
+    ActionResponseSchema,
+    ActionResponseType,
+    ExportInputSchema,
+    SignInInputSchema,
+)
 from fastadmin.api.service import ApiService, get_user_id_from_session_id
 from fastadmin.models.schemas import ConfigurationSchema
 from fastadmin.settings import settings
@@ -328,22 +335,28 @@ async def action(
     model: str,
     action: str,
     payload: ActionInputSchema,
-) -> None:
+) -> dict:
     """This method is used to perform an action.
 
     :params model: a name of model.
     :params action: a name of action.
     :params payload: a payload object.
-    :return: A list of objects.
+    :return: action result.
     """
     try:
-        return await api_service.action(
+        response = await api_service.action(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             action,
             payload,
             request=request,
         )
+        if not response:
+            response = ActionResponseSchema(
+                type=ActionResponseType.MESSAGE,
+                data="Successfully applied",
+            )
+        return asdict(response)
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
 

fastadmin/api/frameworks/flask/api.py

@@ -7,7 +7,13 @@
 
 from fastadmin.api.exceptions import AdminApiException
 from fastadmin.api.helpers import is_valid_id, parse_list_filters_from_query_params
-from fastadmin.api.schemas import ActionInputSchema, ExportInputSchema, SignInInputSchema
+from fastadmin.api.schemas import (
+    ActionInputSchema,
+    ActionResponseSchema,
+    ActionResponseType,
+    ExportInputSchema,
+    SignInInputSchema,
+)
 from fastadmin.api.service import ApiService, get_user_id_from_session_id
 from fastadmin.settings import settings
 
@@ -336,25 +342,30 @@ async def delete(
 async def action(
     model: str,
     action: str,
-) -> dict:
+) -> Response:
     """This method is used to perform an action.
 
     :params model: a name of model.
     :params action: a name of action.
     :params payload: a payload object.
-    :return: A list of objects.
+    :return: action result.
     """
     try:
         request_payload: dict = request.json
         payload: ActionInputSchema = ActionInputSchema(**request_payload)
-        await api_service.action(
+        response = await api_service.action(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             action,
             payload,
             request=request,
         )
-        return {}
+        if not response:
+            response = ActionResponseSchema(
+                type=ActionResponseType.MESSAGE,
+                data="Successfully applied",
+            )
+        return make_response(asdict(response))
     except AdminApiException as e:
         http_exception = HTTPException(e.detail)
         http_exception.code = e.status_code

fastadmin/api/schemas.py

@@ -10,6 +10,13 @@ class ExportFormat(str, Enum):
     JSON = "JSON"
 
 
+class ActionResponseType(str, Enum):
+    """Action response type"""
+
+    DOWNLOAD_BASE64 = "DOWNLOAD_BASE64"
+    MESSAGE = "MESSAGE"
+
+
 @dataclass
 class DashboardWidgetQuerySchema:
     """DashboardWidge query schema"""
@@ -70,3 +77,12 @@ class ActionInputSchema:
     """Action input schema"""
 
     ids: list[int | UUID]
+
+
+@dataclass
+class ActionResponseSchema:
+    """Action response schema"""
+
+    type: ActionResponseType
+    data: str
+    file_name: str | None = None

fastadmin/api/service.py

@@ -14,6 +14,7 @@
 from fastadmin.api.helpers import sanitize_filter_key, sanitize_filter_value
 from fastadmin.api.schemas import (
     ActionInputSchema,
+    ActionResponseSchema,
     ChangePasswordInputSchema,
     DashboardWidgetDataOutputSchema,
     DashboardWidgetQuerySchema,
@@ -478,7 +479,7 @@ async def action(
         action: str,
         payload: ActionInputSchema,
         request: Any | None = None,
-    ) -> None:
+    ) -> ActionResponseSchema | None:
         _current_user_id, current_user = await self._get_authenticated_user(session_id)
 
         admin_model = get_admin_or_admin_inline_model(model)
@@ -498,7 +499,7 @@ async def action(
         else:
             action_function_fn = sync_to_async(action_function)
 
-        await action_function_fn(payload.ids)
+        return await action_function_fn(payload.ids)
 
     async def get_configuration(
         self,

fastadmin/models/base.py

@@ -4,6 +4,7 @@
 import json
 from collections.abc import Sequence
 from contextvars import ContextVar
+from decimal import Decimal
 from io import BytesIO, StringIO
 from typing import Any
 from uuid import UUID
@@ -31,7 +32,7 @@ class BaseModelAdmin:
     # @action(
     #     description="Mark selected stories as published",
     # )
-    # async def make_published(self, objs: list[Any]) -> None:
+    # async def make_published(self, objs: list[Any]) -> ActionResponseSchema | None:
     #     ...
     actions: Sequence[str] = ()
 
@@ -384,7 +385,14 @@ async def serialize_obj_attributes(
         :params attributes_to_serizalize: a list of attributes to serialize.
         :return: A dict of serialized attributes.
         """
-        serialized_dict = {field.name: getattr(obj, field.column_name) for field in attributes_to_serizalize}
+        serialized_dict: dict[str, Any] = {}
+        for field in attributes_to_serizalize:
+            value = getattr(obj, field.column_name)
+            if isinstance(value, Decimal):
+                # Avoid scientific notation for Decimal values in API responses,
+                # e.g. 3.75E+3 -> "3750"
+                value = format(value, "f")
+            serialized_dict[field.name] = value
         if inspect.iscoroutinefunction(obj.__str__):
             str_fn = obj.__str__
         else:

fastadmin/models/decorators.py

@@ -5,7 +5,7 @@ def action(function=None, *, description: str | None = None):
     @action(
         description="Mark selected stories as published",
     )
-    async def make_published(self, objs: list[Any]) -> None:
+    async def make_published(self, objs: list[Any]) -> ActionResponseSchema | None:
         ...
 
     :param function: A function to decorate.