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

orionis/_contracts/console/kernel.py

@@ -1,32 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any, Tuple
-
-class ICLIKernel(ABC):
-    """
-    Interface for CLIKernel, defining the required method for handling CLI command execution.
-
-    This interface ensures that any implementing class can process CLI arguments
-    and delegate execution accordingly.
-
-    Methods
-    -------
-    handle(*args: tuple[Any, ...]) -> Any
-        Processes CLI arguments and delegates execution to the appropriate command runner.
-    """
-
-    @abstractmethod
-    def handle(self, *args: Tuple[Any, ...]) -> Any:
-        """
-        Handles CLI command execution by forwarding arguments to a command runner.
-
-        Parameters
-        ----------
-        *args : tuple[Any, ...]
-            A tuple containing CLI arguments passed from the command line.
-
-        Returns
-        -------
-        Any
-            The result of the executed command.
-        """
-        pass

orionis/_contracts/console/output/console.py

@@ -1,421 +0,0 @@
-from abc import ABC, abstractmethod
-
-class IConsole(ABC):
-
-    @abstractmethod
-    def success(message: str, timestamp: bool = True):
-        """
-        Prints a success message with a green background.
-
-        Parameters
-        ----------
-        message : str, optional
-            The success message to print.
-        timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textSuccess(message: str):
-        """
-        Prints a success message in green.
-
-        Parameters
-        ----------
-        message : str
-            The success message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textSuccessBold(message: str):
-        """
-        Prints a bold success message in green.
-
-        Parameters
-        ----------
-        message : str
-            The success message to print.
-        """
-        pass
-
-    @abstractmethod
-    def info(message: str, timestamp: bool = True):
-        """
-        Prints an informational message with a blue background.
-
-        Parameters
-        ----------
-        message : str
-            The informational message to print.
-            timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textInfo(message: str):
-        """
-        Prints an informational message in blue.
-
-        Parameters
-        ----------
-        message : str
-            The informational message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textInfoBold(message: str):
-        """
-        Prints a bold informational message in blue.
-
-        Parameters
-        ----------
-        message : str
-            The informational message to print.
-        """
-        pass
-
-    @abstractmethod
-    def warning(message: str, timestamp: bool = True):
-        """
-        Prints a warning message with a yellow background.
-
-        Parameters
-        ----------
-        message : str
-            The warning message to print.
-            timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textWarning(message: str):
-        """
-        Prints a warning message in yellow.
-
-        Parameters
-        ----------
-        message : str
-            The warning message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textWarningBold(message: str):
-        """
-        Prints a bold warning message in yellow.
-
-        Parameters
-        ----------
-        message : str
-            The warning message to print.
-        """
-        pass
-
-    @abstractmethod
-    def fail(message: str, timestamp: bool = True):
-        """
-        Prints a failure message with a red background.
-
-        Parameters
-        ----------
-        message : str
-            The failure message to print.
-            timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def error(message: str, timestamp: bool = True):
-        """
-        Prints an error message with a red background.
-
-        Parameters
-        ----------
-        message : str
-            The error message to print.
-            timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textError(message: str):
-        """
-        Prints an error message in red.
-
-        Parameters
-        ----------
-        message : str
-            The error message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textErrorBold(message: str):
-        """
-        Prints a bold error message in red.
-
-        Parameters
-        ----------
-        message : str
-            The error message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textMuted(message: str):
-        """
-        Prints a muted (gray) message.
-
-        Parameters
-        ----------
-        message : str
-            The message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textMutedBold(message: str):
-        """
-        Prints a bold muted (gray) message.
-
-        Parameters
-        ----------
-        message : str
-            The message to print.
-        """
-        pass
-
-    @abstractmethod
-    def textUnderline(message: str):
-        """
-        Prints an underlined message.
-
-        Parameters
-        ----------
-        message : str, optional
-            The message to print.
-        """
-        pass
-
-    @abstractmethod
-    def clear():
-        """
-        Clears the console screen.
-        """
-        pass
-
-    @abstractmethod
-    def clearLine():
-        """
-        Clears the current line in the console.
-        """
-        pass
-
-    @abstractmethod
-    def line():
-        """
-        Prints a horizontal line in the console.
-        """
-        pass
-
-    @abstractmethod
-    def newLine(count: int = 1):
-        """
-        Prints multiple new lines.
-
-        Parameters
-        ----------
-        count : int, optional
-            The number of new lines to print (default is 1).
-
-        Raises
-        ------
-        ValueError
-            If count is less than or equal to 0.
-        """
-        pass
-
-    @abstractmethod
-    def write(message: str):
-        """
-        Prints a message without moving to the next line.
-
-        Parameters
-        ----------
-        message : str
-            The message to print.
-        """
-        pass
-
-    @abstractmethod
-    def writeLine(message: str):
-        """
-        Prints a message and moves to the next line.
-
-        Parameters
-        ----------
-        message : str, optional
-            The message to print.
-        """
-        pass
-
-    @abstractmethod
-    def ask(question: str) -> str:
-        """
-        Prompts the user for input with a message and returns the user's response.
-
-        Parameters
-        ----------
-        question : str
-            The question to ask the user.
-
-        Returns
-        -------
-        str
-            The user's input, as a string.
-        """
-        pass
-
-    @abstractmethod
-    def confirm(question: str, default: bool = False) -> bool:
-        """
-        Asks a confirmation question and returns True or False based on the user's response.
-
-        Parameters
-        ----------
-        question : str
-            The confirmation question to ask.
-        default : bool, optional
-            The default response if the user presses Enter without typing a response.
-            Default is False, which corresponds to a 'No' response.
-
-        Returns
-        -------
-        bool
-            The user's response, which will be True if 'Y' is entered,
-            or False if 'N' is entered or the default is used.
-        """
-        pass
-
-    @abstractmethod
-    def secret(question: str) -> str:
-        """
-        Prompts the user for hidden input, typically used for password input.
-
-        Parameters
-        ----------
-        question : str
-            The prompt to ask the user.
-
-        Returns
-        -------
-        str
-            The user's hidden input, returned as a string.
-        """
-        pass
-
-    @abstractmethod
-    def table(headers: list, rows: list):
-        """
-        Prints a table in the console with the given headers and rows, with bold headers.
-
-        Parameters
-        ----------
-        headers : list of str
-            The column headers for the table.
-        rows : list of list of str
-            The rows of the table, where each row is a list of strings representing the columns.
-
-        Raises
-        ------
-        ValueError
-            If headers or rows are empty.
-
-        Notes
-        -----
-        The table adjusts column widths dynamically, includes bold headers, and uses box-drawing characters for formatting.
-        """
-        pass
-
-    @abstractmethod
-    def anticipate(question: str, options: list, default=None):
-        """
-        Provides autocomplete suggestions based on user input.
-
-        Parameters
-        ----------
-        question : str
-            The prompt for the user.
-        options : list of str
-            The list of possible options for autocomplete.
-        default : str, optional
-            The default value if no matching option is found. Defaults to None.
-
-        Returns
-        -------
-        str
-            The chosen option or the default value.
-
-        Notes
-        -----
-        This method allows the user to input a string, and then attempts to provide
-        an autocomplete suggestion by matching the beginning of the input with the
-        available options. If no match is found, the method returns the default value
-        or the user input if no default is provided.
-        """
-        pass
-
-    @abstractmethod
-    def choice(question: str, choices: list, default_index: int = 0) -> str:
-        """
-        Allows the user to select an option from a list.
-
-        Parameters
-        ----------
-        question : str
-            The prompt for the user.
-        choices : list of str
-            The list of available choices.
-        default_index : int, optional
-            The index of the default choice (zero-based). Defaults to 0.
-
-        Returns
-        -------
-        str
-            The selected choice.
-
-        Raises
-        ------
-        ValueError
-            If `default_index` is out of the range of choices.
-
-        Notes
-        -----
-        The user is presented with a numbered list of choices and prompted to select
-        one by entering the corresponding number. If an invalid input is provided,
-        the user will be repeatedly prompted until a valid choice is made.
-        """
-        pass
-
-    @abstractmethod
-    def exception(e) -> None:
-        """
-        Prints an exception message with detailed information.
-
-        Parameters
-        ----------
-        exception : Exception
-            The exception to print.
-
-        Notes
-        -----
-        This method prints the exception type, message, and a detailed stack trace.
-        """
-        pass

orionis/_contracts/console/output/executor.py

@@ -1,51 +0,0 @@
-from abc import ABC, abstractmethod
-
-class IExecutor(ABC):
-    """
-    Interface for execution state logging.
-
-    This interface defines methods for logging different execution states:
-    "RUNNING", "DONE", and "FAIL".
-    """
-
-    @abstractmethod
-    def running(program: str, time: str = ''):
-        """
-        Logs the execution of a program in a "RUNNING" state.
-
-        Parameters
-        ----------
-        program : str
-            The name of the program being executed.
-        time : str, optional
-            The time duration of execution, default is an empty string.
-        """
-        pass
-
-    @abstractmethod
-    def done(program: str, time: str = ''):
-        """
-        Logs the execution of a program in a "DONE" state.
-
-        Parameters
-        ----------
-        program : str
-            The name of the program being executed.
-        time : str, optional
-            The time duration of execution, default is an empty string.
-        """
-        pass
-
-    @abstractmethod
-    def fail(program: str, time: str = ''):
-        """
-        Logs the execution of a program in a "FAIL" state.
-
-        Parameters
-        ----------
-        program : str
-            The name of the program being executed.
-        time : str, optional
-            The time duration of execution, default is an empty string.
-        """
-        pass

orionis/_contracts/console/parser.py

@@ -1,75 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import List, Tuple, Dict, Any
-import argparse
-
-class IParser(ABC):
-    """
-    Interface for a command-line argument parser.
-
-    Defines the necessary methods for a command-line parser, ensuring
-    consistency across implementations.
-    """
-
-    @abstractmethod
-    def __init__(self, vars: Dict[str, Any], args: Tuple[Any, ...], kwargs: Dict[str, Any]):
-        """
-        Initializes the parser.
-
-        Parameters
-        ----------
-        vars : dict
-            A dictionary containing additional variables.
-        args : tuple
-            A tuple containing command-line arguments.
-        kwargs : dict
-            A dictionary containing keyword arguments.
-        """
-        pass
-
-    @abstractmethod
-    def setArguments(self, arguments: List[Tuple[str, Dict[str, Any]]]) -> None:
-        """
-        Registers command-line arguments dynamically.
-
-        Parameters
-        ----------
-        arguments : list of tuple
-            A list of tuples where each tuple contains:
-            - str: The argument name (e.g., '--value')
-            - dict: A dictionary of options (e.g., {'type': int, 'required': True})
-
-        Raises
-        ------
-        ValueError
-            If an argument is already registered.
-        """
-        pass
-
-    @abstractmethod
-    def recognize(self) -> None:
-        """
-        Processes and formats command-line arguments before parsing.
-
-        Raises
-        ------
-        ValueError
-            If an argument does not follow the correct format.
-        """
-        pass
-
-    @abstractmethod
-    def get(self) -> argparse.Namespace:
-        """
-        Parses the collected command-line arguments.
-
-        Returns
-        -------
-        argparse.Namespace
-            The parsed arguments as an object where each argument is an attribute.
-
-        Raises
-        ------
-        ValueError
-            If required arguments are missing or an error occurs during parsing.
-        """
-        pass

orionis/_contracts/console/task_manager.py

@@ -1,37 +0,0 @@
-from abc import ABC, abstractmethod
-from orionis._facades.commands.scheduler_facade import Schedule
-
-class ITaskManager(ABC):
-    """
-    Abstract base class that defines the interface for managing tasks.
-
-    This class provides an abstract method `schedule` that must be implemented by any
-    subclass to define how tasks are scheduled.
-
-    Methods
-    -------
-    schedule(schedule: Schedule) -> None
-        Schedules a task based on the provided `Schedule` instance.
-    """
-
-    @abstractmethod
-    def schedule(self, schedule: Schedule) -> None:
-        """
-        Schedules a task based on the given `Schedule` instance.
-
-        This method is abstract and must be implemented by a subclass to define
-        the specific scheduling logic.
-
-        Parameters
-        ----------
-        schedule : Schedule
-            An instance of the `Schedule` class, which contains the details of
-            when and how the task should be executed.
-
-        Returns
-        -------
-        None
-            This method does not return anything, but it is expected to schedule
-            the task as defined by the `schedule` object.
-        """
-        pass

orionis/_contracts/facades/commands/commands_facade.py

@@ -1,40 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any
-
-class ICommand(ABC):
-    """
-    Interface for defining a CLI command.
-    Command class for managing and executing registered CLI commands.
-
-    This class provides a static method to invoke commands registered in the
-    `CacheCommands` singleton, passing the required signature and any additional
-    parameters.
-
-    Methods
-    -------
-    call(signature: str, vars: dict[str, Any] = {}, *args: Any, **kwargs: Any) -> Any
-        Executes the specified command with the provided arguments.
-    """
-
-    @abstractmethod
-    def call(signature: str, vars: dict[str, Any] = {}, *args: Any, **kwargs: Any) -> Any:
-        """
-        Calls a registered command using the `CLIRunner`.
-
-        Parameters
-        ----------
-        signature : str
-            The command signature (name) to execute.
-        vars : dict[str, Any], optional
-            A dictionary containing named arguments for the command (default is `{}`).
-        *args : Any
-            Additional positional arguments.
-        **kwargs : Any
-            Additional keyword arguments.
-
-        Returns
-        -------
-        Any
-            The output of the executed command.
-        """
-        pass

orionis/_contracts/facades/commands/scheduler_facade.py

@@ -1,28 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import Any
-from orionis._services.commands.scheduler_service import ScheduleService
-
-class ISchedule(ABC):
-
-    @abstractmethod
-    def command(signature: str, vars: dict[str, Any] = {}, *args: Any, **kwargs: Any) -> 'ScheduleService':
-        """
-        Defines a Orionis command to be executed.
-
-        Parameters
-        ----------
-        signature : str
-            The signature of the command to execute.
-        vars : dict, optional
-            A dictionary of variables to pass to the command, by default an empty dictionary.
-        *args : Any
-            Additional positional arguments to pass to the command.
-        **kwargs : Any
-            Additional keyword arguments to pass to the command.
-
-        Returns
-        -------
-        Schedule
-            Returns the Schedule instance itself, allowing method chaining.
-        """
-        pass