fastadmin 0.7.0__tar.gz → 0.8.0__tar.gz

{fastadmin-0.7.0 → fastadmin-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastadmin
-Version: 0.7.0
+Version: 0.8.0
 Summary: FastAdmin is an easy-to-use Admin Dashboard App for FastAPI/Flask/Django inspired by Django Admin.
 Keywords: admin,dashboard,fastapi,flask,django,tortoise-orm,sqlalchemy,pony,yara-orm,admin-dashboard,django-admin
 Author: Seva D

{fastadmin-0.7.0 → fastadmin-0.8.0}/fastadmin/__init__.py

@@ -38,6 +38,7 @@ except ModuleNotFoundError:  # pragma: no cover
     logging.info("Yara ORM is not installed")  # pragma: no cover
 
 # api
+from fastadmin.api.encoders import register_encoder, unregister_encoder  # noqa: F401
 from fastadmin.api.exceptions import AdminApiException  # noqa: F401
 
 # models

fastadmin-0.8.0/fastadmin/api/encoders.py

@@ -0,0 +1,70 @@
+"""User-registerable custom encoders for admin API serialization.
+
+Model field values are converted to JSON-serializable representations during
+serialization (see :meth:`fastadmin.models.base.BaseModelAdmin.serialize_obj_attributes`).
+Register a custom encoder to control how instances of a given type are represented
+in every admin API response — e.g. a custom datetime format, an ``Enum``'s label,
+or a domain value object.
+
+Example:
+
+.. code-block:: python
+
+    import datetime
+
+    from fastadmin import register_encoder
+
+    # Render every datetime as "2024-01-31 14:05" instead of ISO 8601.
+    register_encoder(datetime.datetime, lambda dt: dt.strftime("%Y-%m-%d %H:%M"))
+
+Encoders are matched via ``isinstance`` in registration order, so register more
+specific types before their base types.
+"""
+
+from collections.abc import Callable
+from typing import Any
+
+# Maps a type to a function converting an instance of that type to a JSON-serializable value.
+CUSTOM_ENCODERS: dict[type, Callable[[Any], Any]] = {}
+
+
+def register_encoder(type_: type, encoder: Callable[[Any], Any]) -> None:
+    """Register a custom encoder for a type used across all admin API responses.
+
+    :params type_: the type to encode (matched via ``isinstance``).
+    :params encoder: a callable converting an instance to a JSON-serializable value.
+    :return: None.
+    """
+    CUSTOM_ENCODERS[type_] = encoder
+
+
+def unregister_encoder(type_: type) -> None:
+    """Remove a previously registered encoder for a type (no-op if absent).
+
+    :params type_: the type whose encoder should be removed.
+    :return: None.
+    """
+    CUSTOM_ENCODERS.pop(type_, None)
+
+
+def clear_encoders() -> None:
+    """Remove all registered custom encoders.
+
+    :return: None.
+    """
+    CUSTOM_ENCODERS.clear()
+
+
+def apply_custom_encoders(value: Any) -> Any:
+    """Return ``value`` encoded by the first matching custom encoder, else unchanged.
+
+    Types are matched via ``isinstance`` in registration order, so a more specific
+    type registered before its base type wins.
+
+    :params value: the value to encode.
+    :return: the encoded value, or the original value if no encoder matches.
+    """
+    for type_, encoder in CUSTOM_ENCODERS.items():
+        if isinstance(value, type_):
+            return encoder(value)
+    return value

{fastadmin-0.7.0 → fastadmin-0.8.0}/fastadmin/models/base.py

@@ -11,6 +11,7 @@ from uuid import UUID
 
 from asgiref.sync import sync_to_async
 
+from fastadmin.api.encoders import apply_custom_encoders
 from fastadmin.api.schemas import ExportFormat
 from fastadmin.models.schemas import ModelFieldWidgetSchema, WidgetType
 
@@ -419,7 +420,12 @@ class BaseModelAdmin:
         serialized_dict: dict[str, Any] = {}
         for field in attributes_to_serizalize:
             value = getattr(obj, field.column_name)
-            if isinstance(value, Decimal):
+            # Let user-registered encoders (e.g. a custom datetime format) take
+            # precedence over the built-in handling below.
+            encoded = apply_custom_encoders(value)
+            if encoded is not value:
+                value = encoded
+            elif isinstance(value, Decimal):
                 # Avoid scientific notation for Decimal values in API responses,
                 # e.g. 3.75E+3 -> "3750"
                 value = format(value, "f")

{fastadmin-0.7.0 → fastadmin-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "fastadmin"
-version = "0.7.0"
+version = "0.8.0"
 description = "FastAdmin is an easy-to-use Admin Dashboard App for FastAPI/Flask/Django inspired by Django Admin."
 readme = "README.md"
 requires-python = ">=3.12"