Merge pull request #170 from python-ellar/extra_route_args_fix

Bug Fixes: Extra Route Args multiple field grouping

Author: eadwinCode

ellar/common/params/args/base.py

@@ -210,36 +210,52 @@ def compute_route_parameter_list(
                 ), "Path params must be of one of the supported types"
                 self._add_to_model(field=param_field)
             else:
-                default_field_info = t.cast(
-                    t.Type[params.ParamFieldInfo],
-                    param_default
-                    if isinstance(param_default, FieldInfo)
-                    else params.QueryFieldInfo,
-                )
-                param_field = get_parameter_field(
+                param_field = self._process_parameter_file(
                     param_default=param_default,
                     param_annotation=param_annotation,
-                    default_field_info=default_field_info,
                     param_name=param_name,
                     body_field_class=body_field_class,
                 )
-                if not isinstance(
-                    param_field.field_info, (params.BodyFieldInfo, params.FileFieldInfo)
-                ) and not is_scalar_field(field=param_field):
-                    if not is_scalar_sequence_field(param_field):
-                        if not lenient_issubclass(param_field.type_, BaseModel):
-                            raise ImproperConfiguration(
-                                f"{param_field.type_} type can't be processed as a field"
-                            )
-
-                        bulk_resolver_generator_class = self.get_resolver_generator(
-                            param_default
-                        )
-                        bulk_resolver_generator_class(param_field).generate_resolvers(
-                            body_field_class=body_field_class
-                        )
                 self._add_to_model(field=param_field)
 
+    def _process_parameter_file(
+        self,
+        *,
+        param_default: t.Any,
+        param_name: str,
+        param_annotation: t.Type,
+        body_field_class: t.Type[FieldInfo] = params.BodyFieldInfo,
+    ) -> ModelField:
+        default_field_info = t.cast(
+            t.Type[params.ParamFieldInfo],
+            param_default
+            if isinstance(param_default, FieldInfo)
+            else params.QueryFieldInfo,
+        )
+        param_field = get_parameter_field(
+            param_default=param_default,
+            param_annotation=param_annotation,
+            default_field_info=default_field_info,
+            param_name=param_name,
+            body_field_class=body_field_class,
+        )
+        if not isinstance(
+            param_field.field_info, (params.BodyFieldInfo, params.FileFieldInfo)
+        ) and not is_scalar_field(field=param_field):
+            if not is_scalar_sequence_field(param_field):
+                if not lenient_issubclass(param_field.type_, BaseModel):
+                    raise ImproperConfiguration(
+                        f"{param_field.type_} type can't be processed as a field"
+                    )
+
+                bulk_resolver_generator_class = self.get_resolver_generator(
+                    param_default
+                )
+                bulk_resolver_generator_class(param_field).generate_resolvers(
+                    body_field_class=body_field_class
+                )
+        return param_field
+
     def _add_system_parameters_to_dependency(
         self,
         *,
@@ -351,17 +367,10 @@ def _add_extra_route_args(
             ):
                 continue
 
-            default_field_info = t.cast(
-                t.Type[params.ParamFieldInfo],
-                param_default
-                if isinstance(param_default, FieldInfo)
-                else params.QueryFieldInfo,
-            )
-            param_field = get_parameter_field(
+            param_field = self._process_parameter_file(
                 param_default=param_default,
-                param_annotation=param.annotation,
-                default_field_info=default_field_info,
-                param_name=param.name,
+                param_annotation=param_annotation,
+                param_name=param_name,
             )
             self._add_to_model(field=param_field, key=key)
 

ellar/common/params/decorators/__init__.py

@@ -1,5 +1,6 @@
 import typing as t
 
+from ellar.common.utils import get_name
 from ellar.pydantic.types import Undefined
 from typing_extensions import Annotated
 
@@ -27,6 +28,7 @@
 class _ParamShortcut:
     def __init__(self, base_func: t.Callable) -> None:
         self._base_func = base_func
+        self.name = get_name(base_func)
 
     def __call__(self, *args: t.Any, **kwargs: t.Any) -> t.Any:
         return self._base_func(*args, **kwargs)
@@ -109,7 +111,7 @@ def P(
     Path = Annotated[T, param_functions.Path()]
     Query = Annotated[T, param_functions.Query()]
     WsBody = Annotated[T, param_functions.WsBody()]
-    Inject = Annotated[T, t.Any]
+    Inject = InjectShortcut()
 
 else:
     Body = _ParamShortcut(param_functions.Body)

tests/test_routing/test_extra_args.py

@@ -63,6 +63,23 @@ def _wrapper(*args, **kwargs):
     return _wrapper
 
 
+def add_additional_grouped_field(func):
+    # EXTRA ARGS SETUP
+    query1 = ExtraEndpointArg(name="query1", annotation=Query[Filter])
+
+    extra_args(query1)(func)
+
+    @wraps(func)
+    def _wrapper(*args, **kwargs):
+        resolved_query1: Filter = query1.resolve(kwargs)
+
+        response = func(*args, **kwargs)
+        response.update(query1=resolved_query1.dict())
+        return response
+
+    return _wrapper
+
+
 @get("/test")
 @add_extra_non_field_extra_args
 @add_additional_signature_to_endpoint
@@ -207,3 +224,27 @@ def test_query_params_extra():
 
     response = client.get("/test?from=1&to=2&range=20&foo=1&range2=50")
     assert response.status_code == 422
+
+
+def test_extra_args_as_grouped_fields():
+    @get("/test-grouped")
+    @add_additional_grouped_field
+    def query_params_extra(
+        request: Inject[Request],
+    ):
+        return {}
+
+    tm.create_application().router.append(query_params_extra)
+    client = tm.get_test_client()
+    response = client.get(
+        "/test-grouped?from=1&to=2&range=20&foo=1&range2=50&query1=somequery1&query2=somequery2"
+    )
+    assert response.json() == {
+        "query1": {
+            "from_datetime": "1970-01-01T00:00:01Z",
+            "range": 20,
+            "to_datetime": "1970-01-01T00:00:02Z",
+        }
+    }
+    response = client.get("/test-grouped?query1=somequery1&query2=somequery2")
+    assert response.status_code == 422