Merge pull request #8 from eadwinCode/default_app_config_fix

Default App config Fix for Django >= 4.0
Added support for django-ninja==0.17.0

Author: eadwinCode

ninja_extra/__init__.py

@@ -2,6 +2,8 @@
 
 __version__ = "0.14.2"
 
+import django
+
 from ninja_extra.controllers import (
     ControllerBase,
     api_controller,
@@ -17,7 +19,9 @@
 from ninja_extra.main import NinjaExtraAPI
 from ninja_extra.router import Router
 
-default_app_config = "ninja_extra.apps.NinjaExtraConfig"
+if django.VERSION < (3, 2):  # pragma: no cover
+    default_app_config = "ninja_extra.apps.NinjaExtraConfig"
+
 
 __all__ = [
     "ControllerBase",

ninja_extra/pagination.py

@@ -11,7 +11,7 @@
 from ninja import Schema
 from ninja.constants import NOT_SET
 from ninja.pagination import LimitOffsetPagination, PageNumberPagination, PaginationBase
-from ninja.signature import has_kwargs, is_async
+from ninja.signature import is_async
 from ninja.types import DictStrAny
 from pydantic import Field
 
@@ -66,8 +66,9 @@ def __init__(
         self,
         page_size: int = settings.PAGINATION_PER_PAGE,
         max_page_size: Optional[int] = None,
+        pass_parameter: Optional[str] = None,
     ) -> None:
-        super().__init__()
+        super().__init__(pass_parameter=pass_parameter)
         self.page_size = page_size
         self.max_page_size = max_page_size or 200
         self.Input = self.create_input()  # type:ignore
@@ -79,14 +80,17 @@ class DynamicInput(PageNumberPaginationExtra.Input):
 
         return DynamicInput
 
-    def paginate_queryset(
-        self, items: QuerySet, request: HttpRequest, **params: Any
+    def paginate_queryset(  # type: ignore
+        self,
+        queryset: QuerySet,
+        pagination: Input,
+        request: Optional[HttpRequest] = None,
+        **params: DictStrAny,
     ) -> Any:
-
-        pagination_input = cast(PageNumberPaginationExtra.Input, params["pagination"])
-        page_size = self.get_page_size(pagination_input.page_size)
-        current_page_number = pagination_input.page
-        paginator = self.paginator_class(items, page_size)
+        assert request, "request is required"
+        page_size = self.get_page_size(pagination.page_size)
+        current_page_number = pagination.page
+        paginator = self.paginator_class(queryset, page_size)
         try:
             url = request.build_absolute_uri()
             page: Page = paginator.page(current_page_number)
@@ -197,13 +201,7 @@ def __init__(
         self.paginator = paginator
         self.paginator_kwargs_name = paginator_kwargs_name
         self.view_func = view_func
-        self.view_func_has_kwargs = True
 
-        if not has_kwargs(view_func):
-            self.view_func_has_kwargs = False
-            logger.debug(
-                f"function {view_func.__name__} should have **kwargs if you want to use pagination parameters"
-            )
         paginator_view = self.get_view_function()
         paginator_view._ninja_contribute_args = [  # type: ignore
             (
@@ -215,11 +213,16 @@ def __init__(
         setattr(paginator_view, "paginator_operation", self)
         self.as_view = wraps(view_func)(paginator_view)
 
+    @property
+    def view_func_has_kwargs(self) -> bool:
+        return self.paginator.pass_parameter is not None
+
     def get_view_function(self) -> Callable:
         def as_view(controller: "ControllerBase", *args: Any, **kw: Any) -> Any:
-            func_kwargs = dict(kw)
-            if not self.view_func_has_kwargs:
-                func_kwargs.pop(self.paginator_kwargs_name)
+            func_kwargs = dict(**kw)
+            pagination_params = func_kwargs.pop(self.paginator_kwargs_name)
+            if self.paginator.pass_parameter:
+                func_kwargs[self.paginator.pass_parameter] = pagination_params
 
             items = self.view_func(controller, *args, **func_kwargs)
             assert (
@@ -235,9 +238,10 @@ def as_view(controller: "ControllerBase", *args: Any, **kw: Any) -> Any:
 class AsyncPaginatorOperation(PaginatorOperation):
     def get_view_function(self) -> Callable:
         async def as_view(controller: "ControllerBase", *args: Any, **kw: Any) -> Any:
-            func_kwargs = dict(kw)
-            if not self.view_func_has_kwargs:
-                func_kwargs.pop(self.paginator_kwargs_name)
+            func_kwargs = dict(**kw)
+            pagination_params = func_kwargs.pop(self.paginator_kwargs_name)
+            if self.paginator.pass_parameter:
+                func_kwargs[self.paginator.pass_parameter] = pagination_params
 
             items = await self.view_func(controller, *args, **func_kwargs)
             assert (

ninja_extra/schemas/__init__.py

@@ -1,3 +1,7 @@
-from .response import PaginatedResponseSchema, RouteParameter
+from .response import (
+    NinjaPaginationResponseSchema,
+    PaginatedResponseSchema,
+    RouteParameter,
+)
 
-__all__ = ["PaginatedResponseSchema", "RouteParameter"]
+__all__ = ["PaginatedResponseSchema", "RouteParameter", "NinjaPaginationResponseSchema"]

ninja_extra/schemas/response.py

@@ -19,6 +19,11 @@ class BasePaginatedResponseSchema(Schema):
     results: List[Any]
 
 
+class BaseNinjaResponseSchema(Schema):
+    count: int
+    items: List[Any]
+
+
 class PaginatedResponseSchema(GenericType):
     def get_generic_type(
         self, wrap_type: Any
@@ -32,13 +37,31 @@ class ListResponseSchema(BasePaginatedResponseSchema):
         return ListResponseSchema
 
 
+class NinjaPaginationResponseSchema(GenericType):
+    def get_generic_type(
+        self, wrap_type: Any
+    ) -> Type[BaseNinjaResponseSchema]:  # pragma: no cover
+        class ListNinjaResponseSchema(BaseNinjaResponseSchema):
+            items: List[wrap_type]  # type: ignore
+
+        ListNinjaResponseSchema.__name__ = (
+            f"{self.__class__.__name__}[{str(wrap_type.__name__).capitalize()}]"
+        )
+        return ListNinjaResponseSchema
+
+
 if sys.version_info >= (3, 8):  # pragma: no cover
 
     class PaginatedResponseSchema(
         GenericModel, Generic[T], BasePaginatedResponseSchema
     ):
         results: List[T]
 
+    class NinjaPaginationResponseSchema(
+        GenericModel, Generic[T], BaseNinjaResponseSchema
+    ):
+        items: List[T]
+
 
 class RouteParameter(BaseModel):
     path: str

pyproject.toml

@@ -63,7 +63,7 @@ test = [
     "isort",
     "injector",
     "flake8",
-    "mypy",
+    "mypy==0.931",
     "django-stubs",
 ]
 doc = []

tests/test_pagination.py

@@ -33,22 +33,22 @@ def paginate_queryset(self, items, request, **params):
 class SomeAPIController:
     @route.get("/items_1")
     @paginate  # WITHOUT brackets (should use default pagination)
-    def items_1(self, **kwargs):
+    def items_1(self):
         return ITEMS
 
     @route.get("/items_2")
     @paginate()  # with brackets (should use default pagination)
-    def items_2(self, someparam: int = 0, **kwargs):
+    def items_2(self, someparam: int = 0):
         # also having custom param `someparam` - that should not be lost
         return ITEMS
 
     @route.get("/items_3")
-    @paginate(CustomPagination)
+    @paginate(CustomPagination, pass_parameter="pass_kwargs")
     def items_3(self, **kwargs):
         return ITEMS
 
     @route.get("/items_4")
-    @paginate(PageNumberPaginationExtra, page_size=10)
+    @paginate(PageNumberPaginationExtra, page_size=10, pass_parameter="pass_kwargs")
     def items_4(self, **kwargs):
         return ITEMS
 
@@ -72,7 +72,7 @@ def test_paginator_operation_used(self):
                 SomeAPIController, lambda member: isinstance(member, RouteFunction)
             )
         }
-        has_kwargs = ("items_1", "items_3", "items_4")
+        has_kwargs = ("items_3", "items_4")
         for name, route_function in some_api_route_functions.items():
             assert hasattr(route_function.as_view, "paginator_operation")
             paginator_operation = route_function.as_view.paginator_operation
@@ -82,7 +82,8 @@ def test_paginator_operation_used(self):
 
     def test_case1(self):
         response = client.get("/items_1?limit=10").json()
-        assert response == ITEMS[:10]
+        assert response.get("items")
+        assert response["items"] == ITEMS[:10]
 
         schema = api.get_openapi_schema()["paths"]["/api/items_1"]["get"]
         # print(schema)
@@ -113,7 +114,8 @@ def test_case1(self):
 
     def test_case2(self):
         response = client.get("/items_2?limit=10").json()
-        assert response == ITEMS[:10]
+        assert response.get("items")
+        assert response["items"] == ITEMS[:10]
 
         schema = api.get_openapi_schema()["paths"]["/api/items_2"]["get"]
         # print(schema["parameters"])
@@ -199,7 +201,8 @@ def test_case4(self):
 
     def test_case5(self):
         response = client.get("/items_5?page=2").json()
-        assert response == ITEMS[10:20]
+        assert response.get("items")
+        assert response["items"] == ITEMS[10:20]
 
         schema = api.get_openapi_schema()["paths"]["/api/items_5"]["get"]
         # print(schema)
@@ -232,17 +235,19 @@ async def items_1(self, **kwargs):
 
             @route.get("/items_2")
             @paginate()  # with brackets (should use default pagination)
-            async def items_2(self, someparam: int = 0, **kwargs):
+            async def items_2(self, someparam: int = 0):
                 # also having custom param `someparam` - that should not be lost
                 return ITEMS
 
             @route.get("/items_3")
-            @paginate(CustomPagination)
+            @paginate(CustomPagination, pass_parameter="pass_kwargs")
             async def items_3(self, **kwargs):
                 return ITEMS
 
             @route.get("/items_4")
-            @paginate(PageNumberPaginationExtra, page_size=10)
+            @paginate(
+                PageNumberPaginationExtra, page_size=10, pass_parameter="pass_kwargs"
+            )
             async def items_4(self, **kwargs):
                 return ITEMS
 
@@ -263,7 +268,7 @@ async def test_paginator_operation_used(self):
                     lambda member: isinstance(member, RouteFunction),
                 )
             }
-            has_kwargs = ("items_1", "items_3", "items_4")
+            has_kwargs = ("items_3", "items_4")
             for name, route_function in some_api_route_functions.items():
                 assert hasattr(route_function.as_view, "paginator_operation")
                 paginator_operation = route_function.as_view.paginator_operation
@@ -273,7 +278,9 @@ async def test_paginator_operation_used(self):
 
         async def test_case1(self):
             response = await self.client.get("/items_1?limit=10")
-            assert response.json() == ITEMS[:10]
+            data = response.json()
+            assert data.get("items")
+            assert data["items"] == ITEMS[:10]
 
             schema = self.api_async.get_openapi_schema()["paths"]["/api/items_1"]["get"]
             # print(schema)
@@ -304,7 +311,9 @@ async def test_case1(self):
 
         async def test_case2(self):
             response = await self.client.get("/items_2?limit=10")
-            assert response.json() == ITEMS[:10]
+            data = response.json()
+            assert data.get("items")
+            assert data["items"] == ITEMS[:10]
 
         async def test_case3(self):
             response = await self.client.get("/items_3?skip=5")
@@ -320,4 +329,6 @@ async def test_case4(self):
 
         async def test_case5(self):
             response = await self.client.get("/items_5?page=2")
-            assert response.json() == ITEMS[10:20]
+            data = response.json()
+            assert data.get("items")
+            assert data["items"] == ITEMS[10:20]