Refactored ModelController, moved crud operation to modelservice and moved model controller settings to model_config

Author: eadwinCode

.coveragerc

@@ -5,9 +5,10 @@ exclude_lines =
     def __str__
     if self.debug:
     if settings.DEBUG
+    if t.TYPE_CHECKING:
     raise AssertionError
     raise NotImplementedError
     if 0:
     if __name__ == .__main__.:
     class .*\bProtocol\):
-    @(abc\.)?abstractmethod
+    @(abc\.)?abstractmethod

ninja_extra/__init__.py

@@ -6,7 +6,13 @@
 
 from ninja_extra.controllers import (
     ControllerBase,
+    ModelConfig,
     ModelControllerBase,
+    ModelControllerBuilder,
+    ModelPagination,
+    ModelSchemeConfig,
+    ModelService,
+    ModelServiceBase,
     api_controller,
     http_delete,
     http_generic,
@@ -27,7 +33,6 @@
 
 
 __all__ = [
-    "ModelControllerBase",
     "ControllerBase",
     "api_controller",
     "NinjaExtraAPI",
@@ -48,4 +53,12 @@
     "Router",
     "throttle",
     "paginate",
+    "ModelControllerBase",
+    "ModelConfig",
+    "ModelService",
+    "ModelSchemeConfig",
+    "ModelControllerBuilder",
+    "ModelPagination",
+    "ModelServiceBase",
+    "ModelControllerBase",
 ]

ninja_extra/controllers/__init__.py

@@ -1,4 +1,12 @@
 from .base import ControllerBase, ModelControllerBase, api_controller
+from .model import (
+    ModelConfig,
+    ModelControllerBuilder,
+    ModelPagination,
+    ModelSchemeConfig,
+    ModelService,
+    ModelServiceBase,
+)
 from .response import Detail, Id, Ok
 from .route import (
     Route,
@@ -33,4 +41,10 @@
     "Detail",
     "RouteContext",
     "ModelControllerBase",
+    "ModelConfig",
+    "ModelService",
+    "ModelSchemeConfig",
+    "ModelControllerBuilder",
+    "ModelPagination",
+    "ModelServiceBase",
 ]

ninja_extra/controllers/base.py

@@ -1,8 +1,7 @@
 import inspect
 import re
-import traceback
 import uuid
-from abc import ABC, abstractmethod
+from abc import ABC
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -27,12 +26,9 @@
 from injector import inject, is_decorated_with_inject
 from ninja import NinjaAPI, Router
 from ninja.constants import NOT_SET
-from ninja.pagination import PaginationBase
 from ninja.security.base import AuthBase
 from ninja.signature import is_async
 from ninja.utils import normalize_path
-from pydantic import BaseModel as PydanticModel
-from pydantic import Field, validator
 
 from ninja_extra.constants import ROUTE_FUNCTION, THROTTLED_FUNCTION
 from ninja_extra.exceptions import APIException, NotFound, PermissionDenied, bad_request
@@ -47,8 +43,7 @@
 )
 from ninja_extra.types import PermissionType
 
-from ..pagination import PageNumberPaginationExtra, PaginatedResponseSchema
-from .model_controller_builder import ModelControllerBuilder
+from .model import ModelConfig, ModelControllerBuilder, ModelService
 from .registry import ControllerRegistry
 from .response import Detail, Id, Ok
 from .route.route_functions import AsyncRouteFunction, RouteFunction
@@ -226,154 +221,8 @@ def create_response(
         )
 
 
-class ModelServiceBase(ABC):
-    @abstractmethod
-    def get_one(self, pk: Any) -> Any:
-        pass
-
-    @abstractmethod
-    def get_all(self) -> QuerySet:
-        pass
-
-    @abstractmethod
-    def create(self, schema: PydanticModel, **kwargs: Any) -> Any:
-        pass
-
-    @abstractmethod
-    def update(self, instance: Model, schema: PydanticModel, **kwargs: Any) -> Any:
-        pass
-
-    @abstractmethod
-    def patch(self, instance: Model, schema: PydanticModel, **kwargs: Any) -> Any:
-        pass
-
-    @abstractmethod
-    def delete(self, instance: Model) -> Any:
-        pass
-
-
-class ModelService(ModelServiceBase):
-    def __init__(self, model: Type[Model]) -> None:
-        self.model = model
-
-    def get_one(self, pk: Any) -> Any:
-        obj = get_object_or_exception(
-            klass=self.model, error_message=None, exception=NotFound, pk=pk
-        )
-        return obj
-
-    def get_all(self) -> QuerySet:
-        return self.model.objects.all()
-
-    def create(self, schema: PydanticModel, **kwargs: Any) -> Any:
-        data = schema.dict(by_alias=True)
-        data.update(kwargs)
-
-        try:
-            instance = self.model._default_manager.create(**data)
-            return instance
-        except TypeError as tex:
-            tb = traceback.format_exc()
-            msg = (
-                "Got a `TypeError` when calling `%s.%s.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.create() method to handle "
-                "this correctly.\nOriginal exception was:\n %s"
-                % (
-                    self.model.__name__,
-                    self.model._default_manager.name,
-                    self.model.__name__,
-                    self.model._default_manager.name,
-                    self.__class__.__name__,
-                    tb,
-                )
-            )
-            raise TypeError(msg) from tex
-
-    def update(self, instance: Model, schema: PydanticModel, **kwargs: Any) -> Any:
-        data = schema.dict(exclude_none=True)
-        data.update(kwargs)
-        for attr, value in data.items():
-            setattr(instance, attr, value)
-        instance.save()
-        return instance
-
-    def patch(self, instance: Model, schema: PydanticModel, **kwargs: Any) -> Any:
-        return self.update(instance=instance, schema=schema, **kwargs)
-
-    def delete(self, instance: Model) -> Any:
-        instance.delete()
-
-
-class ModelConfigSchema(Tuple):
-    in_schema: Type[PydanticModel]
-    out_schema: Optional[Type[PydanticModel]]
-
-    def get_out_schema(self) -> Type[PydanticModel]:
-        if not self.out_schema:
-            return self.in_schema
-        return self.out_schema
-
-
-class ModelPagination(PydanticModel):
-    klass: Type[PaginationBase] = PageNumberPaginationExtra
-    paginate_by: Optional[int] = None
-    schema: Type[PydanticModel] = PaginatedResponseSchema
-
-    @validator("klass")
-    def validate_klass(cls, value: Any) -> Any:
-        if not issubclass(PaginationBase, value):
-            raise ValueError(f"{value} is not of type `PaginationBase`")
-        return value
-
-    @validator(
-        "schema",
-    )
-    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
-
-
-class ModelConfig(PydanticModel):
-    allowed_routes: List[str] = Field(
-        [
-            "create",
-            "read",
-            "update",
-            "patch",
-            "delete",
-            "list",
-        ]
-    )
-    create_schema: ModelConfigSchema
-    update_schema: ModelConfigSchema
-    patch_schema: Optional[ModelConfigSchema] = None
-    retrieve_schema: Type[PydanticModel]
-    pagination: ModelPagination = Field(default=ModelPagination())
-    model: Type[Model]
-
-    @validator("allowed_routes")
-    def validate_allow_routes(cls, value: List[Any]) -> Any:
-        defaults = ["create", "read", "update", "patch", "delete", "list"]
-        for item in value:
-            if item not in defaults:
-                raise ValueError(f"{item} action is not recognized in {defaults}")
-        return value
-
-    @validator("model")
-    def validate_model(cls, value: Any) -> Any:
-        if value and hasattr(value, "objects"):
-            return value
-        raise ValueError(f"{value} is not a valid Django model.")
-
-
 class ModelControllerBase(ControllerBase):
-    service: Optional[ModelService] = None
+    service: ModelService
     model_config: Optional[ModelConfig] = None
 
 
@@ -498,7 +347,7 @@ def __call__(self, cls: Type) -> Union[Type, Type["ControllerBase"]]:
         if issubclass(cls, ModelControllerBase):
             if cls.model_config:
                 # if model_config is not provided, treat controller class as normal
-                builder = ModelControllerBuilder(cls.model_config, self)
+                builder = ModelControllerBuilder(cls, self)
                 builder.register_model_routes()
                 # We create a global service for handle CRUD Operations at class level
                 # giving room for it to be changed at instance level through Dependency injection

ninja_extra/controllers/model/__init__.py

@@ -0,0 +1,13 @@
+from .builder import ModelControllerBuilder
+from .interfaces import ModelServiceBase
+from .schemas import ModelConfig, ModelPagination, ModelSchemeConfig
+from .service import ModelService
+
+__all__ = [
+    "ModelServiceBase",
+    "ModelService",
+    "ModelConfig",
+    "ModelSchemeConfig",
+    "ModelPagination",
+    "ModelControllerBuilder",
+]