django-ninja-aio-crud 2.0.0rc5__tar.gz → 2.0.0rc7__tar.gz

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/.github/workflows/docs.yml

@@ -34,10 +34,10 @@ jobs:
     if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.0.0rc5
+Version: 2.0.0rc7
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
 Requires-Python: >=3.10

django_ninja_aio_crud-2.0.0rc7/docs/api/renderers/orjson_renderer.md

@@ -0,0 +1,20 @@
+# ORJSON renderer option
+
+This package uses an internal ORJSON-based renderer. Configure serialization options via Django settings:
+
+```python
+# settings.py
+import orjson
+
+# Single option
+NINJA_AIO_ORJSON_RENDERER_OPTION = orjson.OPT_INDENT_2
+
+# Multiple options (bitwise OR)
+NINJA_AIO_ORJSON_RENDERER_OPTION = (
+    orjson.OPT_INDENT_2 | orjson.OPT_NON_STR_KEYS
+)
+```
+
+Notes:
+- The value is an orjson option bitmask (e.g., `orjson.OPT_INDENT_2`, `orjson.OPT_NON_STR_KEYS`), and you can combine multiple options using `|`.
+- If not set, the default `orjson.dumps` options are used.

django_ninja_aio_crud-2.0.0rc7/docs/api/views/decorators.md

@@ -0,0 +1,65 @@
+# View decorators
+
+This package provides:
+
+- decorate_view: compose multiple decorators (sync/async views), preserving Python stacking order, and skipping None values.
+- APIViewSet.extra_decorators: declarative per-operation decorators.
+
+## decorate_view
+
+Behavior:
+
+- Order matches normal stacking: `@d1` over `@d2` ≡ `d1(d2(view))`.
+- Works with sync/async views.
+- Ignores None values, useful for conditional decoration.
+
+Example:
+
+```python
+from ninja_aio.decorators import decorate_view
+from ninja_aio.views import APIViewSet
+
+class MyViewSet(APIViewSet):
+    api = api
+    model = MyModel
+
+    def views(self):
+        @self.router.get("health/")
+        @decorate_view(authenticate, log_request)
+        async def health(request):
+            return {"ok": True}
+```
+
+Conditional decoration:
+
+```python
+cache_dec = cache_page(60) if settings.ENABLE_CACHE else None
+
+@self.router.get("data/")
+@decorate_view(cache_dec, authenticate)
+async def data(request):
+    ...
+```
+
+Note: decorate_view does not add an extra wrapper; each decorator should preserve metadata itself (e.g., functools.wraps).
+
+## APIViewSet.extra_decorators
+
+Attach decorators to CRUD operations without redefining views:
+
+```python
+from ninja_aio.schemas.helpers import DecoratorsSchema
+
+class MyViewSet(APIViewSet):
+    api = api
+    model = MyModel
+    extra_decorators = DecoratorsSchema(
+        list=[require_auth, cache_page(30)],
+        retrieve=[require_auth],
+        create=[require_auth],
+        update=[require_auth],
+        delete=[require_auth],
+    )
+```
+
+These are applied in combination with built-ins (e.g., unique_view, paginate) using decorate_view in the implementation.

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/ninja_aio/__init__.py

@@ -1,6 +1,6 @@
 """Django Ninja AIO CRUD - Rest Framework"""
 
-__version__ = "2.0.0-rc5"
+__version__ = "2.0.0-rc7"
 
 from .api import NinjaAIO
 

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/ninja_aio/decorators.py

@@ -143,3 +143,76 @@ def unique_view(self: object | str, plural: bool = False):
         return func  # Return original function (no wrapper)
 
     return decorator
+
+
+def decorate_view(*decorators):
+    """
+    Compose and apply multiple decorators to a view (sync or async) without adding an extra wrapper.
+
+    This utility was introduced to support class-based patterns where Django Ninja’s
+    built-in `decorate_view` does not fit well. For APIs implemented with vanilla
+    Django Ninja (function-based style), you should continue using Django Ninja’s
+    native `decorate_view`.
+
+    Behavior:
+    - Applies decorators in the same order as Python’s stacking syntax:
+        @d1
+        @d2
+      is equivalent to: view = d1(d2(view))
+    - Supports both synchronous and asynchronous views.
+    - Ignores None values, enabling conditional decoration.
+    - Does not introduce an additional wrapper; composition depends on each
+      decorator for signature/metadata preservation (e.g., using functools.wraps).
+
+        *decorators: Decorator callables to apply to the target view. Any None values
+            are skipped.
+
+        Callable: A decorator that applies the provided decorators in Python stacking order.
+
+        Method usage in class-based patterns:
+
+    Args:
+        *decorators: Decorator callables to apply to the target view. Any None
+            values are skipped.
+
+    Returns:
+        A decorator that applies the provided decorators in Python stacking order.
+
+    Examples:
+        Basic usage:
+            class MyAPIViewSet(APIViewSet):
+                api = api
+                model = MyModel
+
+                def views(self):
+                    @self.router.get('some-endpoint/')
+                    @decorate_view(authenticate, log_request)
+                    async def some_view(request):
+                        ...
+        
+        Conditional decoration (skips None):
+            class MyAPIViewSet(APIViewSet):
+                api = api
+                model = MyModel
+                cache_dec = cache_page(60) if settings.ENABLE_CACHE else None
+                def views(self):
+                    @self.router.get('data/')
+                    @decorate_view(self.cache_dec, authenticate)
+                    async def data_view(request):
+                        ...
+
+    Notes:
+        - Each decorator is applied in the order provided, with the first decorator
+          wrapping the result of the second, and so on.
+        - Ensure that each decorator is compatible with the view’s sync/async nature.
+    """
+
+    def _decorator(view):
+        wrapped = view
+        for dec in reversed(decorators):
+            if dec is None:
+                continue
+            wrapped = dec(wrapped)
+        return wrapped
+
+    return _decorator

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/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]:

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/ninja_aio/schemas/helpers.py

@@ -1,4 +1,4 @@
-from typing import Optional, Type
+from typing import List, Optional, Type
 
 from ninja import Schema
 from ninja_aio.types import ModelSerializerMeta
@@ -79,4 +79,12 @@ class QuerySchema(ModelQuerySetSchema):
 
 class QueryUtilBaseScopesSchema(BaseModel):
     READ: str = "read"
-    QUERYSET_REQUEST: str = "queryset_request"
+    QUERYSET_REQUEST: str = "queryset_request"
+
+
+class DecoratorsSchema(Schema):
+    list: Optional[List] = []
+    retrieve: Optional[List] = []
+    create: Optional[List] = []
+    update: Optional[List] = []
+    delete: Optional[List] = []

{django_ninja_aio_crud-2.0.0rc5 → django_ninja_aio_crud-2.0.0rc7}/ninja_aio/views.py

@@ -7,7 +7,7 @@ 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
+from ninja_aio.schemas.helpers import ModelQuerySetSchema, QuerySchema, DecoratorsSchema
 
 from .models import ModelSerializer, ModelUtil
 from .schemas import (
@@ -16,7 +16,7 @@ from .schemas import (
 )
 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})
 
@@ -178,6 +178,7 @@ 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
@@ -309,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)
 
@@ -330,8 +331,11 @@ 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
@@ -359,7 +363,7 @@ 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
             query_data = self._get_query_data()
             return await self.model_util.read_s(
@@ -384,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
@@ -408,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))