django-small-view-set 0.2.4__tar.gz → 0.2.6__tar.gz

{django_small_view_set-0.2.4 → django_small_view_set-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-small-view-set
-Version: 0.2.4
+Version: 0.2.6
 Summary: A lightweight Django ViewSet alternative with minimal abstraction.
 Home-page: https://github.com/nateonguitar/django-small-view-set
 License: MIT

{django_small_view_set-0.2.4 → django_small_view_set-0.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "django-small-view-set"
-version = "0.2.4"
+version = "0.2.6"
 description = "A lightweight Django ViewSet alternative with minimal abstraction."
 readme = "README.md"
 authors = ["Nate Brooks"]

{django_small_view_set-0.2.4 → django_small_view_set-0.2.6}/src/small_view_set/decorators.py

@@ -10,6 +10,7 @@ def endpoint(
         func_name = func.__name__
         def sync_wrapper(viewset, *args, **kwargs):
             request = args[0]
+            args = args[1:]
             try:
                 config: SmallViewSetConfig = getattr(settings, 'SMALL_VIEW_SET_CONFIG', SmallViewSetConfig())
                 pre_response = config.options_and_head_handler(request, allowed_methods)
@@ -17,14 +18,15 @@ def endpoint(
                     return pre_response
                 pk = kwargs.pop('pk', None)
                 if pk is None:
-                    return func(viewset, request=request)
+                    return func(viewset, request=request, *args, **kwargs)
                 else:
-                    return func(viewset, request=request, pk=pk)
+                    return func(viewset, request=request, pk=pk, *args, **kwargs)
             except Exception as e:
                 return config.exception_handler(request, func_name, e)
 
         async def async_wrapper(viewset, *args, **kwargs):
             request = args[0]
+            args = args[1:]
             try:
                 config: SmallViewSetConfig = getattr(settings, 'SMALL_VIEW_SET_CONFIG', SmallViewSetConfig())
                 pre_response = config.options_and_head_handler(request, allowed_methods)
@@ -32,9 +34,9 @@ def endpoint(
                     return pre_response
                 pk = kwargs.pop('pk', None)
                 if pk is None:
-                    return await func(viewset, request=request)
+                    return await func(viewset, request=request, *args, **kwargs)
                 else:
-                    return await func(viewset, request=request, pk=pk)
+                    return await func(viewset, request=request, pk=pk, *args, **kwargs)
             except Exception as e:
                 return config.exception_handler(request, func_name, e)
 

{django_small_view_set-0.2.4 → django_small_view_set-0.2.6}/src/small_view_set/small_view_set.py

@@ -81,7 +81,83 @@ class SmallViewSet:
         pass
 
     @endpoint(allowed_methods=['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS', 'HEAD'])
-    async def default_router(self, request: Request, pk=None, *args, **kwargs):
+    async def default_router_async(self, request: Request, pk=None, *args, **kwargs):
+        """
+        This method routes requests to the appropriate method based on the HTTP method and presence of a primary key (pk).
+        
+        It also handles errors and returns appropriate JSON responses by using the decorator @endpoint(allowed_method=[]).
+        
+        GET/POST for collection endpoints and GET/PUT/PATCH/DELETE for detail endpoints.
+
+        Example:
+        ```
+        # Note: AppViewSet is a subclass of SmallViewSet with overridden protect methods with more specific logic.
+
+        class CommentViewSet(AppViewSet):
+            def urlpatterns(self):
+                return [
+                    path('api/comments/',                     self.default_router_async, name='comments_collection'),
+                    path('api/comments/<int:pk>/',            self.default_router_async, name='comments_detail'),
+                    path('api/comments/<int:pk>/custom_put/', self.custom_put,           name='comments_custom_put_detail'),
+                ]
+
+            @endpoint(allowed_method=['POST'])
+            def create(self, request: Request):
+                self.protect_create(request)
+                . . .
+
+            @endpoint(allowed_method=['PUT', 'PATCH'])
+            def update(self, request: Request, pk: int):
+                self.protect_update(request)
+                . . .
+
+            @endpoint(allowed_method=['PUT'])
+            def custom_put(self, request: Request, pk: int):
+                self.protect_update(request)
+                . . .
+
+            @endpoint(allowed_method=['GET'])
+            @disable_endpoint
+            def some_disabled_endpoint(self, request: Request):
+                self.protect_retrieve(request)
+                . . .
+        ```
+        """
+        func = None
+        if pk is None:
+            if request.method == 'GET':
+                if hasattr(self, 'list'):
+                    func = self.list
+
+            elif request.method == 'POST':
+                if hasattr(self, 'create'):
+                    func = self.create
+        else:
+            if request.method == 'GET':
+                if hasattr(self, 'retrieve'):
+                    func = self.retrieve
+
+            elif request.method == 'PUT':
+                if hasattr(self, 'put'):
+                    func = self.put
+
+            elif request.method == 'PATCH':
+                if hasattr(self, 'patch'):
+                    func = self.patch
+
+            elif request.method == 'DELETE':
+                if hasattr(self, 'delete'):
+                    func = self.delete
+
+        if func is None:
+            raise MethodNotAllowed(request.method)
+        if pk is not None:
+            kwargs['pk'] = pk
+        return await func(request, *args, **kwargs)
+
+
+    @endpoint(allowed_methods=['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS', 'HEAD'])
+    def default_router(self, request: Request, pk=None, *args, **kwargs):
         """
         This method routes requests to the appropriate method based on the HTTP method and presence of a primary key (pk).
         
@@ -151,11 +227,6 @@ class SmallViewSet:
 
         if func is None:
             raise MethodNotAllowed(request.method)
-
         if pk is not None:
             kwargs['pk'] = pk
-
-        if inspect.iscoroutinefunction(func):
-            return await func(request, *args, **kwargs)
-        else:
-            return func(request, *args, **kwargs)
+        return func(request, *args, **kwargs)