django-ninja-aio-crud 0.6.0__py3-none-any.whl → 0.6.2__py3-none-any.whl

{django_ninja_aio_crud-0.6.0.dist-info → django_ninja_aio_crud-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-ninja-aio-crud
-Version: 0.6.0
+Version: 0.6.2
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
 Requires-Python: >=3.10
@@ -100,7 +100,7 @@ class Foo(ModelSerializer):
     fields = ["name", "bar"]
 ```
 
-- ReadSerializer, CreateSerializer, UpdateSerializer are used to define which fields would be included in runtime schemas creation. You can also specify custom fields and handle their function by overriding custom_actions ModelSerializer's method(custom fields are only available for Create and Update serializers).
+- ReadSerializer, CreateSerializer, UpdateSerializer are used to define which fields would be included in runtime schemas creation. You can also specify custom fields and handle their function by overriding custom_actions ModelSerializer's method.
 
 ```python
 # models.py
@@ -157,7 +157,7 @@ class Foo(ModelSerializer):
     optionals = [("bar", str), ("active", bool)]
 
   class UpdateSerializer:
-    optionals = [[("bar", str), ("active", bool)]
+    optionals = [("bar", str), ("active", bool)]
 ```
 
 - Instead of declaring your fields maybe you want to exclude some of them. Declaring "excludes" attribute into serializers will exclude the given fields. (You can declare only one between "fields" and "excludes").
@@ -182,10 +182,39 @@ class Foo(ModelSerializer):
 
   class UpdateSerializer:
     excludes = ["id", "name"]
-    optionals = [[("bar", str), ("active", bool)]
+    optionals = [("bar", str), ("active", bool)]
+```
+- If you want to add into ReadSerializer model properties you must define them as customs.
+```python
+# models.py
+from django.db import models
+from ninja_aio.models import ModelSerializer
+
+
+class Foo(ModelSerializer):
+  name = models.CharField(max_length=30)
+  bar = models.CharField(max_length=30, default="")
+  active = models.BooleanField(default=False)
+
+  @propetry
+  def full_name(self):
+    return f"{self.name} example_full_name"
+
+  class ReadSerializer:
+    excludes = ["bar"]
+    customs = [("full_name", str, "")]
+
+  class CreateSerializer:
+    fields = ["name"]
+    optionals = [("bar", str), ("active", bool)]
+
+  class UpdateSerializer:
+    excludes = ["id", "name"]
+    optionals = [("bar", str), ("active", bool)]
 ```
 
 
+
 ### APIViewSet
 
 - 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.

django_ninja_aio_crud-0.6.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+ninja_aio/__init__.py,sha256=fj_imNMQNt3s9V2z1MaTVCq27ZeyFxCD555vG2F80d8,119
+ninja_aio/api.py,sha256=Fe6l3YCy7MW5TY4-Lbl80CFuK2NT2Y7tHfmqPk6Mqak,1735
+ninja_aio/auth.py,sha256=fKboioU4sezPukKJukIwiboxml_KV7irhCH3vGYt5pU,1008
+ninja_aio/exceptions.py,sha256=gPnZX1Do2GXudbU8wDYkwhO70Qj0ZNrIJJ2UXRs9vYk,2241
+ninja_aio/models.py,sha256=58Uk24f2IQYDdnGq1vXp8HqmCwDYeSkZtbiQ9JOQEXc,15504
+ninja_aio/parsers.py,sha256=e_4lGCPV7zs-HTqtdJTc8yQD2KPAn9njbL8nF_Mmgkc,153
+ninja_aio/renders.py,sha256=mHeKNJtmDhZmgFpS9B6SPn5uZFcyVXrsoMhr149LeW8,1555
+ninja_aio/schemas.py,sha256=EgRkfhnzZqwGvdBmqlZixMtMcoD1ZxV_qzJ3fmaAy20,113
+ninja_aio/types.py,sha256=EHznS-6KWLwSX5hLeXbAi7qHWla09_rGeQraiLpH-aY,491
+ninja_aio/views.py,sha256=z820mKzfbvh9SZ4cALQVKMfc64kx74t8xWGWaUBzHfs,9270
+django_ninja_aio_crud-0.6.2.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+django_ninja_aio_crud-0.6.2.dist-info/METADATA,sha256=QFGhtfwohjs0YQG1K6ysZpHQEYtfM0BTJaopwqaFmGQ,13740
+django_ninja_aio_crud-0.6.2.dist-info/RECORD,,

ninja_aio/__init__.py

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

ninja_aio/auth.py

@@ -1,8 +1,8 @@
-from joserfc import jwt, jwk, errors
+from joserfc import jwt, jwk
 from django.http.request import HttpRequest
 from ninja.security.http import HttpBearer
 
-from .exceptions import AuthError, parse_jose_error
+from .exceptions import AuthError
 
 
 class AsyncJwtBearer(HttpBearer):
@@ -16,15 +16,7 @@ class AsyncJwtBearer(HttpBearer):
 
     def validate_claims(self, claims: jwt.Claims):
         jwt_claims = self.get_claims()
-
-        try:
-            jwt_claims.validate(claims)
-        except (
-            errors.InvalidClaimError,
-            errors.MissingClaimError,
-            errors.ExpiredTokenError,
-        ) as exc:
-            raise AuthError(**parse_jose_error(exc), status_code=401)
+        jwt_claims.validate(claims)
 
     async def auth_handler(self, request: HttpRequest):
         """
@@ -35,8 +27,6 @@ class AsyncJwtBearer(HttpBearer):
     async def authenticate(self, request: HttpRequest, token: str):
         try:
             self.dcd = jwt.decode(token, self.jwt_public, algorithms=self.algorithms)
-        except errors.BadSignatureError as exc:
-            raise AuthError(**parse_jose_error(exc), status_code=401)
         except ValueError as exc:
             raise AuthError(", ".join(exc.args), 401)
 

ninja_aio/exceptions.py

@@ -3,6 +3,7 @@ from functools import partial
 from joserfc.errors import JoseError
 from ninja import NinjaAPI
 from django.http import HttpRequest, HttpResponse
+from pydantic import ValidationError
 
 
 class BaseException(Exception):
@@ -34,14 +35,37 @@ class AuthError(BaseException):
     pass
 
 
+class PydanticValidationError(BaseException):
+    def __init__(self, details=None):
+        super().__init__("Validation Error", 400, details)
+
+
 def _default_error(
     request: HttpRequest, exc: BaseException, api: type[NinjaAPI]
 ) -> HttpResponse:
     return api.create_response(request, exc.error, status=exc.status_code)
 
 
+def _pydantic_validation_error(
+    request: HttpRequest, exc: ValidationError, api: type[NinjaAPI]
+) -> HttpResponse:
+    error = PydanticValidationError(exc.errors(include_input=False))
+    return api.create_response(request, error.error, status=error.status_code)
+
+
+def _jose_error(
+    request: HttpRequest, exc: JoseError, api: type[NinjaAPI]
+) -> HttpResponse:
+    error = BaseException(**parse_jose_error(exc), status_code=401)
+    return api.create_response(request, error.error, status=error.status_code)
+
+
 def set_api_exception_handlers(api: type[NinjaAPI]) -> None:
     api.add_exception_handler(BaseException, partial(_default_error, api=api))
+    api.add_exception_handler(JoseError, partial(_jose_error, api=api))
+    api.add_exception_handler(
+        ValidationError, partial(_pydantic_validation_error, api=api)
+    )
 
 
 def parse_jose_error(jose_exc: JoseError) -> dict:

ninja_aio/models.py

@@ -122,7 +122,10 @@ class ModelUtil:
             try:
                 field_obj = getattr(self.model, k).field
             except AttributeError:
-                field_obj = getattr(self.model, k).related
+                try:
+                    field_obj = getattr(self.model, k).related
+                except AttributeError:
+                    pass
             if isinstance(v, dict) and (
                 isinstance(field_obj, models.ForeignKey)
                 or isinstance(field_obj, models.OneToOneField)
@@ -196,6 +199,7 @@ class ModelSerializer(models.Model, metaclass=ModelSerializerMeta):
     class ReadSerializer:
         fields: list[str] = []
         excludes: list[str] = []
+        customs: list[tuple[str, type, Any]] = []
 
     class UpdateSerializer:
         fields: list[str] = []
@@ -257,20 +261,23 @@ class ModelSerializer(models.Model, metaclass=ModelSerializerMeta):
             case "Patch":
                 s_type = "update"
             case "Out":
-                fields, reverse_rels, excludes = cls.get_schema_out_data()
-                if not fields and not reverse_rels and not excludes:
+                fields, reverse_rels, excludes, customs = cls.get_schema_out_data()
+                if not fields and not reverse_rels and not excludes and not customs:
                     return None
                 return create_schema(
                     model=cls,
                     name=f"{cls._meta.model_name}SchemaOut",
                     depth=depth,
                     fields=fields,
-                    custom_fields=reverse_rels,
+                    custom_fields=reverse_rels + customs,
                     exclude=excludes,
                 )
         fields = cls.get_fields(s_type)
-        customs = cls.get_custom_fields(s_type) + cls.get_optional_fields(s_type)
+        optionals = cls.get_optional_fields(s_type)
+        customs = cls.get_custom_fields(s_type) + optionals
         excludes = cls.get_excluded_fields(s_type)
+        if not fields and not excludes:
+            fields = [f[0] for f in optionals]
         return (
             create_schema(
                 model=cls,
@@ -364,25 +371,36 @@ class ModelSerializer(models.Model, metaclass=ModelSerializerMeta):
         reverse_rels = []
         for f in cls.get_fields("read"):
             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 = field_obj.related.related_model
-                rel_data = cls.get_reverse_relation_schema(rel_obj, "one", f)
+            if isinstance(
+                field_obj,
+                (
+                    ManyToManyDescriptor,
+                    ReverseManyToOneDescriptor,
+                    ReverseOneToOneDescriptor,
+                ),
+            ):
+                if isinstance(field_obj, ManyToManyDescriptor):
+                    rel_obj: ModelSerializer = field_obj.field.related_model
+                    if field_obj.reverse:
+                        rel_obj = field_obj.field.model
+                    rel_type = "many"
+                elif isinstance(field_obj, ReverseManyToOneDescriptor):
+                    rel_obj = field_obj.field.model
+                    rel_type = "many"
+                else:  # ReverseOneToOneDescriptor
+                    rel_obj = field_obj.related.related_model
+                    rel_type = "one"
+
+                rel_data = cls.get_reverse_relation_schema(rel_obj, rel_type, f)
                 reverse_rels.append(rel_data)
                 continue
             fields.append(f)
-        return fields, reverse_rels, cls.get_excluded_fields("read")
+        return (
+            fields,
+            reverse_rels,
+            cls.get_excluded_fields("read"),
+            cls.get_custom_fields("read"),
+        )
 
     @classmethod
     def is_custom(cls, field: str):

ninja_aio/views.py

@@ -112,6 +112,9 @@ class APIViewSet:
     def _generate_filters_schema(self):
         return self._generate_schema(self.query_params, "FiltersSchema")
 
+    def _get_pk(self, data: Schema):
+        return data.model_dump()[self.model_util.model_pk_name]
+
     def get_schemas(self):
         if isinstance(self.model, ModelSerializerMeta):
             return (
@@ -153,14 +156,17 @@ class APIViewSet:
             },
         )
         @paginate(self.pagination_class)
-        async def list(request: HttpRequest, filters: Query[self.filters_schema]):
+        async def list(
+            request: HttpRequest, filters: Query[self.filters_schema] = None
+        ):
             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.query_params_handler(qs, filters.model_dump())
+            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()
@@ -177,7 +183,7 @@ class APIViewSet:
             response={200: self.schema_out, self.error_codes: GenericMessageSchema},
         )
         async def retrieve(request: HttpRequest, pk: Path[self.path_schema]):
-            obj = await self.model_util.get_object(request, pk)
+            obj = await self.model_util.get_object(request, self._get_pk(pk))
             return await self.model_util.read_s(request, obj, self.schema_out)
 
         retrieve.__name__ = f"retrieve_{self.model_util.model_name}"
@@ -192,7 +198,9 @@ class APIViewSet:
         async def update(
             request: HttpRequest, data: self.schema_update, pk: Path[self.path_schema]
         ):
-            return await self.model_util.update_s(request, data, pk, self.schema_out)
+            return await self.model_util.update_s(
+                request, data, self._get_pk(pk), self.schema_out
+            )
 
         update.__name__ = f"update_{self.model_util.model_name}"
         return update
@@ -204,7 +212,7 @@ class APIViewSet:
             response={204: None, self.error_codes: GenericMessageSchema},
         )
         async def delete(request: HttpRequest, pk: Path[self.path_schema]):
-            return 204, await self.model_util.delete_s(request, pk)
+            return 204, await self.model_util.delete_s(request, self._get_pk(pk))
 
         delete.__name__ = f"delete_{self.model_util.model_name}"
         return delete

django_ninja_aio_crud-0.6.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-ninja_aio/__init__.py,sha256=-m_l3-9_2Q1-PvkjWqAfSmu2jt2ILNb490jT2yC4sbk,119
-ninja_aio/api.py,sha256=Fe6l3YCy7MW5TY4-Lbl80CFuK2NT2Y7tHfmqPk6Mqak,1735
-ninja_aio/auth.py,sha256=z9gniLIgT8SjRqhGN7ZI0AGHjsALwgU6eyr2m46fwFY,1389
-ninja_aio/exceptions.py,sha256=JGUvZyYevGnFYFk2JYnNqng1e9ilG8l325wA5YC1RUA,1364
-ninja_aio/models.py,sha256=ddV2QGzWSJzwZ4vt-AJ9rRdiQCVSEtl6Bj3mxroSiQE,15096
-ninja_aio/parsers.py,sha256=e_4lGCPV7zs-HTqtdJTc8yQD2KPAn9njbL8nF_Mmgkc,153
-ninja_aio/renders.py,sha256=mHeKNJtmDhZmgFpS9B6SPn5uZFcyVXrsoMhr149LeW8,1555
-ninja_aio/schemas.py,sha256=EgRkfhnzZqwGvdBmqlZixMtMcoD1ZxV_qzJ3fmaAy20,113
-ninja_aio/types.py,sha256=EHznS-6KWLwSX5hLeXbAi7qHWla09_rGeQraiLpH-aY,491
-ninja_aio/views.py,sha256=b-KLPkNhfMXsTx4egfi-nKeuKqYEUOLXJFNt0fYariE,9027
-django_ninja_aio_crud-0.6.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-django_ninja_aio_crud-0.6.0.dist-info/METADATA,sha256=aRvvPaOFsyvqGwg_wCpoQJ0PiQJfo0obaBPlovRlXeA,13078
-django_ninja_aio_crud-0.6.0.dist-info/RECORD,,