djresttoolkit 1.1.0__py3-none-any.whl → 1.2.1__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
@@ -63,3 +65,7 @@ class PaginatedDataBuilder[T: Model]:
 
         logger.debug(f"Pagination result: {paginated_data}")
         return paginated_data
+
+    @property
+    def paginated_data(self) -> dict[str, Any]:
+        return self.get_paginated_data()

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-1.1.0.dist-info → djresttoolkit-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 1.1.0
+Version: 1.2.1
 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
@@ -970,7 +970,7 @@ from djresttoolkit.pagination import PaginatedDataBuilder
 ```python
 builder = PaginatedDataBuilder(
     request=request,
-    serializer_class=MySerializer,
+    serializer_class=BookSerializer,
     queryset=MyModel.objects.all()
 )
 ```
@@ -979,7 +979,7 @@ builder = PaginatedDataBuilder(
 - `serializer_class: type[BaseSerializer]`:- DRF serializer class for the model.
 - `queryset: QuerySet`:- Django queryset to paginate.
 
-### Paginated Data Builder Methods
+### Paginated Data Builder Methods and Property
 
 - `get_paginated_data() -> dict[str, Any]`
 
@@ -987,6 +987,10 @@ builder = PaginatedDataBuilder(
   - Serializes the paginated results.
   - Returns a dictionary with `"page"` and `"results"`.
   - Raises `NotFound` if no page data is found.
+  
+- `paginated_data -> dict[str, Any]`
+
+  - Call `paginated_data` property that internaly call `get_paginated_data()` method
 
 ### Example Response of Paginated Data Builder
 
@@ -1001,8 +1005,8 @@ builder = PaginatedDataBuilder(
     "previous": "http://api.example.com/items/?page=1&page-size=20"
   },
   "results": [
-    { "id": 21, "name": "Item 21" },
-    { "id": 22, "name": "Item 22" }
+    { "id": 21, "title": "Title 21" },
+    { "id": 22, "title": "Title 22" }
   ]
 }
 ```
@@ -1081,6 +1085,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.1.0.dist-info → djresttoolkit-1.2.1.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=oASu4wA8hN8vaPlh4rx0HM600CUVO179M25JEr9pRx4,2424
 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
@@ -50,8 +51,8 @@ djresttoolkit/views/_exceptions/__init__.py,sha256=DrCUxuPNyBR4WhzNutn5HDxLa--q5
 djresttoolkit/views/_exceptions/_exception_handler.py,sha256=_o7If47bzWLl57LeSXSWsIDsJGo2RIpwYAwNQ-hsHVY,2839
 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,,
+djresttoolkit-1.2.1.dist-info/METADATA,sha256=tfUlUP1aTjciJVuxWBmGMr_pJngjAOKwihneOuThlUI,32697
+djresttoolkit-1.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+djresttoolkit-1.2.1.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
+djresttoolkit-1.2.1.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
+djresttoolkit-1.2.1.dist-info/RECORD,,