djresttoolkit 0.10.0__tar.gz → 0.11.0__tar.gz

{djresttoolkit-0.10.0 → djresttoolkit-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.10.0
+Version: 0.11.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
@@ -605,6 +605,82 @@ products = serializer.save()
 - Automatically updates field error messages based on Django model definitions.
 - Bulk creation is optimized using `model.objects.bulk_create()` for efficiency.
 
+### 10. ModelChoiceFieldMixin — API Reference
+
+```python
+from djresttoolkit.models.mixins import ModelChoiceFieldMixin
+```
+
+### `ModelChoiceFieldMixin`
+
+A **Django model mixin** to retrieve **choice fields** from a model, designed to work seamlessly with Django's `TextChoices`.
+
+#### Class Attributes in Model Choice Field Mixin
+
+- `model: type[Model] | None` — The Django model class to inspect. **Must be set.**
+- `choice_fields: list[str] | None` — List of model field names that contain choices. **Must be set.**
+
+#### Model Choice Field Mixin Methods
+
+`get_choices() -> dict[str, dict[str, str]]`
+
+Retrieve the choice fields from the model as a dictionary.
+
+- **Returns:**
+
+  ```python
+  {
+      "field_name": {
+          "choice_value": "Choice Label",
+          ...
+      },
+      ...
+  }
+  ```
+
+- **Raises:**
+
+  - `AttributeDoesNotExist` — If `model` or `choice_fields` is not set.
+  - `ChoiceFieldNotFound` — If a field does not exist, has no choices, or has invalid choice format.
+
+---
+
+### Model Choice Field Mixin Example
+
+```python
+from django.db import models
+from djresttoolkit.serializers.mixins import ModelChoiceFieldMixin
+
+class Product(models.Model):
+    class Status(models.TextChoices):
+        DRAFT = "draft", "Draft"
+        PUBLISHED = "published", "Published"
+
+    status = models.CharField(max_length=20, choices=Status.choices)
+    category = models.CharField(max_length=50, choices=[
+      ("a", "Category A"),
+      ("b", "Category B"),
+    ])
+
+class ProductChoiceMixin(ModelChoiceFieldMixin):
+    model = Product
+    choice_fields = ["status", "category"]
+
+choices = ProductChoiceMixin.get_choices()
+print(choices)
+# Output:
+# {
+#   "status": {"draft": "Draft", "published": "Published"},
+#   "category": {"a": "Category A", "b": "Category B"}
+# }
+```
+
+#### Features of Model Choice Field Mixin
+
+- Safely validates that fields exist and have valid choices.
+- Returns a ready-to-use dictionary mapping values to labels.
+- Ideal for DRF serializers, forms, and admin customization.
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.10.0 → djresttoolkit-0.11.0}/README.md

@@ -547,6 +547,82 @@ products = serializer.save()
 - Automatically updates field error messages based on Django model definitions.
 - Bulk creation is optimized using `model.objects.bulk_create()` for efficiency.
 
+### 10. ModelChoiceFieldMixin — API Reference
+
+```python
+from djresttoolkit.models.mixins import ModelChoiceFieldMixin
+```
+
+### `ModelChoiceFieldMixin`
+
+A **Django model mixin** to retrieve **choice fields** from a model, designed to work seamlessly with Django's `TextChoices`.
+
+#### Class Attributes in Model Choice Field Mixin
+
+- `model: type[Model] | None` — The Django model class to inspect. **Must be set.**
+- `choice_fields: list[str] | None` — List of model field names that contain choices. **Must be set.**
+
+#### Model Choice Field Mixin Methods
+
+`get_choices() -> dict[str, dict[str, str]]`
+
+Retrieve the choice fields from the model as a dictionary.
+
+- **Returns:**
+
+  ```python
+  {
+      "field_name": {
+          "choice_value": "Choice Label",
+          ...
+      },
+      ...
+  }
+  ```
+
+- **Raises:**
+
+  - `AttributeDoesNotExist` — If `model` or `choice_fields` is not set.
+  - `ChoiceFieldNotFound` — If a field does not exist, has no choices, or has invalid choice format.
+
+---
+
+### Model Choice Field Mixin Example
+
+```python
+from django.db import models
+from djresttoolkit.serializers.mixins import ModelChoiceFieldMixin
+
+class Product(models.Model):
+    class Status(models.TextChoices):
+        DRAFT = "draft", "Draft"
+        PUBLISHED = "published", "Published"
+
+    status = models.CharField(max_length=20, choices=Status.choices)
+    category = models.CharField(max_length=50, choices=[
+      ("a", "Category A"),
+      ("b", "Category B"),
+    ])
+
+class ProductChoiceMixin(ModelChoiceFieldMixin):
+    model = Product
+    choice_fields = ["status", "category"]
+
+choices = ProductChoiceMixin.get_choices()
+print(choices)
+# Output:
+# {
+#   "status": {"draft": "Draft", "published": "Published"},
+#   "category": {"a": "Category A", "b": "Category B"}
+# }
+```
+
+#### Features of Model Choice Field Mixin
+
+- Safely validates that fields exist and have valid choices.
+- Returns a ready-to-use dictionary mapping values to labels.
+- Ideal for DRF serializers, forms, and admin customization.
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.10.0 → djresttoolkit-0.11.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "0.10.0"
+version = "0.11.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.11.0/src/djresttoolkit/models/mixins/__init__.py

@@ -0,0 +1,11 @@
+from ._model_choice_fields_mixin import (
+    AttributeDoesNotExist,
+    ChoiceFieldNotFound,
+    ModelChoiceFieldMixin,
+)
+
+__all__ = [
+    "AttributeDoesNotExist",
+    "ChoiceFieldNotFound",
+    "ModelChoiceFieldMixin",
+]

djresttoolkit-0.11.0/src/djresttoolkit/models/mixins/_model_choice_fields_mixin.py

@@ -0,0 +1,84 @@
+from typing import Iterable, Tuple, cast
+
+from django.db.models import Model
+from django.core.exceptions import FieldDoesNotExist
+
+
+class AttributeDoesNotExist(Exception):
+    """
+    Exception raised when a required attribute is missing in the class.
+    """
+
+
+class ChoiceFieldNotFound(Exception):
+    """
+    Exception raised when a specified choice field is missing
+    or has invalid/empty choices in the model.
+    """
+
+
+class ModelChoiceFieldMixin:
+    """
+    Mixin to retrieve choice fields from a Django model.
+    Designed to work seamlessly with Django's TextChoices.
+    """
+
+    model: type[Model] | None = None
+    choice_fields: list[str] | None = None
+
+    @classmethod
+    def get_choices(cls) -> dict[str, dict[str, str]]:
+        """
+        Retrieve the choice fields from the model class.
+
+        Returns:
+            dict[str, dict[str, str]]: A dictionary where keys are field names
+            and values are dictionaries of choices (value => label).
+
+        Raises:
+            ModelAttributeNotFound: If the model attribute is not set.
+            ChoiceFieldAttributeNotFound: If the choice_fields attribute is not set.
+            ChoiceFieldNotFound: If a field does not exist, has no choices,
+                                 or has an invalid choice format.
+        """
+
+        if cls.model is None:
+            raise AttributeDoesNotExist("Model attribute is not set in the class.")
+
+        if cls.choice_fields is None:
+            raise AttributeDoesNotExist(
+                "The choice_fields attribute must be set in the class."
+            )
+
+        choices_as_dict: dict[str, dict[str, str]] = {}
+
+        for field in cls.choice_fields:
+            try:
+                field_obj = cls.model._meta.get_field(field)  # type: ignore[attr-defined]
+            except FieldDoesNotExist as e:
+                raise ChoiceFieldNotFound(
+                    f"The field '{field}' does not exist in model '{cls.model.__name__}'."
+                ) from e
+
+            raw_choices = cast(
+                Iterable[Tuple[str, str]],
+                field_obj.choices or [],  # type: ignore[union-attr]
+            )
+
+            if not raw_choices:
+                raise ChoiceFieldNotFound(
+                    f"The field '{field}' in model '{cls.model.__name__}' has no choices defined."
+                )
+
+            if not all(
+                isinstance(choice, (list, tuple)) and len(choice) == 2  # type: ignore[misc]
+                for choice in raw_choices
+            ):
+                raise ChoiceFieldNotFound(
+                    f"The field '{field}' in model '{cls.model.__name__}' has invalid choice format. "
+                    "Expected an iterable of 2-tuples (value, label)."
+                )
+
+            choices_as_dict[field] = dict(raw_choices)
+
+        return choices_as_dict