Added support for django-ninja 0.21.0

eadwinCode · eadwinCode · commit 2b93e7eefabc · 2023-02-24T22:25:59.000+01:00
diff --git a/ninja_extra/controllers/base.py b/ninja_extra/controllers/base.py
@@ -382,9 +382,7 @@ def urls_paths(self, prefix: str) -> Iterator[URLPattern]:
             route = route.lstrip("/")
             for op in path_view.operations:
                 op = cast(Operation, op)
-                yield django_path(
-                    route, path_view.get_view(), name=cast(str, op.url_name)
-                )
+                yield django_path(route, path_view.get_view(), name=op.url_name)
 
     def __repr__(self) -> str:  # pragma: no cover
         return f"<controller - {self.controller_class.__name__}>"
@@ -432,6 +430,7 @@ def add_api_operation(
         exclude_none: bool = False,
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Operation:
         auth = self.auth if auth == NOT_SET else auth
 
@@ -459,6 +458,7 @@ def add_api_operation(
             exclude_none=exclude_none,
             url_name=url_name,
             include_in_schema=include_in_schema,
+            openapi_extra=openapi_extra,
         )
         return operation
 
diff --git a/ninja_extra/controllers/route/__init__.py b/ninja_extra/controllers/route/__init__.py
@@ -1,5 +1,15 @@
 import inspect
-from typing import Any, Callable, List, Optional, Type, Union, cast, get_type_hints
+from typing import (
+    Any,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    Type,
+    Union,
+    cast,
+    get_type_hints,
+)
 
 from ninja.constants import NOT_SET
 from ninja.signature import is_async
@@ -45,6 +55,7 @@ def __init__(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> None:
 
         if not isinstance(methods, list):
@@ -97,6 +108,7 @@ def __init__(
             exclude_none=exclude_none,
             url_name=url_name,
             include_in_schema=include_in_schema,
+            openapi_extra=openapi_extra,
         )
         self.route_params = ninja_route_params
         self.is_async = is_async(view_func)
@@ -124,6 +136,7 @@ def _create_route_function(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> RouteFunction:
         if response is NOT_SET:
             response = get_type_hints(view_func).get("return") or NOT_SET
@@ -145,6 +158,7 @@ def _create_route_function(
             url_name=url_name,
             include_in_schema=include_in_schema,
             permissions=permissions,
+            openapi_extra=openapi_extra,
         )
         route_function_class = RouteFunction
         if route_obj.is_async:
@@ -171,6 +185,7 @@ def get(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Callable[[TCallable], RouteFunction]:
         """
         A GET Operation method decorator
@@ -218,6 +233,7 @@ def decorator(view_func: TCallable) -> RouteFunction:
                 url_name=url_name,
                 include_in_schema=include_in_schema,
                 permissions=permissions,
+                openapi_extra=openapi_extra,
             )
 
         return decorator
@@ -241,6 +257,7 @@ def post(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Callable[[TCallable], RouteFunction]:
         """
         A POST Operation method decorator
@@ -288,6 +305,7 @@ def decorator(view_func: TCallable) -> RouteFunction:
                 url_name=url_name,
                 include_in_schema=include_in_schema,
                 permissions=permissions,
+                openapi_extra=openapi_extra,
             )
 
         return decorator
@@ -311,6 +329,7 @@ def delete(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Callable[[TCallable], RouteFunction]:
         """
         A DELETE Operation method decorator
@@ -358,6 +377,7 @@ def decorator(view_func: TCallable) -> RouteFunction:
                 url_name=url_name,
                 include_in_schema=include_in_schema,
                 permissions=permissions,
+                openapi_extra=openapi_extra,
             )
 
         return decorator
@@ -381,6 +401,7 @@ def patch(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Callable[[TCallable], RouteFunction]:
         """
         A PATCH Operation method decorator
@@ -429,6 +450,7 @@ def decorator(view_func: TCallable) -> RouteFunction:
                 url_name=url_name,
                 include_in_schema=include_in_schema,
                 permissions=permissions,
+                openapi_extra=openapi_extra,
             )
 
         return decorator
@@ -452,6 +474,7 @@ def put(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Callable[[TCallable], RouteFunction]:
         """
          A PUT Operation method decorator
@@ -500,6 +523,7 @@ def decorator(view_func: TCallable) -> RouteFunction:
                 url_name=url_name,
                 include_in_schema=include_in_schema,
                 permissions=permissions,
+                openapi_extra=openapi_extra,
             )
 
         return decorator
@@ -524,6 +548,7 @@ def generic(
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
         permissions: Optional[List[Type[BasePermission]]] = None,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Callable[[TCallable], RouteFunction]:
         """
         A Custom Operation method decorator, for creating route with more than one operation
@@ -573,6 +598,7 @@ def decorator(view_func: TCallable) -> RouteFunction:
                 url_name=url_name,
                 include_in_schema=include_in_schema,
                 permissions=permissions,
+                openapi_extra=openapi_extra,
             )
 
         return decorator
diff --git a/ninja_extra/operation.py b/ninja_extra/operation.py
@@ -7,6 +7,7 @@
     Any,
     AsyncIterator,
     Callable,
+    Dict,
     Iterator,
     List,
     Optional,
@@ -50,11 +51,11 @@ def __init__(
         methods: List[str],
         view_func: Callable,
         *,
-        url_name: Optional[str] = None,
+        url_name: str = None,
         **kwargs: Any,
     ) -> None:
         self.is_coroutine = is_async(view_func)
-        self.url_name = url_name
+        self.url_name = url_name  # type: ignore
         super().__init__(path, methods, view_func, **kwargs)
         self.signature = ViewSignature(self.path, self.view_func)
 
@@ -479,6 +480,7 @@ def add_operation(
         exclude_none: bool = False,
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
+        openapi_extra: Optional[Dict[str, Any]] = None,
     ) -> Operation:
         if url_name:
             self.url_name = url_name
@@ -500,6 +502,7 @@ def add_operation(
             exclude_none=exclude_none,
             include_in_schema=include_in_schema,
             url_name=url_name,
+            openapi_extra=openapi_extra,
         )
 
         self.operations.append(operation)
diff --git a/ninja_extra/router.py b/ninja_extra/router.py
@@ -34,6 +34,7 @@ def add_api_operation(
         exclude_none: bool = False,
         url_name: Optional[str] = None,
         include_in_schema: bool = True,
+        openapi_extra: Optional[Dict[str, Any]] = None
     ) -> None:
         if path not in self.path_operations:
             path_view = PathView()
@@ -61,6 +62,7 @@ def add_api_operation(
             exclude_none=exclude_none,
             url_name=url_name,
             include_in_schema=include_in_schema,
+            openapi_extra=openapi_extra,
         )
         if self.api:
             path_view.set_api_instance(self.api, self)
diff --git a/ninja_extra/schemas/response.py b/ninja_extra/schemas/response.py
@@ -1,5 +1,5 @@
 import sys
-from typing import Any, Generic, List, Optional, Type, TypeVar
+from typing import Any, Dict, Generic, List, Optional, Type, TypeVar
 
 from ninja import Schema
 from ninja.constants import NOT_SET
@@ -120,3 +120,4 @@ class RouteParameter(BaseModel):
     exclude_none: bool = False
     url_name: Optional[str] = None
     include_in_schema: bool = True
+    openapi_extra: Optional[Dict[str, Any]]
