django-ninja-aio-crud 2.1.0__py3-none-any.whl → 2.2.0__py3-none-any.whl

{django_ninja_aio_crud-2.1.0.dist-info → django_ninja_aio_crud-2.2.0.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: django-ninja-aio-crud
-Version: 2.1.0
+Version: 2.2.0
 Summary: Django Ninja AIO CRUD - Rest Framework
 Author: Giuseppe Casillo
-Requires-Python: >=3.10
+Requires-Python: >=3.10, <=3.14
 Description-Content-Type: text/markdown
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet

{django_ninja_aio_crud-2.1.0.dist-info → django_ninja_aio_crud-2.2.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-ninja_aio/__init__.py,sha256=YGWehZQ4d5yVFCd1ax-s61BSkND60Yh383YmUJq-LtY,119
-ninja_aio/api.py,sha256=SS1TYUiFkdYjfJLVy6GI90GOzvIHzPEeL-UcqWFRHkM,1684
-ninja_aio/auth.py,sha256=w9TXDQwJSZzCbncsSwemINTUe1IPZGHnLKiqWTeOoFA,9163
+ninja_aio/__init__.py,sha256=Jgj89rpJ3n4pkGfoSYm9NYrwBjGzwhiOeU5c6mr-J8Q,119
+ninja_aio/api.py,sha256=tuC7vdvn7s1GkCnSFy9Kn1zv0glZfYptRQVvo8ZRtGQ,2429
+ninja_aio/auth.py,sha256=4sWdFPjKiQgUL1d_CSGDblVjnY5ptP6LQha6XXdluJA,9157
 ninja_aio/decorators.py,sha256=BHoFIiqdIVMFqSxGh-F6WeZFo1xZK4ieDw3dzKfxZIM,8147
 ninja_aio/exceptions.py,sha256=1-iRbrloIyi0CR6Tcrn5YR4_LloA7PPohKIBaxXJ0-8,2596
 ninja_aio/models.py,sha256=aJlo5a64O4o-fB8QESLMUJpoA5kcjRJxPBiAIMxg46k,47652
 ninja_aio/parsers.py,sha256=e_4lGCPV7zs-HTqtdJTc8yQD2KPAn9njbL8nF_Mmgkc,153
 ninja_aio/renders.py,sha256=VtmSliRJyZ6gjyoib8AXMVUBYF1jPNsiceCHujI_mAs,1699
-ninja_aio/types.py,sha256=_QV0DySZhCV1otuh1zhrlHgCaFnr5fd64GQrcA-qKoc,564
+ninja_aio/types.py,sha256=nFqWEopm7eoEaHRzbi6EyA9WZ5Cneyd602ilFKypeQI,577
 ninja_aio/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ninja_aio/helpers/api.py,sha256=BTe7OL-X7YgWYeXmka8TmN4-gA43FVZhtH7q0dRjYX0,20238
 ninja_aio/helpers/query.py,sha256=tE8RjXvSig-WB_0LRQ0LqoE4G_HMHsu0Na5QzTNIm6U,4262
@@ -15,9 +15,9 @@ ninja_aio/schemas/api.py,sha256=-VwXhBRhmMsZLIAmWJ-P7tB5klxXS75eukjabeKKYsc,360
 ninja_aio/schemas/generics.py,sha256=frjJsKJMAdM_NdNKv-9ddZNGxYy5PNzjIRGtuycgr-w,112
 ninja_aio/schemas/helpers.py,sha256=rmE0D15lJg95Unv8PU44Hbf0VDTcErMCZZFG3D_znTo,2823
 ninja_aio/views/__init__.py,sha256=DEzjWA6y3WF0V10nNF8eEurLNEodgxKzyFd09AqVp3s,148
-ninja_aio/views/api.py,sha256=ispbr5w6WCUdbXmn2LY94zDQ0qb2nDNeTLLNAUBFoDc,17736
+ninja_aio/views/api.py,sha256=O_QQBxk-MltU-bPjxOSu5fFpHaDNP5J3Wk6E5rSBgi4,19744
 ninja_aio/views/mixins.py,sha256=Jh6BG8Cs823nurVlODlzCquTxKrLH7Pmo5udPqUGZek,11378
-django_ninja_aio_crud-2.1.0.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
-django_ninja_aio_crud-2.1.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-django_ninja_aio_crud-2.1.0.dist-info/METADATA,sha256=91kIanSvlN_aeRmhZuXZR2pIBXEzUUOuYLJkijzN7QI,8672
-django_ninja_aio_crud-2.1.0.dist-info/RECORD,,
+django_ninja_aio_crud-2.2.0.dist-info/licenses/LICENSE,sha256=yrDAYcm0gRp_Qyzo3GQa4BjYjWRkAhGC8QRva__RYq0,1073
+django_ninja_aio_crud-2.2.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+django_ninja_aio_crud-2.2.0.dist-info/METADATA,sha256=lJiJIHnNMaKXAM-aOwuKlcAmaJt8oV_wtiDGSFvjjJE,8680
+django_ninja_aio_crud-2.2.0.dist-info/RECORD,,

ninja_aio/__init__.py

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

ninja_aio/api.py

@@ -5,10 +5,13 @@ 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 django.db import models
 
 from .parsers import ORJSONParser
 from .renders import ORJSONRenderer
 from .exceptions import set_api_exception_handlers
+from .views import APIView, APIViewSet
+from .models import ModelSerializer
 
 
 class NinjaAIO(NinjaAPI):
@@ -49,3 +52,24 @@ class NinjaAIO(NinjaAPI):
     def set_default_exception_handlers(self):
         set_api_exception_handlers(self)
         super().set_default_exception_handlers()
+
+    def view(self, prefix: str, tags: list[str] = None) -> Any:
+        def wrapper(view: type[APIView]):
+            instance = view(api=self, prefix=prefix, tags=tags)
+            instance.add_views_to_route()
+            return instance
+
+        return wrapper
+
+    def viewset(
+        self,
+        model: models.Model | ModelSerializer,
+        prefix: str = None,
+        tags: list[str] = None,
+    ) -> None:
+        def wrapper(viewset: type[APIViewSet]):
+            instance = viewset(api=self, model=model, prefix=prefix, tags=tags)
+            instance.add_views_to_route()
+            return instance
+
+        return wrapper

ninja_aio/auth.py

@@ -124,7 +124,7 @@ def validate_key(key: Optional[JwtKeys], setting_name: str) -> JwtKeys:
         key = getattr(settings, setting_name, None)
     if key is None:
         raise ValueError(f"{setting_name} is required")
-    if not isinstance(key, (jwk.RSAKey, jwk.ECKey)):
+    if not isinstance(key, (jwk.RSAKey, jwk.ECKey, jwk.OctKey)):
         raise ValueError(
             f"{setting_name} must be an instance of jwk.RSAKey or jwk.ECKey"
         )
@@ -143,7 +143,7 @@ def validate_mandatory_claims(claims: dict) -> dict:
 
 
 def encode_jwt(
-    claims: dict, duration: int, private_key: jwk.RSAKey = None, algorithm: str = None
+    claims: dict, duration: int, private_key: JwtKeys = None, algorithm: str = None
 ) -> str:
     """
     Encode and sign a JWT.
@@ -192,7 +192,7 @@ def encode_jwt(
 
 def decode_jwt(
     token: str,
-    public_key: jwk.RSAKey | jwk.ECKey = None,
+    public_key: JwtKeys = None,
     algorithms: list[str] = None,
 ) -> jwt.Token:
     """

ninja_aio/types.py

@@ -8,7 +8,7 @@ S_TYPES = Literal["read", "create", "update"]
 F_TYPES = Literal["fields", "customs", "optionals", "excludes"]
 SCHEMA_TYPES = Literal["In", "Out", "Patch", "Related"]
 VIEW_TYPES = Literal["list", "retrieve", "create", "update", "delete", "all"]
-JwtKeys: TypeAlias = jwk.RSAKey | jwk.ECKey
+JwtKeys: TypeAlias = jwk.RSAKey | jwk.ECKey | jwk.OctKey
 
 class ModelSerializerType(type):
     def __repr__(self):

ninja_aio/views/api.py

@@ -18,19 +18,16 @@ from ninja_aio.helpers.api import ManyToManyAPI
 from ninja_aio.types import ModelSerializerMeta, VIEW_TYPES
 from ninja_aio.decorators import unique_view, decorate_view
 
-ERROR_CODES = frozenset({400, 401, 404, 428})
+ERROR_CODES = frozenset({400, 401, 404})
 
 
-class APIView:
-    api: NinjaAPI
-    router_tag: str
-    api_route_path: str
+class API:
+    api: NinjaAPI = None
+    router_tag: str = ""
+    router_tags: list[str] = []
+    api_route_path: str = ""
     auth: list | None = NOT_SET
 
-    def __init__(self) -> None:
-        self.router = Router(tags=[self.router_tag])
-        self.error_codes = ERROR_CODES
-
     def views(self):
         """
         Override this method to add your custom views. For example:
@@ -38,7 +35,7 @@ class APIView:
         async def some_method(request, *args, **kwargs):
             pass
 
-        You can add multilple views just doing:
+        You can add views just doing:
 
         @self.router.get(some_path, response=some_schema)
         async def some_method(request, *args, **kwargs):
@@ -63,20 +60,80 @@ class APIView:
         async def some_method(request, *args, **kwargs):
             pass
         """
+        pass
 
     def _add_views(self):
-        self.views()
-        return self.router
+        raise NotImplementedError("_add_views must be implemented in subclasses")
 
     def add_views_to_route(self):
         return self.api.add_router(f"{self.api_route_path}", self._add_views())
 
 
-class APIViewSet:
+class APIView(API):
+    """
+    Base class to register custom, non-CRUD endpoints on a Ninja Router.
+
+    Usage:
+        @api.view(prefix="/custom", tags=["Custom"])
+        class CustomAPIView(APIView):
+            def views(self):
+                @self.router.get("/hello", response=SomeSchema)
+                async def hello(request):
+                    return SomeSchema(...)
+
+        or
+
+        class CustomAPIView(APIView):
+            api = api
+            api_route_path = "/custom"
+            router_tags = ["Custom"]
+
+            def views(self):
+                @self.router.get("/hello", response=SomeSchema)
+                async def hello(request):
+                    return SomeSchema(...)
+
+
+        CustomAPIView().add_views_to_route()
+
+    Attributes:
+        api: NinjaAPI instance used to mount the router.
+        router_tag: Single tag used if router_tags is not provided.
+        router_tags: List of tags assigned to the router.
+        api_route_path: Base path where the router is mounted.
+        auth: Default auth list or NOT_SET for unauthenticated endpoints.
+        router: Router instance where views are registered.
+        error_codes: Common error codes returned by endpoints.
+
+    Overridable methods:
+        views(): Register your endpoints using self.router.get/post/patch/delete.
+    """
+
+    def __init__(
+        self, api: NinjaAPI = None, prefix: str = None, tags: list[str] = None
+    ) -> None:
+        self.api = api or self.api
+        self.api_route_path = prefix or self.api_route_path
+        self.router_tags = tags or self.router_tags or [self.router_tag]
+        self.router = Router(tags=self.router_tags)
+        self.error_codes = ERROR_CODES
+
+    def _add_views(self):
+        self.views()
+        return self.router
+
+
+class APIViewSet(API):
     """
     Base viewset generating async CRUD + optional M2M endpoints for a Django model.
 
     Usage:
+        @api.viewset(model=MyModel)
+        class MyModelViewSet(APIViewSet):
+            pass
+
+        or
+
         class MyModelViewSet(APIViewSet):
             model = MyModel
             api = api
@@ -109,8 +166,8 @@ class APIViewSet:
         dict, and must return the (optionally) filtered queryset.
 
         Example:
+            @api.viewset(model=models.User)
             class UserViewSet(APIViewSet):
-                model = models.User
                 m2m_relations = [
                     M2MRelationSchema(
                         model=models.Tag,
@@ -149,7 +206,7 @@ class APIViewSet:
         <related_name>_query_params_handler(queryset, filters): Async hook for per-M2M filtering.
 
     Error responses:
-        All endpoints may return GenericMessageSchema for codes in ERROR_CODES (400,401,404,428).
+        All endpoints may return GenericMessageSchema for codes in ERROR_CODES (400,401,404).
 
     Internal:
         Dynamic path/filter schemas built with pydantic.create_model.
@@ -157,12 +214,9 @@ 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
-    auth: list | None = NOT_SET
     get_auth: list | None = NOT_SET
     post_auth: list | None = NOT_SET
     patch_auth: list | None = NOT_SET
@@ -170,7 +224,6 @@ class APIViewSet:
     pagination_class: type[AsyncPaginationBase] = PageNumberPagination
     query_params: dict[str, tuple[type, ...]] = {}
     disable: list[type[VIEW_TYPES]] = []
-    api_route_path: str = ""
     list_docs = "List all objects."
     create_docs = "Create a new object."
     retrieve_docs = "Retrieve a specific object by its primary key."
@@ -180,8 +233,16 @@ class APIViewSet:
     m2m_auth: list | None = NOT_SET
     extra_decorators: DecoratorsSchema = DecoratorsSchema()
 
-    def __init__(self) -> None:
+    def __init__(
+        self,
+        api: NinjaAPI = None,
+        model: Model | ModelSerializer = None,
+        prefix: str = None,
+        tags: list[str] = None,
+    ) -> None:
+        self.api = api or self.api
         self.error_codes = ERROR_CODES
+        self.model = model or self.model
         self.model_util = (
             ModelUtil(self.model)
             if not isinstance(self.model, ModelSerializerMeta)
@@ -191,16 +252,17 @@ class APIViewSet:
         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 if not self.router_tag else self.router_tag
-        )
-        self.router = Router(tags=[self.router_tag])
+        self.router_tag = self.router_tag or self.model_verbose_name
+        self.router_tags = self.router_tags or tags or [self.router_tag]
+        self.router = Router(tags=self.router_tags)
         self.path = "/"
         self.get_path = ""
         self.path_retrieve = f"{{{self.model_util.model_pk_name}}}/"
         self.get_path_retrieve = f"{{{self.model_util.model_pk_name}}}"
         self.api_route_path = (
-            self.api_route_path or self.model_util.verbose_name_path_resolver()
+            self.api_route_path
+            or prefix
+            or self.model_util.verbose_name_path_resolver()
         )
         self.m2m_api = (
             None
@@ -450,18 +512,18 @@ class APIViewSet:
 
         return self._set_additional_views()
 
-    def add_views_to_route(self):
-        """
-        Attach router with registered endpoints to the NinjaAPI instance.
-        """
-        return self.api.add_router(f"{self.api_route_path}", self._add_views())
-
 
 class ReadOnlyViewSet(APIViewSet):
     """
     ReadOnly viewset generating async List + Retrieve endpoints for a Django model.
 
     Usage:
+        @api.viewset(model=MyModel)
+        class MyModelReadOnlyViewSet(ReadOnlyViewSet):
+            pass
+
+        or
+
         class MyModelReadOnlyViewSet(ReadOnlyViewSet):
             model = MyModel
             api = api
@@ -476,10 +538,15 @@ class WriteOnlyViewSet(APIViewSet):
     WriteOnly viewset generating async Create + Update + Delete endpoints for a Django model.
 
     Usage:
+        @api.viewset(model=MyModel)
+        class MyModelWriteOnlyViewSet(WriteOnlyViewSet):
+            pass
+
+        or
+
         class MyModelWriteOnlyViewSet(WriteOnlyViewSet):
             model = MyModel
             api = api
-        MyModelWriteOnlyViewSet().add_views_to_route()
     """
 
     disable = ["list", "retrieve"]