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

orionis/_contracts/console/base/command.py

@@ -1,437 +0,0 @@
-from abc import ABC, abstractmethod
-from typing import List
-from orionis._console.output.progress_bar import ProgressBar
-
-class IBaseCommand(ABC):
-    """
-    Interface for a base command class.
-    """
-
-    @abstractmethod
-    def success(self, message: str, timestamp: bool = True) -> None:
-        """
-        Prints a success message with a green background.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textSuccess(self, message: str) -> None:
-        """
-        Prints a success message in green.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textSuccessBold(self, message: str) -> None:
-        """
-        Prints a bold success message in green.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def info(self, message: str, timestamp: bool = True) -> None:
-        """
-        Prints an informational message with a blue background.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textInfo(self, message: str) -> None:
-        """
-        Prints an informational message in blue.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textInfoBold(self, message: str) -> None:
-        """
-        Prints a bold informational message in blue.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def warning(self, message: str, timestamp: bool = True):
-        """
-        Prints a warning message with a yellow background.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textWarning(self, message: str) -> None:
-        """
-        Prints a warning message in yellow.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textWarningBold(self, message: str) -> None:
-        """
-        Prints a bold warning message in yellow.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def fail(self, message: str, timestamp: bool = True) -> None:
-        """
-        Prints a failure message with a red background.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def error(self, message: str, timestamp: bool = True) -> None:
-        """
-        Prints an error message with a red background.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        timestamp : bool, optional
-            Whether to include a timestamp (default is True).
-        """
-        pass
-
-    @abstractmethod
-    def textError(self, message: str) -> None:
-        """
-        Prints an error message in red.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textErrorBold(self, message: str) -> None:
-        """
-        Prints a bold error message in red.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textMuted(self, message: str) -> None:
-        """
-        Prints a muted (gray) message.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textMutedBold(self, message: str) -> None:
-        """
-        Prints a bold muted (gray) message.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def textUnderline(self, message: str) -> None:
-        """
-        Prints an underlined message.
-
-        Parameters
-        ----------
-        message : str
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def clear(self) -> None:
-        """
-        Clears the console screen.
-        """
-        pass
-
-    @abstractmethod
-    def clearLine(self) -> None:
-        """
-        Clears the current console line.
-        """
-        pass
-
-    @abstractmethod
-    def line(self) -> None:
-        """
-        Prints a line empty.
-        """
-        pass
-
-    @abstractmethod
-    def newLine(self, count: int = 1) -> None:
-        """
-        Prints multiple new lines.
-
-        Parameters
-        ----------
-        count : int, optional
-            The number of new lines to print (default is 1).
-        """
-        pass
-
-    @abstractmethod
-    def write(self, message: str) -> None:
-        """
-        Prints a message without moving to the next line.
-
-        Parameters
-        ----------
-        message : str, optional
-            The message to display.
-        """
-        pass
-
-    @abstractmethod
-    def writeLine(self, message: str) -> None:
-        """
-        Prints a message and moves to the next line.
-
-        Parameters
-        ----------
-        message : str, optional
-            The message to display (default is an empty string).
-        """
-        pass
-
-    @abstractmethod
-    def ask(self, question: str) -> str:
-        """
-        Prompts the user for input and returns the response.
-
-        Parameters
-        ----------
-        question : str
-            The question to ask the user.
-
-        Returns
-        -------
-        str
-            The user's input.
-        """
-        pass
-
-    @abstractmethod
-    def confirm(self, question: str, default: bool = False) -> bool:
-        """
-        Asks a confirmation question and returns True/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).
-
-        Returns
-        -------
-        bool
-            The user's response.
-        """
-        pass
-
-    @abstractmethod
-    def secret(self, question: str) -> str:
-        """
-        Prompts for hidden input (e.g., password).
-
-        Parameters
-        ----------
-        question : str
-            The prompt to ask the user.
-
-        Returns
-        -------
-        str
-            The user's hidden input.
-        """
-        pass
-
-    @abstractmethod
-    def table(self, headers: list, rows: list):
-        """
-        Prints a formatted table in the console.
-
-        Parameters
-        ----------
-        headers : list of str
-            The column headers for the table.
-        rows : list of list of str
-            The rows of the table.
-
-        Raises
-        ------
-        ValueError
-            If headers or rows are empty.
-        """
-        pass
-
-    @abstractmethod
-    def anticipate(self, question: str, options: list, default=None):
-        """
-        Provides autocomplete suggestions for 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 (default is None).
-
-        Returns
-        -------
-        str
-            The chosen option or the default value.
-        """
-        pass
-
-    @abstractmethod
-    def choice(self, question: str, choices: list, default_index: int = 0) -> str:
-        """
-        Prompts the user to select a choice 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 (default is 0).
-
-        Returns
-        -------
-        str
-            The selected choice.
-
-        Raises
-        ------
-        ValueError
-            If `default_index` is out of the range of choices.
-        """
-        pass
-
-    @abstractmethod
-    def createProgressBar(self, total: int = 100, width: int = 50) -> ProgressBar:
-        """
-        Creates and returns a new progress bar.
-
-        This method initializes a `ProgressBar` object with the specified total and width.
-
-        Parameters
-        ----------
-        total : int, optional
-            The total number of steps for the progress bar. Default is 100.
-        width : int, optional
-            The width (in characters) of the progress bar. Default is 50.
-
-        Returns
-        -------
-        ProgressBar
-            A new instance of the `ProgressBar` class, initialized with the specified `total` and `width`.
-
-        Notes
-        -----
-        The progress bar can be used to visually track the progress of a task.
-        The `total` parameter represents the number of steps to complete the task,
-        and the `width` parameter controls the number of characters used to represent the progress bar in the console.
-        """
-        pass
-
-    @abstractmethod
-    def setArgs(self, args) -> None:
-        """
-        Define the logic of setting command arguments.
-
-        Parameters
-        ----------
-        args : argparse.Namespace or dict
-            Contain the arguments to be set for the command.
-        """
-        pass
-
-    @abstractmethod
-    def getArgs(self) -> dict:
-        """
-        Get the command arguments.
-
-        Returns
-        -------
-        dict
-            The command arguments.
-        """
-        pass

orionis/_contracts/console/command_filter.py

@@ -1,32 +0,0 @@
-from abc import ABC, abstractmethod
-
-class ICommandFilter(ABC):
-    """
-    CommandFilter handles the exclusion of specific commands from output formatting.
-
-    This class:
-    - Determines whether a command should be excluded from output formatting based on a predefined list.
-    - Can be extended or modified to support more advanced filtering if needed.
-
-    Methods
-    -------
-    isExcluded(command: str) -> bool
-        Checks if the given command is excluded from output formatting.
-    """
-
-    @abstractmethod
-    def isExcluded(command: str) -> bool:
-        """
-        Checks if the given command is in the excluded commands list.
-
-        Parameters
-        ----------
-        command : str
-            The command to check.
-
-        Returns
-        -------
-        bool
-            Returns True if the command is excluded from output formatting, False otherwise.
-        """
-        pass

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