djresttoolkit 1.0.0__tar.gz → 1.2.0__tar.gz

{djresttoolkit-1.0.0 → djresttoolkit-1.2.0}/PKG-INFO

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

@@ -184,7 +184,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
@@ -745,6 +745,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
@@ -752,17 +753,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
@@ -1023,6 +1025,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 → djresttoolkit-1.2.0}/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.0/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.2.0/demo/apps/todos/urls.py

@@ -0,0 +1,12 @@
+"""
+URL configuration for todos app.
+"""
+
+from django.urls import path
+
+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.0/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.get_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.0/demo/apps_config/__init__.py

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

{djresttoolkit-1.0.0 → djresttoolkit-1.2.0}/demo/apps_config/settings.py

@@ -1,8 +1,7 @@
 import sys
+from os import getenv
 from pathlib import Path
 
-from env_config import env_settings
-
 # Configuration Settings File for the django backend
 # --------------------------------------------------
 BASE_DIR = Path(__file__).resolve().parent.parent.parent
@@ -14,7 +13,7 @@ sys.path.insert(0, str(SRC_DIR))
 
 # Security Configuration Settings
 # -------------------------------
-SECRET_KEY = env_settings.secret_key
+SECRET_KEY = getenv("SECRET_KEY")
 
 # DEBUG Configuration Settings
 # ----------------------------
@@ -22,11 +21,11 @@ DEBUG = True
 
 # Allowed Host Configuration Settings
 # -----------------------------------
-ALLOWED_HOSTS = env_settings.allowed_hosts
+ALLOWED_HOSTS = ["*"]
 
 # Configure CORS Settings
 # -----------------------
-CORS_ALLOWED_ORIGINS = env_settings.cors_allowed_origins
+# CORS_ALLOWED_ORIGINS = []
 
 # Login Redirect URL Configuration Setting
 # ----------------------------------------
@@ -166,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",
     ],
@@ -200,29 +200,13 @@ REST_FRAMEWORK = {
 # -------------------------------------
 AUTHENTICATION_BACKENDS = ["django.contrib.auth.backends.ModelBackend"]
 
-# EMAIL Configuration Settings
-# ----------------------------
-EMAIL_BACKEND = env_settings.email.backend  # type: ignore[]
-EMAIL_HOST = env_settings.email.host
-EMAIL_PORT = env_settings.email.port
-EMAIL_USE_TLS = env_settings.email.use_tls
-EMAIL_USE_SSL = env_settings.email.use_ssl
-EMAIL_HOST_USER = env_settings.email.host_user
-EMAIL_HOST_PASSWORD = env_settings.email.host_password
-DEFAULT_FROM_EMAIL = env_settings.email.default_from_email
-
-# Google OAuth2 Configuration Settings
-# ------------------------------------
-GOOGLE_CLIENT_ID = env_settings.google.client_id
-GOOGLE_CLIENT_SECRET = env_settings.google.client_secret
-GOOGLE_REDIRECT_URI = env_settings.google.redirect_url
 
 # Redis configuration for production
 # ----------------------------------
 CACHES = {
     "default": {
         "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": env_settings.redis.cache_location,
+        "LOCATION": "redis://localhost:6379/1",
         "OPTIONS": {
             "CLIENT_CLASS": "django_redis.client.DefaultClient",
         },

{djresttoolkit-1.0.0 → djresttoolkit-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "1.0.0"
+version = "1.2.0"
 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.0.0 → djresttoolkit-1.2.0}/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

djresttoolkit-1.2.0/src/djresttoolkit/serializers/__init__.py

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

djresttoolkit-1.2.0/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.2.0/src/djresttoolkit/views/mixins/__init__.py

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

djresttoolkit-1.2.0/src/djresttoolkit/views/mixins/_retrieve_object_mixin.py

@@ -0,0 +1,59 @@
+from typing import Any
+
+from django.core.exceptions import ImproperlyConfigured
+from django.db.models import Model, QuerySet
+from django.http import Http404
+
+
+class RetrieveObjectMixin[T: Model]:
+    """
+    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):
+            queryset = Book.objects.all()
+
+            def get(self, request, *args, **kwargs):
+                obj = self.get_object(id=1)
+                return JsonResponse(obj.to_dict())
+    ```
+    """
+
+    queryset: QuerySet[T] | None = None
+
+    def get_object(self, **filters: Any) -> T:
+        """Retrieve a model object based on provided filters."""
+
+        if self.queryset is None:
+            raise ImproperlyConfigured(
+                "Queryset attribute is not set in the class.",
+            )
+
+        try:
+            return self.queryset.get(**filters)
+        except self.queryset.model.DoesNotExist:
+            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 → djresttoolkit-1.2.0}/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.0.0/demo/apps/todos/urls.py

@@ -1,7 +0,0 @@
-"""
-URL configuration for todos app.
-"""
-
-from django.urls import path
-
-urlpatterns = []

djresttoolkit-1.0.0/demo/env_config/__init__.py

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

djresttoolkit-1.0.0/demo/env_config/env_settings.py

@@ -1,54 +0,0 @@
-from typing import Literal
-
-from pydantic import BaseModel
-
-from src.djresttoolkit.envconfig import EnvBaseSettings
-
-
-class DatabaseConfig(BaseModel):
-    engine: str
-    name: str
-    user: str
-    password: str
-    host: str
-    port: int
-
-
-class RedisConfig(BaseModel):
-    cache_location: str
-
-
-class EmailConfig(BaseModel):
-    backend: str
-    host: str
-    port: int
-    use_tls: bool
-    use_ssl: bool
-    host_user: str
-    host_password: str
-    default_from_email: str
-
-
-class GoogleOAuth2Config(BaseModel):
-    client_id: str
-    client_secret: str
-    redirect_url: str
-
-
-class EnvSettings(EnvBaseSettings["EnvSettings"]):
-    """Env Settings class to handle env loads."""
-
-    secret_key: str
-    host: str
-    port: int
-    environ: Literal["dev", "prod"]
-    allowed_hosts: list[str]
-    cors_allowed_origins: list[str]
-    database: DatabaseConfig
-    redis: RedisConfig
-    email: EmailConfig
-    google: GoogleOAuth2Config
-
-
-env_settings = EnvSettings.load(warning=False)
-

djresttoolkit-1.0.0/src/djresttoolkit/views/mixins/__init__.py

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

djresttoolkit-1.0.0/src/djresttoolkit/views/mixins/_retrieve_object_mixin.py

@@ -1,41 +0,0 @@
-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
-
-
-class RetrieveObjectMixin[T: Model]:
-    """
-    Mixin to provide a method for retrieving a single model object by filters.
-
-    Requires the `queryset` attribute to be set in the class that inherits this mixin.
-
-    Example:
-    ```
-        class MyView(RetrieveModelMixin[Book], APIView):
-            queryset = Book.objects.all()
-
-            def get(self, request, *args, **kwargs):
-                obj = self.get_object(id=1)
-                return JsonResponse(obj.to_dict())
-    ```
-    """
-
-    queryset: QuerySet[T] | None = None
-
-    def get_object(self, **filters: Any) -> T | None:
-        """Retrieve a model object based on provided filters."""
-
-        if self.queryset is None:
-            raise QuerysetNotDefinedError(
-                "Queryset attribute is not set in the class.",
-            )
-
-        try:
-            return self.queryset.get(**filters)
-        except self.queryset.model.DoesNotExist:
-            return None