djresttoolkit 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

djresttoolkit/views/mixins/__init__.py

@@ -1,6 +1,3 @@
-from ._retrieve_object_mixin import RetrieveObjectMixin, QuerysetNotDefinedError
+from ._retrieve_object_mixin import RetrieveObjectMixin
 
-__all__ = [
-    "RetrieveObjectMixin",
-    "QuerysetNotDefinedError",
-]
+__all__ = ["RetrieveObjectMixin"]

djresttoolkit/views/mixins/_retrieve_object_mixin.py

@@ -1,19 +1,20 @@
 from typing import Any
-from django.db.models import Model, QuerySet
-
-
-class QuerysetNotDefinedError(Exception):
-    """Exception raised when the `queryset` attribute is not set in the class."""
 
-    pass
+from django.core.exceptions import ImproperlyConfigured
+from django.db.models import Model, QuerySet
+from django.http import Http404
 
 
 class RetrieveObjectMixin[T: Model]:
     """
-    Mixin to provide a method for retrieving a single model object by filters.
+    Retrieve a single model object by filters.
 
     Requires the `queryset` attribute to be set in the class that inherits this mixin.
 
+    Raises `Http404` when the object is missing.
+
+    This works in both Django views and DRF views.
+
     Example:
     ```
         class MyView(RetrieveModelMixin[Book], APIView):
@@ -27,15 +28,32 @@ class RetrieveObjectMixin[T: Model]:
 
     queryset: QuerySet[T] | None = None
 
-    def get_object(self, **filters: Any) -> T | None:
+    def get_object(self, **filters: Any) -> T:
         """Retrieve a model object based on provided filters."""
 
         if self.queryset is None:
-            raise QuerysetNotDefinedError(
+            raise ImproperlyConfigured(
                 "Queryset attribute is not set in the class.",
             )
 
         try:
             return self.queryset.get(**filters)
         except self.queryset.model.DoesNotExist:
-            return None
+            raise Http404(self.not_found_detail())
+
+    def not_found_detail(self) -> dict[str, str] | str:
+        """
+        Hook for customizing the 404 message.
+        Can be overridden per view.
+        """
+
+        if self.queryset is None:
+            raise ImproperlyConfigured(
+                "Queryset attribute is not set in the class.",
+            )
+
+        verbose_name = self.queryset.model._meta.verbose_name
+        model_name = (
+            verbose_name.title() if verbose_name else self.queryset.model.__name__
+        )
+        return f"The requested {model_name} was not found."

{djresttoolkit-1.0.0.dist-info → djresttoolkit-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 1.0.0
+Version: 1.1.0
 Summary: A collection of Django and DRF utilities to simplify API development.
 Project-URL: Homepage, https://github.com/shaileshpandit141/djresttoolkit
 Project-URL: Documentation, https://shaileshpandit141.github.io/djresttoolkit
@@ -240,7 +240,7 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-###  3. BaseEnvConfig — API Reference
+### 3. BaseEnvConfig — API Reference
 
 ```python
 from djresttoolkit.envconfig import BaseEnvConfig
@@ -801,6 +801,7 @@ Retrieve a single model object using the provided filter criteria.
 
 ```python
 from rest_framework.views import APIView
+from rest_framework.response import Respone
 from django.http import JsonResponse
 from myapp.models import Book
 from djresttoolkit.mixins import RetrieveObjectMixin
@@ -808,17 +809,18 @@ from djresttoolkit.mixins import RetrieveObjectMixin
 class BookDetailView(RetrieveObjectMixin[Book], APIView):
     queryset = Book.objects.all()
 
-    def get(self, request, *args, **kwargs):
+    def not_found_detail(self) -> dict[str, str] | str:
+        return  "The requested Book was not found."
+
+    def get(self, request, *args, **kwargs) -> Respone:
         book = self.get_object(id=kwargs["id"])
-        if book:
-            return JsonResponse({"title": book.title, "author": book.author})
-        return JsonResponse({"detail": "Not found"}, status=404)
+        return Respone({"title": book.title, "author": book.author})
 ```
 
 #### Features of Retrieve Object Mixin
 
 - Simplifies object retrieval in class-based views or DRF views.
-- Returns `None` instead of raising `DoesNotExist`, making error handling easier.
+- Raise `http404` if requested resource does not extst.
 - Works with any Django model and queryset.
 
 ### 13. build_absolute_uri — API Reference

{djresttoolkit-1.0.0.dist-info → djresttoolkit-1.1.0.dist-info}/RECORD

@@ -48,10 +48,10 @@ djresttoolkit/views/_apiviews/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 djresttoolkit/views/_apiviews/_choice_fields_apiview.py,sha256=zABPgqxMVaWd814B_sC64bWL61fDJkyYQZmJXQCa6Xc,1395
 djresttoolkit/views/_exceptions/__init__.py,sha256=DrCUxuPNyBR4WhzNutn5HDxLa--q51ykIxSG7_bFsOI,83
 djresttoolkit/views/_exceptions/_exception_handler.py,sha256=_o7If47bzWLl57LeSXSWsIDsJGo2RIpwYAwNQ-hsHVY,2839
-djresttoolkit/views/mixins/__init__.py,sha256=K-1tk5d8tCVViMynw5DdffJ3Oo5uHpEx32E3_4X2UxM,154
-djresttoolkit/views/mixins/_retrieve_object_mixin.py,sha256=Q9znYPb07YXXUhsL7VIrk3BC-zDwjOhwLJKe2GPJ-k0,1155
-djresttoolkit-1.0.0.dist-info/METADATA,sha256=pyiY9lXJeoLC9xHgZSuE4f72eRkugl0Zkt00hWaDrSU,31832
-djresttoolkit-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-djresttoolkit-1.0.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
-djresttoolkit-1.0.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-djresttoolkit-1.0.0.dist-info/RECORD,,
+djresttoolkit/views/mixins/__init__.py,sha256=mHD49OUxuJ9v81tGfM0hLnUJuJlYi7E-5cTVdplh-vs,91
+djresttoolkit/views/mixins/_retrieve_object_mixin.py,sha256=v7CQDUkRWjtevFZnAYRBdDl7wcfYWF3evWoKWHAcckA,1749
+djresttoolkit-1.1.0.dist-info/METADATA,sha256=0Ln7HqEDc0-fHHiJZhZv0uipTH5TC9IsoWH9dWCswvI,31878
+djresttoolkit-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+djresttoolkit-1.1.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
+djresttoolkit-1.1.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
+djresttoolkit-1.1.0.dist-info/RECORD,,