Merge pull request #62 from eadwinCode/routefunction_refactor

RouteFunction Refactor

Author: eadwinCode

docs/api_controller/api_controller_permission.md

@@ -71,4 +71,4 @@ class PermissionController:
 ## **Permissions Supported Operands**
 - & (and) eg: `permissions.IsAuthenticated & ReadOnly`
 - | (or) eg: `permissions.IsAuthenticated | ReadOnly`
-- ~ (not) eg: `!(permissions.IsAuthenticated & ReadOnly)`
+- ~ (not) eg: `~(permissions.IsAuthenticated & ReadOnly)`

ninja_extra/constants.py

@@ -8,3 +8,4 @@
 TRACE = "TRACE"
 ROUTE_METHODS = [POST, PUT, PATCH, DELETE, GET, HEAD, OPTIONS, TRACE]
 THROTTLED_FUNCTION = "__throttled_endpoint__"
+ROUTE_FUNCTION = "__route_function__"

ninja_extra/controllers/base.py

@@ -29,7 +29,7 @@
 from ninja.signature import is_async
 from ninja.utils import normalize_path
 
-from ninja_extra.constants import THROTTLED_FUNCTION
+from ninja_extra.constants import ROUTE_FUNCTION, THROTTLED_FUNCTION
 from ninja_extra.exceptions import APIException, NotFound, PermissionDenied, bad_request
 from ninja_extra.helper import get_function_name
 from ninja_extra.operation import ControllerPathView, Operation
@@ -59,13 +59,13 @@ class MissingAPIControllerDecoratorException(Exception):
 
 def get_route_functions(cls: Type) -> Iterable[RouteFunction]:
     for method in cls.__dict__.values():
-        if isinstance(method, RouteFunction):
-            yield method
+        if hasattr(method, ROUTE_FUNCTION):
+            yield getattr(method, ROUTE_FUNCTION)
 
 
 def get_all_controller_route_function(
     controller: Union[Type["ControllerBase"], Type]
-) -> List[RouteFunction]:
+) -> List[RouteFunction]:  # pragma: no cover
     route_functions: List[RouteFunction] = []
     for item in dir(controller):
         attr = getattr(controller, item)
@@ -317,7 +317,7 @@ def tags(self, value: Union[str, List[str], None]) -> None:
             tag = [value]
         self._tags = tag
 
-    def __call__(self, cls: Type) -> Type["ControllerBase"]:
+    def __call__(self, cls: Type) -> Union[Type, Type["ControllerBase"]]:
         from ninja_extra.throttling import throttle
 
         self.auto_import = getattr(cls, "auto_import", self.auto_import)
@@ -468,7 +468,9 @@ def add_api_operation(
 
 
 @overload
-def api_controller(prefix_or_class: Type) -> Type[ControllerBase]:  # pragma: no cover
+def api_controller(
+    prefix_or_class: Type,
+) -> Union[Type[ControllerBase], Callable[..., Any], Any]:  # pragma: no cover
     ...
 
 
@@ -479,7 +481,7 @@ def api_controller(
     tags: Union[Optional[List[str]], str] = None,
     permissions: Optional["PermissionType"] = None,
     auto_import: bool = True,
-) -> APIController:  # pragma: no cover
+) -> Union[Type[ControllerBase], Callable[..., Any], Any]:  # pragma: no cover
     ...
 
 
@@ -489,21 +491,23 @@ def api_controller(
     tags: Union[Optional[List[str]], str] = None,
     permissions: Optional["PermissionType"] = None,
     auto_import: bool = True,
-) -> Union[Type[ControllerBase], APIController]:
+) -> Union[Type[ControllerBase], Callable[..., Any], Any]:
     if isinstance(prefix_or_class, type):
-        _api_controller = APIController(
+        return APIController(
             prefix="",
             auth=auth,
             tags=tags,
             permissions=permissions,
             auto_import=auto_import,
-        )
-        return _api_controller(prefix_or_class)
-
-    return APIController(
-        prefix=prefix_or_class,
-        auth=auth,
-        tags=tags,
-        permissions=permissions,
-        auto_import=auto_import,
-    )
+        )(prefix_or_class)
+
+    def _decorator(cls: Type) -> Union[Type[ControllerBase], Any]:
+        return APIController(
+            prefix=str(prefix_or_class),
+            auth=auth,
+            tags=tags,
+            permissions=permissions,
+            auto_import=auto_import,
+        )(cls)
+
+    return _decorator

ninja_extra/controllers/route/__init__.py

@@ -15,7 +15,15 @@
 from ninja.signature import is_async
 from ninja.types import TCallable
 
-from ninja_extra.constants import DELETE, GET, PATCH, POST, PUT, ROUTE_METHODS
+from ninja_extra.constants import (
+    DELETE,
+    GET,
+    PATCH,
+    POST,
+    PUT,
+    ROUTE_FUNCTION,
+    ROUTE_METHODS,
+)
 from ninja_extra.controllers.response import ControllerResponse, ControllerResponseMeta
 from ninja_extra.permissions import BasePermission
 from ninja_extra.schemas import RouteParameter
@@ -141,7 +149,7 @@ def _create_route_function(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> RouteFunction:
+    ) -> TCallable:
         if response is NOT_SET:
             response = get_type_hints(view_func).get("return") or NOT_SET
         route_obj = cls(
@@ -168,7 +176,8 @@ def _create_route_function(
         if route_obj.is_async:
             route_function_class = AsyncRouteFunction
 
-        return route_function_class(route=route_obj)
+        setattr(view_func, ROUTE_FUNCTION, route_function_class(route=route_obj))
+        return view_func
 
     @classmethod
     def get(
@@ -192,7 +201,7 @@ def get(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> Callable[[TCallable], RouteFunction]:
+    ) -> Callable[[TCallable], TCallable]:
         """
         A GET Operation method decorator
          eg.
@@ -220,7 +229,7 @@ def get_operation(self):
         :return: Route[GET]
         """
 
-        def decorator(view_func: TCallable) -> RouteFunction:
+        def decorator(view_func: TCallable) -> TCallable:
             return cls._create_route_function(
                 view_func,
                 path=path,
@@ -266,7 +275,7 @@ def post(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> Callable[[TCallable], RouteFunction]:
+    ) -> Callable[[TCallable], TCallable]:
         """
         A POST Operation method decorator
         eg.
@@ -294,7 +303,7 @@ def post_operation(self,  create_schema: Schema):
         :return: Route[POST]
         """
 
-        def decorator(view_func: TCallable) -> RouteFunction:
+        def decorator(view_func: TCallable) -> TCallable:
             return cls._create_route_function(
                 view_func,
                 path=path,
@@ -340,7 +349,7 @@ def delete(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> Callable[[TCallable], RouteFunction]:
+    ) -> Callable[[TCallable], TCallable]:
         """
         A DELETE Operation method decorator
         eg.
@@ -368,7 +377,7 @@ def delete_operation(self, some_id: int):
         :return: Route[DELETE]
         """
 
-        def decorator(view_func: TCallable) -> RouteFunction:
+        def decorator(view_func: TCallable) -> TCallable:
             return cls._create_route_function(
                 view_func,
                 path=path,
@@ -414,7 +423,7 @@ def patch(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> Callable[[TCallable], RouteFunction]:
+    ) -> Callable[[TCallable], TCallable]:
         """
         A PATCH Operation method decorator
         eg.
@@ -443,7 +452,7 @@ def patch_operation(self,  some_id: int):
         :return: Route[PATCH]
         """
 
-        def decorator(view_func: TCallable) -> RouteFunction:
+        def decorator(view_func: TCallable) -> TCallable:
             return cls._create_route_function(
                 view_func,
                 path=path,
@@ -489,7 +498,7 @@ def put(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> Callable[[TCallable], RouteFunction]:
+    ) -> Callable[[TCallable], TCallable]:
         """
          A PUT Operation method decorator
         eg.
@@ -518,7 +527,7 @@ def put_operation(self, some_id: int):
          :return: Route[PUT]
         """
 
-        def decorator(view_func: TCallable) -> RouteFunction:
+        def decorator(view_func: TCallable) -> TCallable:
             return cls._create_route_function(
                 view_func,
                 path=path,
@@ -565,7 +574,7 @@ def generic(
             List[Union[Type[BasePermission], BasePermission, Any]]
         ] = None,
         openapi_extra: Optional[Dict[str, Any]] = None,
-    ) -> Callable[[TCallable], RouteFunction]:
+    ) -> Callable[[TCallable], TCallable]:
         """
         A Custom Operation method decorator, for creating route with more than one operation
         eg.
@@ -595,7 +604,7 @@ def list_create(self, some_schema: Optional[Schema] = None):
         :return: Route[PATCH]
         """
 
-        def decorator(view_func: TCallable) -> RouteFunction:
+        def decorator(view_func: TCallable) -> TCallable:
             return cls._create_route_function(
                 view_func,
                 path=path,

ninja_extra/controllers/route/route_functions.py

@@ -11,7 +11,7 @@
 from ...dependency_resolver import get_injector, service_resolver
 from .context import RouteContext, get_route_execution_context
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from ninja_extra.operation import ControllerOperation
 
     from ...controllers.base import APIController, ControllerBase

ninja_extra/helper.py

@@ -1,8 +1,20 @@
 import inspect
-from typing import Any
+import typing as t
 
+from ninja_extra.constants import ROUTE_FUNCTION
 
-def get_function_name(func_class: Any) -> str:
+if t.TYPE_CHECKING:  # pragma: no cover
+    from ninja_extra.controllers import RouteFunction
+
+
+def get_function_name(func_class: t.Any) -> str:
     if inspect.isfunction(func_class) or inspect.isclass(func_class):
         return str(func_class.__name__)
     return str(func_class.__class__.__name__)
+
+
+@t.no_type_check
+def get_route_function(func: t.Callable) -> t.Optional["RouteFunction"]:
+    if hasattr(func, ROUTE_FUNCTION):
+        return func.__dict__[ROUTE_FUNCTION]
+    return None  # pragma: no cover

ninja_extra/ordering.py

@@ -226,7 +226,7 @@ def __init__(
         self.as_view = wraps(view_func)(orderator_view)
 
     @property
-    def view_func_has_kwargs(self) -> bool:
+    def view_func_has_kwargs(self) -> bool:  # pragma: no cover
         return self.orderator.pass_parameter is not None
 
     def get_view_function(self) -> Callable:

ninja_extra/pagination.py

@@ -207,7 +207,7 @@ def __init__(
         self.as_view = wraps(view_func)(paginator_view)
 
     @property
-    def view_func_has_kwargs(self) -> bool:
+    def view_func_has_kwargs(self) -> bool:  # pragma: no cover
         return self.paginator.pass_parameter is not None
 
     def get_view_function(self) -> Callable:

ninja_extra/searching.py

@@ -268,7 +268,7 @@ def __init__(
         self.as_view = wraps(view_func)(searcherator_view)
 
     @property
-    def view_func_has_kwargs(self) -> bool:
+    def view_func_has_kwargs(self) -> bool:  # pragma: no cover
         return self.searcherator.pass_parameter is not None
 
     def get_view_function(self) -> Callable: