orionis 0.400.0__py3-none-any.whl → 0.402.0__py3-none-any.whl

orionis/foundation/config/logging/entities/chunked.py

@@ -1,10 +1,11 @@
-from dataclasses import asdict, dataclass, field, fields
+from dataclasses import dataclass, field
+from orionis.foundation.config.base import BaseConfigEntity
+from orionis.foundation.config.logging.validators import IsValidPath, IsValidLevel
 from orionis.foundation.exceptions import OrionisIntegrityException
 from orionis.foundation.config.logging.enums import Level
-import re
 
 @dataclass(unsafe_hash=True, kw_only=True)
-class Chunked:
+class Chunked(BaseConfigEntity):
     """
     Configuration for chunked log file rotation.
 
@@ -25,23 +26,23 @@ class Chunked:
     """
 
     path: str = field(
-        default='storage/log/application.log',
-        metadata={
-            "description": "Filesystem path where chunked log files are stored.",
+        default = 'storage/log/application.log',
+        metadata = {
+            "description": "The file path where the log is stored.",
             "default": "storage/log/application.log",
         },
     )
 
     level: int | str | Level = field(
-        default=Level.INFO,
-        metadata={
-            "description": "Logging level for the log file. Accepts int, str, or Level enum.",
+        default = Level.INFO,
+        metadata = {
+            "description": "The logging level (e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL).",
             "default": Level.INFO,
         },
     )
 
     mb_size: int = field(
-        default=10,
+        default = 10,
         metadata={
             "description": "Maximum size (in MB) of a log file before chunking.",
             "default": 10,
@@ -49,7 +50,7 @@ class Chunked:
     )
 
     files: int = field(
-        default=5,
+        default = 5,
         metadata={
             "description": "Maximum number of log files to retain.",
             "default": 5,
@@ -57,94 +58,38 @@ class Chunked:
     )
 
     def __post_init__(self):
-        # Validate 'path'
-        if not isinstance(self.path, str) or not self.path.strip():
-            raise OrionisIntegrityException(
-                f"Chunked log configuration error: 'path' must be a non-empty string, got {repr(self.path)}."
-            )
+        """
+        Performs validation and normalization of configuration fields.
 
-        # Validate 'level'
-        valid_level_types = (int, str, Level)
-        if not isinstance(self.level, valid_level_types):
-            raise OrionisIntegrityException(
-                f"File cache configuration error: 'level' must be int, str, or Level enum, got {type(self.level).__name__}."
-            )
+        - path: Validates that the path is correct using the IsValidPath validator.
+        - level: Validates that the log level is correct using the IsValidLevel validator.
+        - mb_size: Checks that it is an integer between 1 and 1000 (MB).
+        - files: Checks that it is a positive integer greater than 0.
+
+        Raises
+        ------
+        OrionisIntegrityException
+            If any of the configuration values are invalid.
+        """
 
-        if isinstance(self.level, str):
-            _value = self.level.strip().upper()
-            if not _value:
-                raise OrionisIntegrityException(
-                    "File cache configuration error: 'level' string cannot be empty."
-                )
-            if _value not in Level.__members__:
-                raise OrionisIntegrityException(
-                    f"File cache configuration error: 'level' must be one of {list(Level.__members__.keys())}, got '{self.level}'."
-                )
-            self.level = Level[_value].value
-        elif isinstance(self.level, int):
-            valid_values = [level.value for level in Level]
-            if self.level not in valid_values:
-                raise OrionisIntegrityException(
-                    f"File cache configuration error: 'level' must be one of {valid_values}, got '{self.level}'."
-                )
-        elif isinstance(self.level, Level):
-            self.level = self.level.value
+        # Validate 'path' using the IsValidPath validator
+        IsValidPath(self.path)
+
+        # Validate 'level' using the IsValidLevel validator
+        IsValidLevel(self.level)
 
         # Validate 'mb_size'
-        if isinstance(self.mb_size, str):
-            match = re.match(r'^(\d+)\s*(MB|KB|B)?$', self.mb_size.strip(), re.IGNORECASE)
-            if not match:
-                raise OrionisIntegrityException(
-                    f"Chunked log configuration error: 'mb_size' string must be like '10MB', '500KB', or integer, got '{self.mb_size}'."
-                )
-            size, unit = match.groups()
-            size = int(size)
-            if unit is None or unit.upper() == 'MB':
-                self.mb_size = size
-            elif unit.upper() == 'KB':
-                self.mb_size = max(1, size // 1024)
-            elif unit.upper() == 'B':
-                self.mb_size = max(1, size // (1024 * 1024))
-        if not isinstance(self.mb_size, int) or self.mb_size < 1:
+        if not isinstance(self.mb_size, int):
             raise OrionisIntegrityException(
-                f"Chunked log configuration error: 'mb_size' must be a positive integer (MB), got {self.mb_size}."
+                f"'mb_size' must be an integer in MB, got {type(self.mb_size).__name__}."
+            )
+        if self.mb_size < 1 or self.mb_size > 1000:
+            raise OrionisIntegrityException(
+                f"'mb_size' must be between 1 and 1000 MB, got {self.mb_size}."
             )
 
         # Validate 'files'
         if not isinstance(self.files, int) or self.files < 1:
             raise OrionisIntegrityException(
-                f"Chunked log configuration error: 'files' must be a positive integer, got {self.files}."
-            )
-
-    def toDict(self) -> dict:
-        """
-        Returns a dictionary representation of the Chunked configuration.
-
-        Returns
-        -------
-        dict
-            Dictionary containing all configuration fields and their values.
-        """
-        return asdict(self)
-
-    def getFields(self):
-        """
-        Retrieves a list of field information for the current dataclass instance.
-
-        Returns:
-            list: A list of dictionaries, each containing details about a field:
-                - name (str): The name of the field.
-                - type (type): The type of the field.
-                - default: The default value of the field, if specified; otherwise, the value from metadata or None.
-                - metadata (mapping): The metadata associated with the field.
-        """
-        __fields = []
-        for field in fields(self):
-            __metadata = dict(field.metadata) or {}
-            __fields.append({
-                "name": field.name,
-                "type": field.type.__name__ if hasattr(field.type, '__name__') else str(field.type),
-                "default": field.default if (field.default is not None and '_MISSING_TYPE' not in str(field.default)) else __metadata.get('default', None),
-                "metadata": __metadata
-            })
-        return __fields
+                f"'files' must be a positive integer greater than 0, got {self.files} ({type(self.files).__name__})."
+            )

orionis/foundation/config/logging/entities/daily.py

@@ -1,10 +1,12 @@
-from dataclasses import asdict, dataclass, field, fields
-from datetime import time
+from dataclasses import dataclass, field
+from datetime import datetime, time
+from orionis.foundation.config.base import BaseConfigEntity
+from orionis.foundation.config.logging.validators import IsValidPath, IsValidLevel
 from orionis.foundation.exceptions import OrionisIntegrityException
 from orionis.foundation.config.logging.enums import Level
 
 @dataclass(unsafe_hash=True, kw_only=True)
-class Daily:
+class Daily(BaseConfigEntity):
     """
     Represents the configuration for daily log file rotation.
 
@@ -16,34 +18,34 @@ class Daily:
     """
 
     path: str = field(
-        default='storage/log/application.log',
-        metadata={
+        default = 'storage/log/application.log',
+        metadata = {
             "description": "The file path where the log is stored.",
             "default": "storage/log/application.log",
         },
     )
 
     level: int | str | Level = field(
-        default=Level.INFO,
-        metadata={
-            "description": "The logging level (e.g., 'info', 'error', 'debug').",
+        default = Level.INFO,
+        metadata = {
+            "description": "The logging level (e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL).",
             "default": Level.INFO,
         },
     )
 
     retention_days: int = field(
-        default=7,
-        metadata={
+        default = 7,
+        metadata = {
             "description": "The number of days to retain log files before deletion.",
             "default": 7,
         },
     )
 
-    at: time = field(
-        default=time(0, 0),
+    at: time | str = field(
+        default = time(0, 0).strftime("%H:%M"),
         metadata={
             "description": "The time of day when the log rotation should occur.",
-            "default": time(0, 0),
+            "default": time(0, 0).strftime("%H:%M"),
         },
     )
 
@@ -54,82 +56,42 @@ class Daily:
         Raises:
             OrionisIntegrityException: If any attribute is invalid.
         """
-        # Validate 'path'
-        if not isinstance(self.path, str) or not self.path.strip():
-            raise OrionisIntegrityException(
-                f"File cache configuration error: 'path' must be a non-empty string, got {repr(self.path)}."
-            )
 
-        # Validate 'level'
-        valid_level_types = (int, str, Level)
-        if not isinstance(self.level, valid_level_types):
-            raise OrionisIntegrityException(
-                f"File cache configuration error: 'level' must be int, str, or Level enum, got {type(self.level).__name__}."
-            )
+        # Validate 'path' using the IsValidPath validator
+        IsValidPath(self.path)
 
-        # Normalize 'level' to int
-        if isinstance(self.level, str):
-            _value = self.level.strip().upper()
-            if not _value:
-                raise OrionisIntegrityException(
-                    "File cache configuration error: 'level' string cannot be empty."
-                )
-            if _value not in Level.__members__:
-                raise OrionisIntegrityException(
-                    f"File cache configuration error: 'level' must be one of {list(Level.__members__.keys())}, got '{self.level}'."
-                )
-            self.level = Level[_value].value
-        elif isinstance(self.level, int):
-            valid_values = [level.value for level in Level]
-            if self.level not in valid_values:
-                raise OrionisIntegrityException(
-                    f"File cache configuration error: 'level' must be one of {valid_values}, got '{self.level}'."
-                )
-        elif isinstance(self.level, Level):
-            self.level = self.level.value
+        # Validate 'level' using the IsValidLevel validator
+        IsValidLevel(self.level)
 
         # Validate 'retention_days'
-        if not isinstance(self.retention_days, int) or self.retention_days < 1 or self.retention_days > 90:
+        if not isinstance(self.retention_days, int):
             raise OrionisIntegrityException(
-                f"File cache configuration error: 'retention_days' must be a positive integer between 1 and 90, got {repr(self.retention_days)}."
+                f"'retention_days' must be an integer, got {type(self.retention_days).__name__}."
             )
-
-        # Validate 'at'
-        if not isinstance(self.at, time):
+        if not (1 <= self.retention_days <= 90):
             raise OrionisIntegrityException(
-                f"File cache configuration error: 'at' must be a datetime.time instance, got {type(self.at).__name__}."
+                f"'retention_days' must be between 1 and 90, got {self.retention_days}."
             )
 
-        # Convert 'at' to "HH:MM:SS" string format
-        self.at = self.at.strftime("%H:%M:%S")
-
-    def toDict(self) -> dict:
-        """
-        Converts the Daily object to a dictionary representation.
-
-        Returns:
-            dict: A dictionary containing the dataclass fields and their values.
-        """
-        return asdict(self)
+        # Validate 'at' must be a time instance or a valid "HH:MM" string
+        if not isinstance(self.at, (time, str)):
+            raise OrionisIntegrityException(
+                f"'at' must be a datetime.time instance or a 'HH:MM' string, got {type(self.at).__name__}."
+            )
 
-    def getFields(self):
-        """
-        Retrieves a list of field information for the current dataclass instance.
+        # Validate and normalize 'at'
+        if isinstance(self.at, str):
+            try:
+                parsed_time = datetime.strptime(self.at, "%H:%M").time()
+                self.at = parsed_time
+            except ValueError:
+                raise OrionisIntegrityException(
+                    f"'at' must be a valid time string in 'HH:MM' format, got '{self.at}'."
+                )
+        elif not isinstance(self.at, time):
+            raise OrionisIntegrityException(
+                f"'at' must be a datetime.time instance or a 'HH:MM' string, got {type(self.at).__name__}."
+            )
 
-        Returns:
-            list: A list of dictionaries, each containing details about a field:
-                - name (str): The name of the field.
-                - type (type): The type of the field.
-                - default: The default value of the field, if specified; otherwise, the value from metadata or None.
-                - metadata (mapping): The metadata associated with the field.
-        """
-        __fields = []
-        for field in fields(self):
-            __metadata = dict(field.metadata) or {}
-            __fields.append({
-                "name": field.name,
-                "type": field.type.__name__ if hasattr(field.type, '__name__') else str(field.type),
-                "default": field.default if (field.default is not None and '_MISSING_TYPE' not in str(field.default)) else __metadata.get('default', None),
-                "metadata": __metadata
-            })
-        return __fields
+        # Normalize 'at' to "HH:MM" format
+        self.at = self.at.strftime("%H:%M")

orionis/foundation/config/logging/entities/hourly.py

@@ -1,9 +1,11 @@
-from dataclasses import asdict, dataclass, field, fields
+from dataclasses import dataclass, field
+from orionis.foundation.config.base import BaseConfigEntity
+from orionis.foundation.config.logging.validators import IsValidLevel, IsValidPath
 from orionis.foundation.exceptions import OrionisIntegrityException
 from orionis.foundation.config.logging.enums import Level
 
 @dataclass(unsafe_hash=True, kw_only=True)
-class Hourly:
+class Hourly(BaseConfigEntity):
     """
     Represents the configuration for hourly log file management.
 
@@ -14,24 +16,24 @@ class Hourly:
     """
 
     path: str = field(
-        default='storage/log/application.log',
-        metadata={
+        default = 'storage/log/application.log',
+        metadata = {
             "description": "The file path where the log is stored.",
             "default": "storage/log/application.log",
         },
     )
 
     level: int | str | Level = field(
-        default=Level.INFO,
-        metadata={
-            "description": "The logging level (e.g., 'info', 'error', 'debug').",
+        default = Level.INFO,
+        metadata = {
+            "description": "The logging level (e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL).",
             "default": Level.INFO,
         },
     )
 
     retention_hours: int = field(
-        default=24,
-        metadata={
+        default = 24,
+        metadata = {
             "description": "The number of hours to retain log files before deletion.",
             "default": 24,
         },
@@ -47,38 +49,12 @@ class Hourly:
                 - 'level' must be an int, str, or Level enum, and a valid value.
                 - 'retention_hours' must be an integer between 1 and 168.
         """
-        # Validate 'path'
-        if not isinstance(self.path, str) or not self.path.strip():
-            raise OrionisIntegrityException(
-                f"File cache configuration error: 'path' must be a non-empty string, got {repr(self.path)}."
-            )
 
-        # Validate 'level'
-        valid_level_types = (int, str, Level)
-        if not isinstance(self.level, valid_level_types):
-            raise OrionisIntegrityException(
-                f"File cache configuration error: 'level' must be int, str, or Level enum, got {type(self.level).__name__}."
-            )
+        # Validate 'path' using the IsValidPath validator
+        IsValidPath(self.path)
 
-        if isinstance(self.level, str):
-            _value = self.level.strip().upper()
-            if not _value:
-                raise OrionisIntegrityException(
-                    "File cache configuration error: 'level' string cannot be empty."
-                )
-            if _value not in Level.__members__:
-                raise OrionisIntegrityException(
-                    f"File cache configuration error: 'level' must be one of {list(Level.__members__.keys())}, got '{self.level}'."
-                )
-            self.level = Level[_value].value
-        elif isinstance(self.level, int):
-            valid_values = [level.value for level in Level]
-            if self.level not in valid_values:
-                raise OrionisIntegrityException(
-                    f"File cache configuration error: 'level' must be one of {valid_values}, got '{self.level}'."
-                )
-        elif isinstance(self.level, Level):
-            self.level = self.level.value
+        # Validate 'level' using the IsValidLevel validator
+        IsValidLevel(self.level)
 
         # Validate 'retention_hours'
         if not isinstance(self.retention_hours, int) or self.retention_hours < 0:
@@ -88,35 +64,4 @@ class Hourly:
         if self.retention_hours < 1 or self.retention_hours > 168:
             raise OrionisIntegrityException(
                 f"File cache configuration error: 'retention_hours' must be between 1 and 168, got {self.retention_hours}."
-            )
-
-    def toDict(self) -> dict:
-        """
-        Converts the Hourly object to a dictionary representation.
-
-        Returns:
-            dict: A dictionary containing all the dataclass fields and their values.
-        """
-        return asdict(self)
-
-    def getFields(self):
-        """
-        Retrieves a list of field information for the current dataclass instance.
-
-        Returns:
-            list: A list of dictionaries, each containing details about a field:
-                - name (str): The name of the field.
-                - type (type): The type of the field.
-                - default: The default value of the field, if specified; otherwise, the value from metadata or None.
-                - metadata (mapping): The metadata associated with the field.
-        """
-        __fields = []
-        for field in fields(self):
-            __metadata = dict(field.metadata) or {}
-            __fields.append({
-                "name": field.name,
-                "type": field.type.__name__ if hasattr(field.type, '__name__') else str(field.type),
-                "default": field.default if (field.default is not None and '_MISSING_TYPE' not in str(field.default)) else __metadata.get('default', None),
-                "metadata": __metadata
-            })
-        return __fields
+            )

orionis/foundation/config/logging/entities/logging.py

@@ -1,9 +1,10 @@
-from dataclasses import dataclass, field, asdict, fields
+from dataclasses import dataclass, field, fields
+from orionis.foundation.config.base import BaseConfigEntity
 from orionis.foundation.config.logging.entities.channels import Channels
 from orionis.foundation.exceptions import OrionisIntegrityException
 
 @dataclass(unsafe_hash=True, kw_only=True)
-class Logging:
+class Logging(BaseConfigEntity):
     """
     Represents the logging system configuration.
 
@@ -18,21 +19,39 @@ class Logging:
         default="stack",
         metadata={
             "description": "The default logging channel to use.",
-            "default": "stack",
+            "default": "stack"
         }
     )
-    channels: Channels = field(
-        default_factory=Channels,
+
+    channels: Channels | dict = field(
+        default_factory = lambda: Channels(),
         metadata={
             "description": "A collection of available logging channels.",
-            "default": "Channels()",
+            "default": lambda: Channels().toDict()
         }
     )
 
     def __post_init__(self):
         """
-        Validates the types of the attributes after initialization.
+        Validates the logging configuration after dataclass initialization by ensuring
+        the default channel and channels configuration are properly formatted and valid.
+        Parameters
+        ----------
+        None
+        Raises
+        ------
+        OrionisIntegrityException
+            If the default channel is not a string or doesn't match available channel options.
+        OrionisIntegrityException
+            If the channels configuration is malformed or cannot be converted to a Channels instance.
+        OrionisIntegrityException
+            If the channels property is not a Channels instance or a dictionary.
+        Notes
+        -----
+        This method performs the following validations:
+        - Ensures 'default' is a string matching available channel options from Channels fields
         """
+
         options = [field.name for field in fields(Channels)]
         if not isinstance(self.default, str) or self.default not in options:
             raise OrionisIntegrityException(
@@ -40,34 +59,14 @@ class Logging:
             )
 
         if not isinstance(self.channels, Channels):
-            raise OrionisIntegrityException(
-                "The 'channels' property must be an instance of Channels."
-            )
-
-    def toDict(self) -> dict:
-        """
-        Converts the current instance into a dictionary representation.
-        """
-        return asdict(self)
-
-    def getFields(self):
-        """
-        Retrieves a list of field information for the current dataclass instance.
-
-        Returns:
-            list: A list of dictionaries, each containing details about a field:
-                - name (str): The name of the field.
-                - type (type): The type of the field.
-                - default: The default value of the field, if specified; otherwise, the value from metadata or None.
-                - metadata (mapping): The metadata associated with the field.
-        """
-        __fields = []
-        for field in fields(self):
-            __metadata = dict(field.metadata) or {}
-            __fields.append({
-                "name": field.name,
-                "type": field.type.__name__ if hasattr(field.type, '__name__') else str(field.type),
-                "default": field.default if (field.default is not None and '_MISSING_TYPE' not in str(field.default)) else __metadata.get('default', None),
-                "metadata": __metadata
-            })
-        return __fields
+            if isinstance(self.channels, dict):
+                try:
+                    self.channels = Channels(**self.channels)
+                except TypeError as e:
+                    raise OrionisIntegrityException(
+                        f"Invalid channels configuration: {e}"
+                    )
+            else:
+                raise OrionisIntegrityException(
+                    "The 'channels' property must be an instance of Channels or a dictionary."
+                )