django-ninja-aio-crud 2.11.0__tar.gz → 2.11.2__tar.gz

{django_ninja_aio_crud-2.11.0 → django_ninja_aio_crud-2.11.2}/PKG-INFO

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

django_ninja_aio_crud-2.11.2/docs/api/renderers/orjson_renderer.md

@@ -0,0 +1,57 @@
+# ORJSON Renderer
+
+This package uses an internal ORJSON-based renderer that automatically handles JSON serialization with support for special types.
+
+## Configuration
+
+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.
+
+## HttpResponse Passthrough
+
+The renderer automatically detects when you return a Django `HttpResponse` (or any `HttpResponseBase` subclass) and passes it through without JSON serialization. This allows you to return custom responses with different content types.
+
+```python
+from django.http import HttpResponse
+
+@api.get("/public-key")
+def get_public_key(request):
+    return HttpResponse(
+        settings.JWT_PUBLIC_KEY.as_pem(),
+        content_type="application/x-pem-file",
+        status=200,
+    )
+```
+
+This also works with `StreamingHttpResponse` for large files:
+
+```python
+from django.http import StreamingHttpResponse
+
+@api.get("/download")
+def download_file(request):
+    return StreamingHttpResponse(
+        file_iterator(),
+        content_type="application/octet-stream",
+    )
+```
+
+!!! note
+    When returning an `HttpResponse` directly, the response bypasses the renderer entirely. Set the `status` parameter on the `HttpResponse` itself rather than using a tuple return like `return 200, HttpResponse(...)`.

{django_ninja_aio_crud-2.11.0 → django_ninja_aio_crud-2.11.2}/ninja_aio/__init__.py

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

{django_ninja_aio_crud-2.11.0 → django_ninja_aio_crud-2.11.2}/ninja_aio/models/utils.py

@@ -601,7 +601,7 @@ class ModelUtil:
     async def _bump_object_from_schema(
         self, obj: type["ModelSerializer"] | models.Model, schema: Schema
     ):
-        return (await sync_to_async(schema.from_orm)(obj)).model_dump(mode="json")
+        return (await sync_to_async(schema.from_orm)(obj)).model_dump()
 
     def _validate_read_params(self, request: HttpRequest, query_data: QuerySchema):
         """Validate required parameters for read operations."""

{django_ninja_aio_crud-2.11.0 → django_ninja_aio_crud-2.11.2}/ninja_aio/renders.py

@@ -3,7 +3,7 @@ from ipaddress import IPv4Address, IPv6Address
 from typing import Any
 
 import orjson
-from django.http import HttpRequest
+from django.http import HttpRequest, HttpResponseBase
 from django.conf import settings
 from ninja.renderers import BaseRenderer
 from pydantic import AnyUrl
@@ -14,6 +14,8 @@ class ORJSONRenderer(BaseRenderer):
     option = getattr(settings, "NINJA_AIO_ORJSON_RENDERER_OPTION", None)
 
     def render(self, request: HttpRequest, data: dict, *, response_status):
+        if isinstance(data, HttpResponseBase):
+            return data
         try:
             old_d = data
             for k, v in old_d.items():

{django_ninja_aio_crud-2.11.0 → django_ninja_aio_crud-2.11.2}/tests/core/test_renderer_parser.py

@@ -1,6 +1,7 @@
 import base64
 from ipaddress import IPv4Address, IPv6Address
 
+from django.http import HttpResponse, StreamingHttpResponse
 from django.test import TestCase, tag
 import orjson
 from ninja_aio.renders import ORJSONRenderer
@@ -73,3 +74,25 @@ class ORJSONRendererParserTestCase(TestCase):
         rendered = self.renderer.render(DummyRequest(), int_data, response_status=200)
         decoded = orjson.loads(rendered)
         self.assertEqual(decoded, 42)
+
+    def test_renderer_http_response_passthrough(self):
+        """Test that renderer returns HttpResponse as-is without serialization."""
+        response = HttpResponse(
+            b"-----BEGIN PUBLIC KEY-----\ntest\n-----END PUBLIC KEY-----",
+            content_type="application/x-pem-file",
+            status=200,
+        )
+        rendered = self.renderer.render(DummyRequest(), response, response_status=200)
+        self.assertIs(rendered, response)
+        self.assertEqual(rendered.content, b"-----BEGIN PUBLIC KEY-----\ntest\n-----END PUBLIC KEY-----")
+        self.assertEqual(rendered["Content-Type"], "application/x-pem-file")
+
+    def test_renderer_streaming_http_response_passthrough(self):
+        """Test that renderer returns StreamingHttpResponse as-is."""
+        response = StreamingHttpResponse(
+            iter([b"chunk1", b"chunk2"]),
+            content_type="application/octet-stream",
+        )
+        rendered = self.renderer.render(DummyRequest(), response, response_status=200)
+        self.assertIs(rendered, response)
+        self.assertEqual(rendered["Content-Type"], "application/octet-stream")

django_ninja_aio_crud-2.11.0/docs/api/renderers/orjson_renderer.md

@@ -1,20 +0,0 @@
-# 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.