stop multidimensional arrays from breaking FastAPIWrapper

piccolo_api/fastapi/endpoints.py

@@ -12,7 +12,7 @@
 from inspect import Parameter, Signature, isclass
 
 from fastapi import APIRouter, FastAPI, Request, status
-from fastapi.params import Query
+from fastapi.params import Body, Query
 from pydantic import BaseModel as PydanticBaseModel
 from pydantic.main import BaseModel
 
@@ -120,6 +120,17 @@ def _get_type(type_: t.Type) -> t.Type:
     return type_
 
 
+def _is_multidimensional_array(type_: t.Type) -> bool:
+    """
+    Returns ``True`` if ``_type`` is list[list].
+    """
+    if t.get_origin(type_) is list:
+        args = t.get_args(type_)
+        if args and t.get_origin(args[0]) is list:
+            return True
+    return False
+
+
 class FastAPIWrapper:
     """
     Wraps ``PiccoloCRUD`` so it can easily be integrated into FastAPI.
@@ -325,9 +336,9 @@ async def post(request: Request, model):
                 """
                 return await piccolo_crud.root(request=request)
 
-            post.__annotations__[
-                "model"
-            ] = f"ANNOTATIONS['{self.alias}']['ModelIn']"
+            post.__annotations__["model"] = (
+                f"ANNOTATIONS['{self.alias}']['ModelIn']"
+            )
 
             fastapi_app.add_api_route(
                 path=root_url,
@@ -386,9 +397,9 @@ async def put(row_id: str, request: Request, model):
                 """
                 return await piccolo_crud.detail(request=request)
 
-            put.__annotations__[
-                "model"
-            ] = f"ANNOTATIONS['{self.alias}']['ModelIn']"
+            put.__annotations__["model"] = (
+                f"ANNOTATIONS['{self.alias}']['ModelIn']"
+            )
 
             fastapi_app.add_api_route(
                 path=self.join_urls(root_url, "/{row_id:str}/"),
@@ -410,9 +421,9 @@ async def patch(row_id: str, request: Request, model):
                 """
                 return await piccolo_crud.detail(request=request)
 
-            patch.__annotations__[
-                "model"
-            ] = f"ANNOTATIONS['{self.alias}']['ModelOptional']"
+            patch.__annotations__["model"] = (
+                f"ANNOTATIONS['{self.alias}']['ModelOptional']"
+            )
 
             fastapi_app.add_api_route(
                 path=self.join_urls(root_url, "/{row_id:str}/"),
@@ -462,11 +473,20 @@ def modify_signature(
             assert annotation is not None
             type_ = _get_type(annotation)
 
+            # Multidimensional arrays can't be used as query params - only
+            # body params. For now, we'll use a body param, so it doesn't
+            # crash, but will explore other options in the future (perhaps a
+            # string query param with a special query syntax for filtering
+            # multidimensional arrays).
+            param_class = (
+                Body if _is_multidimensional_array(type_=type_) else Query
+            )
+
             parameters.append(
                 Parameter(
                     name=field_name,
                     kind=Parameter.POSITIONAL_OR_KEYWORD,
-                    default=Query(
+                    default=param_class(
                         default=None,
                         description=(f"Filter by the `{field_name}` column."),
                     ),

requirements/dev-requirements.txt

@@ -1,7 +1,7 @@
-black==23.7.0
-isort==5.12.0
-twine==4.0.2
-mypy==1.5.1
+black==24.2.0
+isort==5.13.2
+twine==5.0.0
+mypy==1.9.0
 pip-upgrader==1.4.15
-wheel==0.41.2
-setuptools==68.2.2
+wheel==0.43.0
+setuptools==69.2.0

tests/serve.py

@@ -3,6 +3,7 @@
 
 Run it from the root of the project using `python -m tests.serve`.
 """
+
 import os
 
 import uvicorn