djresttoolkit 0.7.0__tar.gz → 0.9.0__tar.gz

{djresttoolkit-0.7.0 → djresttoolkit-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djresttoolkit
-Version: 0.7.0
+Version: 0.9.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
@@ -47,7 +47,9 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.13
 Requires-Dist: faker>=37.5.3
+Requires-Dist: pydantic-settings>=2.10.1
 Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pyyaml>=6.0.2
 Provides-Extra: dev
 Requires-Dist: mypy; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
@@ -201,7 +203,79 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-### 3. EmailSender
+### 3. EnvBaseSettings
+
+```python
+from djresttoolkit.envconfig import EnvBaseSettings
+```
+
+#### `EnvBaseSettings`
+
+A **base settings class** for managing application configuration using:
+
+- YAML files (default `.environ.yaml`)
+- Environment variables (default `.env`)
+
+Supports **nested configuration** using double underscores (`__`) in environment variable names.
+
+#### Class Attributes
+
+- Attributes
+  - `env_file`
+    - Type: `str`
+    - Default: `.env`
+    - Description: Environment variable file path.
+  - `yaml_file`
+    - Type: `str`
+    - Default: `.environ.yaml`
+    - Description: YAML configuration file path.
+  - `model_config`
+    - Type: `SettingsConfigDict`
+    - Description: Pydantic settings configuration (file encoding, nested delimiter).
+
+#### Methods
+
+#### `load(cls, *, env_file: str | None = None, ymal_file: str | None = None, warning: bool = True) -> EnvBaseSettings`
+
+Loads configuration from **YAML first**, then overrides with **environment variables**.
+
+#### Parameters
+
+- `env_file` — Optional custom `.env` file path.
+- `ymal_file` — Optional custom YAML file path.
+- `warning` — Emit a warning if YAML file is missing (default `True`).
+
+#### Returns
+
+- Instance of `EnvBaseSettings` (or subclass) with loaded configuration.
+
+#### Raises
+
+- `UserWarning` if YAML file not found and `warning=True`.
+
+### Usage Example
+
+```python
+from djresttoolkit.envconfig import EnvBaseSettings
+
+class EnvSettings(EnvBaseSettings):
+    debug: bool = False
+    database_url: str
+
+# Load settings
+settings = EnvSettings.load(warning=False)
+
+print(settings.debug)
+print(settings.database_url)
+```
+
+#### Features
+
+- Prioritizes `.env` variables over YAML.
+- Supports nested keys: `DATABASE__HOST` → `settings.database.host`.
+- Designed to be subclassed for project-specific settings.
+
+### 4. EmailSender
 
 ```python
 from djresttoolkit.mail import EmailSender, EmailContent, EmailTemplate
@@ -217,7 +291,7 @@ Send templated emails.
 EmailSender(email_content: EmailContent | EmailContentDict)
 ```
 
-#### Methods
+#### EmailSender Methods
 
 ```python
 send(to: list[str], exceptions: bool = False) -> bool
@@ -250,7 +324,7 @@ EmailSender(content).send(to=["user@example.com"])
 
 - `text`, `html` — template file paths
 
-### 4. Custom DRF Exception Handler
+### 5. Custom DRF Exception Handler
 
 ```python
 from djresttoolkit.views import exception_handler
@@ -264,12 +338,12 @@ A DRF exception handler that:
 - Adds throttling support (defaults to `AnonRateThrottle`).
 - Returns **429 Too Many Requests** with `retry_after` if throttle limit is exceeded.
 
-#### Parameters
+#### Exception Handler Parameters
 
 - `exc`: Exception object.
 - `context`: DRF context dictionary containing `"request"` and `"view"`.
 
-#### Returns
+#### Returns Type of Exception Handler
 
 - `Response` — DRF Response object (with throttling info if applicable), or `None`.
 
@@ -290,7 +364,7 @@ REST_FRAMEWORK = {
 - Tracks requests in cache and calculates `retry_after`.
 - Cleans expired timestamps automatically.
 
-### 5. Response Time Middleware
+### 6. Response Time Middleware
 
 ```python
 from djresttoolkit.middlewares import ResponseTimeMiddleware
@@ -337,7 +411,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 6. Throttle Utilities
+### 7. Throttle Utilities
 
 #### `ThrottleInfoJSONRenderer`
 
@@ -393,6 +467,66 @@ ThrottleInspector(
 - `attach_headers(response: Response, throttle_info: dict | None)`
   Attaches throttle data to HTTP headers.
 
+### 8. AbsoluteUrlFileMixin — API Reference
+
+```python
+from djresttoolkit.serializers.mixins import AbsoluteUrlFileMixin
+```
+
+### `AbsoluteUrlFileMixin`
+
+A **serializer mixin** that converts **FileField** and **ImageField** URLs to **absolute URLs**, ensuring compatibility with cloud storage backends.
+
+---
+
+### Attributes
+
+- `file_fields`
+- type: `list[str] | None`
+- default: `None`
+- description: Manual list of file field names for non-model serializers.
+
+### Absolute Url File Mixin Methods
+
+#### `to_representation(self, instance: Any) -> dict[str, Any]`
+
+- Overrides default serializer `to_representation`.
+- Enhances all file-related fields in the serialized output to **absolute URLs**.
+
+#### `enhance_file_fields(self, instance: Any, representation: dict[str, Any], request: Any) -> dict[str, Any]`
+
+- Core logic to process each file field.
+- Converts relative URLs to absolute URLs using `request.build_absolute_uri()`.
+- Supports model serializers or manual `file_fields`.
+- Logs warnings if request context is missing or file is not found.
+
+#### Exceptions
+
+- `MissingRequestContext`: Raised if the request object is missing in serializer context and `DEBUG=True`.
+
+### Absolute Url File Mixin Example
+
+```python
+from rest_framework import serializers
+from djresttoolkit.serializers.mixins import AbsoluteUrlFileMixin
+from myapp.models import Document
+
+class DocumentSerializer(AbsoluteUrlFileMixin, serializers.ModelSerializer):
+    class Meta:
+        model = Document
+        fields = ["id", "title", "file"]
+
+# Output will convert `file` field to an absolute URL
+serializer = DocumentSerializer(instance, context={"request": request})
+data = serializer.data
+```
+
+#### Notes
+
+- Works with both Django model serializers and custom serializers.
+- Relative file paths are automatically converted to absolute URLs.
+- Can manually specify fields via `file_fields` for non-model serializers.
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.7.0 → djresttoolkit-0.9.0}/README.md

@@ -145,7 +145,79 @@ or
 Flushed 120 records from all models and reset IDs.
 ```
 
-### 3. EmailSender
+### 3. EnvBaseSettings
+
+```python
+from djresttoolkit.envconfig import EnvBaseSettings
+```
+
+#### `EnvBaseSettings`
+
+A **base settings class** for managing application configuration using:
+
+- YAML files (default `.environ.yaml`)
+- Environment variables (default `.env`)
+
+Supports **nested configuration** using double underscores (`__`) in environment variable names.
+
+#### Class Attributes
+
+- Attributes
+  - `env_file`
+    - Type: `str`
+    - Default: `.env`
+    - Description: Environment variable file path.
+  - `yaml_file`
+    - Type: `str`
+    - Default: `.environ.yaml`
+    - Description: YAML configuration file path.
+  - `model_config`
+    - Type: `SettingsConfigDict`
+    - Description: Pydantic settings configuration (file encoding, nested delimiter).
+
+#### Methods
+
+#### `load(cls, *, env_file: str | None = None, ymal_file: str | None = None, warning: bool = True) -> EnvBaseSettings`
+
+Loads configuration from **YAML first**, then overrides with **environment variables**.
+
+#### Parameters
+
+- `env_file` — Optional custom `.env` file path.
+- `ymal_file` — Optional custom YAML file path.
+- `warning` — Emit a warning if YAML file is missing (default `True`).
+
+#### Returns
+
+- Instance of `EnvBaseSettings` (or subclass) with loaded configuration.
+
+#### Raises
+
+- `UserWarning` if YAML file not found and `warning=True`.
+
+### Usage Example
+
+```python
+from djresttoolkit.envconfig import EnvBaseSettings
+
+class EnvSettings(EnvBaseSettings):
+    debug: bool = False
+    database_url: str
+
+# Load settings
+settings = EnvSettings.load(warning=False)
+
+print(settings.debug)
+print(settings.database_url)
+```
+
+#### Features
+
+- Prioritizes `.env` variables over YAML.
+- Supports nested keys: `DATABASE__HOST` → `settings.database.host`.
+- Designed to be subclassed for project-specific settings.
+
+### 4. EmailSender
 
 ```python
 from djresttoolkit.mail import EmailSender, EmailContent, EmailTemplate
@@ -161,7 +233,7 @@ Send templated emails.
 EmailSender(email_content: EmailContent | EmailContentDict)
 ```
 
-#### Methods
+#### EmailSender Methods
 
 ```python
 send(to: list[str], exceptions: bool = False) -> bool
@@ -194,7 +266,7 @@ EmailSender(content).send(to=["user@example.com"])
 
 - `text`, `html` — template file paths
 
-### 4. Custom DRF Exception Handler
+### 5. Custom DRF Exception Handler
 
 ```python
 from djresttoolkit.views import exception_handler
@@ -208,12 +280,12 @@ A DRF exception handler that:
 - Adds throttling support (defaults to `AnonRateThrottle`).
 - Returns **429 Too Many Requests** with `retry_after` if throttle limit is exceeded.
 
-#### Parameters
+#### Exception Handler Parameters
 
 - `exc`: Exception object.
 - `context`: DRF context dictionary containing `"request"` and `"view"`.
 
-#### Returns
+#### Returns Type of Exception Handler
 
 - `Response` — DRF Response object (with throttling info if applicable), or `None`.
 
@@ -234,7 +306,7 @@ REST_FRAMEWORK = {
 - Tracks requests in cache and calculates `retry_after`.
 - Cleans expired timestamps automatically.
 
-### 5. Response Time Middleware
+### 6. Response Time Middleware
 
 ```python
 from djresttoolkit.middlewares import ResponseTimeMiddleware
@@ -281,7 +353,7 @@ X-Response-Time: 0.01234 seconds
 INFO: Request processed in 0.01234 seconds
 ```
 
-### 6. Throttle Utilities
+### 7. Throttle Utilities
 
 #### `ThrottleInfoJSONRenderer`
 
@@ -337,6 +409,66 @@ ThrottleInspector(
 - `attach_headers(response: Response, throttle_info: dict | None)`
   Attaches throttle data to HTTP headers.
 
+### 8. AbsoluteUrlFileMixin — API Reference
+
+```python
+from djresttoolkit.serializers.mixins import AbsoluteUrlFileMixin
+```
+
+### `AbsoluteUrlFileMixin`
+
+A **serializer mixin** that converts **FileField** and **ImageField** URLs to **absolute URLs**, ensuring compatibility with cloud storage backends.
+
+---
+
+### Attributes
+
+- `file_fields`
+- type: `list[str] | None`
+- default: `None`
+- description: Manual list of file field names for non-model serializers.
+
+### Absolute Url File Mixin Methods
+
+#### `to_representation(self, instance: Any) -> dict[str, Any]`
+
+- Overrides default serializer `to_representation`.
+- Enhances all file-related fields in the serialized output to **absolute URLs**.
+
+#### `enhance_file_fields(self, instance: Any, representation: dict[str, Any], request: Any) -> dict[str, Any]`
+
+- Core logic to process each file field.
+- Converts relative URLs to absolute URLs using `request.build_absolute_uri()`.
+- Supports model serializers or manual `file_fields`.
+- Logs warnings if request context is missing or file is not found.
+
+#### Exceptions
+
+- `MissingRequestContext`: Raised if the request object is missing in serializer context and `DEBUG=True`.
+
+### Absolute Url File Mixin Example
+
+```python
+from rest_framework import serializers
+from djresttoolkit.serializers.mixins import AbsoluteUrlFileMixin
+from myapp.models import Document
+
+class DocumentSerializer(AbsoluteUrlFileMixin, serializers.ModelSerializer):
+    class Meta:
+        model = Document
+        fields = ["id", "title", "file"]
+
+# Output will convert `file` field to an absolute URL
+serializer = DocumentSerializer(instance, context={"request": request})
+data = serializer.data
+```
+
+#### Notes
+
+- Works with both Django model serializers and custom serializers.
+- Relative file paths are automatically converted to absolute URLs.
+- Can manually specify fields via `file_fields` for non-model serializers.
+
 ## 🛠️ Planned Features
 
 - Add more utils

{djresttoolkit-0.7.0 → djresttoolkit-0.9.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "djresttoolkit"
-version = "0.7.0"
+version = "0.9.0"
 description = "A collection of Django and DRF utilities to simplify API development."
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }
@@ -48,6 +48,8 @@ requires-python = ">=3.13"
 dependencies = [
     "faker>=37.5.3",
     "pydantic>=2.11.7",
+    "pydantic-settings>=2.10.1",
+    "pyyaml>=6.0.2",
 ]
 
 # CLI scripts entry point configuration

djresttoolkit-0.9.0/src/djresttoolkit/envconfig/__init__.py

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

djresttoolkit-0.9.0/src/djresttoolkit/envconfig/_env_settings.py

@@ -0,0 +1,84 @@
+import warnings
+from pathlib import Path
+from typing import Any, ClassVar
+
+import yaml
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class EnvBaseSettings[T: "EnvBaseSettings"](BaseSettings):
+    """ "
+    EnvBaseSettings is a base settings class for managing application configuration
+    using both YAML files and environment variables.
+    This class is designed to load configuration values from a YAML file first,
+    and then override those values with environment variables if present. It supports
+    nested configuration using a double underscore (`__`) as the delimiter in
+    environment variable names, allowing for hierarchical settings.
+
+    Class Attributes:
+        env_file (str): The default filename for the environment variables file (default: ".env").
+        yaml_file (str): The default filename for the YAML configuration file (default: ".environ.yaml").
+        model_config (SettingsConfigDict): Configuration for environment variable parsing, including file encoding and nested delimiter.
+
+    Methods:
+        load(cls, *, env_file: str | None = None, ymal_file: str | None = None, warning: bool = True) -> "EnvBaseSettings":
+            Loads configuration from a YAML file (if it exists), then overrides with environment variables.
+            - env_file: Optional custom path to the .env file.
+            - ymal_file: Optional custom path to the YAML file.
+            - warning: If True, emits a warning if the YAML file is not found.
+            Returns an instance of EnvBaseSettings with the loaded configuration.
+
+    Usage:
+        - Define your settings as subclasses of EnvBaseSettings.
+        - Call `YourSettingsClass.load()` to load configuration from files and environment variables.
+        - Supports nested configuration via double underscore in environment variable names (e.g., `DATABASE__HOST`).
+
+    Raises:
+        - UserWarning: If the YAML file is not found and `warning` is True.
+
+    Example:
+    ```python
+        from djresttoolkit.envconfig import EnvBaseSettings
+        
+        class EnvSettings(EnvBaseSettings):
+            debug: bool = False
+            database_url: str
+            
+        settings = EnvSettings.load(warning=False)
+    ```
+
+    """
+
+    env_file: ClassVar[str] = ".env"
+    yaml_file: ClassVar[str] = ".environ.yaml"
+
+    model_config = SettingsConfigDict(
+        env_file=env_file,
+        env_file_encoding="utf-8",
+        env_nested_delimiter="__",
+    )
+
+    @classmethod
+    def load(
+        cls: type[T],
+        *,
+        env_file: str | None = None,
+        ymal_file: str | None = None,
+        warning: bool = True,
+    ) -> T:
+        """Load from YAML first, then override with .env."""
+        if env_file:
+            cls.env_file = env_file
+        if ymal_file:
+            cls.yaml_file = ymal_file
+
+        config_file = Path(cls.yaml_file)
+        yaml_data: dict[str, Any] = {}
+        if config_file.exists():
+            with config_file.open("r") as f:
+                yaml_data = yaml.safe_load(f) or {}
+        elif warning:
+            msg: str = f"Config file {config_file} not found, using only env vars."
+            warnings.warn(msg, UserWarning, stacklevel=1)
+
+        return cls(**yaml_data)

djresttoolkit-0.9.0/src/djresttoolkit/serializers/_serializer_create_mixin.py

@@ -0,0 +1,87 @@
+import logging
+from typing import Any, cast
+
+from django.core.exceptions import FieldDoesNotExist
+from django.db.models import Model
+from rest_framework.serializers import Field as SerializerField
+from django.db.models import Field as ModelField
+
+
+logger = logging.getLogger(__name__)
+
+
+class RecordsCreationMixin:
+    """
+    A mixin for DRF serializers that supports:
+      - Single instance creation with extra context fields
+      - Bulk creation from a list of validated_data dicts
+      - Updating field error messages with model-specific messages
+
+    Notes:
+      - bulk_create() does not trigger model signals or .save()
+      - Meta.model must be defined
+    """
+
+    def create(
+        self, validated_data: dict[str, Any] | list[dict[str, Any]]
+    ) -> Model | list[Model]:
+        logger.debug("Starting creation", extra={"validated_data": validated_data})
+
+        model: type[Model] | None = getattr(getattr(self, "Meta", None), "model", None)
+        if model is None:
+            logger.error("Meta.model not defined.")
+            raise AttributeError(f"{self.__class__.__name__} missing Meta.model.")
+
+        # Bulk creation
+        if isinstance(validated_data, list):
+            instances = [model(**item) for item in validated_data]
+            if instances:
+                logger.info(
+                    "Bulk creating instances",
+                    extra={"count": len(instances), "model": model.__name__},
+                )
+                return model.objects.bulk_create(instances)
+            logger.info("No instances to create.")
+            return []
+
+        # Single instance creation
+        if not hasattr(super(), "create"):
+            raise NotImplementedError(
+                f"{self.__class__.__name__} must be used with a DRF serializer "
+                "that implements create()."
+            )
+
+        logger.info("Creating a single instance", extra={"model": model.__name__})
+        return super().create({**validated_data})  # type: ignore[misc]
+
+    def get_fields(self) -> dict[str, SerializerField[Any, Any, Any, Any]]:
+        # DRF serializer fields
+        fields = cast(
+            dict[str, SerializerField[Any, Any, Any, Any]],
+            super().get_fields(),  # type: ignore
+        )
+
+        meta = getattr(self, "Meta", None)
+        model: type[Model] | None = getattr(meta, "model", None)
+
+        if model is None:
+            raise ValueError(f"{self.__class__.__name__}.Meta.model must be defined.")
+
+        logger.debug("Setting up serializer fields", extra={"model": model.__name__})
+
+        for field_name, serializer_field in fields.items():
+            try:
+                # Django model field
+                model_field = cast(
+                    ModelField[Any, Any],
+                    model._meta.get_field(field_name),  # type: ignore
+                )
+                if hasattr(model_field, "error_messages"):
+                    serializer_field.error_messages.update(model_field.error_messages)
+            except FieldDoesNotExist:
+                logger.warning(
+                    "Skipping serializer field not present on model",
+                    extra={"field_name": field_name, "model": model.__name__},
+                )
+
+        return fields

djresttoolkit-0.9.0/src/djresttoolkit/serializers/mixins/__init__.py

@@ -0,0 +1,6 @@
+from ._absolute_url_file_mixin import AbsoluteUrlFileMixin, MissingRequestContext
+
+__all__ = [
+    "AbsoluteUrlFileMixin",
+    "MissingRequestContext",
+]

djresttoolkit-0.9.0/src/djresttoolkit/serializers/mixins/_absolute_url_file_mixin.py

@@ -0,0 +1,94 @@
+import logging
+from typing import Any, cast
+from urllib.parse import urlparse
+
+from django.conf import settings
+from django.db import models
+
+logger = logging.getLogger(__name__)
+
+
+class MissingRequestContext(Exception):
+    """Custom exception for missing request in serializer context."""
+
+    ...
+
+
+class AbsoluteUrlFileMixin:
+    """
+    A mixin that updates FileField and ImageField URLs in serializer output
+    to be absolute URLs, compatible with cloud storage backends.
+    """
+
+    # manually specify file fields for non-model serializers
+    file_fields: list[str] | None = None
+
+    def to_representation(self, instance: Any) -> dict[str, Any]:
+        """Extend serializer representation to enhance file field URLs."""
+        representation = cast(dict[str, Any], super().to_representation(instance))  # type: ignore[misc]
+        request = self.context.get("request")  # type: ignore
+        return self.enhance_file_fields(instance, representation, request)
+
+    def enhance_file_fields(
+        self,
+        instance: Any,
+        representation: dict[str, Any],
+        request: Any,
+    ) -> dict[str, Any]:
+        if request is None:
+            logger.warning("Request not found in serializer context.")
+            if settings.DEBUG:
+                raise MissingRequestContext("Request not found in serializer context.")
+            return representation
+
+        # Collect only file-related model fields if available
+        model_fields = (
+            {
+                field.name: field
+                for field in instance._meta.get_fields()
+                if isinstance(field, (models.FileField, models.ImageField))
+            }
+            if hasattr(instance, "_meta")
+            else {}
+        )
+
+        manual_fields = getattr(self, "file_fields", []) or []
+
+        for field_name, field_value in representation.items():
+            model_field = model_fields.get(field_name)
+
+            is_file_field = model_field or (field_name in manual_fields)
+            if not is_file_field:
+                continue
+
+            try:
+                # Get file URL from instance or raw serializer value
+                if model_field:
+                    file_instance = getattr(instance, field_name, None)
+                    file_url = (
+                        getattr(file_instance, "url", None) if file_instance else None
+                    )
+                else:
+                    file_url = field_value
+
+                if not file_url:
+                    logger.info("No file found for field: %s", field_name)
+                    representation[field_name] = None
+                    continue
+
+                # Only build absolute URL if it's relative
+                parsed_url = urlparse(str(file_url))
+                if not parsed_url.netloc:  # relative path
+                    file_url = request.build_absolute_uri(file_url)
+
+                representation[field_name] = file_url
+                logger.debug("Enhanced URL for %s: %s", field_name, file_url)
+
+            except Exception as error:
+                logger.error(
+                    "Unexpected error processing file field %s: %s",
+                    field_name,
+                    error,
+                )
+
+        return representation