djresttoolkit 0.16.0__tar.gz → 0.17.0__tar.gz

{djresttoolkit-0.16.0 → djresttoolkit-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.16.0
+Version: 0.17.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
@@ -64,13 +64,56 @@ Description-Content-Type: text/markdown
 
 djresttoolkit is a collection of utilities and helpers for Django and Django REST Framework (DRF) that simplify common development tasks such as API handling, authentication, and email sending and much more.
 
-## ✨ Features
+## 📖 Feature Index (djresttoolkit)
 
-- Django REST Framework helpers (serializers, views, pagination, etc.)
-- Django utilities (e.g., email sending, model mixins)
-- Ready-to-use shortcuts to speed up API development
-- Lightweight, no unnecessary dependencies
-- Type Safe - written with modern Python type hints.
+- **DB Seed Command (`dbseed`)**
+  Seed your database with fake data using Pydantic models powered by **Faker**. Supports relationships, transactions, and a `manage.py dbseed` command.
+
+- **DB Flush Command (`dbflush`)**
+  Management command to flush all models or a specific model, resetting auto-increment IDs safely with transaction support.
+
+- **EnvBaseSettings**
+  Typed settings loader using **YAML + .env**, supports nested keys and overrides. Great for structured configuration management.
+
+- **EmailSender**
+  Custom class to send templated emails (`text` and `html`) with context. Supports error handling and logging.
+
+- **Custom DRF Exception Handler**
+  Centralized error handler for DRF that extends default behavior and adds throttle support (`429 Too Many Requests` with retry info).
+
+- **Response Time Middleware**
+  Middleware to measure, log, and inject `X-Response-Time` headers into every response.
+
+- **Throttle**
+  - `ThrottleInfoJSONRenderer`: Automatically adds throttle headers to responses.
+  - `ThrottleInspector`: Inspect view/request throttling and attach structured headers.
+
+- **AbsoluteUrlFileMixin**
+  DRF serializer mixin that converts `FileField` / `ImageField` URLs to **absolute URLs** automatically.
+
+- **BulkCreateMixin**
+  Serializer mixin that enables **bulk creation** of objects and syncs field error messages with model fields.
+
+- **ModelChoiceFieldMixin**
+  Retrieve choice fields (`TextChoices`, etc.) from Django models as structured dictionaries for API responses.
+
+- **ChoiceFieldsAPIView**
+  Generic API view that exposes model `choices` in a REST-friendly JSON format.
+
+- **RetrieveObjectMixin**
+  Lightweight mixin to fetch a single object from a queryset with filters, raising a custom error if `queryset` is not defined.
+
+- **build\_absolute\_uri**
+  Helper to build full absolute URLs for named routes with optional query params. Works with Django + DRF requests.
+
+- **PageNumberPagination**
+  Custom paginator with a structured `"page"` metadata block and support for dynamic `page-size` query param.
+
+- **PaginatedDataBuilder**
+  Builder that combines `PageNumberPagination` + serializers to return standardized paginated responses with `"page"` + `"results"`.
+
+- **Caching Mixins**
+  This module provides a set of DRF mixins to handle caching for `list`, `retrieve`, and `custom actions` with automatic invalidation on create, update, and destroy.
 
 ## 📦 Installation
 
@@ -88,7 +131,7 @@ djresttoolkit is a collection of utilities and helpers for Django and Django RES
 
 ## 📚 All API Reference
 
-### 1. DB Seed Utilities — API Reference
+### 1. DB Seed Command — API Reference
 
 #### `Generator`
 
@@ -272,7 +315,7 @@ print(settings.database_url)
 #### Features
 
 - Prioritizes `.env` variables over YAML.
-- Supports nested keys: `DATABASE__HOST` → `settings.database.host`.
+- Supports nested keys: `DATABASE__HOST`:- `settings.database.host`.
 - Designed to be subclassed for project-specific settings.
 
 ### 4. EmailSender — API Reference
@@ -411,7 +454,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 7. Throttle Utilities — API Reference
+### 7. Throttle — API Reference
 
 #### `ThrottleInfoJSONRenderer`
 
@@ -888,17 +931,17 @@ from djresttoolkit.pagination import PageNumberPagination
 - Clients can control items per page using `?page-size=`.
 - Structured pagination metadata:
 
-  - `current` → current page number
-  - `total` → total number of pages
-  - `size` → number of items per page
-  - `total_items` → total number of items across all pages
-  - `next` → next page URL
-  - `previous` → previous page URL
+  - `current`:- current page number
+  - `total`:- total number of pages
+  - `size`:- number of items per page
+  - `total_items`:- total number of items across all pages
+  - `next`:- next page URL
+  - `previous`:- previous page URL
 - Standardized API response format.
 
 ### Attributes of Page Number Pagination
 
-- `page_size_query_param: str` → Query parameter name (`"page-size"`).
+- `page_size_query_param: str`:- Query parameter name (`"page-size"`).
 
 ### Page Number Pagination Methods
 
@@ -943,8 +986,8 @@ from djresttoolkit.pagination import PaginatedDataBuilder
 - Integrates with **DRF serializers**.
 - Handles **invalid pages** gracefully by raising `NotFound`.
 - Returns both:
-  - `"page"` → pagination metadata
-  - `"results"` → serialized data.
+  - `"page"`:- pagination metadata
+  - `"results"`:- serialized data.
 - Provides **structured pagination response format**.
 
 ---
@@ -959,9 +1002,9 @@ builder = PaginatedDataBuilder(
 )
 ```
 
-- `request: Request` → DRF request object.
-- `serializer_class: type[BaseSerializer]` → DRF serializer class for the model.
-- `queryset: QuerySet` → Django queryset to paginate.
+- `request: Request`:- DRF request object.
+- `serializer_class: type[BaseSerializer]`:- DRF serializer class for the model.
+- `queryset: QuerySet`:- Django queryset to paginate.
 
 ### Paginated Data Builder Methods
 
@@ -991,6 +1034,80 @@ builder = PaginatedDataBuilder(
 }
 ```
 
+### 16. Caching Mixins — API Reference
+
+This module provides a set of DRF mixins to handle **caching for list, retrieve, and custom actions** with automatic invalidation on create, update, and destroy.
+
+#### 1️ `CacheKeyMixin`
+
+- **Purpose**: Generate unique cache keys for DRF viewset actions.
+- **Attributes**:
+  - `cache_timeout: int = 300`:- default cache duration in seconds.
+- **Methods**:
+  - `get_cache_timeout()`:- returns the cache timeout.
+  - `get_cache_key(action_type, pk=None, action_name=None)`:- returns a cache key string based on action type:**
+    - `list` or `custom-list`:- hash of query parameters.
+    - `retrieve` or `custom-detail`:- uses primary key (`pk`).
+
+#### 2️ `CacheOpsMixin`
+
+- **Purpose**: Get, set, and invalidate cache.
+- **Methods**:
+  - `get_or_set_cache(cache_key, data_fn, timeout=None)`:- fetch from cache or compute and set.
+  - `invalidate_cache(pk=None, custom_actions=None)`:- delete cached items:
+    - Deletes retrieve/detail caches for a `pk`.
+    - Deletes list caches (supports `delete_pattern` if available).
+
+#### 3️ `CacheActionMixin`
+
+- **Purpose**: Decorator for caching custom DRF `@action` methods.
+- **Methods**:
+  - `cache_action(detail=False, action_name=None)`:- returns a decorator that caches action results automatically.
+  - Works for:
+    - `detail=False`:- custom-list action cache.
+    - `detail=True`:- custom-detail action cache.
+
+#### 4️ `CacheListRetrieveMixin`
+
+- **Purpose**: Caches DRF `list()` and `retrieve()` responses.
+- **Methods**:
+  - `list(request, *args, **kwargs)`:- caches list responses.
+  - `retrieve(request, *args, **kwargs)`:- caches detail responses.
+  - `_get_list_data(request)`:- internal method to fetch paginated list data.
+  - `_get_detail_data()`:- internal method to fetch a single object.
+
+#### 5️ `CacheInvalidateMixin`
+
+- **Purpose**: Automatically invalidates caches on write operations.
+- **Methods**:
+  - `create(request, *args, **kwargs)`:- invalidates list caches.
+  - `update(request, *args, **kwargs)`:- invalidates detail caches for `pk`.
+  - `destroy(request, *args, **kwargs)`:- invalidates detail caches for `pk`.
+
+#### Example of Caching Mixins
+
+```python
+from rest_framework.viewsets import ModelViewSet
+from myapp.models import Book
+from myapp.serializers import BookSerializer
+from djresttoolkit.cache_mixins import CacheInvalidateMixin, CacheActionMixin
+
+class BookViewSet(CacheInvalidateMixin, ModelViewSet):
+    queryset = Book.objects.all()
+    serializer_class = BookSerializer
+    basename = "book"
+
+    @CacheActionMixin.cache_action(detail=False)
+    def popular(self, request):
+        data = Book.objects.filter(is_popular=True)
+        serializer = self.get_serializer(data, many=True)
+        return Response(serializer.data)
+```
+
+- Automatically caches `list`, `retrieve`, and `popular` actions.
+- Invalidates caches when books are created, updated, or deleted.
+- Supports custom cache keys per action.
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.16.0 → djresttoolkit-0.17.0}/README.md

@@ -6,13 +6,56 @@
 
 djresttoolkit is a collection of utilities and helpers for Django and Django REST Framework (DRF) that simplify common development tasks such as API handling, authentication, and email sending and much more.
 
-## ✨ Features
+## 📖 Feature Index (djresttoolkit)
 
-- Django REST Framework helpers (serializers, views, pagination, etc.)
-- Django utilities (e.g., email sending, model mixins)
-- Ready-to-use shortcuts to speed up API development
-- Lightweight, no unnecessary dependencies
-- Type Safe - written with modern Python type hints.
+- **DB Seed Command (`dbseed`)**
+  Seed your database with fake data using Pydantic models powered by **Faker**. Supports relationships, transactions, and a `manage.py dbseed` command.
+
+- **DB Flush Command (`dbflush`)**
+  Management command to flush all models or a specific model, resetting auto-increment IDs safely with transaction support.
+
+- **EnvBaseSettings**
+  Typed settings loader using **YAML + .env**, supports nested keys and overrides. Great for structured configuration management.
+
+- **EmailSender**
+  Custom class to send templated emails (`text` and `html`) with context. Supports error handling and logging.
+
+- **Custom DRF Exception Handler**
+  Centralized error handler for DRF that extends default behavior and adds throttle support (`429 Too Many Requests` with retry info).
+
+- **Response Time Middleware**
+  Middleware to measure, log, and inject `X-Response-Time` headers into every response.
+
+- **Throttle**
+  - `ThrottleInfoJSONRenderer`: Automatically adds throttle headers to responses.
+  - `ThrottleInspector`: Inspect view/request throttling and attach structured headers.
+
+- **AbsoluteUrlFileMixin**
+  DRF serializer mixin that converts `FileField` / `ImageField` URLs to **absolute URLs** automatically.
+
+- **BulkCreateMixin**
+  Serializer mixin that enables **bulk creation** of objects and syncs field error messages with model fields.
+
+- **ModelChoiceFieldMixin**
+  Retrieve choice fields (`TextChoices`, etc.) from Django models as structured dictionaries for API responses.
+
+- **ChoiceFieldsAPIView**
+  Generic API view that exposes model `choices` in a REST-friendly JSON format.
+
+- **RetrieveObjectMixin**
+  Lightweight mixin to fetch a single object from a queryset with filters, raising a custom error if `queryset` is not defined.
+
+- **build\_absolute\_uri**
+  Helper to build full absolute URLs for named routes with optional query params. Works with Django + DRF requests.
+
+- **PageNumberPagination**
+  Custom paginator with a structured `"page"` metadata block and support for dynamic `page-size` query param.
+
+- **PaginatedDataBuilder**
+  Builder that combines `PageNumberPagination` + serializers to return standardized paginated responses with `"page"` + `"results"`.
+
+- **Caching Mixins**
+  This module provides a set of DRF mixins to handle caching for `list`, `retrieve`, and `custom actions` with automatic invalidation on create, update, and destroy.
 
 ## 📦 Installation
 
@@ -30,7 +73,7 @@ djresttoolkit is a collection of utilities and helpers for Django and Django RES
 
 ## 📚 All API Reference
 
-### 1. DB Seed Utilities — API Reference
+### 1. DB Seed Command — API Reference
 
 #### `Generator`
 
@@ -214,7 +257,7 @@ print(settings.database_url)
 #### Features
 
 - Prioritizes `.env` variables over YAML.
-- Supports nested keys: `DATABASE__HOST` → `settings.database.host`.
+- Supports nested keys: `DATABASE__HOST`:- `settings.database.host`.
 - Designed to be subclassed for project-specific settings.
 
 ### 4. EmailSender — API Reference
@@ -353,7 +396,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 7. Throttle Utilities — API Reference
+### 7. Throttle — API Reference
 
 #### `ThrottleInfoJSONRenderer`
 
@@ -830,17 +873,17 @@ from djresttoolkit.pagination import PageNumberPagination
 - Clients can control items per page using `?page-size=`.
 - Structured pagination metadata:
 
-  - `current` → current page number
-  - `total` → total number of pages
-  - `size` → number of items per page
-  - `total_items` → total number of items across all pages
-  - `next` → next page URL
-  - `previous` → previous page URL
+  - `current`:- current page number
+  - `total`:- total number of pages
+  - `size`:- number of items per page
+  - `total_items`:- total number of items across all pages
+  - `next`:- next page URL
+  - `previous`:- previous page URL
 - Standardized API response format.
 
 ### Attributes of Page Number Pagination
 
-- `page_size_query_param: str` → Query parameter name (`"page-size"`).
+- `page_size_query_param: str`:- Query parameter name (`"page-size"`).
 
 ### Page Number Pagination Methods
 
@@ -885,8 +928,8 @@ from djresttoolkit.pagination import PaginatedDataBuilder
 - Integrates with **DRF serializers**.
 - Handles **invalid pages** gracefully by raising `NotFound`.
 - Returns both:
-  - `"page"` → pagination metadata
-  - `"results"` → serialized data.
+  - `"page"`:- pagination metadata
+  - `"results"`:- serialized data.
 - Provides **structured pagination response format**.
 
 ---
@@ -901,9 +944,9 @@ builder = PaginatedDataBuilder(
 )
 ```
 
-- `request: Request` → DRF request object.
-- `serializer_class: type[BaseSerializer]` → DRF serializer class for the model.
-- `queryset: QuerySet` → Django queryset to paginate.
+- `request: Request`:- DRF request object.
+- `serializer_class: type[BaseSerializer]`:- DRF serializer class for the model.
+- `queryset: QuerySet`:- Django queryset to paginate.
 
 ### Paginated Data Builder Methods
 
@@ -933,6 +976,80 @@ builder = PaginatedDataBuilder(
 }
 ```
 
+### 16. Caching Mixins — API Reference
+
+This module provides a set of DRF mixins to handle **caching for list, retrieve, and custom actions** with automatic invalidation on create, update, and destroy.
+
+#### 1️ `CacheKeyMixin`
+
+- **Purpose**: Generate unique cache keys for DRF viewset actions.
+- **Attributes**:
+  - `cache_timeout: int = 300`:- default cache duration in seconds.
+- **Methods**:
+  - `get_cache_timeout()`:- returns the cache timeout.
+  - `get_cache_key(action_type, pk=None, action_name=None)`:- returns a cache key string based on action type:**
+    - `list` or `custom-list`:- hash of query parameters.
+    - `retrieve` or `custom-detail`:- uses primary key (`pk`).
+
+#### 2️ `CacheOpsMixin`
+
+- **Purpose**: Get, set, and invalidate cache.
+- **Methods**:
+  - `get_or_set_cache(cache_key, data_fn, timeout=None)`:- fetch from cache or compute and set.
+  - `invalidate_cache(pk=None, custom_actions=None)`:- delete cached items:
+    - Deletes retrieve/detail caches for a `pk`.
+    - Deletes list caches (supports `delete_pattern` if available).
+
+#### 3️ `CacheActionMixin`
+
+- **Purpose**: Decorator for caching custom DRF `@action` methods.
+- **Methods**:
+  - `cache_action(detail=False, action_name=None)`:- returns a decorator that caches action results automatically.
+  - Works for:
+    - `detail=False`:- custom-list action cache.
+    - `detail=True`:- custom-detail action cache.
+
+#### 4️ `CacheListRetrieveMixin`
+
+- **Purpose**: Caches DRF `list()` and `retrieve()` responses.
+- **Methods**:
+  - `list(request, *args, **kwargs)`:- caches list responses.
+  - `retrieve(request, *args, **kwargs)`:- caches detail responses.
+  - `_get_list_data(request)`:- internal method to fetch paginated list data.
+  - `_get_detail_data()`:- internal method to fetch a single object.
+
+#### 5️ `CacheInvalidateMixin`
+
+- **Purpose**: Automatically invalidates caches on write operations.
+- **Methods**:
+  - `create(request, *args, **kwargs)`:- invalidates list caches.
+  - `update(request, *args, **kwargs)`:- invalidates detail caches for `pk`.
+  - `destroy(request, *args, **kwargs)`:- invalidates detail caches for `pk`.
+
+#### Example of Caching Mixins
+
+```python
+from rest_framework.viewsets import ModelViewSet
+from myapp.models import Book
+from myapp.serializers import BookSerializer
+from djresttoolkit.cache_mixins import CacheInvalidateMixin, CacheActionMixin
+
+class BookViewSet(CacheInvalidateMixin, ModelViewSet):
+    queryset = Book.objects.all()
+    serializer_class = BookSerializer
+    basename = "book"
+
+    @CacheActionMixin.cache_action(detail=False)
+    def popular(self, request):
+        data = Book.objects.filter(is_popular=True)
+        serializer = self.get_serializer(data, many=True)
+        return Response(serializer.data)
+```
+
+- Automatically caches `list`, `retrieve`, and `popular` actions.
+- Invalidates caches when books are created, updated, or deleted.
+- Supports custom cache keys per action.
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.16.0 → djresttoolkit-0.17.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "0.16.0"
+version = "0.17.0"
 description = "A collection of Django and DRF utilities to simplify API development."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }

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

@@ -0,0 +1,16 @@
+from ._retrieve_object_mixin import RetrieveObjectMixin, QuerysetNotDefinedError
+from ._cache_action_mixin import CacheActionMixin
+from ._cache_invalidate_mixin import CacheInvalidateMixin
+from ._cache_key_mixin import CacheKeyMixin
+from ._cache_list_retrieve_mixin import CacheListRetrieveMixin
+from ._cache_ops_mixin import CacheOpsMixin
+
+__all__ = [
+    "RetrieveObjectMixin",
+    "QuerysetNotDefinedError",
+    "CacheActionMixin",
+    "CacheInvalidateMixin",
+    "CacheKeyMixin",
+    "CacheListRetrieveMixin",
+    "CacheOpsMixin",
+]

djresttoolkit-0.17.0/src/djresttoolkit/views/mixins/_cache_action_mixin.py

@@ -0,0 +1,44 @@
+from functools import wraps
+from typing import Any, Callable
+
+from rest_framework.response import Response
+from ._cache_ops_mixin import CacheOpsMixin
+from rest_framework.request import Request
+
+
+class CacheActionMixin(CacheOpsMixin):
+    """Provides decorator for caching custom @action methods."""
+
+    def cache_action(
+        self,
+        detail: bool = False,
+        action_name: str | None = None,
+    ) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
+        def decorator(view_method: Callable[..., Any]) -> Callable[..., Any]:
+            @wraps(view_method)
+            def wrapper(
+                viewset: Any,
+                request: Request,
+                *args: Any,
+                **kwargs: Any,
+            ) -> Response:
+                name = action_name or view_method.__name__
+                pk = kwargs.get("pk") if detail else None
+                action_type = "custom-detail" if detail else "custom-list"
+                key = viewset.get_cache_key(action_type, pk=pk, action_name=name)
+
+                def get_data() -> None | Any:
+                    response = view_method(
+                        viewset,
+                        request,
+                        *args,
+                        **kwargs,
+                    )
+                    return response.data if isinstance(response, Response) else response
+
+                data = viewset.get_or_set_cache(key, get_data)
+                return Response(data)
+
+            return wrapper
+
+        return decorator

djresttoolkit-0.17.0/src/djresttoolkit/views/mixins/_cache_invalidate_mixin.py

@@ -0,0 +1,38 @@
+from typing import Any
+from rest_framework.request import Request
+from rest_framework.response import Response
+from ._cache_list_retrieve_mixin import CacheListRetrieveMixin
+
+
+class CacheInvalidateMixin(CacheListRetrieveMixin):
+    """Invalidate caches after create, update, destroy."""
+
+    def create(
+        self,
+        request: Request,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Response:
+        response = super().create(request, *args, **kwargs)  # type: ignore
+        self.invalidate_cache()
+        return response  # type: ignore
+
+    def update(
+        self,
+        request: Request,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Response:
+        response = super().update(request, *args, **kwargs)  # type: ignore
+        self.invalidate_cache(pk=self.kwargs.get("pk"))  # type: ignore
+        return response  # type: ignore
+
+    def destroy(
+        self,
+        request: Request,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Response:
+        response = super().destroy(request, *args, **kwargs)  # type: ignore
+        self.invalidate_cache(pk=self.kwargs.get("pk"))  # type: ignore
+        return response  # type: ignore

djresttoolkit-0.17.0/src/djresttoolkit/views/mixins/_cache_key_mixin.py

@@ -0,0 +1,33 @@
+import hashlib
+import json
+from typing import Any
+
+
+class CacheKeyMixin:
+    """Handles generating unique cache keys for views."""
+
+    cache_timeout: int = 300
+
+    def get_cache_timeout(self) -> int:
+        return self.cache_timeout
+
+    def get_cache_key(
+        self,
+        action_type: str,
+        pk: Any | str = None,
+        action_name: str | None = None,
+    ) -> str | None:
+        if action_type in ("list", "custom-list"):
+            query_params = dict(sorted(self.request.query_params.items()))  # type: ignore
+            query_string = json.dumps(query_params, separators=(",", ":"))
+            query_hash = hashlib.md5(query_string.encode()).hexdigest()
+            if action_type == "list":
+                return f"{self.basename}_list_{query_hash}"  # type: ignore
+            return f"{self.basename}_{action_name}_list_{query_hash}"  # type: ignore
+
+        if action_type in ("retrieve", "custom-detail") and pk is not None:
+            if action_type == "retrieve":
+                return f"{self.basename}_detail_{pk}"  # type: ignore
+            return f"{self.basename}_{action_name}_detail_{pk}"  # type: ignore
+
+        return None

djresttoolkit-0.17.0/src/djresttoolkit/views/mixins/_cache_list_retrieve_mixin.py

@@ -0,0 +1,57 @@
+from typing import Any
+
+from rest_framework.response import Response
+from rest_framework.request import Request
+from ._cache_action_mixin import CacheActionMixin
+
+
+class CacheListRetrieveMixin(CacheActionMixin):
+    """Caches list() and retrieve() responses."""
+
+    def list(
+        self,
+        request: Request,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Response:
+        cache_key = self.get_cache_key("list")
+        if not cache_key:
+            return super().list(request, *args, **kwargs)  # type: ignore
+
+        data = self.get_or_set_cache(
+            cache_key,
+            lambda: self._get_list_data(request),  # type: ignore
+        )
+        return Response(data)
+
+    def _get_list_data(self, request: Response) -> Any:
+        queryset = self.filter_queryset(self.get_queryset())  # type: ignore
+        page = self.paginate_queryset(queryset)  # type: ignore
+        if page is not None:
+            serializer = self.get_serializer(page, many=True)  # type: ignore
+            return self.get_paginated_response(serializer.data).data  # type: ignore
+        else:
+            serializer = self.get_serializer(queryset, many=True)  # type: ignore
+            return serializer.data  # type: ignore
+
+    def retrieve(
+        self,
+        request: Request,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Response:
+        pk = self.kwargs.get("pk")  # type: ignore
+        cache_key = self.get_cache_key("retrieve", pk=pk)  # type: ignore
+        if not cache_key:
+            return super().retrieve(request, *args, **kwargs)  # type: ignore
+
+        data = self.get_or_set_cache(
+            cache_key,
+            lambda: self._get_detail_data(),
+        )
+        return Response(data)
+
+    def _get_detail_data(self) -> Any:
+        instance = self.get_object()  # type: ignore
+        serializer = self.get_serializer(instance)  # type: ignore
+        return serializer.data  # type: ignore

djresttoolkit-0.17.0/src/djresttoolkit/views/mixins/_cache_ops_mixin.py

@@ -0,0 +1,47 @@
+from typing import Any, Callable
+
+from django.core.cache import cache
+
+from ._cache_key_mixin import CacheKeyMixin
+
+
+class CacheOpsMixin(CacheKeyMixin):
+    """Handles getting, setting, and invalidating cache."""
+
+    def get_or_set_cache(
+        self,
+        cache_key: str,
+        data_fn: Callable[[], Any],
+        timeout: int | None = None,
+    ) -> Any:
+        data = cache.get(cache_key)
+        if data is None:
+            data = data_fn()
+            cache.set(cache_key, data, timeout or self.get_cache_timeout())
+        return data
+
+    def invalidate_cache(
+        self,
+        pk: Any | None = None,
+        custom_actions: list[str] | None = None,
+    ) -> None:
+        if pk:
+            key = self.get_cache_key("retrieve", pk=pk)
+            if key:
+                cache.delete(key)
+
+            if custom_actions:
+                for action in custom_actions:
+                    key = self.get_cache_key(
+                        "custom-detail",
+                        pk=pk,
+                        action_name=action,
+                    )
+                    if key:
+                        cache.delete(key)
+
+        if hasattr(cache, "delete_pattern"):
+            cache.delete_pattern(f"{self.basename}_list_*")  # type: ignore
+            if custom_actions:
+                for action in custom_actions:
+                    cache.delete_pattern(f"{self.basename}_{action}_list_*")  # type: ignore

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

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