fix dict pydantic fields

Author: NatalyaGrigoreva

fastapi_jsonapi/signature.py

@@ -4,10 +4,14 @@
 import logging
 from enum import Enum
 from inspect import Parameter
-from typing import Optional
+from typing import Any, Optional, Type, Union, get_args, get_origin
 
 from fastapi import Query
 
+# noinspection PyProtectedMember
+from fastapi._compat import field_annotation_is_scalar, field_annotation_is_sequence
+from fastapi.types import UnionType
+
 # noinspection PyProtectedMember
 from pydantic.fields import FieldInfo
 
@@ -17,6 +21,23 @@
 log = logging.getLogger(__name__)
 
 
+def field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:
+    origin = get_origin(annotation)
+    if origin is Union or origin is UnionType:
+        at_least_one_scalar_sequence = False
+        for arg in get_args(annotation):
+            if field_annotation_is_scalar_sequence(arg):
+                at_least_one_scalar_sequence = True
+                continue
+            elif not field_annotation_is_scalar(arg):
+                return False
+        return at_least_one_scalar_sequence
+    return (
+        field_annotation_is_sequence(annotation)
+        and all(field_annotation_is_scalar(sub_annotation) for sub_annotation in get_args(annotation))
+    ) or field_annotation_is_scalar(annotation)
+
+
 def create_filter_parameter(
     name: str,
     field: FieldInfo,
@@ -30,6 +51,9 @@ def create_filter_parameter(
     ):
         default = Query(None, alias=query_filter_name, enum=list(field.annotation))
         type_field = str
+    elif not field_annotation_is_scalar_sequence(field.annotation):
+        default = Query(None, alias=query_filter_name)
+        type_field = str
     else:
         default = Query(None, alias=query_filter_name)
         type_field = field.annotation

tests/fixtures/models/task.py

@@ -9,4 +9,5 @@
 class Task(Base):
     __tablename__ = "tasks"
 
-    task_ids: Mapped[Optional[list]] = mapped_column(JSON, unique=False)
+    task_ids_dict: Mapped[Optional[dict]] = mapped_column(JSON, unique=False)
+    task_ids_list: Mapped[Optional[list]] = mapped_column(JSON, unique=False)

tests/fixtures/schemas/task.py

@@ -12,12 +12,22 @@ class TaskBaseSchema(BaseModel):
         from_attributes=True,
     )
 
-    task_ids: Optional[list[str]] = None
+    task_ids_dict: Optional[dict[str, list]] = None
+    task_ids_list: Optional[list] = None
 
     # noinspection PyMethodParameters
-    @field_validator("task_ids", mode="before", check_fields=False)
+    @field_validator("task_ids_dict", mode="before", check_fields=False)
     @classmethod
-    def task_ids_validator(cls, value: Optional[list[str]]):
+    def task_ids_dict_validator(cls, value: Optional[dict[str, list]]):
+        """
+        return `{}`, if value is None both on get and on create
+        """
+        return value or {}
+
+    # noinspection PyMethodParameters
+    @field_validator("task_ids_list", mode="before", check_fields=False)
+    @classmethod
+    def task_ids_list_validator(cls, value: Optional[list]):
         """
         return `[]`, if value is None both on get and on create
         """

tests/test_api/test_validators.py

@@ -24,7 +24,10 @@
 async def task_with_none_ids(
     async_session: AsyncSession,
 ) -> Task:
-    task = Task(task_ids=None)
+    task = Task(
+        task_ids_dict=None,
+        task_ids_list=None,
+    )
     async_session.add(task)
     await async_session.commit()
 
@@ -44,7 +47,8 @@ async def test_base_model_validator_pre_true_get_one(
         resource_type: str,
         task_with_none_ids: Task,
     ):
-        assert task_with_none_ids.task_ids is None
+        assert task_with_none_ids.task_ids_dict is None
+        assert task_with_none_ids.task_ids_list is None
         url = app.url_path_for(f"get_{resource_type}_detail", obj_id=task_with_none_ids.id)
         res = await client.get(url)
         assert res.status_code == status.HTTP_200_OK, res.text
@@ -59,20 +63,22 @@ async def test_base_model_validator_pre_true_get_one(
             "meta": None,
         }
         assert attributes == {
-            # not `None`! schema validator returns empty list `[]`
+            # not `None`! schema validator returns empty dict `{}` and empty list `[]`
             # "task_ids": None,
-            "task_ids": [],
+            "task_ids_dict": {},
+            "task_ids_list": [],
         }
         assert attributes == TaskBaseSchema.model_validate(task_with_none_ids).model_dump()
 
-    async def test_base_model_model_validator_get_list(
+    async def test_base_model_model_validator_get_list_and_dict(
         self,
         app: FastAPI,
         client: AsyncClient,
         resource_type: str,
         task_with_none_ids: Task,
     ):
-        assert task_with_none_ids.task_ids is None
+        assert task_with_none_ids.task_ids_dict is None
+        assert task_with_none_ids.task_ids_list is None
         url = app.url_path_for(f"get_{resource_type}_list")
         res = await client.get(url)
         assert res.status_code == status.HTTP_200_OK, res.text
@@ -83,9 +89,10 @@ async def test_base_model_model_validator_get_list(
                     "id": f"{task_with_none_ids.id}",
                     "type": resource_type,
                     "attributes": {
-                        # not `None`! schema validator returns empty list `[]`
+                        # not `None`! schema validator returns empty dict `{}` and empty list `[]`
                         # "task_ids": None,
-                        "task_ids": [],
+                        "task_ids_dict": {},
+                        "task_ids_list": [],
                     },
                 },
             ],
@@ -109,8 +116,9 @@ async def test_base_model_model_validator_create(
             "data": {
                 "type": resource_type,
                 "attributes": {
-                    # should be converted to [] by schema on create
-                    "task_ids": None,
+                    # should be converted to [] and {} by schema on create
+                    "task_ids_dict": None,
+                    "task_ids_list": None,
                 },
             },
         }
@@ -121,16 +129,17 @@ async def test_base_model_model_validator_create(
         task_id = response_data["data"].pop("id")
         task = await async_session.get(Task, int(task_id))
         assert isinstance(task, Task)
-        assert task.task_ids == []
-        # we sent request with `None`, but value in db is `[]`
+        # we sent request with `None`, but value in db is `[]` and `{}`
         # because validator converted data before object creation
-        assert task.task_ids == []
+        assert task.task_ids_dict == {}
+        assert task.task_ids_list == []
         assert response_data == {
             "data": {
                 "type": resource_type,
                 "attributes": {
-                    # should be empty list
-                    "task_ids": [],
+                    # should be empty list and empty dict
+                    "task_ids_dict": {},
+                    "task_ids_list": [],
                 },
             },
             "jsonapi": {"version": "1.0"},