Annotated syntax support

WHATSNEW_V1.md

@@ -3,9 +3,14 @@
  - CSRF changes
  - Auth async support
  - Schema.Meta
- - pagination request in paginate_queryset
+ - pagination: request in paginate_queryset
+ - decorators
  - openapi docs plugable
+ - add_router supports strings
 
 TODO:
  - async pagination
 
+Backwards incompatible stuff
+ - resolve_xxx(self, ...)
+ - pydantic v1

ninja/compatibility/util.py

@@ -1,21 +1,8 @@
-from typing import Any, Callable, Optional, Union
+from typing import Callable, Union
 
 import django
 
-__all__ = ["get_origin", "get_args", "async_to_sync"]
-
-# python3.8+ get_origin, get_args
-try:
-    from typing import get_args, get_origin  # type: ignore
-except ImportError:  # pragma: no coverage
-
-    def get_origin(tp: Any) -> Optional[Any]:
-        "typing.get_origin introduced in python3.8"
-        return getattr(tp, "__origin__", None)
-
-    def get_args(tp: Any) -> Optional[Any]:
-        "typing.get_args introduced in python3.8"
-        return getattr(tp, "__args__", None)
+__all__ = ["async_to_sync", "UNION_TYPES"]
 
 
 # python3.10+ syntax of creating a union or optional type (with str | int)

ninja/pagination.py

@@ -6,9 +6,9 @@
 from django.db.models import QuerySet
 from django.http import HttpRequest
 from django.utils.module_loading import import_string
+from typing_extensions import get_args as get_collection_args  # type: ignore
 
 from ninja import Field, Query, Router, Schema
-from ninja.compatibility.util import get_args as get_collection_args
 from ninja.conf import settings
 from ninja.constants import NOT_SET
 from ninja.errors import ConfigError

ninja/params_functions.py

@@ -9,7 +9,7 @@
 
 
 def Path(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,
@@ -48,7 +48,7 @@ def Path(  # noqa: N802
 
 
 def Query(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,
@@ -87,7 +87,7 @@ def Query(  # noqa: N802
 
 
 def Header(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,
@@ -126,7 +126,7 @@ def Header(  # noqa: N802
 
 
 def Cookie(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,
@@ -165,7 +165,7 @@ def Cookie(  # noqa: N802
 
 
 def Body(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,
@@ -204,7 +204,7 @@ def Body(  # noqa: N802
 
 
 def Form(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,
@@ -243,7 +243,7 @@ def Form(  # noqa: N802
 
 
 def File(  # noqa: N802
-    default: Any,
+    default: Any = ...,
     *,
     alias: Optional[str] = None,
     title: Optional[str] = None,

ninja/signature/details.py

@@ -7,15 +7,10 @@
 from django.http import HttpResponse
 from pydantic.fields import FieldInfo
 from pydantic_core import PydanticUndefined
+from typing_extensions import Annotated, get_args, get_origin  # type: ignore
 
 from ninja import UploadedFile, params
-from ninja.compatibility.util import (
-    UNION_TYPES,
-    get_args,
-)
-from ninja.compatibility.util import (
-    get_origin as get_collection_origin,
-)
+from ninja.compatibility.util import UNION_TYPES
 from ninja.errors import ConfigError
 from ninja.params import Body, File, Form, _MultiPartBody
 from ninja.params_models import TModel, TModels
@@ -205,15 +200,24 @@ def _model_flatten_map(self, model: TModel, prefix: str) -> Generator:
     def _get_param_type(self, name: str, arg: inspect.Parameter) -> FuncParam:
         # _EMPTY = self.signature.empty
         annotation = arg.annotation
+        default = arg.default
+
+        if get_origin(annotation) is Annotated:
+            args = get_args(annotation)
+            if isinstance(args[1], params.Param):
+                prev_default = default
+                annotation, default = args
+                if prev_default != self.signature.empty:
+                    default.default = prev_default
 
         if annotation == self.signature.empty:
-            if arg.default == self.signature.empty:
+            if default == self.signature.empty:
                 annotation = str
             else:
-                if isinstance(arg.default, params.Param):
-                    annotation = type(arg.default.default)
+                if isinstance(default, params.Param):
+                    annotation = type(default.default)
                 else:
-                    annotation = type(arg.default)
+                    annotation = type(default)
 
             if annotation == PydanticUndefined.__class__:
                 # TODO: ^ check why is that so
@@ -228,34 +232,34 @@ def _get_param_type(self, name: str, arg: inspect.Parameter) -> FuncParam:
             is_collection and annotation.__args__[0] == UploadedFile
         ):
             # People often forgot to mark UploadedFile as a File, so we better assign it automatically
-            if arg.default == self.signature.empty or arg.default is None:
-                default = arg.default == self.signature.empty and ... or arg.default
+            if default == self.signature.empty or default is None:
+                default = default == self.signature.empty and ... or default
                 return FuncParam(name, name, File(default), annotation, is_collection)
 
         # 1) if type of the param is defined as one of the Param's subclasses - we just use that definition
-        if isinstance(arg.default, params.Param):
-            param_source = arg.default
+        if isinstance(default, params.Param):
+            param_source = default
 
         # 2) if param name is a part of the path parameter
         elif name in self.path_params_names:
             assert (
-                arg.default == self.signature.empty
+                default == self.signature.empty
             ), f"'{name}' is a path param, default not allowed"
             param_source = params.Path(...)
 
         # 3) if param is a collection, or annotation is part of pydantic model:
         elif is_collection or is_pydantic_model(annotation):
-            if arg.default == self.signature.empty:
+            if default == self.signature.empty:
                 param_source = params.Body(...)
             else:
-                param_source = params.Body(arg.default)
+                param_source = params.Body(default)
 
         # 4) the last case is query param
         else:
-            if arg.default == self.signature.empty:
+            if default == self.signature.empty:
                 param_source = params.Query(...)
             else:
-                param_source = params.Query(arg.default)
+                param_source = params.Query(default)
 
         return FuncParam(
             name, param_source.alias or name, param_source, annotation, is_collection
@@ -264,15 +268,15 @@ def _get_param_type(self, name: str, arg: inspect.Parameter) -> FuncParam:
 
 def is_pydantic_model(cls: Any) -> bool:
     try:
-        if get_collection_origin(cls) in UNION_TYPES:
+        if get_origin(cls) in UNION_TYPES:
             return any(issubclass(arg, pydantic.BaseModel) for arg in get_args(cls))
         return issubclass(cls, pydantic.BaseModel)
     except TypeError:
         return False
 
 
 def is_collection_type(annotation: Any) -> bool:
-    origin = get_collection_origin(annotation)
+    origin = get_origin(annotation)
     collection_types = (List, list, set, tuple)
     if origin is None:
         return (