0.1.30: inlines, wysiwig editor and form_fields_widgets parameter.

Author: vsdudakov

docs/index.html

@@ -181,6 +181,9 @@ <h4 class="title">FastAdmin</h4>
             <li class="nav-item">
               <a class="nav-link" href="#changelog">Changelog</a>
               <ul class="nav flex-column">
+                <li class="nav-item">
+                  <a class="nav-link" href="#v0_1_30">v0.1.30</a>
+                </li>
                 <li class="nav-item">
                   <a class="nav-link" href="#v0_1_29">v0.1.29</a>
                 </li>
@@ -227,7 +230,7 @@ <h1>Documentation</h1>
               <div class="row">
                 <div class="col-sm-6 col-lg-4">
                   <ul class="list-unstyled">
-                    <li><strong>Version:</strong> 0.1.29</li>
+                    <li><strong>Version:</strong> 0.1.30</li>
                     <li>
                       <strong>Author:</strong>
                       <a href="mailto:vsdudakov@gmail.com" target="_blank"
@@ -800,6 +803,14 @@ <h3>ModelAdmin options</h3>
               <p class="lead">Base options:</p>
               <pre>
                 <code class="language-python">
+  # Widgets for fields. Overload widgets in your ModelAdmin class using this parameter.
+  # It contains widget type and default widget props for type.
+  # Example of usage:
+  # form_fields_widgets = {
+  #     "description": (WidgetType.RichTextArea, {})
+  # }
+  form_fields_widgets: dict[str, tuple[WidgetType, dict]] = {}
+
   # A list of actions to make available on the change list page.
   # You have to implement methods with names like action_name in your ModelAdmin class and decorate them with @action decorator.
   # Example of usage:
@@ -1367,6 +1378,38 @@ <h2>Changelog</h2>
               </p>
               <hr class="small-divider" />
               <!-- <p class="alert alert-info mb-5"> For Future Updates Follow Us <a target="_blank" href="http://themeforest.net/user/harnishdesign?ref=HarnishDesign">@themeforest</a> / <a target="_blank" href="http://facebook.com/harnishdesign">@facebook</a> / <a target="_blank" href="http://twitter.com/harnishdesign">@twitter</a> / <a target="_blank" href="https://dribbble.com/harnishdesign">@Dribbble</a></p> -->
+              <h3 id="v0_1_30">
+                Version 0.1.30
+                <small class="text-muted">(26 March, 2024)</small>
+              </h3>
+              <ul class="changelog">
+                <li>Fixed frontend part of inlines.</li>
+                <li>Added wysiwig editor and RichTextArea widget type.</li>
+                <li>
+                  Added form_fields_widgets parameter to configure widgets fr
+                  fields easily.
+                </li>
+                <li>Bug fixes.</li>
+              </ul>
+              <hr class="small-divider" />
+
+              <h3 id="v0_1_29">
+                Version 0.1.29
+                <small class="text-muted">(26 March, 2024)</small>
+              </h3>
+              <ul class="changelog">
+                <li>Bug fixes.</li>
+              </ul>
+              <hr class="small-divider" />
+
+              <h3 id="v0_1_28">
+                Version 0.1.28
+                <small class="text-muted">(26 March, 2024)</small>
+              </h3>
+              <ul class="changelog">
+                <li>Bug fixes.</li>
+              </ul>
+              <hr class="small-divider" />
 
               <h3 id="v0_1_27">
                 Version 0.1.27
@@ -1383,7 +1426,9 @@ <h3 id="v0_1_26">
               </h3>
               <ul class="changelog">
                 <li>Fixed bugs.</li>
-                <li>Added RichTextArea WidgetType based on quill wysiwig editor.</li>
+                <li>
+                  Added RichTextArea WidgetType based on quill wysiwig editor.
+                </li>
               </ul>
               <hr class="small-divider" />
 

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

@@ -254,15 +254,15 @@ async def export(request: HttpRequest, model: str) -> JsonResponse:
     sort_by = filters.get("sort_by", None)
     try:
         payload = ExportInputSchema(**json.loads(request.body))
-        file_name, stream = await api_service.export(
+        file_name, content_type, stream = await api_service.export(
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             payload,
             search=search,
             sort_by=sort_by,
             filters=filters,
         )
-        response = StreamingHttpResponse(stream, content_type="text/csv")
+        response = StreamingHttpResponse(stream, content_type=content_type)
         response.headers["Content-Disposition"] = f'attachment; filename="{file_name}"'
         return response
 

fastadmin/api/frameworks/fastapi/api.py

@@ -203,7 +203,7 @@ async def export(
     :return: A stream of export data.
     """
     try:
-        file_name, stream = await api_service.export(
+        file_name, content_type, stream = await api_service.export(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             payload,
@@ -215,7 +215,7 @@ async def export(
         return StreamingResponse(
             stream,  # type: ignore
             headers=headers,
-            media_type="text/csv",
+            media_type=content_type,
         )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail)

fastadmin/api/frameworks/flask/api.py

@@ -207,15 +207,15 @@ async def export(model: str) -> Response:
     try:
         request_payload: dict = request.json
         payload: ExportInputSchema = ExportInputSchema(**request_payload)
-        file_name, stream = await api_service.export(
+        file_name, content_type, stream = await api_service.export(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             payload,
             search=search,
             sort_by=sort_by,
             filters=filters,
         )
-        response = Response(stream, mimetype="text/csv")
+        response = Response(stream, mimetype=content_type)
         response.headers["Content-Disposition"] = f'attachment; filename="{file_name}"'
         return response
     except AdminApiException as e:

fastadmin/api/schemas.py

@@ -8,6 +8,7 @@ class ExportFormat(str, Enum):
     """Export format"""
 
     CSV = "CSV"
+    JSON = "JSON"
 
 
 class ListQuerySchema(BaseModel):
@@ -30,9 +31,9 @@ class SignInInputSchema(BaseModel):
 class ExportInputSchema(BaseModel):
     """Export input schema"""
 
-    format: ExportFormat | None
-    limit: int | None
-    offset: int | None
+    format: ExportFormat | None = ExportFormat.CSV
+    limit: int | None = 1000
+    offset: int | None = 0
 
 
 class ActionInputSchema(BaseModel):

fastadmin/api/service.py

@@ -10,7 +10,7 @@
 
 from fastadmin.api.exceptions import AdminApiException
 from fastadmin.api.helpers import get_user_id_from_session_id, sanitize
-from fastadmin.api.schemas import ActionInputSchema, ExportInputSchema, SignInInputSchema
+from fastadmin.api.schemas import ActionInputSchema, ExportFormat, ExportInputSchema, SignInInputSchema
 from fastadmin.models.base import InlineModelAdmin, ModelAdmin
 from fastadmin.models.helpers import (
     generate_models_schema,
@@ -181,7 +181,7 @@ async def export(
         search: str | None = None,
         sort_by: str | None = None,
         filters: dict = {},
-    ) -> tuple[str, StringIO | BytesIO | None]:
+    ) -> tuple[str, str, StringIO | BytesIO | None]:
         current_user_id = await get_user_id_from_session_id(session_id)
         if not current_user_id:
             raise AdminApiException(401, detail="User is not authenticated.")
@@ -191,14 +191,26 @@ async def export(
             raise AdminApiException(404, detail=f"{model} model is not registered.")
 
         filters = {k: sanitize(v) for k, v in filters.items() if k not in ("search", "sort_by", "offset", "limit")}
-        file_name = f"{model}.{(payload.format or 'csv').lower()}"
-        return file_name, await admin_model.get_export(
-            payload.format,
-            search=search,
-            sort_by=sort_by,
-            filters=filters,
-            offset=payload.offset,
-            limit=payload.limit,
+
+        content_type = "text/plain"
+        file_name = f"{model}.txt"
+        if payload.format == ExportFormat.CSV:
+            content_type = "text/csv"
+            file_name = f"{model}.csv"
+        elif payload.format == ExportFormat.JSON:
+            content_type = "text/plain"
+            file_name = f"{model}.json"
+        return (
+            file_name,
+            content_type,
+            await admin_model.get_export(
+                payload.format,
+                search=search,
+                sort_by=sort_by,
+                filters=filters,
+                offset=payload.offset,
+                limit=payload.limit,
+            ),
         )
 
     async def delete(

fastadmin/models/base.py

@@ -1,5 +1,6 @@
 import csv
 import inspect
+import json
 from collections.abc import Sequence
 from io import BytesIO, StringIO
 from typing import Any
@@ -434,17 +435,27 @@ async def get_export(
         fields = self.get_model_fields_with_widget_types(with_m2m=False)
 
         export_fields = [f.name for f in fields]
+        output = StringIO()
         if not export_format or export_format == ExportFormat.CSV:
-            output = StringIO()
             writer = csv.DictWriter(output, fieldnames=export_fields)
             writer.writeheader()
             for obj in objs:
                 obj_dict = await self.serialize_obj(obj, list_view=True)
                 obj_dict = {k: v for k, v in obj_dict.items() if k in export_fields}
                 writer.writerow(obj_dict)
-            output.seek(0)
-            return output
-        return None
+        if not export_format or export_format == ExportFormat.JSON:
+
+            class JSONEncoder(json.JSONEncoder):
+                def default(self, obj):
+                    try:
+                        return super().default(obj)
+                    except TypeError:
+                        return str(obj)
+
+            json.dump([await self.serialize_obj(obj, list_view=True) for obj in objs], output, cls=JSONEncoder)
+
+        output.seek(0)
+        return output
 
     def has_add_permission(self, user_id: UUID | int | None = None) -> bool:
         """This method is used to check if user has permission to add new model instance.

fastadmin/models/helpers.py

@@ -243,6 +243,8 @@ def generate_models_schema(
             )
         else:
             admin_model_obj = cast(InlineModelAdmin, admin_model_obj)
+            # TODO: replace parent on dynamic identification of fk name in inline model
+            fk_name = admin_model_obj.fk_name or "parent"
             models_schemas.append(
                 InlineModelSchema(
                     name=model_name,
@@ -259,7 +261,7 @@ def generate_models_schema(
                     list_max_show_all=admin_model_obj.list_max_show_all,
                     show_full_result_count=admin_model_obj.show_full_result_count,
                     # specific inline model fields
-                    fk_name=admin_model_obj.fk_name,
+                    fk_name=fk_name,
                     max_num=admin_model_obj.max_num,
                     min_num=admin_model_obj.min_num,
                     verbose_name=admin_model_obj.verbose_name,

fastadmin/models/orms/django.py

@@ -54,11 +54,11 @@ def get_model_fields_with_widget_types(
                 is_pk or getattr(orm_model_field, "auto_now", False) or getattr(orm_model_field, "auto_now_add", False)
             ) and field_name not in self.readonly_fields
 
-            required = (
-                not getattr(orm_model_field, "null", False)
-                and not getattr(orm_model_field, "default", False)
-                and not is_m2m
-            )
+            has_default = getattr(orm_model_field, "default", False)
+            if hasattr(has_default, "__name__") and has_default.__name__ == "NOT_PROVIDED":
+                has_default = False
+
+            required = not getattr(orm_model_field, "null", False) and not has_default and not is_m2m
             choices = (
                 {item[0]: item[1] for item in orm_model_field.choices}
                 if getattr(orm_model_field, "choices", None)
@@ -97,6 +97,7 @@ def get_model_fields_with_widget_types(
                     filter_widget_type = WidgetType.TextArea
                 case "BooleanField":
                     form_widget_type = WidgetType.Switch
+                    form_widget_props["required"] = False
                     filter_widget_type = WidgetType.RadioGroup
                     filter_widget_props["options"] = [
                         {"label": "Yes", "value": True},

fastadmin/models/orms/ponyorm.py

@@ -85,6 +85,7 @@ def get_model_fields_with_widget_types(
                     filter_widget_type = WidgetType.TextArea
                 case "bool":
                     form_widget_type = WidgetType.Switch
+                    form_widget_props["required"] = False
                     filter_widget_type = WidgetType.RadioGroup
                     filter_widget_props["options"] = [
                         {"label": "Yes", "value": True},