feat: New feature, update_fields support PropertyField.

Author: amisadmin

fastapi_amis_admin/crud/_sqlmodel.py

@@ -19,6 +19,7 @@
 from fastapi.encoders import DictIntStrAny, SetIntStr
 from pydantic import Extra, Json
 from pydantic.fields import ModelField
+from pydantic.utils import ValueItems
 from sqlalchemy import Column, Table, delete, func, insert
 from sqlalchemy.future import select
 from sqlalchemy.orm import InstrumentedAttribute, Session
@@ -313,14 +314,18 @@ def _create_schema_read(self) -> Type[SchemaReadT]:
     def _create_schema_update(self) -> Type[SchemaUpdateT]:
         if self.schema_update:
             return self.schema_update
-        if not self.readonly_fields and not self.update_fields:
-            return super(SQLModelCrud, self)._create_schema_update()
-        self.update_fields = self.parser.filter_insfield(self.update_fields) or self.schema_model.__fields__.values()
+        self.update_fields = (
+            self.parser.filter_insfield(self.update_fields, save_class=(ModelField,)) or self.schema_model.__fields__.values()
+        )
         modelfields = [self.parser.get_modelfield(ins, deepcopy=True) for ins in self.update_fields]
-        readonly_fields = {
-            self.parser.get_modelfield(ins, deepcopy=False).name for ins in self.parser.filter_insfield(self.readonly_fields)
-        } | {self.pk_name}
-        modelfields = [field for field in modelfields if field.name not in readonly_fields]
+        if self.update_exclude is None:  # deprecated in version 0.4.0
+            exclude = {self.pk_name} | {
+                self.parser.get_modelfield(ins, deepcopy=False).name
+                for ins in self.parser.filter_insfield(self.readonly_fields)  # readonly fields, deprecated
+            }
+        else:
+            exclude = {k for k, v in ValueItems.merge(self.update_exclude, {}).items() if not isinstance(v, (dict, list, set))}
+        modelfields = [field for field in modelfields if field.name not in exclude]
         return schema_create_by_modelfield(f"{self.schema_name_prefix}Update", modelfields, set_none=True)
 
     def _create_schema_create(self) -> Type[SchemaCreateT]:

tests/test_crud/test_SQLModelCrud_fields.py

@@ -7,7 +7,7 @@
 from fastapi_amis_admin.crud.parser import LabelField, PropertyField
 from fastapi_amis_admin.models import Field
 from tests.conftest import async_db as db
-from tests.models import Article, Category, User
+from tests.models import Article, ArticleContent, Category, User
 
 
 async def test_pk_name(app: FastAPI, async_client: AsyncClient, fake_users):
@@ -302,3 +302,43 @@ class ArticleCrud(SQLModelCrud):
     assert items["category"]["name"] == "Category_1"
     assert "content_text" in items
     # assert items["user"]["username"] == "User_1"
+
+
+async def test_update_fields_relationship(app: FastAPI, async_client: AsyncClient, fake_articles, async_session):
+    class ArticleCrud(SQLModelCrud):
+        router_prefix = "/article"
+        update_exclude = {"content": {"id"}}
+        update_fields = [
+            Article.description,
+            PropertyField(name="content", type_=ArticleContent),  # Relationship attribute
+        ]
+
+    ins = ArticleCrud(Article, db.engine).register_crud()
+
+    app.include_router(ins.router)
+
+    # test schemas
+    assert "id" not in ins.schema_update.__fields__
+    assert "title" not in ins.schema_update.__fields__
+    assert "description" in ins.schema_update.__fields__
+    assert "content" in ins.schema_update.__fields__
+
+    # test api
+    res = await async_client.put(
+        "/article/item/1",
+        json={
+            "title": "new_title",
+            "description": "new_description",
+            "content": {
+                "id": 22,  # will be ignored by `update_exclude`
+                "content": "new_content",
+            },
+        },
+    )
+    assert res.json()["data"] == 1
+    article = await async_session.get(Article, 1)
+    assert article.title != "new_title"
+    assert article.description == "new_description"
+
+    content = await async_session.get(ArticleContent, 1)
+    assert content.content == "new_content"