Added tests for model controller

Author: eadwinCode

ninja_extra/controllers/model/builder.py

@@ -105,7 +105,7 @@ def generate_all_schema(self) -> None:
                 self._config.model,
                 name=f"{self._model_name}PatchSchema",
                 fields=list(create_schema_fields),
-                optional_fields="__all__",
+                optional_fields=list(create_schema_fields),
                 skip_registry=True,
                 depth=self._config.schema_config.depth,
             )
@@ -169,7 +169,7 @@ def _register_update_endpoint(self) -> None:
 
         update_item = ModelEndpointFactory.update(
             path=_path,
-            lookup_field=self._model_pk_name,
+            lookup_param=self._model_pk_name,
             schema_in=self._update_schema,  # type: ignore[arg-type]
             schema_out=self._retrieve_schema,  # type: ignore[arg-type]
             url_name=f"{self._model_pk_name}-put",
@@ -188,7 +188,7 @@ def _register_patch_endpoint(self) -> None:
 
         patch_item = ModelEndpointFactory.patch(
             path=_path,
-            lookup_field=self._model_pk_name,
+            lookup_param=self._model_pk_name,
             schema_out=self._retrieve_schema,  # type: ignore[arg-type]
             schema_in=self._patch_schema,  # type: ignore[arg-type]
             url_name=f"{self._model_pk_name}-patch",
@@ -206,7 +206,7 @@ def _register_find_one_endpoint(self) -> None:
 
         get_item = ModelEndpointFactory.retrieve(
             path=_path,
-            lookup_field=self._model_pk_name,
+            lookup_param=self._model_pk_name,
             schema_out=self._retrieve_schema,  # type: ignore[arg-type]
             url_name=f"{self._model_pk_name}-get-item",
             description=f"""Get {self._model_name} item by {self._model_pk_name}""",
@@ -216,16 +216,21 @@ def _register_find_one_endpoint(self) -> None:
         self._add_to_controller(get_item)
 
     def _register_list_endpoint(self) -> None:
-        paginate_kwargs: t.Dict[str, t.Any] = {}
-
-        if self._config.pagination.paginate_by:
-            paginate_kwargs.update(page_size=self._config.pagination.paginate_by)
+        paginate_kwargs: t.Dict[str, t.Any] = {
+            "pagination_class": None,
+            "pagination_response_schema": None,
+        }
+        if self._config.pagination:
+            paginate_kwargs.update(
+                pagination_class=self._config.pagination.klass,
+                pagination_response_schema=self._config.pagination.pagination_schema,
+            )
+            if self._config.pagination.paginator_kwargs:
+                paginate_kwargs.update(self._config.pagination.paginator_kwargs)
 
         list_items = ModelEndpointFactory.list(
             path="/",
             schema_out=self._retrieve_schema,  # type: ignore[arg-type]
-            pagination_class=self._config.pagination.klass,
-            pagination_response_schema=self._config.pagination.pagination_schema,
             description=f"List {self._model_name} model items",
             url_name=f"{self._model_pk_name}-list",
             summary="List Items",
@@ -242,7 +247,7 @@ def _register_delete_endpoint(self) -> None:
 
         delete_item = ModelEndpointFactory.delete(
             path=_path,
-            lookup_field=self._model_pk_name,
+            lookup_param=self._model_pk_name,
             url_name=f"{self._model_pk_name}-delete",
             description=f"""Delete {self._model_name} item""",
             summary="Delete an item",
@@ -254,7 +259,7 @@ def register_model_routes(self) -> None:
         for action in self._config.allowed_routes:
             action_registration = getattr(self, f"_register_{action}_endpoint", None)
 
-            if not action_registration:
+            if not action_registration:  # pragma: no cover
                 raise Exception(
                     f"Route `{action}` action in `class[{self._base_cls.__name__}]` "
                     f"is not recognized as ModelController action"

ninja_extra/controllers/model/endpoints.py

@@ -207,7 +207,7 @@ def create_item(
             **kwargs: t.Any,
         ) -> t.Any:
             instance = (
-                custom_handler(self, **kwargs)
+                custom_handler(self, data, **kwargs)
                 if custom_handler
                 else self.service.create(data, **kwargs)
             )
@@ -220,7 +220,7 @@ def create_item(
     def update(
         cls,
         path: str,
-        lookup_field: str,
+        lookup_param: str,
         schema_in: t.Type[PydanticModel],
         schema_out: t.Type[PydanticModel],
         status_code: int = status.HTTP_200_OK,
@@ -270,7 +270,7 @@ def update_item(
             data: schema_in = Body(default=...),  # type:ignore[valid-type]
             **kwargs: t.Any,
         ) -> t.Any:
-            pk = kwargs.pop(lookup_field)
+            pk = kwargs.pop(lookup_param)
             obj = (
                 object_getter(self, pk=pk, **kwargs)
                 if object_getter
@@ -295,7 +295,7 @@ def update_item(
     def patch(
         cls,
         path: str,
-        lookup_field: str,
+        lookup_param: str,
         schema_in: t.Type[PydanticModel],
         schema_out: t.Type[PydanticModel],
         status_code: int = status.HTTP_200_OK,
@@ -324,7 +324,7 @@ def patch(
 
         @route.patch(
             working_path,
-            response={status_code: schema_in},
+            response={status_code: schema_out},
             url_name=url_name,
             description=description,
             operation_id=operation_id,
@@ -342,10 +342,10 @@ def patch(
         @cls._path_resolver(path)
         def patch_item(
             self: "ModelControllerBase",
-            data: schema_out = Body(default=...),  # type:ignore[valid-type]
+            data: schema_in = Body(default=...),  # type:ignore[valid-type]
             **kwargs: t.Any,
         ) -> t.Any:
-            pk = kwargs.pop(lookup_field)
+            pk = kwargs.pop(lookup_param)
             obj = (
                 object_getter(self, pk=pk, **kwargs)
                 if object_getter
@@ -368,7 +368,7 @@ def patch_item(
     def retrieve(
         cls,
         path: str,
-        lookup_field: str,
+        lookup_param: str,
         schema_out: t.Type[PydanticModel],
         status_code: int = status.HTTP_200_OK,
         url_name: t.Optional[str] = None,
@@ -412,7 +412,7 @@ def retrieve(
         )
         @cls._path_resolver(path)
         def get_item(self: "ModelControllerBase", **kwargs: t.Any) -> t.Any:
-            pk = kwargs.pop(lookup_field)
+            pk = kwargs.pop(lookup_param)
             obj = (
                 object_getter(self, pk=pk, **kwargs)
                 if object_getter
@@ -515,7 +515,7 @@ def list_items(self: "ModelControllerBase", **kwargs: t.Any) -> t.Any:
     def delete(
         cls,
         path: str,
-        lookup_field: str,
+        lookup_param: str,
         status_code: int = status.HTTP_204_NO_CONTENT,
         url_name: t.Optional[str] = None,
         description: t.Optional[str] = None,
@@ -559,7 +559,7 @@ def delete(
         )
         @cls._path_resolver(path)
         def delete_item(self: "ModelControllerBase", **kwargs: t.Any) -> t.Any:
-            pk = kwargs.pop(lookup_field)
+            pk = kwargs.pop(lookup_param)
             obj = (
                 object_getter(self, pk=pk, **kwargs)
                 if object_getter

ninja_extra/controllers/model/schemas.py

@@ -1,4 +1,4 @@
-from typing import Any, List, Optional, Set, Type, Union
+from typing import Any, Generic, List, Optional, Set, Type, Union
 
 from django.db.models import Model
 from ninja.pagination import PaginationBase
@@ -10,22 +10,26 @@
 
 class ModelPagination(PydanticModel):
     klass: Type[PaginationBase] = PageNumberPaginationExtra
-    paginate_by: Optional[int] = None
+    paginator_kwargs: Optional[dict] = None
     pagination_schema: Type[PydanticModel] = PaginatedResponseSchema
 
     @validator("klass", allow_reuse=True)
     def validate_klass(cls, value: Any) -> Any:
-        if not issubclass(PaginationBase, value):
-            raise ValueError(f"{value} is not of type `PaginationBase`")
-        return value
+        if isinstance(value, type) and issubclass(value, PaginationBase):
+            return value
+        raise ValueError(f"{value} is not of type `PaginationBase`")
 
     @validator("pagination_schema", allow_reuse=True)
     def validate_schema(cls, value: Any) -> Any:
-        if not issubclass(PydanticModel, value):
-            raise ValueError(
-                f"{value} is not a valid type. Please use a generic pydantic model."
-            )
-        return value
+        if (
+            isinstance(value, type)
+            and issubclass(value, PydanticModel)
+            and issubclass(value, Generic)  # type:ignore[arg-type]
+        ):
+            return value
+        raise ValueError(
+            f"{value} is not a valid type. Please use a generic pydantic model."
+        )
 
 
 class ModelSchemaConfig(PydanticModel):
@@ -55,7 +59,7 @@ class ModelConfig(PydanticModel):
     update_schema: Optional[Type[PydanticModel]] = None
     patch_schema: Optional[Type[PydanticModel]] = None
 
-    pagination: ModelPagination = Field(default=ModelPagination())
+    pagination: Optional[ModelPagination] = Field(default=ModelPagination())
     model: Type[Model]
 
     schema_config: ModelSchemaConfig = Field(default=ModelSchemaConfig(exclude=set()))
@@ -82,7 +86,6 @@ def validate_model(cls, value: Any) -> Any:
         allow_reuse=True,
     )
     def validate_schemas(cls, value: Any) -> Any:
-        if value:
-            if not issubclass(value, PydanticModel):
-                raise ValueError(f"{value} is not a valid pydantic type.")
+        if value and not issubclass(value, PydanticModel):
+            raise ValueError(f"{value} is not a valid pydantic type.")
         return value

ninja_extra/schemas/response.py

@@ -66,49 +66,6 @@ class RouteParameter(Schema):
     openapi_extra: Optional[Dict[str, Any]]
 
 
-# class ModelControllerSchema:
-#     dict: Callable
-#     config: BaseModel.Config
-#
-#     def perform_create(self, **kwargs: Any) -> Any:
-#         data = self.dict(by_alias=True)
-#         data.update(kwargs)
-#         model = cast(Model, self.config.model)
-#         try:
-#             instance = model._default_manager.create(**data)
-#             return instance
-#         except TypeError:
-#             tb = traceback.format_exc()
-#             msg = (
-#                 "Got a `TypeError` when calling `%s.%s.perform_create()`. "
-#                 "This may be because you have a writable field on the "
-#                 "serializer class that is not a valid argument to "
-#                 "`%s.%s.create()`. You may need to make the field "
-#                 "read-only, or override the %s.perform_create() method to handle "
-#                 "this correctly.\nOriginal exception was:\n %s"
-#                 % (
-#                     model.__name__,
-#                     model._default_manager.name,
-#                     model.__name__,
-#                     model._default_manager.name,
-#                     self.__class__.__name__,
-#                     tb,
-#                 )
-#             )
-#             raise TypeError(msg)
-#
-#     def perform_update(self, instance: Model, **kwargs: Any) -> Any:
-#         data = self.dict(exclude_none=True)
-#         data.update(kwargs)
-#         for attr, value in data.items():
-#             setattr(instance, attr, value)
-#         instance.save()
-#         return instance
-#
-#     def perform_patch(self, instance: Model, **kwargs: Any) -> Any:
-#         return self.perform_update(instance=instance, **kwargs)
-
-
 def __getattr__(name: str) -> Any:  # pragma: no cover
     if name in [
         "IdSchema",