djresttoolkit 1.1.0__tar.gz → 1.2.1__tar.gz

{djresttoolkit-1.1.0 → djresttoolkit-1.2.1}/PKG-INFO

@@ -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 → djresttoolkit-1.2.1}/README.md

@@ -914,7 +914,7 @@ from djresttoolkit.pagination import PaginatedDataBuilder
 ```python
 builder = PaginatedDataBuilder(
     request=request,
-    serializer_class=MySerializer,
+    serializer_class=BookSerializer,
     queryset=MyModel.objects.all()
 )
 ```
@@ -923,7 +923,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]`
 
@@ -931,6 +931,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
 
@@ -945,8 +949,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" }
   ]
 }
 ```
@@ -1025,6 +1029,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 → djresttoolkit-1.2.1}/demo/apps/todos/models.py

@@ -57,8 +57,18 @@ class Todo(BaseModel):
         on_delete=CASCADE,
         related_name="todos",
         help_text="Owner of this todo",
+        error_messages={
+            "null": "Every todo must belong to a user.",
+            "invalid": "Invalid user reference.",
+        },
+    )
+    title: CharField[str, str] = CharField(
+        max_length=255,
+        error_messages={
+            "blank": "Please give your todo a title.",
+            "max_length": "The title cannot exceed 255 characters.",
+        },
     )
-    title: CharField[str, str] = CharField(max_length=255)
     description: TextField[str, str] = TextField(blank=True, default="")
     due_date: DateTimeField[str | None, str | None] = DateTimeField(
         null=True,
@@ -69,16 +79,25 @@ class Todo(BaseModel):
         max_length=20,
         choices=TodoPriority.choices,
         default=TodoPriority.MEDIUM,
+        error_messages={
+            "invalid_choice": "Priority must be one of: low, medium, high, critical.",
+        },
     )
     status: CharField[str, str] = CharField(
         max_length=20,
         choices=TodoStatus.choices,
         default=TodoStatus.PENDING,
+        error_messages={
+            "invalid_choice": "Status must be one of: pending, in_progress, completed, archived.",
+        },
     )
 
     completed_at: DateTimeField[str | None, str | None] = DateTimeField(
         null=True,
         blank=True,
+        error_messages={
+            "invalid": "Completed at must be a valid datetime.",
+        },
     )
 
     def mark_completed(self) -> None:

djresttoolkit-1.2.1/demo/apps/todos/serializers.py

@@ -0,0 +1,9 @@
+from djresttoolkit.serializers import EnhancedModelSerializer
+
+from .models import Todo
+
+
+class TodoSerializer(EnhancedModelSerializer[Todo]):
+    class Meta:
+        model = Todo
+        exclude = ["created_at", "updated_at"] 

{djresttoolkit-1.1.0 → djresttoolkit-1.2.1}/demo/apps/todos/urls.py

@@ -4,8 +4,9 @@ URL configuration for todos app.
 
 from django.urls import path
 
-from .views import TodoDetailView
+from .views import TodoDetailView, TodoListView
 
 urlpatterns = [
+    path("", TodoListView.as_view(), name="todo-list"),
     path("<int:id>/", TodoDetailView.as_view(), name="todo-detail"),
 ]

djresttoolkit-1.2.1/demo/apps/todos/views.py

@@ -0,0 +1,43 @@
+from rest_framework.permissions import AllowAny
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from djresttoolkit.pagination import PaginatedDataBuilder
+from djresttoolkit.views.mixins import RetrieveObjectMixin
+
+from .models import Todo
+from .serializers import TodoSerializer
+
+
+class TodoListView(APIView):
+    permission_classes = [AllowAny]
+
+    def get(self, request: Request) -> Response:
+        pagination = PaginatedDataBuilder[Todo](
+            request=request,
+            serializer_class=TodoSerializer,
+            queryset=Todo.objects.all(),
+        )
+        return Response(data=pagination.paginated_data)
+
+    def post(self, request: Request) -> Response:
+        serializer = TodoSerializer(
+            data=request.data,
+            many=isinstance(request.data, list),
+        )
+
+        if serializer.is_valid():
+            serializer.save(user=request.user)
+
+        return Response(data=serializer.data)
+
+
+class TodoDetailView(RetrieveObjectMixin[Todo], APIView):
+    permission_classes = [AllowAny]
+    queryset = Todo.objects.all()
+
+    def get(self, request: Request, id: int) -> Response:
+        todo = self.get_object(id=id)
+        serializer = TodoSerializer(instance=todo, many=False)
+        return Response(data=serializer.data)

djresttoolkit-1.2.1/demo/apps_config/__init__.py

@@ -0,0 +1,3 @@
+from dotenv import load_dotenv
+
+load_dotenv()

{djresttoolkit-1.1.0 → djresttoolkit-1.2.1}/demo/apps_config/settings.py

@@ -1,4 +1,5 @@
 import sys
+from os import getenv
 from pathlib import Path
 
 # Configuration Settings File for the django backend
@@ -12,7 +13,7 @@ sys.path.insert(0, str(SRC_DIR))
 
 # Security Configuration Settings
 # -------------------------------
-SECRET_KEY = "asdkjasdjgasdgjioarejalk54884a651asdgklnaskdg"
+SECRET_KEY = getenv("SECRET_KEY")
 
 # DEBUG Configuration Settings
 # ----------------------------
@@ -164,6 +165,7 @@ MEDIA_URL = "/media/"
 # -------------------------------------
 REST_FRAMEWORK = {
     "NON_FIELD_ERRORS_KEY": "non_field",
+    "DATETIME_FORMAT": "%Y-%m-%d %H:%M",
     "DEFAULT_AUTHENTICATION_CLASSES": [
         "rest_framework.authentication.TokenAuthentication",
     ],

{djresttoolkit-1.1.0 → djresttoolkit-1.2.1}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "1.1.0"
+version = "1.2.1"
 description = "A collection of Django and DRF utilities to simplify API development."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }
@@ -45,10 +45,7 @@ keywords = [
     "python-package",
 ]
 requires-python = ">=3.13"
-dependencies = [
-    "faker>=37.5.3",
-    "pydantic>=2.11.7",
-]
+dependencies = ["faker>=37.5.3", "pydantic>=2.11.7"]
 
 # CLI scripts entry point configuration
 # -------------------------------------
@@ -109,12 +106,19 @@ Source = "https://github.com/shaileshpandit141/djresttoolkit"
 Issues = "https://github.com/shaileshpandit141/djresttoolkit/issues"
 License = "https://github.com/shaileshpandit141/djresttoolkit/blob/main/LICENSE"
 
-# ===================
-# Tool Configurations
-# ===================
 
+# ==========================
+# Add pyright Configurations
+# ==========================
+[tool.pyright]
+typeCheckingMode = "strict"
+reportMissingTypeStubs = false
+reportUnknownMemberType = false
+reportIncompatibleVariableOverride = false
+
+# =========================================
 # Disable ruff S101 rule for test casecases
-# -----------------------------------------
+# =========================================
 [tool.ruff.lint.per-file-ignores]
 "tests/*.py" = ["S101"]
 

{djresttoolkit-1.1.0 → djresttoolkit-1.2.1}/src/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-1.2.1/src/djresttoolkit/serializers/__init__.py

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

djresttoolkit-1.2.1/src/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 → djresttoolkit-1.2.1}/uv.lock

@@ -342,7 +342,7 @@ wheels = [
 
 [[package]]
 name = "djresttoolkit"
-version = "1.0.0"
+version = "1.1.0"
 source = { editable = "." }
 dependencies = [
     { name = "faker" },

djresttoolkit-1.1.0/demo/apps/todos/views.py

@@ -1,18 +0,0 @@
-from django.forms.models import model_to_dict
-from rest_framework.permissions import AllowAny
-from rest_framework.request import Request
-from rest_framework.response import Response
-from rest_framework.views import APIView
-
-from djresttoolkit.views.mixins import RetrieveObjectMixin
-
-from .models import Todo
-
-
-class TodoDetailView(RetrieveObjectMixin[Todo], APIView):
-    permission_classes = [AllowAny]
-    queryset = Todo.objects.all()
-
-    def get(self, request: Request, id: int) -> Response:
-        todo = self.get_object(id=id)
-        return Response(data=model_to_dict(todo))