django-small-view-set 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

{django_small_view_set-0.1.3.dist-info → django_small_view_set-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-small-view-set
-Version: 0.1.3
+Version: 0.1.4
 Summary: A lightweight Django ViewSet alternative with minimal abstraction.
 Home-page: https://github.com/nateonguitar/django-small-view-set
 License: MIT
@@ -30,26 +30,39 @@ This guide provides a simple example to get started with the library.
 Here’s how you can define a basic API endpoint with one collection route and one detail route:
 
 ```python
+import asyncio
 from django.http import JsonResponse
 from django.urls import path
-from small_view_set.small_view_set import SmallViewSet
-from small_view_set.decorators import default_handle_endpoint_exceptions
+from small_view_set.small_view_set import SmallViewSet, default_handle_endpoint_exceptions, disable_endpoint
 
 class BarViewSet(SmallViewSet):
 
     def urlpatterns(self):
         return [
             path('api/bars/',          self.default_router, name='bars_collection'),
+            path('api/bars/items/',    self.items, name='bars_items'),
             path('api/bars/<int:pk>/', self.default_router, name='bars_detail'),
         ]
 
     @default_handle_endpoint_exceptions
-    def list(self, request, *args, **kwargs):
+    def list(self, request):
         self.protect_list(request)
         return JsonResponse({"message": "Hello, world!"}, status=200)
 
     @default_handle_endpoint_exceptions
-    def retrieve(self, request, pk, *args, **kwargs):
+    @disable_endpoint
+    async def items(self, request):
+        self.protect_list(request)
+        await asyncio.sleep(1)
+        return JsonResponse({"message": "List of items"}, status=200)
+
+    @default_handle_endpoint_exceptions
+    def patch(self, request, pk):
+        self.protect_update(request)
+        return JsonResponse({"message": f"Updated {pk}"}, status=200)
+
+    @default_handle_endpoint_exceptions
+    async def retrieve(self, request, pk):
         self.protect_retrieve(request)
         return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)
 ```
@@ -76,5 +89,6 @@ urlpatterns = [
 - [Handling Endpoint Exceptions](./README_HANDLE_ENDPOINT_EXCEPTIONS.md): Understand how to write your own decorators for exception handling.
 - [Custom Protections](./README_CUSTOM_PROTECTIONS.md): Learn how to subclass `SmallViewSet` to add custom protections like logged-in checks.
 - [DRF Compatibility](./README_DRF_COMPATIBILITY.md): Learn how to use some of Django Rest Framework's tools, like Serializers.
+- [Disabling an endpoint](./README_DISABLE_ENDPOINT.md): Learn how to disable an endpoint without needing to delete it or comment it out.
 - [Reason](./README_REASON.md): Reasoning behind this package.
 

django_small_view_set-0.1.4.dist-info/RECORD

@@ -0,0 +1,9 @@
+small_view_set/README.md,sha256=oovLoOhBsg5wK8AwGe9iyuWXStHUo9x4fsrlb-oxHt4,1061
+small_view_set/__init__.py,sha256=FoYcTj03W41-w0jC1EOv1_VD4iBxO_03fIr_plSKnp8,441
+small_view_set/decorators.py,sha256=f_1K7YVvWe409UdwnX3rTTypzkV0IsKqS9oBaBICqRQ,7509
+small_view_set/exceptions.py,sha256=5VaPS9m9syhag7p-gveG7Dep4DV3YQ7WjI1Sv5C_1N0,966
+small_view_set/small_view_set.py,sha256=t_oRePTjjHhMjc1g3vrJtY9C5oW_dtfrhdKNA3PzU7Q,4775
+django_small_view_set-0.1.4.dist-info/LICENSE,sha256=M4ZuHeiGHHuewaZyqz7tol4E6E2GMz7fF1ywNoXD1tA,1069
+django_small_view_set-0.1.4.dist-info/METADATA,sha256=yxIVHh9dcAYCrw9157Q6SwGscdCNdhP3W5lLGyewmtc,3475
+django_small_view_set-0.1.4.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+django_small_view_set-0.1.4.dist-info/RECORD,,

small_view_set/README.md

@@ -12,25 +12,25 @@
 3. **Install Dependencies**:
    - Install dependencies inside the container after mounting the directory:
      ```bash
-     docker compose run django-small-view-set-builder poetry install
+     docker compose run --remove-orphans django-small-view-set-builder poetry install
      ```
 
 4. **Run Tests**:
    - Run tests before releasing:
      ```bash
-     docker compose run django-small-view-set-builder python /app/tests/manage.py test
+     docker compose run --remove-orphans django-small-view-set-builder python /app/tests/manage.py test
      ```
 
 5. **Build the Package**:
    Inside the Docker container, build the package:
    ```bash
-   docker compose run django-small-view-set-builder poetry build
+   docker compose run --remove-orphans django-small-view-set-builder poetry build
      ```
 
 6. **Publish to PyPI**:
    Upload the package to PyPI:
    ```bash
-   docker compose run django-small-view-set-builder poetry publish
+   docker compose run --remove-orphans django-small-view-set-builder poetry publish
      ```
 
 7. **Verify the Release**:

small_view_set/decorators.py

@@ -1,9 +1,8 @@
+import inspect
 import logging
 from django.conf import settings
-from functools import wraps
 
 import json
-import functools
 from django.conf import settings
 from django.core.exceptions import ObjectDoesNotExist, SuspiciousOperation, PermissionDenied
 from django.http import (
@@ -58,12 +57,11 @@ def _get_logger(name):
 
 
 def default_handle_endpoint_exceptions(func):
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-        logger = _get_logger('django-small-view-set.default_handle_endpoint_exceptions')
+    logger = _get_logger('django-small-view-set.default_handle_endpoint_exceptions')
 
+    def _exception_handler(e):
         try:
-            return func(*args, **kwargs)
+            raise e
 
         except json.JSONDecodeError:
             return JsonResponse(data={"errors": "Invalid JSON"}, status=400)
@@ -81,8 +79,11 @@ def default_handle_endpoint_exceptions(func):
         except (PermissionDenied, SuspiciousOperation):
             return JsonResponse(data=None, safe=False, status=403)
 
-        except (EndpointDisabledException, Http404, ObjectDoesNotExist):
+        except (Http404, ObjectDoesNotExist):
             return JsonResponse(data=None, safe=False, status=404)
+        
+        except EndpointDisabledException:
+            return JsonResponse(data=None, safe=False, status=405)
 
         except MethodNotAllowed as e:
             return JsonResponse(
@@ -151,10 +152,25 @@ def default_handle_endpoint_exceptions(func):
                 status=status_code,
                 content_type='application/json')
 
-    return wrapper
+    def sync_wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            return _exception_handler(e)
+
+    async def async_wrapper(*args, **kwargs):
+        try:
+            return await func(*args, **kwargs)
+        except Exception as e:
+            return _exception_handler(e)
 
+    if inspect.iscoroutinefunction(func):
+        return async_wrapper
+    else:
+        return sync_wrapper
 
-def disable_endpoint(view_func):
+
+def disable_endpoint(func):
     """
     Temporarily disables an API endpoint based on the SMALL_VIEWSET_RESPECT_DISABLED_ENDPOINTS setting.
 
@@ -169,17 +185,27 @@ def disable_endpoint(view_func):
         ```python
         class ExampleViewSet(SmallViewSet):
 
-            @disable_endpoint
             @default_handle_endpoint_exceptions
+            @disable_endpoint
             def retrieve(self, request: Request) -> JsonResponse:
                 self.protect_retrieve(request)
                 . . .
         ```
     """
-    @wraps(view_func)
-    def wrapper(*args, **kwargs):
-        if settings.SMALL_VIEWSET_RESPECT_DISABLED_ENDPOINTS:
+    respect_disabled_endpoints = getattr(settings, 'SMALL_VIEWSET_RESPECT_DISABLED_ENDPOINTS', True)
+    def sync_wrapper(*args, **kwargs):
+        if respect_disabled_endpoints:
             raise EndpointDisabledException()
-        return view_func(*args, **kwargs)
-    return wrapper
+        return func(*args, **kwargs)
+
+    async def async_wrapper(*args, **kwargs):
+        if respect_disabled_endpoints:
+            raise EndpointDisabledException()
+        return await func(*args, **kwargs)
+
+
+    if inspect.iscoroutinefunction(func):
+        return async_wrapper
+    else:
+        return sync_wrapper
 

small_view_set/exceptions.py

@@ -1,7 +1,7 @@
 class EndpointDisabledException(Exception):
-    status_code = 404
-    message = "Not Found"
-    error_code = "not_found"
+    status_code = 405
+    message = "Method Not Allowed"
+    error_code = "method_not_allowed"
 
 class Unauthorized(Exception):
     status_code = 401

small_view_set/small_view_set.py

@@ -1,6 +1,6 @@
+import inspect
 import json
 import logging
-from django.http import JsonResponse
 from urllib.request import Request
 
 from .exceptions import BadRequest, MethodNotAllowed
@@ -8,24 +8,6 @@ from .exceptions import BadRequest, MethodNotAllowed
 logger = logging.getLogger('app')
 
 class SmallViewSet:
-    def create(self, request: Request, *args, **kwargs):
-        raise MethodNotAllowed('POST')
-
-    def list(self, request: Request, *args, **kwarg):
-        raise MethodNotAllowed('GET')
-
-    def retrieve(self, request: Request, pk, *args, **kwargs):
-        raise MethodNotAllowed('GET')
-
-    def put(self, request: Request, pk, *args, **kwargs):
-        raise MethodNotAllowed('PUT')
-
-    def patch(self, request: Request, pk, *args, **kwargs):
-        raise MethodNotAllowed('PATCH')
-
-    def delete(self, request: Request, pk, *args, **kwargs):
-        raise MethodNotAllowed('DELETE')
-
     def parse_json_body(self, request: Request):
         if request.content_type != 'application/json':
             raise BadRequest('Invalid content type')
@@ -76,7 +58,7 @@ class SmallViewSet:
         if request.method != 'DELETE':
             raise MethodNotAllowed(request.method)
 
-    def default_router(self, request: Request, pk=None, *args, **kwargs):
+    async 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).
         
@@ -116,23 +98,41 @@ class SmallViewSet:
             def some_disabled_endpoint(self, request: Request):
                 self.protect_retrieve(request)
                 . . .
-                
         ```
         """
+        func = None
         if pk is None:
             if request.method == 'GET':
-                return self.list(request, *args, **kwargs)
+                if hasattr(self, 'list'):
+                    func = self.list
+
             elif request.method == 'POST':
-                return self.create(request, *args, **kwargs)
+                if hasattr(self, 'create'):
+                    func = self.create
         else:
             if request.method == 'GET':
-                return self.retrieve(request, pk, *args, **kwargs)
+                if hasattr(self, 'retrieve'):
+                    func = self.retrieve
+
             elif request.method == 'PUT':
-                return self.put(request, pk, *args, **kwargs)
+                if hasattr(self, 'put'):
+                    func = self.put
+
             elif request.method == 'PATCH':
-                return self.patch(request, pk, *args, **kwargs)
+                if hasattr(self, 'patch'):
+                    func = self.patch
+
             elif request.method == 'DELETE':
-                return self.delete(request, pk, *args, **kwargs)
-        endpoint_type = "detail" if pk else "collection"
-        logger.error(f'Got a none response from request_router for {endpoint_type} method {request.method}')
-        return JsonResponse(data=None, safe=False, status=500)
+                if hasattr(self, 'delete'):
+                    func = self.delete
+
+        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)

django_small_view_set-0.1.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-small_view_set/README.md,sha256=AVHm5FrLxNzFKt9-PGvx0vkAcfMEO9ZtFoCG__lQp-s,993
-small_view_set/__init__.py,sha256=FoYcTj03W41-w0jC1EOv1_VD4iBxO_03fIr_plSKnp8,441
-small_view_set/decorators.py,sha256=OSwGz5SfTw7hUjOcPNmCmUl8mLqaHOMXaLcqg9JBHXo,6750
-small_view_set/exceptions.py,sha256=8CAnzvNZFlqjez8z66jLo-4P3Tlj5Y5MioDPmrb9wQg,948
-small_view_set/small_view_set.py,sha256=THDeJp1PmodaWzFUUnowpDmhH8w1El4p97jvQnjyU4k,5192
-django_small_view_set-0.1.3.dist-info/LICENSE,sha256=M4ZuHeiGHHuewaZyqz7tol4E6E2GMz7fF1ywNoXD1tA,1069
-django_small_view_set-0.1.3.dist-info/METADATA,sha256=CfEGIqD7i2PPsYsDf-k8ksloNXlOGCutgaaqhH_BQd8,2881
-django_small_view_set-0.1.3.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-django_small_view_set-0.1.3.dist-info/RECORD,,