orionis 0.401.0__py3-none-any.whl → 0.403.0__py3-none-any.whl

orionis/foundation/config/logging/entities/weekly.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 IsValidPath, IsValidLevel
 from orionis.foundation.exceptions import OrionisIntegrityException
 from orionis.foundation.config.logging.enums import Level
 
 @dataclass(unsafe_hash=True, kw_only=True)
-class Weekly:
+class Weekly(BaseConfigEntity):
     """
     Configuration entity for weekly log file management.
 
@@ -14,24 +16,24 @@ class Weekly:
     """
 
     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_weeks: int = field(
-        default=4,
-        metadata={
+        default = 4,
+        metadata = {
             "description": "The number of weeks to retain log files before deletion.",
             "default": 4,
         },
@@ -49,76 +51,18 @@ class Weekly:
         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 'path' using the IsValidPath validator
+        IsValidPath(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__}."
-            )
-
-        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_weeks'
-        if not isinstance(self.retention_weeks, int) or self.retention_weeks < 0:
+        if not isinstance(self.retention_weeks, int):
             raise OrionisIntegrityException(
-                f"File cache configuration error: 'retention_weeks' must be a non-negative integer, got {self.retention_weeks}."
+                f"Invalid type for 'retention_weeks': expected int, got {type(self.retention_weeks).__name__}."
             )
         if self.retention_weeks < 1 or self.retention_weeks > 12:
             raise OrionisIntegrityException(
-                f"File cache configuration error: 'retention_weeks' must be between 1 and 12, got {self.retention_weeks}."
-            )
-
-    def toDict(self) -> dict:
-        """
-        Converts the Weekly configuration object to a dictionary.
-
-        Returns:
-            dict: Dictionary representation of the Weekly configuration.
-        """
-        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"'retention_weeks' must be an integer between 1 and 12 (inclusive), but got {self.retention_weeks}."
+            )

orionis/foundation/config/logging/enums/levels.py

@@ -1,11 +1,11 @@
 from enum import Enum
+import logging
 
 class Level(Enum):
     """
     Enumeration of standard logging levels.
 
     Attributes:
-        NOTSET (int): No specific logging level set. Value is 0.
         DEBUG (int): Detailed information, typically of interest only when diagnosing problems. Value is 10.
         INFO (int): Confirmation that things are working as expected. Value is 20.
         WARNING (int): An indication that something unexpected happened, or indicative of some problem in the near future. Value is 30.
@@ -13,9 +13,8 @@ class Level(Enum):
         CRITICAL (int): A very serious error, indicating that the program itself may be unable to continue running. Value is 50.
     """
 
-    NOTSET = 0
-    DEBUG = 10
-    INFO = 20
-    WARNING = 30
-    ERROR = 40
-    CRITICAL = 50
+    DEBUG = logging.DEBUG
+    INFO = logging.INFO
+    WARNING = logging.WARNING
+    ERROR = logging.ERROR
+    CRITICAL = logging.CRITICAL

orionis/foundation/config/logging/validators/__init__.py

@@ -0,0 +1,7 @@
+from .level import IsValidLevel
+from .path import IsValidPath
+
+__all__ = [
+    "IsValidLevel",
+    "IsValidPath",
+]

orionis/foundation/config/logging/validators/level.py

@@ -0,0 +1,54 @@
+from typing import Any
+from orionis.foundation.config.logging.enums import Level
+from orionis.foundation.exceptions import OrionisIntegrityException
+
+class _IsValidLevel:
+    """
+    Validator that checks if a value is a valid logging level.
+    Accepts int, str, or Level enum.
+    """
+
+    _level_names = {level.name for level in Level}
+    _level_values = {level.value for level in Level}
+
+    def __call__(self, value: Any) -> None:
+        """
+        Validate the provided logging level value.
+        Parameters
+        ----------
+        value : Any
+            The value to validate as a logging level. Can be an integer, string, or Level enum instance.
+        Raises
+        ------
+        OrionisIntegrityException
+            If the value is not a valid logging level or not of an accepted type (int, str, or Level).
+        Notes
+        -----
+        - If `value` is an integer, it must be present in `self._level_values`.
+        - If `value` is a string, it is stripped, uppercased, and must be present in `self._level_names`.
+        - If `value` is a Level enum instance, it is accepted as valid.
+        """
+        if isinstance(value, Level):
+            return
+
+        if isinstance(value, int):
+            if value not in self._level_values:
+                raise OrionisIntegrityException(
+                    f"'level' must be one of {sorted(self._level_values)}, got {value}."
+                )
+            return
+
+        if isinstance(value, str):
+            name = value.strip().upper()
+            if name not in self._level_names:
+                raise OrionisIntegrityException(
+                    f"'level' must be one of {sorted(self._level_names)}, got '{value}'."
+                )
+            return
+
+        raise OrionisIntegrityException(
+            f"'level' must be int, str, or Level enum, got {type(value).__name__}."
+        )
+
+# Exported singleton instance
+IsValidLevel = _IsValidLevel()

orionis/foundation/config/logging/validators/path.py

@@ -0,0 +1,34 @@
+from typing import Any
+from orionis.foundation.exceptions import OrionisIntegrityException
+
+class __IsValidPath:
+    """
+    __IsValidPath is a callable class used to validate that a given value is a non-empty string representing a file path.
+
+    Methods
+    -------
+    __call__(value: Any) -> None
+
+    Raises
+    ------
+    OrionisIntegrityException
+        If the provided value is not a non-empty string representing a file path.
+    """
+
+    def __call__(self, value: Any) -> None:
+        """
+        Validates that the provided value is a non-empty string representing a file path.
+
+        Args:
+            value (Any): The value to validate as a file path.
+
+        Raises:
+            OrionisIntegrityException: If the value is not a non-empty string.
+        """
+        if not isinstance(value, str) or not value.strip():
+            raise OrionisIntegrityException(
+                f"File cache configuration error: 'path' must be a non-empty string, got {repr(value)}."
+            )
+
+# Exported singleton instance
+IsValidPath = __IsValidPath()

orionis/foundation/providers/console_provider.py

@@ -3,10 +3,6 @@ from orionis.console.output.contracts.console import IConsole
 from orionis.container.providers.service_provider import ServiceProvider
 
 class ConsoleProvider(ServiceProvider):
-    """
-    Debug provider for the Orionis framework.
-    This provider is responsible for debugging functionalities.
-    """
 
     def register(self) -> None:
         """

orionis/foundation/providers/dumper_provider.py

@@ -3,10 +3,6 @@ from orionis.console.dumper.contracts.dump import IDebug
 from orionis.container.providers.service_provider import ServiceProvider
 
 class DumperProvider(ServiceProvider):
-    """
-    Debug provider for the Orionis framework.
-    This provider is responsible for debugging functionalities.
-    """
 
     def register(self) -> None:
         """

orionis/foundation/providers/logger_provider.py

@@ -0,0 +1,17 @@
+from orionis.container.providers.service_provider import ServiceProvider
+from orionis.services.log.contracts.log_service import ILoggerService
+from orionis.services.log.log_service import LoggerService
+
+class LoggerProvider(ServiceProvider):
+
+    def register(self) -> None:
+        """
+        Register services into the application container.
+        """
+        self.app.instance(ILoggerService, LoggerService(self.app.config('logging')), alias="core.orionis.logger")
+
+    def boot(self) -> None:
+        """
+        Perform any post-registration bootstrapping or initialization.
+        """
+        pass

orionis/foundation/providers/path_resolver_provider.py

@@ -3,10 +3,6 @@ from orionis.services.paths.contracts.resolver import IResolver
 from orionis.services.paths.resolver import Resolver
 
 class PathResolverProvider(ServiceProvider):
-    """
-    Debug provider for the Orionis framework.
-    This provider is responsible for debugging functionalities.
-    """
 
     def register(self) -> None:
         """

orionis/foundation/providers/progress_bar_provider.py

@@ -3,10 +3,6 @@ from orionis.console.dynamic.progress_bar import ProgressBar
 from orionis.container.providers.service_provider import ServiceProvider
 
 class ProgressBarProvider(ServiceProvider):
-    """
-    Debug provider for the Orionis framework.
-    This provider is responsible for debugging functionalities.
-    """
 
     def register(self) -> None:
         """

orionis/foundation/providers/workers_provider.py

@@ -3,10 +3,6 @@ from orionis.services.system.contracts.workers import IWorkers
 from orionis.services.system.workers import Workers
 
 class WorkersProvider(ServiceProvider):
-    """
-    Debug provider for the Orionis framework.
-    This provider is responsible for debugging functionalities.
-    """
 
     def register(self) -> None:
         """

orionis/metadata/framework.py

@@ -5,7 +5,7 @@
 NAME = "orionis"
 
 # Current version of the framework
-VERSION = "0.401.0"
+VERSION = "0.403.0"
 
 # Full name of the author or maintainer of the project
 AUTHOR = "Raul Mauricio Uñate Castro"

orionis/services/log/contracts/log_service.py

@@ -0,0 +1,23 @@
+from abc import ABC, abstractmethod
+
+class ILoggerService(ABC):
+
+    @abstractmethod
+    def info(self, message: str) -> None:
+        """Log an informational message."""
+        pass
+
+    @abstractmethod
+    def error(self, message: str) -> None:
+        """Log an error message."""
+        pass
+
+    @abstractmethod
+    def warning(self, message: str) -> None:
+        """Log a warning message."""
+        pass
+
+    @abstractmethod
+    def debug(self, message: str) -> None:
+        """Log a debug message."""
+        pass

orionis/services/log/exceptions/__init__.py

@@ -0,0 +1,5 @@
+from .runtime import LoggerRuntimeError
+
+__all__ = [
+    "LoggerRuntimeError",
+]

orionis/services/log/exceptions/runtime.py

@@ -0,0 +1,19 @@
+class LoggerRuntimeError(RuntimeError):
+
+    def __init__(self, msg: str):
+        """
+        Parameters
+        ----------
+        msg : str
+            Descriptive error message explaining the cause of the exception.
+        """
+        super().__init__(msg)
+
+    def __str__(self) -> str:
+        """
+        Returns
+        -------
+        str
+            Formatted string describing the exception.
+        """
+        return str(self.args[0])

orionis/services/log/handlers/size_rotating.py

@@ -0,0 +1,52 @@
+from datetime import datetime
+from logging.handlers import RotatingFileHandler
+from pathlib import Path
+import os
+
+class PrefixedSizeRotatingFileHandler(RotatingFileHandler):
+
+    def rotation_filename(self, default_name):
+        """
+        Generates a rotated log filename by prefixing the original filename with a timestamp.
+        This method takes an original file path, extracts its directory, base name, and extension,
+        and returns a new file path where the base name is prefixed with the current timestamp
+        in the format 'YYYYMMDD_HHMMSS'. If the target directory does not exist, it is created.
+            The original file path to be rotated.
+            The new file path with a timestamp prefix added to the base name.
+        Notes
+        -----
+        - The timestamp is based on the current local time.
+        - The method ensures that the parent directory for the new file exists.
+
+        Returns
+        -------
+        str
+            The new filename with a timestamp prefix in the format 'YYYYMMDD_HHMMSS'.
+        """
+        # Split the original path to extract the base name and extension
+        if '/' in default_name:
+            parts = default_name.split('/')
+        elif '\\' in default_name:
+            parts = default_name.split('\\')
+        else:
+            parts = default_name.split(os.sep)
+
+        # Get the base name and extension
+        filename, ext = os.path.splitext(parts[-1])
+
+        # Create the path without the last part
+        path = os.path.join(*parts[:-1]) if len(parts) > 1 else ''
+
+        # Prefix the base name with a timestamp
+        prefix = datetime.now().strftime("%Y%m%d_%H%M%S")
+
+        # Join the path, prefix, and filename to create the full path
+        full_path = os.path.join(path, f"{prefix}_{filename}{ext}")
+
+        # Ensure the log directory exists
+        log_dir = Path(full_path).parent
+        if not log_dir.exists():
+            log_dir.mkdir(parents=True, exist_ok=True)
+
+        # Return the full path as a string
+        return full_path

orionis/services/log/handlers/timed_rotating.py

@@ -0,0 +1,53 @@
+from datetime import datetime
+from logging.handlers import TimedRotatingFileHandler
+from pathlib import Path
+import os
+
+class PrefixedTimedRotatingFileHandler(TimedRotatingFileHandler):
+
+    def rotation_filename(self, default_name):
+        """
+        Generates a rotated log filename by prefixing the original filename with a timestamp.
+        This method takes an original file path, extracts its directory, base name, and extension,
+        and returns a new file path where the base name is prefixed with the current timestamp
+        in the format 'YYYYMMDD_HHMMSS'. If the target directory does not exist, it is created.
+            The original file path to be rotated.
+            The new file path with a timestamp prefix added to the base name.
+        Notes
+        -----
+        - The timestamp is based on the current local time.
+        - The method ensures that the parent directory for the new file exists.
+
+        Returns
+        -------
+        str
+            The new filename with a timestamp prefix in the format 'YYYYMMDD_HHMMSS'.
+        """
+
+        # Split the original path to extract the base name and extension
+        if '/' in default_name:
+            parts = default_name.split('/')
+        elif '\\' in default_name:
+            parts = default_name.split('\\')
+        else:
+            parts = default_name.split(os.sep)
+
+        # Get the base name and extension
+        filename, ext = os.path.splitext(parts[-1])
+
+        # Create the path without the last part
+        path = os.path.join(*parts[:-1]) if len(parts) > 1 else ''
+
+        # Prefix the base name with a timestamp
+        prefix = datetime.now().strftime("%Y%m%d_%H%M%S")
+
+        # Join the path, prefix, and filename to create the full path
+        full_path = os.path.join(path, f"{prefix}_{filename}{ext}")
+
+        # Ensure the log directory exists
+        log_dir = Path(full_path).parent
+        if not log_dir.exists():
+            log_dir.mkdir(parents=True, exist_ok=True)
+
+        # Return the full path as a string
+        return full_path