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

djresttoolkit/pagination/_paginated_data_builder.py

@@ -1,11 +1,13 @@
 import logging
 from typing import Any
 
-from django.db.models import QuerySet
+from django.db.models import Model, QuerySet
 from rest_framework.exceptions import NotFound
 from rest_framework.request import Request
 from rest_framework.serializers import BaseSerializer
-from django.db.models import Model
+
+from djresttoolkit.serializers import EnhancedModelSerializer
+
 from ._page_number_pagination import PageNumberPagination
 
 # Get logger from logging.
@@ -18,7 +20,7 @@ class PaginatedDataBuilder[T: Model]:
     def __init__(
         self,
         request: Request,
-        serializer_class: type[BaseSerializer[T]],
+        serializer_class: type[BaseSerializer[T] | EnhancedModelSerializer[T]],
         queryset: QuerySet[T],
     ) -> None:
         """Initilize the PaginatedDataBuilder class."""
@@ -49,7 +51,7 @@ class PaginatedDataBuilder[T: Model]:
         )
 
         # Construct the paginated response
-        paginated_data = {
+        paginated_data: dict[str, Any] = {
             "page": {
                 "current": paginator.page.number,  # type: ignore
                 "total": paginator.page.paginator.num_pages,  # type: ignore

djresttoolkit/serializers/__init__.py

@@ -0,0 +1,3 @@
+from ._enhanced_model_serializer import EnhancedModelSerializer
+
+__all__ = ["EnhancedModelSerializer"]

djresttoolkit/serializers/_enhanced_model_serializer.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from copy import deepcopy
+from typing import Any
+
+from django.db.models import Field as DjangoField
+from django.db.models import Model
+from rest_framework.serializers import Field as DrfField
+from rest_framework.serializers import ModelSerializer
+from rest_framework.utils.model_meta import RelationInfo
+
+
+class EnhancedModelSerializer[T: Model](ModelSerializer[Model]):
+    """
+    A DRF ModelSerializer that automatically applies Django model field
+    `error_messages` unless explicitly overridden in the serializer.
+    """
+
+    def _merge_error_messages(
+        self,
+        field_kwargs: dict[str, Any],
+        model_field: DjangoField[Any, Any] | None,
+    ) -> dict[str, Any]:
+        """Safely merge model field error_messages with serializer kwargs."""
+        model_errors: dict[str, str] | None = getattr(
+            model_field, "error_messages", None
+        )
+        if model_errors:
+            existing: dict[str, str] = field_kwargs.get("error_messages", {})
+            field_kwargs["error_messages"] = {**deepcopy(model_errors), **existing}
+        return field_kwargs
+
+    def build_standard_field(
+        self,
+        field_name: str,
+        model_field: DjangoField[Any, Any],
+    ) -> tuple[type[DrfField[Any, Any, Any, Any]], dict[str, Any]]:
+        field_class, field_kwargs = super().build_standard_field(  # type: ignore
+            field_name,
+            model_field,
+        )
+        return field_class, self._merge_error_messages(
+            field_kwargs,
+            model_field,
+        )  # type: ignore
+
+    def build_relational_field(
+        self,
+        field_name: str,
+        relation_info: RelationInfo,
+    ) -> tuple[type[DrfField[Any, Any, Any, Any]], dict[str, Any]]:
+        field_class, field_kwargs = super().build_relational_field(  # type: ignore
+            field_name,
+            relation_info,
+        )
+        return field_class, self._merge_error_messages(
+            field_kwargs,
+            relation_info.model_field,  # type: ignore
+        )

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.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 1.0.0
+Version: 1.2.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
@@ -1079,6 +1081,27 @@ class BookViewSet(CacheInvalidateMixin, ModelViewSet):
 - Invalidates caches when books are created, updated, or deleted.
 - Supports custom cache keys per action.
 
+### 17. EnhancedModelSerializer — API Reference
+
+A subclass of Django REST Framework’s `ModelSerializer` that automatically merges Django model field `error_messages` into the serializer field, unless explicitly overridden.
+This helps maintain consistent validation messages between the model and the serializer.
+
+#### Type Parameters
+
+- `T` (`Model`): The Django model type that the serializer corresponds to.
+
+#### Example of EnhancedModelSerializer
+
+```python
+from myapp.models import Book
+from myapp.serializers import EnhancedModelSerializer
+
+class BookSerializer(EnhancedModelSerializer[Book]):
+    class Meta:
+        model = Book
+        fields = "__all__"
+```
+
 ## 🛠️ Planned Features
 
 - Add more utils

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

@@ -32,10 +32,11 @@ djresttoolkit/models/mixins/__init__.py,sha256=MHwv36f3nHwI0bXeejuO7MTYuV93ln2tS
 djresttoolkit/models/mixins/_model_choice_fields_mixin.py,sha256=9FZbe3PwrtIUZYGQh1gcOix5bfeyvKEOaNmkemvZX8E,2843
 djresttoolkit/pagination/__init__.py,sha256=lQhyyX381RbWBsYV9Os3OQIbY7Z6aouL0QE5kI_u5SU,176
 djresttoolkit/pagination/_page_number_pagination.py,sha256=NHPdMZfmTurKLdgpMBT2usTiGAoZMyA3dYXq_n11y34,2358
-djresttoolkit/pagination/_paginated_data_builder.py,sha256=N4JaJwmfmC2NiC8MqOpkxV8-itKTueaOdawnv_it4bU,2239
+djresttoolkit/pagination/_paginated_data_builder.py,sha256=_HjWbh0kUsn1WswONhqFI4dPCog3foqFQryLpmGarD8,2320
 djresttoolkit/renderers/__init__.py,sha256=kmFMPRiMfD8CuJTN1_-6Z_Hqil3x8GBM0IN1roZESm0,107
 djresttoolkit/renderers/_throttle_info_json_renderer.py,sha256=aP2cN4cB_Imcpy732zsPBQrMQqcKEs5R3dld5Y_4AMU,1089
-djresttoolkit/serializers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+djresttoolkit/serializers/__init__.py,sha256=367CLluj8C15Zpr7BD-euP4DxKbwepm58gnGGcuYOJU,103
+djresttoolkit/serializers/_enhanced_model_serializer.py,sha256=XNYM-zy5_ecfUNRtmBfaDKSuxEDhmoBV9HNx8iSaDpE,2055
 djresttoolkit/serializers/mixins/__init__.py,sha256=dRT0kXDckOkZo1RQHrT1gXbGFMIv5M8TBHGF2uF-81Q,225
 djresttoolkit/serializers/mixins/_absolute_url_file_mixin.py,sha256=5ewael0_RsJZ9b36IfXacxjb-Vx1eQ9Dk6dWuj5D_dc,3261
 djresttoolkit/serializers/mixins/_bulk_create_mixin.py,sha256=9ZWm2MNaZOhmhKlWOu6VECtlDbUtaPeceGHmivDYwYQ,3248
@@ -48,10 +49,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.2.0.dist-info/METADATA,sha256=ZLrUSwjbWip4-Rh6Mrkc2sD2sha_AHF8G-cR39VdiOo,32552
+djresttoolkit-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+djresttoolkit-1.2.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
+djresttoolkit-1.2.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
+djresttoolkit-1.2.0.dist-info/RECORD,,