Added fieldsets interface

vsdudakov · vsdudakov · commit 10c8b97ab372 · 2023-03-06T14:37:29.000+04:00
diff --git a/fastadmin/api/api.py b/fastadmin/api/api.py
@@ -430,6 +430,7 @@ async def configuration(
                 actions_on_bottom=admin_obj.actions_on_bottom,
                 actions_selection_counter=admin_obj.actions_selection_counter,
                 fields=fields_schema,
+                fieldsets=admin_obj.fieldsets,
                 list_per_page=admin_obj.list_per_page,
                 save_on_top=admin_obj.save_on_top,
                 save_as=admin_obj.save_as,
diff --git a/fastadmin/models/base.py b/fastadmin/models/base.py
@@ -420,18 +420,21 @@ def get_fields(self) -> Sequence[str]:
 
         :return: A list of model field names.
         """
-        fields = self.fields
         model_fields = self.get_model_fields()
-        if not fields:
-            return [f for f in model_fields if not self.exclude or f not in self.exclude]
-        return [f for f in fields if f in model_fields]
 
-    # def get_fieldsets(self) -> Sequence[tuple[str | None, dict[str, Sequence[str]]]]:
-    #     """This method is used to get fieldsets data for form view.
-
-    #     :return: A list of fieldsets data.
-    #     """
-    #     return self.fieldsets
+        fields = [f for f in model_fields if model_fields[f].get("is_pk")]
+        if not self.fields:
+            if self.fieldsets:
+                for item in self.fieldsets:
+                    for field in item[1].get("fields") or []:
+                        if field not in fields and field not in self.exclude:
+                            fields.append(field)
+            else:
+                for field in model_fields:
+                    if field not in fields and field not in self.exclude:
+                        fields.append(field)
+
+        return fields
 
     def has_add_permission(self) -> bool:
         """This method is used to check if user has permission to add new model instance.
diff --git a/fastadmin/models/orm/tortoise.py b/fastadmin/models/orm/tortoise.py
@@ -247,7 +247,7 @@ def get_form_widget(self, field_name: str) -> tuple[WidgetType, dict]:
         widget_props = {
             "required": field.get("required") or False,
             "disabled": field_name in self.readonly_fields,
-            "readonly": field_name in self.readonly_fields,
+            "readOnly": field_name in self.readonly_fields,
         }
         match field.get("orm_class_name"):
             case "CharField":
diff --git a/fastadmin/schemas/configuration.py b/fastadmin/schemas/configuration.py
@@ -92,6 +92,7 @@ class ModelSchema(BaseModel):
     actions_on_bottom: bool | None
     actions_selection_counter: bool | None
     fields: Sequence[ModelFieldSchema]
+    fieldsets: Sequence[tuple[str | None, dict[str, Sequence[str]]]] | None
     list_per_page: int | None
     save_on_top: bool | None
     save_as: bool | None
diff --git a/frontend/src/components/form-container/index.tsx b/frontend/src/components/form-container/index.tsx
@@ -1,7 +1,7 @@
 import React, { useCallback, useContext } from 'react';
 import { useParams } from 'react-router-dom';
 import { useTranslation } from 'react-i18next';
-import { Divider, Form } from 'antd';
+import { Collapse, Divider, Form } from 'antd';
 
 import {
   EFieldWidgetType,
@@ -50,39 +50,69 @@ export const FormContainer: React.FC<IFormContainer> = ({ form, onFinish, childr
     [mode]
   );
 
+  const formItemWidgets = useCallback(
+    (formFields: IModelField[]) => {
+      return formFields
+        .sort((a: IModelField, b: IModelField) => (getConf(a).index || 0) - (getConf(b).index || 0))
+        .map((field: IModelField) => (
+          <Form.Item
+            key={field.name}
+            name={field.name}
+            label={getTitleFromFieldName(field.name)}
+            rules={
+              getConf(field).required
+                ? [
+                    {
+                      required: true,
+                    },
+                  ]
+                : []
+            }
+            valuePropName={
+              [
+                EFieldWidgetType.Checkbox,
+                EFieldWidgetType.Switch,
+                EFieldWidgetType.CheckboxGroup,
+              ].includes(getConf(field).form_widget_type as EFieldWidgetType)
+                ? 'checked'
+                : undefined
+            }
+          >
+            {getWidget(getConf(field))}
+          </Form.Item>
+        ));
+    },
+    [getConf, getWidget]
+  );
+
   const formItems = useCallback(() => {
-    const fields = (modelConfiguration || { fields: [] }).fields;
-    return fields
-      .filter((field: IModelField) => !!getConf(field).form_widget_type)
-      .sort((a: IModelField, b: IModelField) => (getConf(a).index || 0) - (getConf(b).index || 0))
-      .map((field: IModelField) => (
-        <Form.Item
-          key={field.name}
-          name={field.name}
-          label={getTitleFromFieldName(field.name)}
-          rules={
-            getConf(field).required
-              ? [
-                  {
-                    required: true,
-                  },
-                ]
-              : []
-          }
-          valuePropName={
-            [
-              EFieldWidgetType.Checkbox,
-              EFieldWidgetType.Switch,
-              EFieldWidgetType.CheckboxGroup,
-            ].includes(getConf(field).form_widget_type as EFieldWidgetType)
-              ? 'checked'
-              : undefined
-          }
-        >
-          {getWidget(getConf(field))}
-        </Form.Item>
-      ));
-  }, [getConf, getWidget, modelConfiguration]);
+    const fields = (modelConfiguration?.fields || []).filter(
+      (field: IModelField) => !!getConf(field).form_widget_type
+    );
+    const fieldsets = modelConfiguration?.fieldsets || [];
+    if (fieldsets.length > 0) {
+      const defaultActiveKey = fieldsets
+        .filter((fieldset) => !(fieldset[1]?.classes || []).includes('collapse'))
+        .map((fieldset) => JSON.stringify(fieldset[1]?.fields));
+      return (
+        <Collapse defaultActiveKey={defaultActiveKey}>
+          {fieldsets.map((fieldset) => {
+            const collapseTitle = fieldset[0];
+            const collapseFields = fieldset[1]?.fields;
+            return (
+              <Collapse.Panel header={collapseTitle || ''} key={JSON.stringify(collapseFields)}>
+                {formItemWidgets(
+                  fields.filter((field: IModelField) => (collapseFields || []).includes(field.name))
+                )}
+              </Collapse.Panel>
+            );
+          })}
+        </Collapse>
+      );
+    }
+
+    return formItemWidgets(fields);
+  }, [formItemWidgets, modelConfiguration?.fields, modelConfiguration?.fieldsets]);
 
   return (
     <Form layout="vertical" form={form} onFinish={onFinish}>
diff --git a/frontend/src/interfaces/configuration.ts b/frontend/src/interfaces/configuration.ts
@@ -67,6 +67,7 @@ export interface IModel {
   actions_on_bottom?: boolean;
   actions_selection_counter?: boolean;
   fields: IModelField[];
+  fieldsets?: [string | undefined, Record<string, string[]>][];
   list_per_page?: number;
   save_on_top?: boolean;
   save_as?: boolean;
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastadmin"
-version = "0.1.16"
+version = "0.1.17"
 description = ""
 authors = ["Seva D <vsdudakov@gmail.com>"]
 license = "MIT"
diff --git a/tests/api/api/test_configuration.py b/tests/api/api/test_configuration.py
@@ -142,6 +142,7 @@ async def test_configuration_list_display(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -155,7 +156,7 @@ async def test_configuration_list_display_display_fields(objects, client):
     await sign_in(client, superuser, admin_user_cls)
 
     register_admin_model(admin_event_cls, [event.__class__])
-    admin_event_cls.list_display = ["started", "name_with_price"]  # see EventAdmin display methods
+    admin_event_cls.list_display = ("started", "name_with_price")  # see EventAdmin display methods
     r = await client.get(
         f"/api/configuration",
     )
@@ -164,6 +165,7 @@ async def test_configuration_list_display_display_fields(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -187,6 +189,8 @@ async def test_configuration_list_filter(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
+    admin_event_cls.list_filter = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -202,7 +206,7 @@ async def test_configuration_sortable_by(objects, client):
     register_admin_model(admin_event_cls, [event.__class__])
     admin_event_cls.list_display = LIST_EVENT_FIELDS
     admin_event_cls.list_filter = LIST_EVENT_FIELDS
-    admin_event_cls.sortable_by = ["name"]
+    admin_event_cls.sortable_by = ("name",)
     r = await client.get(
         f"/api/configuration",
     )
@@ -211,6 +215,9 @@ async def test_configuration_sortable_by(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
+    admin_event_cls.list_filter = ()
+    admin_event_cls.sortable_by = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -226,7 +233,7 @@ async def test_configuration_radio_fields(objects, client):
     register_admin_model(admin_event_cls, [event.__class__])
     admin_event_cls.list_display = LIST_EVENT_FIELDS
     admin_event_cls.list_filter = LIST_EVENT_FIELDS
-    admin_event_cls.radio_fields = ["event_type"]
+    admin_event_cls.radio_fields = ("event_type",)
     r = await client.get(
         f"/api/configuration",
     )
@@ -235,6 +242,9 @@ async def test_configuration_radio_fields(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
+    admin_event_cls.list_filter = ()
+    admin_event_cls.radio_fields = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -250,7 +260,7 @@ async def test_configuration_filter_horizontal_vertical(objects, client):
     register_admin_model(admin_event_cls, [event.__class__])
     admin_event_cls.list_display = LIST_EVENT_FIELDS
     admin_event_cls.list_filter = LIST_EVENT_FIELDS
-    admin_event_cls.filter_horizontal = ["participants"]
+    admin_event_cls.filter_horizontal = ("participants",)
     r = await client.get(
         f"/api/configuration",
     )
@@ -268,6 +278,9 @@ async def test_configuration_filter_horizontal_vertical(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
+    admin_event_cls.list_filter = ()
+    admin_event_cls.filter_horizontal = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -283,7 +296,7 @@ async def test_configuration_raw_id_fields(objects, client):
     register_admin_model(admin_event_cls, [event.__class__])
     admin_event_cls.list_display = LIST_EVENT_FIELDS
     admin_event_cls.list_filter = LIST_EVENT_FIELDS
-    admin_event_cls.raw_id_fields = ["participants", "tournament_id", "base_id"]
+    admin_event_cls.raw_id_fields = ("participants", "tournament_id", "base_id")
     r = await client.get(
         f"/api/configuration",
     )
@@ -292,6 +305,9 @@ async def test_configuration_raw_id_fields(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.list_display = ()
+    admin_event_cls.list_filter = ()
+    admin_event_cls.raw_id_fields = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -314,6 +330,7 @@ async def test_configuration_fields(objects, client):
     assert response_data
     validate_configuration_response_data(response_data)
 
+    admin_event_cls.fields = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
 
@@ -327,7 +344,7 @@ async def test_configuration_actions(objects, client):
     await sign_in(client, superuser, admin_user_cls)
 
     register_admin_model(admin_event_cls, [event.__class__])
-    admin_event_cls.actions = ["make_is_active"]
+    admin_event_cls.actions = ("make_is_active",)
     r = await client.get(
         f"/api/configuration",
     )
@@ -339,3 +356,42 @@ async def test_configuration_actions(objects, client):
     admin_event_cls.actions = ()
     unregister_admin_model([event.__class__])
     await sign_out(client, superuser)
+
+
+async def test_configuration_fieldsets(objects, client):
+    superuser = objects["superuser"]
+    event = objects["event"]
+    admin_user_cls = objects["admin_user_cls"]
+    admin_event_cls = objects["admin_event_cls"]
+
+    await sign_in(client, superuser, admin_user_cls)
+
+    register_admin_model(admin_event_cls, [event.__class__])
+    admin_event_cls.fieldsets = [
+        (None, {"fields": ("base_id", "name", "tournament_id", "participants")}),
+        (
+            "Types",
+            {
+                "classes": ("collapse",),
+                "fields": ("is_active",),
+            },
+        ),
+        (
+            "Geo",
+            {
+                "classes": ("collapse",),
+                "fields": ("latitude", "longitude"),
+            },
+        ),
+    ]
+    r = await client.get(
+        f"/api/configuration",
+    )
+    assert r.status_code == 200, r.text
+    response_data = r.json()
+    assert response_data
+    validate_configuration_response_data(response_data)
+
+    admin_event_cls.fieldsets = ()
+    unregister_admin_model([event.__class__])
+    await sign_out(client, superuser)

Original file line number	Diff line number	Diff line change
`@@ -247,7 +247,7 @@ def get_form_widget(self, field_name: str) -> tuple[WidgetType, dict]:`
`247`	`247`	`widget_props = {`
`248`	`248`	`"required": field.get("required") or False,`
`249`	`249`	`"disabled": field_name in self.readonly_fields,`
`250`		`- "readonly": field_name in self.readonly_fields,`
	`250`	`+ "readOnly": field_name in self.readonly_fields,`
`251`	`251`	`}`
`252`	`252`	`match field.get("orm_class_name"):`
`253`	`253`	`case "CharField":`