Merge pull request #127 from eadwinCode/api_controller_typing

fix mypy typing error

Author: eadwinCode

ninja_extra/constants.py

@@ -17,7 +17,7 @@
 THROTTLED_FUNCTION = "__throttled_endpoint__"
 ROUTE_FUNCTION = "__route_function__"
 
-ROUTE_CONTEXT_VAR: contextvars.ContextVar[
-    t.Optional["RouteContext"]
-] = contextvars.ContextVar("ROUTE_CONTEXT_VAR")
+ROUTE_CONTEXT_VAR: contextvars.ContextVar[t.Optional["RouteContext"]] = (
+    contextvars.ContextVar("ROUTE_CONTEXT_VAR")
+)
 ROUTE_CONTEXT_VAR.set(None)

ninja_extra/controllers/base.py

@@ -55,6 +55,8 @@
 
     from .route.context import RouteContext
 
+T = TypeVar("T")
+
 
 class MissingAPIControllerDecoratorException(Exception):
     pass
@@ -243,6 +245,12 @@ class SomeController(ControllerBase):
     model_config: Optional[ModelConfig] = None
 
 
+ControllerClassType = TypeVar(
+    "ControllerClassType",
+    bound=Union[Type[ControllerBase], Type],
+)
+
+
 class APIController:
     _PATH_PARAMETER_COMPONENT_RE = r"{(?:(?P<converter>[^>:]+):)?(?P<parameter>[^>]+)}"
 
@@ -339,13 +347,13 @@ 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: ControllerClassType) -> ControllerClassType:
         from ninja_extra.throttling import throttle
 
         self.auto_import = getattr(cls, "auto_import", self.auto_import)
         if not issubclass(cls, ControllerBase):
             # We force the cls to inherit from `ControllerBase` by creating another type.
-            cls = type(cls.__name__, (ControllerBase, cls), {"_api_controller": self})
+            cls = type(cls.__name__, (ControllerBase, cls), {"_api_controller": self})  # type:ignore[assignment]
         else:
             cls._api_controller = self
 
@@ -388,7 +396,7 @@ def __call__(self, cls: Type) -> Type[ControllerBase]:
             fail_silently(inject, constructor_or_class=cls)
 
         ControllerRegistry().add_controller(cls)
-        return cls
+        return cls  # type:ignore[return-value]
 
     @property
     def path_operations(self) -> Dict[str, PathView]:
@@ -502,8 +510,8 @@ def add_api_operation(
 
 @overload
 def api_controller(
-    prefix_or_class: Type,
-) -> Type[ControllerBase]:  # pragma: no cover
+    prefix_or_class: Type[T],
+) -> Union[Type[ControllerBase], Type[T]]:  # pragma: no cover
     ...
 
 
@@ -514,20 +522,17 @@ def api_controller(
     tags: Union[Optional[List[str]], str] = None,
     permissions: Optional["PermissionType"] = None,
     auto_import: bool = True,
-) -> Callable[[Type], Type[ControllerBase]]:  # pragma: no cover
+) -> Callable[[Type[T]], Union[Type[ControllerBase], Type[T]]]:  # pragma: no cover
     ...
 
 
-InputClassType = TypeVar("InputClassType", bound=ControllerBase)
-
-
 def api_controller(
-    prefix_or_class: Union[str, Type] = "",
+    prefix_or_class: Union[str, ControllerClassType] = "",
     auth: Any = NOT_SET,
     tags: Union[Optional[List[str]], str] = None,
     permissions: Optional["PermissionType"] = None,
     auto_import: bool = True,
-) -> Union[Type[ControllerBase], Callable[[InputClassType], Type[InputClassType]]]:
+) -> Union[ControllerClassType, Callable[[ControllerClassType], ControllerClassType]]:
     if isinstance(prefix_or_class, type):
         return APIController(
             prefix="",
@@ -537,7 +542,7 @@ def api_controller(
             auto_import=auto_import,
         )(prefix_or_class)
 
-    def _decorator(cls: InputClassType) -> Type[InputClassType]:
+    def _decorator(cls: ControllerClassType) -> ControllerClassType:
         return APIController(
             prefix=str(prefix_or_class),
             auth=auth,

ninja_extra/controllers/model/schemas.py

@@ -15,9 +15,9 @@
         ModelSchemaConfigAdapter,
     )
 except Exception:  # pragma: no cover
-    ConfigError = (
-        NinjaSchemaModelSchemaConfig
-    ) = ModelSchemaConfigAdapter = SchemaFactory = None
+    ConfigError = NinjaSchemaModelSchemaConfig = ModelSchemaConfigAdapter = (
+        SchemaFactory
+    ) = None
 
 
 from ...pagination import PageNumberPaginationExtra, PaginatedResponseSchema

ninja_extra/exceptions.py

@@ -1,6 +1,7 @@
 """
 DRF Exceptions
 """
+
 import math
 from typing import Any, Dict, List, Optional, Type, Union, no_type_check
 

ninja_extra/ordering.py

@@ -41,8 +41,7 @@
 
 
 class OrderingBase(ABC):
-    class Input(Schema):
-        ...
+    class Input(Schema): ...
 
     InputSource = Query(...)
 
@@ -52,8 +51,7 @@ def __init__(self, *, pass_parameter: Optional[str] = None, **kwargs: Any) -> No
     @abstractmethod
     def ordering_queryset(
         self, items: Union[QuerySet, List], ordering_input: Any
-    ) -> Union[QuerySet, List]:
-        ...
+    ) -> Union[QuerySet, List]: ...
 
 
 class Ordering(OrderingBase):

ninja_extra/permissions/base.py

@@ -2,6 +2,7 @@
 Copied from DRF
 Provides a set of pluggable permission policies.
 """
+
 from abc import ABC, ABCMeta, abstractmethod
 from typing import TYPE_CHECKING, Any, Generic, Tuple, Type, TypeVar, Union
 

ninja_extra/searching.py

@@ -56,8 +56,7 @@ def _isicontains(a: str, b: str) -> bool:
 
 
 class SearchingBase(ABC):
-    class Input(Schema):
-        ...
+    class Input(Schema): ...
 
     InputSource = Query(...)
 
@@ -67,8 +66,7 @@ def __init__(self, *, pass_parameter: Optional[str] = None, **kwargs: Any) -> No
     @abstractmethod
     def searching_queryset(
         self, items: Union[QuerySet, List], searching_input: Any
-    ) -> Union[QuerySet, List]:
-        ...
+    ) -> Union[QuerySet, List]: ...
 
 
 class Searching(SearchingBase):

ninja_extra/throttling/model.py

@@ -2,6 +2,7 @@
 Provides various throttling policies.
 From DjangoRestFramework - https://github.com/encode/django-rest-framework/blob/master/rest_framework/throttling.py
 """
+
 import time
 from typing import Any, Callable, Dict, List, Optional, Tuple, cast