orionis 0.418.0__py3-none-any.whl → 0.420.0__py3-none-any.whl

orionis/_contracts/facades/environment/environment_facade.py

@@ -1,74 +0,0 @@
-from abc import ABC, abstractmethod
-
-class IEnv(ABC):
-
-    @abstractmethod
-    def _initialize(self, path: str = None):
-        """
-        Initializes the instance by setting the path to the .env file.
-        If no path is provided, defaults to a `.env` file in the current directory.
-
-        Parameters
-        ----------
-        path : str, optional
-            Path to the .env file. Defaults to None.
-        """
-        pass
-
-    @abstractmethod
-    def get(self, key: str, default=None) -> str:
-        """
-        Retrieves the value of an environment variable from the .env file
-        or from system environment variables if not found.
-
-        Parameters
-        ----------
-        key : str
-            The key of the environment variable.
-        default : optional
-            Default value if the key does not exist. Defaults to None.
-
-        Returns
-        -------
-        str
-            The value of the environment variable or the default value.
-        """
-        pass
-
-    @abstractmethod
-    def set(self, key: str, value: str) -> None:
-        """
-        Sets the value of an environment variable in the .env file.
-
-        Parameters
-        ----------
-        key : str
-            The key of the environment variable.
-        value : str
-            The value to set.
-        """
-        pass
-
-    @abstractmethod
-    def unset(self, key: str) -> None:
-        """
-        Removes an environment variable from the .env file.
-
-        Parameters
-        ----------
-        key : str
-            The key of the environment variable to remove.
-        """
-        pass
-
-    @abstractmethod
-    def all(self) -> dict:
-        """
-        Retrieves all environment variable values from the .env file.
-
-        Returns
-        -------
-        dict
-            A dictionary of all environment variables and their values.
-        """
-        pass

orionis/_contracts/facades/facade.py

@@ -1,38 +0,0 @@
-from orionis._container.container import Container
-# from orionis.support.async.async_io import AsyncExecutor
-
-class FacadeMeta(type):
-    """
-    Metaclass for Facade pattern. It intercepts attribute access to dynamically resolve and delegate calls
-    to the underlying service. This is where the magic happens, folks!
-    """
-    def __getattr__(cls, name: str):
-        """
-        When an undefined attribute is accessed, this method resolves the service and delegates the call.
-        It's like having a genie in a bottle, but for services.
-        """
-        service = cls.resolve()
-        return getattr(service, name)
-
-class Facade(metaclass=FacadeMeta):
-    """
-    Base Facade class. It provides a clean and simple interface to interact with complex services.
-    Think of it as the friendly face of a very complicated machine.
-    """
-
-    @classmethod
-    def getFacadeAccessor(cls):
-        """
-        This method must be overridden by subclasses to return the name of the service to be resolved.
-        If not, it throws a tantrum (NotImplementedError).
-        """
-        raise NotImplementedError("You must define the service name")
-
-    @classmethod
-    def resolve(cls):
-        """
-        Resolves the service by using the AsyncExecutor to make it from the Container.
-        It's like calling the butler to fetch something from the pantry.
-        """
-        pass
-        # return AsyncExecutor.run(Container().make(cls.getFacadeAccessor()))

orionis/_contracts/facades/files/path_facade.py

@@ -1,148 +0,0 @@
-from abc import ABC, abstractmethod
-
-class IPath(ABC):
-    """
-    A facade class for resolving absolute paths to various application directories.
-
-    This class provides static methods to resolve paths to common directories such as
-    'app', 'config', 'database', 'resources', 'routes', 'storage', and 'tests'.
-    It uses the `PathService` to resolve and validate paths.
-
-    Methods
-    -------
-    _resolve_directory(directory: str, file: str = None) -> SkeletonPath
-        Resolves the absolute path for a given directory and optional file.
-    app(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'app' directory.
-    config(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'config' directory.
-    database(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'database' directory.
-    resource(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'resource' directory.
-    routes(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'routes' directory.
-    storage(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'storage' directory.
-    tests(file: str = None) -> SkeletonPath
-        Returns the absolute path for a file inside the 'tests' directory.
-    """
-
-    @abstractmethod
-    def app(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'app' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'app' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass
-
-    @abstractmethod
-    def config(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'config' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'config' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass
-
-    @abstractmethod
-    def database(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'database' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'database' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass
-
-    @abstractmethod
-    def resource(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'resource' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'resource' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass
-
-    @abstractmethod
-    def routes(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'routes' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'routes' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass
-
-    @abstractmethod
-    def storage(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'storage' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'storage' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass
-
-    @abstractmethod
-    def tests(file: str = None):
-        """
-        Returns the absolute path for a file inside the 'tests' directory.
-
-        Parameters
-        ----------
-        file : str, optional
-            The relative file path inside the 'tests' directory.
-
-        Returns
-        -------
-        SkeletonPath
-            The resolved path wrapped in a SkeletonPath object.
-        """
-        pass

orionis/_contracts/facades/log/log_facade.py

@@ -1,83 +0,0 @@
-from abc import ABC, abstractmethod
-
-class ILog(ABC):
-    """
-    A facade class for logging messages with different severity levels.
-
-    This class provides static methods to log messages using the `LogguerService`.
-    It simplifies the process of logging by abstracting the service resolution
-    and providing a clean interface for logging.
-
-    Methods
-    -------
-    info(message: str) -> None
-        Logs an informational message.
-    error(message: str) -> None
-        Logs an error message.
-    success(message: str) -> None
-        Logs a success message.
-    warning(message: str) -> None
-        Logs a warning message.
-    debug(message: str) -> None
-        Logs a debug message.
-    """
-
-    @abstractmethod
-    def info(message: str) -> None:
-        """
-        Logs an informational message.
-
-        Parameters
-        ----------
-        message : str
-            The message to log.
-        """
-        pass
-
-    @abstractmethod
-    def error(message: str) -> None:
-        """
-        Logs an error message.
-
-        Parameters
-        ----------
-        message : str
-            The message to log.
-        """
-        pass
-
-    @abstractmethod
-    def success(message: str) -> None:
-        """
-        Logs a success message.
-
-        Parameters
-        ----------
-        message : str
-            The message to log.
-        """
-        pass
-
-    @abstractmethod
-    def warning(message: str) -> None:
-        """
-        Logs a warning message.
-
-        Parameters
-        ----------
-        message : str
-            The message to log.
-        """
-        pass
-
-    @abstractmethod
-    def debug(message: str) -> None:
-        """
-        Logs a debug message.
-
-        Parameters
-        ----------
-        message : str
-            The message to log.
-        """
-        pass

orionis/_contracts/facades/tests/tests_facade.py

@@ -1,30 +0,0 @@
-from abc import ABC, abstractmethod
-
-class IUnitTests(ABC):
-    """
-    Interface for executing unit tests based on a specified pattern.
-
-    Methods
-    -------
-    execute(pattern: str) -> dict
-        Executes unit tests by iterating over the 'tests' directory and its subdirectories,
-        matching test files based on the provided pattern.
-    """
-
-    @abstractmethod
-    def execute(pattern='test_*.py') -> dict:
-        """
-        Executes the unit tests in the 'tests' directory and its subdirectories
-        by filtering test files based on a specified pattern.
-
-        Parameters
-        ----------
-        pattern : str, optional
-            The pattern to filter test files (default is 'test_*.py').
-
-        Returns
-        -------
-        dict
-            A dictionary containing the results of the executed tests.
-        """
-        pass

orionis/_contracts/foundation/bootstraper.py

@@ -1,41 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any
-
-class IBootstrapper(ABC):
-
-    @abstractmethod
-    def _autoload(self) -> None:
-        """
-        Loads environment variables from the `.env` file or creates the file if it does not exist.
-
-        This method checks if the `.env` file exists in the current working directory.
-        If the file does not exist, it creates an empty `.env` file. If the file exists,
-        it loads the environment variables into the `_environment_vars` dictionary.
-
-        Raises
-        ------
-        PermissionError
-            If the `.env` file cannot be created or read due to insufficient permissions.
-        """
-        pass
-
-    def get(self, *args, **kwargs) -> Any:
-        """
-        Retrieves the value of an environment variable.
-
-        Parameters
-        ----------
-        key : str
-            The name of the environment variable.
-
-        Returns
-        -------
-        str
-            The value of the environment variable.
-
-        Raises
-        ------
-        KeyError
-            If the environment variable does not exist.
-        """
-        pass

orionis/_contracts/foundation/config/config_bootstrapper.py

@@ -1,140 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any, Dict
-
-class IConfigBootstrapper(ABC):
-    """
-    Attributes
-    ----------
-    _config : Dict[str, Any]
-        A dictionary to store registered configuration sections and their data.
-
-    Methods
-    -------
-    __init__()
-        Initializes the `ConfigBootstrapper` and triggers the autoload process.
-    _autoload()
-        Scans the configuration directory and loads configuration classes.
-    _set(concrete: Any, section: str)
-        Validates and registers a configuration class.
-    _parse(data: Any) -> Dict[str, Any]
-        Converts the 'config' attribute of a class into a dictionary.
-    _register(section: str, data: Dict[str, Any])
-        Registers a configuration section.
-    set(key: str, value: Any)
-        Dynamically sets a configuration value using dot notation.
-    get(key: str, default: Optional[Any] = None) -> Any
-        Retrieves a configuration value using dot notation.
-    """
-
-    @abstractmethod
-    def _autoload(self) -> None:
-        """
-        Scans the configuration directory and loads configuration classes.
-
-        This method searches for Python files in the specified directory, imports them,
-        and registers any class named `Config` that inherits from `IConfig`.
-
-        Raises
-        ------
-        FileNotFoundError
-            If the configuration directory does not exist.
-        BootstrapRuntimeError
-            If there is an error loading a module.
-        """
-        pass
-
-    @abstractmethod
-    def _set(self, concrete: Any, section: str) -> None:
-        """
-        Validates and registers a configuration class.
-
-        This method ensures that the provided class is valid (inherits from `IConfig`
-        and has a `config` attribute) and registers it in the `_config` dictionary.
-
-        Parameters
-        ----------
-        concrete : Any
-            The configuration class to register.
-        section : str
-            The section name under which the configuration will be registered.
-
-        Raises
-        ------
-        TypeError
-            If the input is not a class or does not inherit from `IConfig`.
-        ValueError
-            If the class does not have a `config` attribute.
-        """
-        pass
-
-    @abstractmethod
-    def _parse(data: Any) -> Dict[str, Any]:
-        """
-        Converts the 'config' attribute of a class into a dictionary.
-
-        If the input is already a dictionary, it is returned as-is. If the input is a
-        dataclass, it is converted to a dictionary using `asdict`.
-
-        Parameters
-        ----------
-        data : Any
-            The data to convert into a dictionary.
-
-        Returns
-        -------
-        Dict[str, Any]
-            The converted dictionary.
-
-        Raises
-        ------
-        TypeError
-            If the data cannot be converted to a dictionary.
-        """
-        pass
-
-    @abstractmethod
-    def _register(self, section: str, data: Dict[str, Any]) -> None:
-        """
-        Registers a configuration section.
-
-        Parameters
-        ----------
-        section : str
-            The name of the configuration section.
-        data : Dict[str, Any]
-            The configuration data to register.
-
-        Raises
-        ------
-        ValueError
-            If the section is already registered.
-        """
-        pass
-
-    @abstractmethod
-    def get(self, key: str = None, default: Any = None) -> Any:
-        """
-        Retrieves configuration data.
-
-        If a key is provided, it retrieves the value associated with the key using dot notation.
-        If no key is provided, it returns the entire configuration dictionary.
-
-        Parameters
-        ----------
-        key : str, optional
-            The key to retrieve the value for, using dot notation (default is None).
-        default : Any, optional
-            The default value to return if the key is not found (default is None).
-
-        Returns
-        -------
-        Any
-            The configuration value associated with the key, or the entire configuration dictionary
-            if no key is provided. If the key is not found, returns the default value.
-
-        Raises
-        ------
-        KeyError
-            If the key is not found and no default value is provided.
-        """
-        pass

orionis/_contracts/foundation/console/command_bootstrapper.py

@@ -1,81 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict
-
-class ICommandsBootstrapper(ABC):
-    """
-    Attributes
-    ----------
-    _commands : Dict[str, Dict[str, Any]]
-        A dictionary to store registered commands, where the key is the command signature
-        and the value is a dictionary containing the command class, arguments, description,
-        and signature.
-
-    Methods
-    -------
-    __init__()
-        Initializes the `CommandsBootstrapper` and triggers the autoload process.
-    _autoload()
-        Scans the command directories and loads command classes.
-    _register(concrete: Callable[..., Any])
-        Validates and registers a command class.
-    """
-
-    @abstractmethod
-    def _autoload(self) -> None:
-        """
-        Scans the command directories and loads command classes.
-
-        This method searches for Python files in the specified directories, imports them,
-        and registers any class that inherits from `BaseCommand`.
-
-        Raises
-        ------
-        BootstrapRuntimeError
-            If there is an error loading a module.
-        """
-        pass
-
-    @abstractmethod
-    def _register(self, concrete: Callable[..., Any]) -> None:
-        """
-        Validates and registers a command class.
-
-        This method ensures that the provided class is valid (inherits from `BaseCommand`,
-        has a `signature`, `description`, and `handle` method) and registers it in the
-        `_commands` dictionary.
-
-        Parameters
-        ----------
-        concrete : Callable[..., Any]
-            The command class to register.
-
-        Raises
-        ------
-        TypeError
-            If the input is not a class or does not inherit from `BaseCommand`.
-        ValueError
-            If the class does not have required attributes or methods.
-        """
-        pass
-
-    @abstractmethod
-    def get(self, signature: str = None) -> Dict[str, Any]:
-        """
-        Retrieves a registered command by its signature.
-
-        Parameters
-        ----------
-        signature : str
-            The command signature to retrieve.
-
-        Returns
-        -------
-        Dict[str, Any]
-            A dictionary containing the command class, arguments, description, and signature.
-
-        Raises
-        ------
-        KeyError
-            If the command signature is not found.
-        """
-        pass

orionis/_contracts/foundation/environment/environment_bootstrapper.py

@@ -1,33 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any, Optional
-
-class IEnvironmentBootstrapper(ABC):
-    """
-    Attributes
-    ----------
-    _environment_vars : Dict[str, str]
-        A dictionary to store the loaded environment variables.
-    path : Path
-        The path to the `.env` file.
-
-    Methods
-    -------
-    _autoload()
-        Loads environment variables from the `.env` file or creates the file if it does not exist.
-    """
-
-    @abstractmethod
-    def _autoload(self) -> None:
-        """
-        Loads environment variables from the `.env` file or creates the file if it does not exist.
-
-        This method checks if the `.env` file exists in the current working directory.
-        If the file does not exist, it creates an empty `.env` file. If the file exists,
-        it loads the environment variables into the `_environment_vars` dictionary.
-
-        Raises
-        ------
-        PermissionError
-            If the `.env` file cannot be created or read due to insufficient permissions.
-        """
-        pass