djresttoolkit 0.12.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

README.md

@@ -695,6 +695,124 @@ urlpatterns = [
 - Useful for frontend forms or API consumers that need selectable options.
 - Integrates seamlessly with `ModelChoiceFieldMixin` from `djresttoolkit`.
 
+### 12. RetrieveObjectMixin — API Reference
+
+```python
+from djresttoolkit.views.mixins import RetrieveObjectMixin
+```
+
+#### `RetrieveObjectMixin[T: Model]`
+
+A **generic mixin** to retrieve a single Django model instance by filters.
+
+#### Class Attributes of Retrieve Object Mixin
+
+- `queryset: QuerySet[T] | None` — The queryset used to retrieve objects. **Must be set.**
+
+#### Raises of Retrieve Object Mixin
+
+- `QuerysetNotDefinedError` — If `queryset` is not set in the class.
+
+#### Retrieve Object Mixin Methods
+
+- `get_object(**filters: Any) -> T | None`
+
+Retrieve a single model object using the provided filter criteria.
+
+- **Parameters:**
+  - `**filters` — Keyword arguments to filter the queryset (e.g., `id=1`, `slug="abc"`).
+
+- **Returns:**
+  - Model instance matching the filters, or `None` if no match is found.
+
+#### Example of Retrieve Object Mixin
+
+```python
+from rest_framework.views import APIView
+from django.http import JsonResponse
+from myapp.models import Book
+from djresttoolkit.mixins import RetrieveObjectMixin
+
+class BookDetailView(RetrieveObjectMixin[Book], APIView):
+    queryset = Book.objects.all()
+
+    def get(self, request, *args, **kwargs):
+        book = self.get_object(id=kwargs["id"])
+        if book:
+            return JsonResponse({"title": book.title, "author": book.author})
+        return JsonResponse({"detail": "Not found"}, status=404)
+```
+
+#### 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.
+- Works with any Django model and queryset.
+
+### 13. build_absolute_uri — API Reference
+
+```python
+from djresttoolkit.urls import build_absolute_uri
+```
+
+#### build absolute uri Description
+
+- Builds a **fully qualified absolute URL** for a Django or DRF view.
+- Optionally includes **query parameters**.
+- Works with both **Django `HttpRequest`** and **DRF `Request`** objects.
+- Uses Django's `reverse()` to dynamically resolve URL names.
+
+#### build absolute uri Function Signature
+
+```python
+def build_absolute_uri(
+    request: HttpRequest | Request,
+    url_name: str,
+    query_params: dict[str, Any] | None = None,
+    *args: Any,
+    **kwargs: Any,
+) -> str:
+    ...
+```
+
+---
+
+#### build absolute uri Parameters
+
+- `request` (`HttpRequest | Request`): The incoming Django or DRF request object.
+- `url_name` (`str`): Name of the URL pattern to reverse.
+- `query_params` (`dict[str, Any] | None`): Optional dictionary of query parameters to append to the URL.
+- `*args` (`Any`): Positional arguments for the URL reversal.
+- `**kwargs` (`Any`): Keyword arguments for the URL reversal.
+
+---
+
+### build absolute uri Returns
+
+- `str`: Absolute URI of the view including optional query parameters.
+
+### Example of build absolute uri
+
+```python
+from django.http import HttpRequest
+from djresttoolkit.utils import build_absolute_uri
+
+def my_view(request: HttpRequest):
+    absolute_url = build_absolute_uri(
+        request,
+        url_name="book-detail",
+        query_params={"ref": "newsletter"},
+        pk=123
+    )
+    return HttpResponse(f"URL: {absolute_url}")
+```
+
+**Output Example:**
+
+```url
+https://example.com/api/books/123/?ref=newsletter
+```
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.12.0.dist-info → djresttoolkit-0.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.12.0
+Version: 0.14.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
@@ -753,6 +753,124 @@ urlpatterns = [
 - Useful for frontend forms or API consumers that need selectable options.
 - Integrates seamlessly with `ModelChoiceFieldMixin` from `djresttoolkit`.
 
+### 12. RetrieveObjectMixin — API Reference
+
+```python
+from djresttoolkit.views.mixins import RetrieveObjectMixin
+```
+
+#### `RetrieveObjectMixin[T: Model]`
+
+A **generic mixin** to retrieve a single Django model instance by filters.
+
+#### Class Attributes of Retrieve Object Mixin
+
+- `queryset: QuerySet[T] | None` — The queryset used to retrieve objects. **Must be set.**
+
+#### Raises of Retrieve Object Mixin
+
+- `QuerysetNotDefinedError` — If `queryset` is not set in the class.
+
+#### Retrieve Object Mixin Methods
+
+- `get_object(**filters: Any) -> T | None`
+
+Retrieve a single model object using the provided filter criteria.
+
+- **Parameters:**
+  - `**filters` — Keyword arguments to filter the queryset (e.g., `id=1`, `slug="abc"`).
+
+- **Returns:**
+  - Model instance matching the filters, or `None` if no match is found.
+
+#### Example of Retrieve Object Mixin
+
+```python
+from rest_framework.views import APIView
+from django.http import JsonResponse
+from myapp.models import Book
+from djresttoolkit.mixins import RetrieveObjectMixin
+
+class BookDetailView(RetrieveObjectMixin[Book], APIView):
+    queryset = Book.objects.all()
+
+    def get(self, request, *args, **kwargs):
+        book = self.get_object(id=kwargs["id"])
+        if book:
+            return JsonResponse({"title": book.title, "author": book.author})
+        return JsonResponse({"detail": "Not found"}, status=404)
+```
+
+#### 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.
+- Works with any Django model and queryset.
+
+### 13. build_absolute_uri — API Reference
+
+```python
+from djresttoolkit.urls import build_absolute_uri
+```
+
+#### build absolute uri Description
+
+- Builds a **fully qualified absolute URL** for a Django or DRF view.
+- Optionally includes **query parameters**.
+- Works with both **Django `HttpRequest`** and **DRF `Request`** objects.
+- Uses Django's `reverse()` to dynamically resolve URL names.
+
+#### build absolute uri Function Signature
+
+```python
+def build_absolute_uri(
+    request: HttpRequest | Request,
+    url_name: str,
+    query_params: dict[str, Any] | None = None,
+    *args: Any,
+    **kwargs: Any,
+) -> str:
+    ...
+```
+
+---
+
+#### build absolute uri Parameters
+
+- `request` (`HttpRequest | Request`): The incoming Django or DRF request object.
+- `url_name` (`str`): Name of the URL pattern to reverse.
+- `query_params` (`dict[str, Any] | None`): Optional dictionary of query parameters to append to the URL.
+- `*args` (`Any`): Positional arguments for the URL reversal.
+- `**kwargs` (`Any`): Keyword arguments for the URL reversal.
+
+---
+
+### build absolute uri Returns
+
+- `str`: Absolute URI of the view including optional query parameters.
+
+### Example of build absolute uri
+
+```python
+from django.http import HttpRequest
+from djresttoolkit.utils import build_absolute_uri
+
+def my_view(request: HttpRequest):
+    absolute_url = build_absolute_uri(
+        request,
+        url_name="book-detail",
+        query_params={"ref": "newsletter"},
+        pk=123
+    )
+    return HttpResponse(f"URL: {absolute_url}")
+```
+
+**Output Example:**
+
+```url
+https://example.com/api/books/123/?ref=newsletter
+```
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.12.0.dist-info → djresttoolkit-0.14.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-README.md,sha256=swcg_Yd0tKwp4PDXQn7gfj7HKpwLs-UPV4jvqOHvHvQ,18485
+README.md,sha256=VZKLjTbak58sMkj073lXbWJVrxZk3VqPS1wIhuqmu7U,21729
 demo/staticfiles/admin/img/LICENSE,sha256=0RT6_zSIwWwxmzI13EH5AjnT1j2YU3MwM9j3U19cAAQ,1081
 src/djresttoolkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/djresttoolkit/admin.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -34,13 +34,17 @@ src/djresttoolkit/serializers/mixins/_absolute_url_file_mixin.py,sha256=5ewael0_
 src/djresttoolkit/serializers/mixins/_bulk_create_mixin.py,sha256=9ZWm2MNaZOhmhKlWOu6VECtlDbUtaPeceGHmivDYwYQ,3248
 src/djresttoolkit/throttling/__init__.py,sha256=01sjMymjx8XjqnAw3bEBLc-JtfhCDrp5dGxSNXMvPpU,84
 src/djresttoolkit/throttling/_throttle_inspector.py,sha256=Kss6ZxKy-EXq9UGaGprGDhpSuJ5992bmEYZSWmUVBHo,6480
+src/djresttoolkit/urls/__init__.py,sha256=u-Hj8GARO0mWZwiehCi3VslMXqtkdAFff7VcXVuiN8w,86
+src/djresttoolkit/urls/_build_absolute_uri.py,sha256=X9kdoTRGIJ2ordpkHgSXmqwmmMT-OZBgluV5ULUhJEk,915
 src/djresttoolkit/views/__init__.py,sha256=QuJ9C0Vfzkfrwyqzunxh-A-aErmS6yOoy0uzjDu3oG8,177
 src/djresttoolkit/views/_api_views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 src/djresttoolkit/views/_api_views/_choice_fields_apiview.py,sha256=zABPgqxMVaWd814B_sC64bWL61fDJkyYQZmJXQCa6Xc,1395
 src/djresttoolkit/views/_exceptions/__init__.py,sha256=DrCUxuPNyBR4WhzNutn5HDxLa--q51ykIxSG7_bFsOI,83
 src/djresttoolkit/views/_exceptions/_exception_handler.py,sha256=_o7If47bzWLl57LeSXSWsIDsJGo2RIpwYAwNQ-hsHVY,2839
-djresttoolkit-0.12.0.dist-info/METADATA,sha256=QP01vFRs3pOUXn7AuZ4kCVC37ZVo06HgiFm48wdaWVE,21495
-djresttoolkit-0.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-djresttoolkit-0.12.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
-djresttoolkit-0.12.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
-djresttoolkit-0.12.0.dist-info/RECORD,,
+src/djresttoolkit/views/mixins/__init__.py,sha256=K-1tk5d8tCVViMynw5DdffJ3Oo5uHpEx32E3_4X2UxM,154
+src/djresttoolkit/views/mixins/_retrieve_object_mixin.py,sha256=Q9znYPb07YXXUhsL7VIrk3BC-zDwjOhwLJKe2GPJ-k0,1155
+djresttoolkit-0.14.0.dist-info/METADATA,sha256=rYNwwhrKT4i3RuKPMFC6l1xU8yzJkcd7vC8rkYeeOsc,24739
+djresttoolkit-0.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+djresttoolkit-0.14.0.dist-info/entry_points.txt,sha256=YMhfTF-7mYppO8QqqWnvR_hyMWvoYxD6XI94_ViFu3k,60
+djresttoolkit-0.14.0.dist-info/licenses/LICENSE,sha256=8-oZM3yuuTRjySMbVKX9YXYA7Y4M_KhQNBYXPFjeWUo,1074
+djresttoolkit-0.14.0.dist-info/RECORD,,

src/djresttoolkit/urls/__init__.py

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

src/djresttoolkit/urls/_build_absolute_uri.py

@@ -0,0 +1,33 @@
+from typing import Any
+from urllib.parse import urlencode
+from django.http import HttpRequest
+from django.urls import reverse
+from rest_framework.request import Request
+
+
+def build_absolute_uri(
+    request: HttpRequest | Request,
+    url_name: str,
+    query_params: dict[str, Any] | None = None,
+    *args: Any,
+    **kwargs: Any,
+) -> str:
+    """
+    Build an absolute URI for a given Django or DRF view.
+
+    Args:
+        request: Django or DRF request object.
+        url_name: Name of the URL pattern to reverse.
+        query_params: Optional dictionary of query parameters.
+        *args: Positional arguments for the URL.
+        **kwargs: Keyword arguments for the URL.
+
+    Returns:
+        Absolute URI as a string.
+    """
+    url = reverse(url_name, args=args, kwargs=kwargs)
+
+    if query_params:
+        url += f"?{urlencode(query_params, doseq=True)}"
+
+    return request.build_absolute_uri(url)

src/djresttoolkit/views/mixins/__init__.py

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

src/djresttoolkit/views/mixins/_retrieve_object_mixin.py

@@ -0,0 +1,41 @@
+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