fastapi-rtk 2.3.4__tar.gz → 2.4.0__tar.gz

{fastapi_rtk-2.3.4 → fastapi_rtk-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-rtk
-Version: 2.3.4
+Version: 2.4.0
 Summary: A package that provides a set of tools to build a FastAPI application with a Class-Based CRUD API.
 Project-URL: Homepage, https://codeberg.org/datatactics/fastapi-rtk
 Project-URL: Issues, https://codeberg.org/datatactics/fastapi-rtk/issues

fastapi_rtk-2.4.0/fastapi_rtk/_version.py

@@ -0,0 +1 @@
+__version__ = "2.4.0"

{fastapi_rtk-2.3.4 → fastapi_rtk-2.4.0}/fastapi_rtk/api/model_rest_api/__init__.py

@@ -705,6 +705,34 @@ class ModelRestApi(
 
     A workaround for issue https://github.com/eclipsesource/jsonforms/issues/2271
     """
+    add_jsonforms_list_as_object: (
+        bool
+        | collections.abc.Callable[
+            [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+        ]
+        | dict[
+            str,
+            bool
+            | collections.abc.Callable[
+                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+            ],
+        ]
+    ) = False
+    """
+    A flag or a callable or a dictionary to determine whether a list column (e.g. `ListColumn` / `JSONBListColumn`) is rendered as a single `object` control in the JSONForms schema for the add endpoint, instead of the default per-item `array` table. The callable receives the column's `ColumnInfo` when available, else `None`. Defaults to False (array).
+
+    Use this when a per-field `component` override should receive the whole list value once, rather than being re-applied per array item.
+
+    Example:
+    ```python
+    # Can be a simple boolean (applies to every list column)
+    add_jsonforms_list_as_object = True
+    # Can be a callable that takes the column info and returns a boolean
+    add_jsonforms_list_as_object = lambda info: info.name == "tags"
+    # Can be a dictionary that maps column names to booleans or callables
+    add_jsonforms_list_as_object = {"tags": True}
+    ```
+    """
 
     edit_jsonforms_schema: (
         dict[str, typing.Any]
@@ -755,6 +783,34 @@ class ModelRestApi(
 
     A workaround for issue https://github.com/eclipsesource/jsonforms/issues/2271
     """
+    edit_jsonforms_list_as_object: (
+        bool
+        | collections.abc.Callable[
+            [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+        ]
+        | dict[
+            str,
+            bool
+            | collections.abc.Callable[
+                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+            ],
+        ]
+    ) = False
+    """
+    A flag or a callable or a dictionary to determine whether a list column (e.g. `ListColumn` / `JSONBListColumn`) is rendered as a single `object` control in the JSONForms schema for the edit endpoint, instead of the default per-item `array` table. The callable receives the column's `ColumnInfo` when available, else `None`. Defaults to False (array).
+
+    Use this when a per-field `component` override should receive the whole list value once, rather than being re-applied per array item.
+
+    Example:
+    ```python
+    # Can be a simple boolean (applies to every list column)
+    edit_jsonforms_list_as_object = True
+    # Can be a callable that takes the column info and returns a boolean
+    edit_jsonforms_list_as_object = lambda info: info.name == "tags"
+    # Can be a dictionary that maps column names to booleans or callables
+    edit_jsonforms_list_as_object = {"tags": True}
+    ```
+    """
 
     """
     -------------

{fastapi_rtk-2.3.4 → fastapi_rtk-2.4.0}/fastapi_rtk/api/model_rest_api/_columns_mixin.py

@@ -535,6 +535,17 @@ class ColumnsMixin(_TypedModelRestApi):
                 [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool
             ],
         ] = False,
+        list_as_object: bool
+        | collections.abc.Callable[
+            [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+        ]
+        | dict[
+            str,
+            bool
+            | collections.abc.Callable[
+                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+            ],
+        ] = False,
     ):
         """
         Generate the JSONForms schema for the API.
@@ -543,6 +554,7 @@ class ColumnsMixin(_TypedModelRestApi):
             schema (type[BaseModel]): The schema to generate the JSONForms schema from.
             info_columns (list[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo]): The list of columns to include in the JSONForms schema.
             use_enum (bool | Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool] | dict[str, bool | Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool]], optional): A flag or a callable or a dictionary to determine whether to use enum instead of oneOf. Defaults to False.
+            list_as_object (bool | Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool] | dict[str, bool | Callable[[ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool]], optional): A flag or a callable or a dictionary to determine whether to render a list column as a single `object` control instead of the per-item `array` table. The callable receives the column's `ColumnInfo` when available, else `None`. Defaults to False.
 
         Returns:
             dict[str, typing.Any]: The generated JSONForms schema.
@@ -595,10 +607,21 @@ class ColumnsMixin(_TypedModelRestApi):
                     enum_val = [str(item.value) for item in enum_val]
                 value["enum"] = enum_val
             elif self.datamodel.is_list(key):
-                value["type"] = "array"
-                value["items"] = self._jsonforms_list_items_schema(
-                    self.datamodel.get_list_col_type(key)
+                col_list_as_object = list_as_object
+                if isinstance(col_list_as_object, dict):
+                    col_list_as_object = col_list_as_object.get(key, False)
+                list_info = next((x for x in info_columns if x.name == key), None)
+                col_list_as_object = parse_from_values_or_func(
+                    col_list_as_object, list_info
                 )
+                if col_list_as_object:
+                    value["type"] = "object"
+                    value.pop("items", None)
+                else:
+                    value["type"] = "array"
+                    value["items"] = self._jsonforms_list_items_schema(
+                        self.datamodel.get_list_col_type(key)
+                    )
             elif self.datamodel.is_json(key) or self.datamodel.is_jsonb(key):
                 value["type"] = "object"
             elif self.datamodel.is_relation(key):

{fastapi_rtk-2.3.4 → fastapi_rtk-2.4.0}/fastapi_rtk/api/model_rest_api/_info_mixin.py

@@ -146,7 +146,10 @@ class InfoMixin(_TypedModelRestApi):
             if callable(add_jsonforms_schema):
                 add_jsonforms_schema = await smart_run(add_jsonforms_schema)
             schema.add_schema = add_jsonforms_schema or self._generate_jsonforms_schema(
-                self.add_obj_schema, schema.add_columns, self.add_jsonforms_use_enum
+                self.add_obj_schema,
+                schema.add_columns,
+                self.add_jsonforms_use_enum,
+                self.add_jsonforms_list_as_object,
             )
             schema.add_uischema = self.add_jsonforms_uischema
 
@@ -190,6 +193,7 @@ class InfoMixin(_TypedModelRestApi):
                     self.edit_obj_schema,
                     schema.edit_columns,
                     self.edit_jsonforms_use_enum,
+                    self.edit_jsonforms_list_as_object,
                 )
             )
             schema.edit_uischema = self.edit_jsonforms_uischema

{fastapi_rtk-2.3.4 → fastapi_rtk-2.4.0}/fastapi_rtk/api/model_rest_api/_typed_base.py

@@ -100,6 +100,19 @@ class _TypedModelRestApi:
                 ],
             ]
         )
+        add_jsonforms_list_as_object: (
+            bool
+            | collections.abc.Callable[
+                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+            ]
+            | dict[
+                str,
+                bool
+                | collections.abc.Callable[
+                    [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+                ],
+            ]
+        )
         add_jsonforms_uischema: dict[str, typing.Any] | None
 
         # -- edit --
@@ -129,6 +142,19 @@ class _TypedModelRestApi:
                 ],
             ]
         )
+        edit_jsonforms_list_as_object: (
+            bool
+            | collections.abc.Callable[
+                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+            ]
+            | dict[
+                str,
+                bool
+                | collections.abc.Callable[
+                    [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+                ],
+            ]
+        )
         edit_jsonforms_uischema: dict[str, typing.Any] | None
 
         # -- search --
@@ -167,6 +193,17 @@ class _TypedModelRestApi:
                     [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo], bool
                 ],
             ] = False,
+            list_as_object: bool
+            | collections.abc.Callable[
+                [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+            ]
+            | dict[
+                str,
+                bool
+                | collections.abc.Callable[
+                    [ColumnInfo | ColumnEnumInfo | ColumnRelationInfo | None], bool
+                ],
+            ] = False,
         ) -> dict[str, typing.Any]: ...
 
         def _get_datamodel_and_column(self, col: str) -> tuple[SQLAInterface, str]: ...

{fastapi_rtk-2.3.4 → fastapi_rtk-2.4.0}/tests/unit/api/model_rest_api/test_columns.py

@@ -313,3 +313,36 @@ class TestGenerateJsonformsSchemaListBranch:
         result = list_api._generate_jsonforms_schema(schema, [], False)
         # Plain `sqlalchemy.JSON` (not a ListColumn) keeps the original behavior.
         assert result["properties"]["payload"]["type"] == ["object", "null"]
+
+    def test_list_as_object_bool_true(self, list_api):
+        schema = list_api.add_obj_schema
+        result = list_api._generate_jsonforms_schema(
+            schema, [], False, list_as_object=True
+        )
+        assert result["properties"]["tags"]["type"] == ["object", "null"]
+        assert "items" not in result["properties"]["tags"]
+
+    def test_list_as_object_dict_targets_one_column(self, list_api):
+        schema = list_api.add_obj_schema
+        result = list_api._generate_jsonforms_schema(
+            schema, [], False, list_as_object={"tags": True}
+        )
+        assert result["properties"]["tags"]["type"] == ["object", "null"]
+        assert "items" not in result["properties"]["tags"]
+        # A column absent from the dict keeps the array rendering.
+        assert result["properties"]["nums"]["type"] == ["array", "null"]
+        assert result["properties"]["nums"]["items"] == {"type": "integer"}
+
+    def test_list_as_object_callable(self, list_api):
+        schema = list_api.add_obj_schema
+        result = list_api._generate_jsonforms_schema(
+            schema, [], False, list_as_object=lambda info: True
+        )
+        assert result["properties"]["tags"]["type"] == ["object", "null"]
+        assert "items" not in result["properties"]["tags"]
+
+    def test_list_as_object_default_keeps_array(self, list_api):
+        schema = list_api.add_obj_schema
+        result = list_api._generate_jsonforms_schema(schema, [], False)
+        assert result["properties"]["tags"]["type"] == ["array", "null"]
+        assert result["properties"]["tags"]["items"] == {"type": "string"}

fastapi_rtk-2.3.4/fastapi_rtk/_version.py

@@ -1 +0,0 @@
-__version__ = "2.3.4"