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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-small-view-set
-Version: 0.2.6
+Version: 0.2.7
 Summary: A lightweight Django ViewSet alternative with minimal abstraction.
 Home-page: https://github.com/nateonguitar/django-small-view-set
 License: MIT
@@ -19,16 +19,12 @@ Description-Content-Type: text/markdown
 
 # Django Small View Set
 
-A lightweight Django ViewSet alternative with minimal abstraction. This library provides a simple and transparent way to define API endpoints without relying on complex abstractions.
+A recommended pattern and a lightweight Django ViewSet with minimal abstraction.
 
-## Getting Started with Django Small View Set
-
-This guide provides a simple example to get started with the library.
+This pattern supports both standard endpoints and `async` endpoints.
 
 ### Example Usage
 
-Here’s how to define a basic view set:
-
 In settings.py
 ```python
 # Register SmallViewSetConfig in settings
@@ -37,43 +33,60 @@ from small_view_set SmallViewSetConfig
 SMALL_VIEW_SET_CONFIG = SmallViewSetConfig()
 ```
 
+^^^ This will get you up and running, but it is recommended to write your own [Custom exception handler](./README_CUSTOM_EXCEPTION_HANDLER.md)
+
+Please note, endpoints cannot be registered in `urls.py` with the
+request method (like POST, or GET), therefore create a `collection` and/or `detail` orchestrator
+method for the standard CRUD operations.
+
 
 ```python
 import asyncio
 from django.http import JsonResponse
 from django.urls import path
 from small_view_set import SmallViewSet, endpoint, endpoint_disabled
+from urllib.request import Request
 
 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'),
+            path('api/bars/',          self.collection, name='bars_collection'),
+            path('api/bars/<int:pk>/', self.detail,     name='bars_detail'),
+            path('api/bars/items/',    self.items,      name='bars_items'),
         ]
+    @endpoint(allowed_methods=['GET', 'POST'])
+    def collection(self, request: Request):
+        if request.method == 'GET':
+            return self.list(request)
+        raise MethodNotAllowed(request.method)
+
+    @endpoint(allowed_methods=['GET', 'PATCH'])
+    async def detail(self, request: Request, pk: int):
+        if request.method == 'GET':
+            return await self.retrieve(request, pk)
+        elif request.method == 'PATCH':
+            return self.patch(request, pk)
+        raise MethodNotAllowed(request.method)
 
-    @endpoint(allowed_methods=['GET'])
     def list(self, request):
         self.protect_list(request)
         return JsonResponse({"message": "Hello, world!"}, status=200)
 
-    @endpoint(allowed_methods=['GET'])
-    @endpoint_disabled
-    async def items(self, request):
-        self.protect_list(request)
-        await asyncio.sleep(1)
-        return JsonResponse({"message": "List of items"}, status=200)
+    async def retrieve(self, request: Request, pk: int):
+        self.protect_retrieve(request)
+        return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)
 
-    @endpoint(allowed_methods=['PATCH'])
-    def patch(self, request, pk):
+    def patch(self, request: Request, pk: int):
         self.protect_update(request)
         return JsonResponse({"message": f"Updated {pk}"}, status=200)
 
     @endpoint(allowed_methods=['GET'])
-    async def retrieve(self, request, pk):
-        self.protect_retrieve(request)
-        return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)
+    async def items(self, request: Request):
+        # Pick the closest protect that matches the endoint. `GET items` is closest to a list
+        self.protect_list(request)
+        await asyncio.sleep(1)
+        return JsonResponse({"message": "List of items"}, status=200)
 ```
 
 
@@ -92,12 +105,11 @@ urlpatterns = [
 ```
 
 
-## Documentation
+## Deeper learning
 
-- [Custom Endpoints](./README_CUSTOM_ENDPOINT.md): Learn how to define custom endpoints alongside the default router.
-- [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.
+- [Custom protections](./README_CUSTOM_PROTECTIONS.md): Learn how to subclass `SmallViewSet` to add custom protections like logged-in checks.
+- [Custom exception handler](./README_CUSTOM_EXCEPTION_HANDLER.md): Understand how to write your own exception handler.
+- [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.2.7/README.md

@@ -0,0 +1,95 @@
+# Django Small View Set
+
+A recommended pattern and a lightweight Django ViewSet with minimal abstraction.
+
+This pattern supports both standard endpoints and `async` endpoints.
+
+### Example Usage
+
+In settings.py
+```python
+# Register SmallViewSetConfig in settings
+from small_view_set SmallViewSetConfig
+
+SMALL_VIEW_SET_CONFIG = SmallViewSetConfig()
+```
+
+^^^ This will get you up and running, but it is recommended to write your own [Custom exception handler](./README_CUSTOM_EXCEPTION_HANDLER.md)
+
+Please note, endpoints cannot be registered in `urls.py` with the
+request method (like POST, or GET), therefore create a `collection` and/or `detail` orchestrator
+method for the standard CRUD operations.
+
+
+```python
+import asyncio
+from django.http import JsonResponse
+from django.urls import path
+from small_view_set import SmallViewSet, endpoint, endpoint_disabled
+from urllib.request import Request
+
+class BarViewSet(SmallViewSet):
+
+    def urlpatterns(self):
+        return [
+            path('api/bars/',          self.collection, name='bars_collection'),
+            path('api/bars/<int:pk>/', self.detail,     name='bars_detail'),
+            path('api/bars/items/',    self.items,      name='bars_items'),
+        ]
+    @endpoint(allowed_methods=['GET', 'POST'])
+    def collection(self, request: Request):
+        if request.method == 'GET':
+            return self.list(request)
+        raise MethodNotAllowed(request.method)
+
+    @endpoint(allowed_methods=['GET', 'PATCH'])
+    async def detail(self, request: Request, pk: int):
+        if request.method == 'GET':
+            return await self.retrieve(request, pk)
+        elif request.method == 'PATCH':
+            return self.patch(request, pk)
+        raise MethodNotAllowed(request.method)
+
+    def list(self, request):
+        self.protect_list(request)
+        return JsonResponse({"message": "Hello, world!"}, status=200)
+
+    async def retrieve(self, request: Request, pk: int):
+        self.protect_retrieve(request)
+        return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)
+
+    def patch(self, request: Request, pk: int):
+        self.protect_update(request)
+        return JsonResponse({"message": f"Updated {pk}"}, status=200)
+
+    @endpoint(allowed_methods=['GET'])
+    async def items(self, request: Request):
+        # Pick the closest protect that matches the endoint. `GET items` is closest to a list
+        self.protect_list(request)
+        await asyncio.sleep(1)
+        return JsonResponse({"message": "List of items"}, status=200)
+```
+
+
+## Registering in `urls.py`
+
+To register the viewset in your `urls.py`:
+
+```python
+from api.views.bar import BarViewSet
+
+urlpatterns = [
+    # Other URLs like admin, static, etc.
+
+    *BarViewSet().urlpatterns(),
+]
+```
+
+
+## Deeper learning
+
+- [Custom protections](./README_CUSTOM_PROTECTIONS.md): Learn how to subclass `SmallViewSet` to add custom protections like logged-in checks.
+- [Custom exception handler](./README_CUSTOM_EXCEPTION_HANDLER.md): Understand how to write your own exception handler.
+- [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.2.6 → django_small_view_set-0.2.7}/pyproject.toml

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

{django_small_view_set-0.2.6 → django_small_view_set-0.2.7}/src/small_view_set/helpers.py

@@ -18,7 +18,7 @@ if not _logger.hasHandlers():
     _logger.setLevel(logging.INFO)
 
 
-def default_options_and_head_handler(request, allowed_methods: list[str]):
+def default_options_and_head_handler(request: Request, allowed_methods: list[str]):
     if request.method == 'OPTIONS':
             response = JsonResponse(
                 data=None,

django_small_view_set-0.2.7/src/small_view_set/small_view_set.py

@@ -0,0 +1,78 @@
+import json
+import logging
+from urllib.request import Request
+
+from .exceptions import BadRequest
+
+logger = logging.getLogger('app')
+
+class SmallViewSet:
+    def parse_json_body(self, request: Request):
+        if request.content_type != 'application/json':
+            raise BadRequest('Invalid content type')
+        return json.loads(request.body)
+
+    def protect_create(self, request: Request):
+        """
+        Stub for adding any custom business logic to protect the create method.
+        For example:
+        - Check if the user is authenticated
+        - Check if the user has validated their email
+        - Throttle requests
+
+        Recommended to call super().protect_create(request) in the subclass in case
+        this library adds logic in the future.
+        """
+        pass
+
+    def protect_list(self, request: Request):
+        """
+        Stub for adding any custom business logic to protect the list method.
+        For example:
+        - Check if the user is authenticated
+        - Check if the user has validated their email
+        - Throttle requests
+
+        Recommended to call super().protect_create(request) in the subclass in case
+        this library adds logic in the future.
+        """
+        pass
+
+    def protect_retrieve(self, request: Request):
+        """
+        Stub for adding any custom business logic to protect the retrieve method.
+        For example:
+        - Check if the user is authenticated
+        - Check if the user has validated their email
+        - Throttle requests
+
+        Recommended to call super().protect_create(request) in the subclass in case
+        this library adds logic in the future.
+        """
+        pass
+
+    def protect_update(self, request: Request):
+        """
+        Stub for adding any custom business logic to protect the update method.
+        For example:
+        - Check if the user is authenticated
+        - Check if the user has validated their email
+        - Throttle requests
+
+        Recommended to call super().protect_create(request) in the subclass in case
+        this library adds logic in the future.
+        """
+        pass
+
+    def protect_delete(self, request: Request):
+        """
+        Stub for adding any custom business logic to protect the delete method.
+        For example:
+        - Check if the user is authenticated
+        - Check if the user has validated their email
+        - Throttle requests
+
+        Recommended to call super().protect_create(request) in the subclass in case
+        this library adds logic in the future.
+        """
+        pass

django_small_view_set-0.2.6/README.md

@@ -1,83 +0,0 @@
-# Django Small View Set
-
-A lightweight Django ViewSet alternative with minimal abstraction. This library provides a simple and transparent way to define API endpoints without relying on complex abstractions.
-
-## Getting Started with Django Small View Set
-
-This guide provides a simple example to get started with the library.
-
-### Example Usage
-
-Here’s how to define a basic view set:
-
-In settings.py
-```python
-# Register SmallViewSetConfig in settings
-from small_view_set SmallViewSetConfig
-
-SMALL_VIEW_SET_CONFIG = SmallViewSetConfig()
-```
-
-
-```python
-import asyncio
-from django.http import JsonResponse
-from django.urls import path
-from small_view_set import SmallViewSet, endpoint, endpoint_disabled
-
-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'),
-        ]
-
-    @endpoint(allowed_methods=['GET'])
-    def list(self, request):
-        self.protect_list(request)
-        return JsonResponse({"message": "Hello, world!"}, status=200)
-
-    @endpoint(allowed_methods=['GET'])
-    @endpoint_disabled
-    async def items(self, request):
-        self.protect_list(request)
-        await asyncio.sleep(1)
-        return JsonResponse({"message": "List of items"}, status=200)
-
-    @endpoint(allowed_methods=['PATCH'])
-    def patch(self, request, pk):
-        self.protect_update(request)
-        return JsonResponse({"message": f"Updated {pk}"}, status=200)
-
-    @endpoint(allowed_methods=['GET'])
-    async def retrieve(self, request, pk):
-        self.protect_retrieve(request)
-        return JsonResponse({"message": f"Detail for ID {pk}"}, status=200)
-```
-
-
-## Registering in `urls.py`
-
-To register the viewset in your `urls.py`:
-
-```python
-from api.views.bar import BarViewSet
-
-urlpatterns = [
-    # Other URLs like admin, static, etc.
-
-    *BarViewSet().urlpatterns(),
-]
-```
-
-
-## Documentation
-
-- [Custom Endpoints](./README_CUSTOM_ENDPOINT.md): Learn how to define custom endpoints alongside the default router.
-- [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.2.6/src/small_view_set/small_view_set.py

@@ -1,232 +0,0 @@
-import inspect
-import json
-import logging
-from urllib.request import Request
-
-
-from .decorators import endpoint
-from .exceptions import BadRequest, MethodNotAllowed
-
-logger = logging.getLogger('app')
-
-class SmallViewSet:
-    def parse_json_body(self, request: Request):
-        if request.content_type != 'application/json':
-            raise BadRequest('Invalid content type')
-        return json.loads(request.body)
-
-    def protect_create(self, request: Request):
-        """
-        Stub for adding any custom business logic to protect the create method.
-        For example:
-        - Check if the user is authenticated
-        - Check if the user has validated their email
-        - Throttle requests
-
-        Recommended to call super().protect_create(request) in the subclass in case
-        this library adds logic in the future.
-        """
-        pass
-
-    def protect_list(self, request: Request):
-        """
-        Stub for adding any custom business logic to protect the list method.
-        For example:
-        - Check if the user is authenticated
-        - Check if the user has validated their email
-        - Throttle requests
-
-        Recommended to call super().protect_create(request) in the subclass in case
-        this library adds logic in the future.
-        """
-        pass
-
-    def protect_retrieve(self, request: Request):
-        """
-        Stub for adding any custom business logic to protect the retrieve method.
-        For example:
-        - Check if the user is authenticated
-        - Check if the user has validated their email
-        - Throttle requests
-
-        Recommended to call super().protect_create(request) in the subclass in case
-        this library adds logic in the future.
-        """
-        pass
-
-    def protect_update(self, request: Request):
-        """
-        Stub for adding any custom business logic to protect the update method.
-        For example:
-        - Check if the user is authenticated
-        - Check if the user has validated their email
-        - Throttle requests
-
-        Recommended to call super().protect_create(request) in the subclass in case
-        this library adds logic in the future.
-        """
-        pass
-
-    def protect_delete(self, request: Request):
-        """
-        Stub for adding any custom business logic to protect the delete method.
-        For example:
-        - Check if the user is authenticated
-        - Check if the user has validated their email
-        - Throttle requests
-
-        Recommended to call super().protect_create(request) in the subclass in case
-        this library adds logic in the future.
-        """
-        pass
-
-    @endpoint(allowed_methods=['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS', 'HEAD'])
-    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).
-        
-        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, name='comments_collection'),
-                    path('api/comments/<int:pk>/',            self.default_router, 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)
-                . . .
-
-            @disable_endpoint
-            @endpoint(allowed_method=['GET'])
-            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 func(request, *args, **kwargs)