django-ninja-aio-crud 0.1.4__tar.gz → 0.2.1__tar.gz

{django_ninja_aio_crud-0.1.4 → django_ninja_aio_crud-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-ninja-aio-crud
-Version: 0.1.4
+Version: 0.2.1
 Summary: Django Ninja AIO CRUD - Rest Framework 
 Author: Giuseppe Casillo
 Requires-Python: >=3.10
@@ -130,20 +130,21 @@ class Foo(ModelSerializer):
 
 - post create method is a custom method that comes out to handle actions which will be excuted after that the object is created. It can be used, indeed, for example to handle custom fields' actions.
 
+
 ### APIViewSet
 
-- View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAPI class. As Parser and Render of the API you must use ninja_aio built-in classes which will serialize data using orjson.
+- View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAIO class. NinjaAIO class uses built-in parser and renderer which use orjson for data serialization.
 
 ```Python
 # views.py
-from ninja import NinjAPI
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):
@@ -158,14 +159,15 @@ FooAPI().add_views_to_route()
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class ExampleSchemaOut(Schema):
@@ -196,12 +198,13 @@ FooAPI().add_views_to_route()
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIView
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class ExampleSchemaOut(Schema):
@@ -228,10 +231,7 @@ SumView().add_views_to_route()
 ```
 
 ### Relations
-- You can also set ForeignKey and OneToOne relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
-
-> [!WARNING]
-> Only ForeignKey and OneToOne relations are supported for serialization, ManyToMany relations are not supported yet.
+- You can also set ForeignKey, OneToOne and ManyToMany relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
 
 - Define models:
 
@@ -270,14 +270,14 @@ class Foo(ModelSerializer):
 
 ```Python
 # views.py
-from ninja import NinjAPI
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo, Bar
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):
@@ -336,14 +336,15 @@ class CustomJWTBearer(AsyncJWTBearer):
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet, APIView
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):

{django_ninja_aio_crud-0.1.4 → django_ninja_aio_crud-0.2.1}/README.md

@@ -101,20 +101,21 @@ class Foo(ModelSerializer):
 
 - post create method is a custom method that comes out to handle actions which will be excuted after that the object is created. It can be used, indeed, for example to handle custom fields' actions.
 
+
 ### APIViewSet
 
-- View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAPI class. As Parser and Render of the API you must use ninja_aio built-in classes which will serialize data using orjson.
+- View class used to automatically generate CRUD views. in your views.py import APIViewSet and define your api using NinjaAIO class. NinjaAIO class uses built-in parser and renderer which use orjson for data serialization.
 
 ```Python
 # views.py
-from ninja import NinjAPI
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):
@@ -129,14 +130,15 @@ FooAPI().add_views_to_route()
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class ExampleSchemaOut(Schema):
@@ -167,12 +169,13 @@ FooAPI().add_views_to_route()
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIView
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class ExampleSchemaOut(Schema):
@@ -199,10 +202,7 @@ SumView().add_views_to_route()
 ```
 
 ### Relations
-- You can also set ForeignKey and OneToOne relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
-
-> [!WARNING]
-> Only ForeignKey and OneToOne relations are supported for serialization, ManyToMany relations are not supported yet.
+- You can also set ForeignKey, OneToOne and ManyToMany relations into serialization(reverse relations are supported too). Django ninja aio crud will serialize every of these relation automatically.
 
 - Define models:
 
@@ -241,14 +241,14 @@ class Foo(ModelSerializer):
 
 ```Python
 # views.py
-from ninja import NinjAPI
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo, Bar
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):
@@ -307,14 +307,15 @@ class CustomJWTBearer(AsyncJWTBearer):
 
 ```Python
 # views.py
-from ninja import NinjAPI, Schema
+from ninja import Schema
+from ninja_aio import NinjaAIO
 from ninja_aio.views import APIViewSet, APIView
 from ninja_aio.parsers import ORJSONParser
 from ninja_aio.renders import ORJSONRender
 
 from .models import Foo
 
-api = NinjaAPI(renderer=ORJSONRenderer(), parser=ORJSONParser())
+api = NinjaAIO()
 
 
 class FooAPI(APIViewSet):

django_ninja_aio_crud-0.2.1/ninja_aio/__init__.py

@@ -0,0 +1,7 @@
+""" Django Ninja AIO CRUD - Rest Framework """
+
+__version__ = "0.2.1"
+
+from .api import NinjaAIO
+
+__all__ = ["NinjaAIO"]

django_ninja_aio_crud-0.2.1/ninja_aio/api.py

@@ -0,0 +1,48 @@
+from typing import Any, Sequence
+
+from ninja.router import Router
+from ninja.throttling import BaseThrottle
+from ninja import NinjaAPI
+from ninja.openapi.docs import DocsBase, Swagger
+from ninja.constants import NOT_SET, NOT_SET_TYPE
+
+from ninja_aio.parsers import ORJSONParser
+from ninja_aio.renders import ORJSONRenderer
+
+
+class NinjaAIO(NinjaAPI):
+    def __init__(
+        self,
+        title: str = "NinjaAPI",
+        version: str = "1.0.0",
+        description: str = "",
+        openapi_url: str | None = "/openapi.json",
+        docs: DocsBase = Swagger(),
+        docs_url: str | None = "/docs",
+        docs_decorator = None,
+        servers: list[dict[str, Any]] | None = None,
+        urls_namespace: str | None = None,
+        csrf: bool = False,
+        auth: Sequence[Any]| NOT_SET_TYPE = NOT_SET,
+        throttle: BaseThrottle | list[BaseThrottle] | NOT_SET_TYPE = NOT_SET,
+        default_router: Router | None = None,
+        openapi_extra: dict[str, Any] | None = None
+    ):
+        super().__init__(
+            title=title,
+            version=version,
+            description=description,
+            openapi_url=openapi_url,
+            docs=docs,
+            docs_url=docs_url,
+            docs_decorator=docs_decorator,
+            servers=servers,
+            urls_namespace=urls_namespace,
+            csrf=csrf,
+            auth=auth,
+            throttle=throttle,
+            default_router=default_router,
+            openapi_extra=openapi_extra,
+            renderer=ORJSONRenderer(),
+            parser=ORJSONParser(),
+        )

{django_ninja_aio_crud-0.1.4 → django_ninja_aio_crud-0.2.1}/ninja_aio/models.py

@@ -7,10 +7,10 @@ from ninja.orm import create_schema
 from django.db import models
 from django.http import HttpResponse, HttpRequest
 from django.core.exceptions import ObjectDoesNotExist
-from django.db.models.fields.related import OneToOneRel
 from django.db.models.fields.related_descriptors import (
     ReverseManyToOneDescriptor,
     ReverseOneToOneDescriptor,
+    ManyToManyDescriptor,
 )
 
 from .exceptions import SerializeError
@@ -46,6 +46,10 @@ class ModelSerializer(models.Model):
     def has_custom_fields(self):
         return self.has_custom_fields_create or self.has_custom_fields_update
 
+    @classmethod
+    def verbose_name_path_resolver(cls) -> str:
+        return "-".join(cls._meta.verbose_name_plural.split(" "))
+
     def has_changed(self, field: str) -> bool:
         """
         Check if a model field has changed
@@ -86,10 +90,14 @@ class ModelSerializer(models.Model):
         reverse_rels = []
         for f in cls.ReadSerializer.fields:
             field_obj = getattr(cls, f)
+            if isinstance(field_obj, ManyToManyDescriptor):
+                reverse_rels.append(f)
+                continue
             if isinstance(field_obj, ReverseManyToOneDescriptor):
                 reverse_rels.append(field_obj.field._related_name)
+                continue
             if isinstance(field_obj, ReverseOneToOneDescriptor):
-                reverse_rels.append(list(field_obj[0].related_name))
+                reverse_rels.append(field_obj.related.name)
         return reverse_rels
 
     @classmethod
@@ -98,14 +106,24 @@ class ModelSerializer(models.Model):
     ):
         cls_f = []
         for rel_f in obj.ReadSerializer.fields:
-            rel_f_obj = getattr(obj, rel_f).field
+            rel_f_obj = getattr(obj, rel_f)
             if (
-                isinstance(rel_f_obj, (models.ForeignKey, models.OneToOneField))
-                and rel_f_obj.related_model == cls
+                isinstance(
+                    rel_f_obj.field,
+                    (
+                        models.ForeignKey,
+                        models.OneToOneField,
+                    ),
+                )
+                and rel_f_obj.field.related_model == cls
             ):
                 cls_f.append(rel_f)
                 obj.ReadSerializer.fields.remove(rel_f)
-                break
+                continue
+            if isinstance(rel_f_obj.field, models.ManyToManyField):
+                cls_f.append(rel_f)
+                obj.ReadSerializer.fields.remove(rel_f)
+
         rel_schema = obj.generate_read_s(depth=0)
         if rel_type == "many":
             rel_schema = list[rel_schema]
@@ -124,13 +142,20 @@ class ModelSerializer(models.Model):
         reverse_rels = []
         for f in cls.ReadSerializer.fields:
             field_obj = getattr(cls, f)
+            if isinstance(field_obj, ManyToManyDescriptor):
+                rel_obj: ModelSerializer = field_obj.field.related_model
+                if field_obj.reverse:
+                    rel_obj: ModelSerializer = field_obj.field.model
+                rel_data = cls.get_reverse_relation_schema(rel_obj, "many", f)
+                reverse_rels.append(rel_data)
+                continue
             if isinstance(field_obj, ReverseManyToOneDescriptor):
                 rel_obj: ModelSerializer = field_obj.field.model
                 rel_data = cls.get_reverse_relation_schema(rel_obj, "many", f)
                 reverse_rels.append(rel_data)
                 continue
             if isinstance(field_obj, ReverseOneToOneDescriptor):
-                rel_obj: ModelSerializer = list(field_obj)[0].related_model
+                rel_obj: ModelSerializer = field_obj.related.related_model
                 rel_data = cls.get_reverse_relation_schema(rel_obj, "one", f)
                 reverse_rels.append(rel_data)
                 continue
@@ -178,7 +203,7 @@ class ModelSerializer(models.Model):
                 field_obj = getattr(cls, k).related
             if isinstance(v, dict) and (
                 isinstance(field_obj, models.ForeignKey)
-                or isinstance(field_obj, OneToOneRel)
+                or isinstance(field_obj, models.OneToOneField)
             ):
                 rel: ModelSerializer = await field_obj.related_model.get_object(
                     request, list(v.values())[0]
@@ -280,10 +305,10 @@ class ModelSerializer(models.Model):
         for k, v in payload.items():
             if v is not None:
                 setattr(obj, k, v)
-        payload |= customs
-        await obj.custom_actions(payload)
+        await obj.custom_actions(customs)
         await obj.asave()
-        return await cls.read_s(request, obj)
+        updated_object = await cls.get_object(request, pk)
+        return await cls.read_s(request, updated_object)
 
     @classmethod
     async def delete_s(cls, request: HttpRequest, pk: int | str):

{django_ninja_aio_crud-0.1.4 → django_ninja_aio_crud-0.2.1}/ninja_aio/views.py

@@ -192,6 +192,6 @@ class APIViewSet:
 
     def add_views_to_route(self):
         return self.api.add_router(
-            f"{self.model._meta.verbose_name_plural}/",
+            f"{self.model.verbose_name_path_resolver()}/",
             self.add_views(),
         )

django_ninja_aio_crud-0.1.4/ninja_aio/__init__.py

@@ -1,3 +0,0 @@
-""" Django Ninja AIO CRUD - Rest Framework """
-
-__version__ = "0.1.4"