django-ninja-aio-crud 1.0.5__py3-none-any.whl → 2.0.0__py3-none-any.whl

ninja_aio/renders.py

@@ -4,11 +4,13 @@ from typing import Any
 
 import orjson
 from django.http import HttpRequest
+from django.conf import settings
 from ninja.renderers import BaseRenderer
 
 
 class ORJSONRenderer(BaseRenderer):
     media_type = "application/json"
+    option = getattr(settings, "NINJA_AIO_ORJSON_RENDERER_OPTION", None)
 
     def render(self, request: HttpRequest, data: dict, *, response_status):
         try:
@@ -16,9 +18,13 @@ class ORJSONRenderer(BaseRenderer):
             for k, v in old_d.items():
                 if isinstance(v, list):
                     data |= {k: self.render_list(v)}
-            return orjson.dumps(self.render_dict(data))
+            return self.dumps(self.render_dict(data))
         except AttributeError:
-            return orjson.dumps(data)
+            return self.dumps(data)
+
+    @classmethod
+    def dumps(cls, data: dict) -> bytes:
+        return orjson.dumps(data, option=cls.option)
 
     @classmethod
     def render_list(cls, data: list[dict]) -> list[dict]:

ninja_aio/schemas/__init__.py

@@ -0,0 +1,23 @@
+from .generics import GenericMessageSchema
+from .api import (
+    M2MDetailSchema,
+    M2MSchemaOut,
+    M2MAddSchemaIn,
+    M2MRemoveSchemaIn,
+    M2MSchemaIn,
+)
+from .helpers import M2MRelationSchema, QuerySchema, ModelQuerySetSchema, ObjectQuerySchema, ObjectsQuerySchema
+
+__all__ = [
+    "GenericMessageSchema",
+    "M2MDetailSchema",
+    "M2MSchemaOut",
+    "M2MAddSchemaIn",
+    "M2MRemoveSchemaIn",
+    "M2MSchemaIn",
+    "M2MRelationSchema",
+    "QuerySchema",
+    "ModelQuerySetSchema",
+    "ObjectQuerySchema",
+    "ObjectsQuerySchema",
+]

ninja_aio/schemas/api.py

@@ -0,0 +1,24 @@
+from ninja import Schema
+
+
+class M2MDetailSchema(Schema):
+    count: int
+    details: list[str]
+
+
+class M2MSchemaOut(Schema):
+    errors: M2MDetailSchema
+    results: M2MDetailSchema
+
+
+class M2MAddSchemaIn(Schema):
+    add: list = []
+
+
+class M2MRemoveSchemaIn(Schema):
+    remove: list = []
+
+
+class M2MSchemaIn(Schema):
+    add: list = []
+    remove: list = []

ninja_aio/schemas/generics.py

@@ -0,0 +1,5 @@
+from pydantic import RootModel
+
+
+class GenericMessageSchema(RootModel[dict[str, str]]):
+    root: dict[str, str]

ninja_aio/{schemas.py → schemas/helpers.py}

@@ -1,36 +1,9 @@
-from typing import Optional, Type
+from typing import List, Optional, Type
 
 from ninja import Schema
-from .models import ModelSerializer
+from ninja_aio.types import ModelSerializerMeta
 from django.db.models import Model
-from pydantic import BaseModel, RootModel, ConfigDict, model_validator
-
-
-class GenericMessageSchema(RootModel[dict[str, str]]):
-    root: dict[str, str]
-
-
-class M2MDetailSchema(Schema):
-    count: int
-    details: list[str]
-
-
-class M2MSchemaOut(Schema):
-    errors: M2MDetailSchema
-    results: M2MDetailSchema
-
-
-class M2MAddSchemaIn(Schema):
-    add: list = []
-
-
-class M2MRemoveSchemaIn(Schema):
-    remove: list = []
-
-
-class M2MSchemaIn(Schema):
-    add: list = []
-    remove: list = []
+from pydantic import BaseModel, ConfigDict, model_validator
 
 
 class M2MRelationSchema(BaseModel):
@@ -55,7 +28,7 @@ class M2MRelationSchema(BaseModel):
         )
     """
 
-    model: Type[ModelSerializer] | Type[Model]
+    model: ModelSerializerMeta | Type[Model]
     related_name: str
     add: bool = True
     remove: bool = True
@@ -74,9 +47,44 @@ class M2MRelationSchema(BaseModel):
         if related_schema is not None:
             return data
         model = data.get("model")
-        if not issubclass(model, ModelSerializer):
+        if not isinstance(model, ModelSerializerMeta):
             raise ValueError(
                 "related_schema must be provided if model is not a ModelSerializer",
             )
         data["related_schema"] = model.generate_related_s()
         return data
+
+
+class ModelQuerySetSchema(BaseModel):
+    select_related: Optional[list[str]] = []
+    prefetch_related: Optional[list[str]] = []
+
+
+class ModelQuerySetExtraSchema(ModelQuerySetSchema):
+    scope: str
+
+
+class ObjectQuerySchema(ModelQuerySetSchema):
+    getters: Optional[dict] = {}
+
+
+class ObjectsQuerySchema(ModelQuerySetSchema):
+    filters: Optional[dict] = {}
+
+
+class QuerySchema(ModelQuerySetSchema):
+    filters: Optional[dict] = {}
+    getters: Optional[dict] = {}
+
+
+class QueryUtilBaseScopesSchema(BaseModel):
+    READ: str = "read"
+    QUERYSET_REQUEST: str = "queryset_request"
+
+
+class DecoratorsSchema(Schema):
+    list: Optional[List] = []
+    retrieve: Optional[List] = []
+    create: Optional[List] = []
+    update: Optional[List] = []
+    delete: Optional[List] = []

ninja_aio/views.py

@@ -7,14 +7,16 @@ from django.http import HttpRequest
 from django.db.models import Model, QuerySet
 from pydantic import create_model
 
+from ninja_aio.schemas.helpers import ModelQuerySetSchema, QuerySchema, DecoratorsSchema
+
 from .models import ModelSerializer, ModelUtil
 from .schemas import (
     GenericMessageSchema,
     M2MRelationSchema,
 )
-from .helpers import ManyToManyAPI
+from .helpers.api import ManyToManyAPI
 from .types import ModelSerializerMeta, VIEW_TYPES
-from .decorators import unique_view
+from .decorators import unique_view, decorate_view
 
 ERROR_CODES = frozenset({400, 401, 404, 428})
 
@@ -156,6 +158,7 @@ class APIViewSet:
 
     model: ModelSerializer | Model
     api: NinjaAPI
+    router_tag: str = ""
     schema_in: Schema | None = None
     schema_out: Schema | None = None
     schema_update: Schema | None = None
@@ -175,15 +178,22 @@ class APIViewSet:
     delete_docs = "Delete an object by its primary key."
     m2m_relations: list[M2MRelationSchema] = []
     m2m_auth: list | None = NOT_SET
+    extra_decorators: DecoratorsSchema = DecoratorsSchema()
 
     def __init__(self) -> None:
         self.error_codes = ERROR_CODES
-        self.model_util = ModelUtil(self.model)
+        self.model_util = (
+            ModelUtil(self.model)
+            if not isinstance(self.model, ModelSerializerMeta)
+            else self.model.util
+        )
         self.schema_out, self.schema_in, self.schema_update = self.get_schemas()
         self.path_schema = self._generate_path_schema()
         self.filters_schema = self._generate_filters_schema()
         self.model_verbose_name = self.model._meta.verbose_name.capitalize()
-        self.router_tag = self.model_verbose_name
+        self.router_tag = (
+            self.model_verbose_name if not self.router_tag else self.router_tag
+        )
         self.router = Router(tags=[self.router_tag])
         self.path = "/"
         self.get_path = ""
@@ -241,7 +251,7 @@ class APIViewSet:
         Schema containing only the primary key field for path resolution.
         """
         return self._generate_schema(
-            {self.model_util.model_pk_name: (int | str, ...)}, "PathSchema"
+            {self.model_util.model_pk_name: self.model_util.pk_field_type}, "PathSchema"
         )
 
     def _generate_filters_schema(self):
@@ -256,6 +266,16 @@ class APIViewSet:
         """
         return data.model_dump()[self.model_util.model_pk_name]
 
+    def _get_query_data(self) -> ModelQuerySetSchema:
+        """
+        Return default query data for list/retrieve views.
+        """
+        return (
+            ModelQuerySetSchema()
+            if not isinstance(self.model, ModelSerializerMeta)
+            else self.model.query_util.read_config
+        )
+
     def get_schemas(self):
         """
         Return (schema_out, schema_in, schema_update), generating them if model is a ModelSerializer.
@@ -290,7 +310,7 @@ class APIViewSet:
             description=self.create_docs,
             response={201: self.schema_out, self.error_codes: GenericMessageSchema},
         )
-        @unique_view(self)
+        @decorate_view(unique_view(self), *self.extra_decorators.create)
         async def create(request: HttpRequest, data: self.schema_in):  # type: ignore
             return 201, await self.model_util.create_s(request, data, self.schema_out)
 
@@ -311,25 +331,23 @@ class APIViewSet:
                 self.error_codes: GenericMessageSchema,
             },
         )
-        @unique_view(self, plural=True)
-        @paginate(self.pagination_class)
+        @decorate_view(
+            paginate(self.pagination_class),
+            unique_view(self, plural=True),
+            *self.extra_decorators.list,
+        )
         async def list(
             request: HttpRequest,
             filters: Query[self.filters_schema] = None,  # type: ignore
         ):
-            qs = self.model.objects.select_related()
-            if isinstance(self.model, ModelSerializerMeta):
-                qs = await self.model.queryset_request(request)
-            rels = self.model_util.get_reverse_relations()
-            if len(rels) > 0:
-                qs = qs.prefetch_related(*rels)
+            qs = await self.model_util.get_objects(
+                request,
+                query_data=self._get_query_data(),
+                is_for_read=True,
+            )
             if filters is not None:
                 qs = await self.query_params_handler(qs, filters.model_dump())
-            objs = [
-                await self.model_util.read_s(request, obj, self.schema_out)
-                async for obj in qs.all()
-            ]
-            return objs
+            return await self.model_util.list_read_s(self.schema_out, request, qs)
 
         return list
 
@@ -345,10 +363,16 @@ class APIViewSet:
             description=self.retrieve_docs,
             response={200: self.schema_out, self.error_codes: GenericMessageSchema},
         )
-        @unique_view(self)
+        @decorate_view(unique_view(self), *self.extra_decorators.retrieve)
         async def retrieve(request: HttpRequest, pk: Path[self.path_schema]):  # type: ignore
-            obj = await self.model_util.get_object(request, self._get_pk(pk))
-            return await self.model_util.read_s(request, obj, self.schema_out)
+            query_data = self._get_query_data()
+            return await self.model_util.read_s(
+                self.schema_out,
+                request,
+                query_data=QuerySchema(
+                    getters={"pk": self._get_pk(pk)}, **query_data.model_dump()
+                ),
+            )
 
         return retrieve
 
@@ -364,7 +388,7 @@ class APIViewSet:
             description=self.update_docs,
             response={200: self.schema_out, self.error_codes: GenericMessageSchema},
         )
-        @unique_view(self)
+        @decorate_view(unique_view(self), *self.extra_decorators.update)
         async def update(
             request: HttpRequest,
             data: self.schema_update,  # type: ignore
@@ -388,7 +412,7 @@ class APIViewSet:
             description=self.delete_docs,
             response={204: None, self.error_codes: GenericMessageSchema},
         )
-        @unique_view(self)
+        @decorate_view(unique_view(self), *self.extra_decorators.delete)
         async def delete(request: HttpRequest, pk: Path[self.path_schema]):  # type: ignore
             return 204, await self.model_util.delete_s(request, self._get_pk(pk))
 

django_ninja_aio_crud-1.0.5.dist-info/RECORD

@@ -1,17 +0,0 @@
-ninja_aio/__init__.py,sha256=_Euc356-ScYsaVY9gvZ7xLRgTfnHKXk0pv69eFhjdJg,119
-ninja_aio/api.py,sha256=Fe6l3YCy7MW5TY4-Lbl80CFuK2NT2Y7tHfmqPk6Mqak,1735
-ninja_aio/auth.py,sha256=zUwruKcz7MXuOnWp5k1CCSwEc8s2Lyqqk7Qm9kPbJ3o,5149
-ninja_aio/decorators.py,sha256=LsvHbMxmw_So8NV0ey5NRRvSbfYkOZLeLQ4Fix7rQAY,5519
-ninja_aio/exceptions.py,sha256=1-iRbrloIyi0CR6Tcrn5YR4_LloA7PPohKIBaxXJ0-8,2596
-ninja_aio/models.py,sha256=fsFYjKFZb8MDpE1g3Nte-Dot4x7ofmuxIDi8qtkWu0o,35422
-ninja_aio/parsers.py,sha256=e_4lGCPV7zs-HTqtdJTc8yQD2KPAn9njbL8nF_Mmgkc,153
-ninja_aio/renders.py,sha256=5TdSQI8e4x3Gb2tAw1AaxrbU-asVjf2chWMr8x2Tt80,1485
-ninja_aio/schemas.py,sha256=sYxhovFq6nE_Gdx_yl1ufcuHBAXxpsnBmNytyTSqFLI,2449
-ninja_aio/types.py,sha256=TJSGlA7bt4g9fvPhJ7gzH5tKbLagPmZUzfgttEOp4xs,468
-ninja_aio/views.py,sha256=31pyOzABHwO1jcIVJRHXVrpMu9__FHmdX2vEhX6XrPs,15890
-ninja_aio/helpers/__init__.py,sha256=E45h2prtpCudx_bSKkIDMNK9oxrHPDJrweXWCuLxUOs,59
-ninja_aio/helpers/api.py,sha256=VW5C4hQl2flYhGPgVJ2ZkFK1tGMdNOaxVWJfZfLd7OY,17171
-django_ninja_aio_crud-1.0.5.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
-django_ninja_aio_crud-1.0.5.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_ninja_aio_crud-1.0.5.dist-info/METADATA,sha256=V6cJgV_yDqLnEtG1FKbQR0fdmGE6okwPChkwEkyfNzs,8570
-django_ninja_aio_crud-1.0.5.dist-info/RECORD,,