Merge pull request #69 from eadwinCode/ninja_pagination_response_schema_fix

Ninja pagination response schema fix

Author: eadwinCode

ninja_extra/schemas/response.py

@@ -3,6 +3,7 @@
 
 from ninja import Schema
 from ninja.constants import NOT_SET
+from pydantic import validator
 from pydantic.generics import GenericModel
 from pydantic.main import BaseModel
 from pydantic.networks import AnyHttpUrl
@@ -86,6 +87,12 @@ class NinjaPaginationResponseSchema(
     ):
         items: List[T]
 
+        @validator("items", pre=True)
+        def validate_items(cls, value: Any) -> Any:
+            if value and not isinstance(value, list):
+                return list(value)
+            return value
+
     NinjaPaginationResponseSchema.__generic_model__ = NinjaPaginationResponseSchema
 
     class IdSchema(GenericModel, Generic[T], Schema):

tests/test_pagination.py

@@ -1,4 +1,7 @@
 import inspect
+import typing
+from abc import abstractmethod
+from typing import Sequence, overload
 
 import django
 import pytest
@@ -14,11 +17,27 @@
     PaginatorOperation,
     paginate,
 )
+from ninja_extra.schemas import NinjaPaginationResponseSchema
 from ninja_extra.testing import TestAsyncClient, TestClient
 
 ITEMS = list(range(100))
 
 
+class FakeQuerySet(typing.Sequence):
+    def __init__(self, items=None):
+        self.items = items or ITEMS
+
+    def __getitem__(self, index: int) -> typing.Any:
+        return FakeQuerySet(self.items[index])
+
+    def __len__(self) -> int:
+        return len(self.items)
+
+    def __iter__(self):
+        for item in self.items:
+            yield item
+
+
 class CustomPagination(PaginationBase):
     # only offset param, defaults to 5 per page
     class Input(Schema):
@@ -36,11 +55,11 @@ class SomeAPIController:
     def items_1(self):
         return ITEMS
 
-    @route.get("/items_2")
+    @route.get("/items_2", response=NinjaPaginationResponseSchema[int])
     @paginate()  # with brackets (should use default pagination)
     def items_2(self, someparam: int = 0):
         # also having custom param `someparam` - that should not be lost
-        return ITEMS
+        return FakeQuerySet()
 
     @route.get("/items_3")
     @paginate(CustomPagination, pass_parameter="pass_kwargs")