orionis 0.1.0__py3-none-any.whl

orionis/luminate/console/command.py

@@ -0,0 +1,40 @@
+from typing import Any
+from orionis.luminate.console.runner import CLIRunner
+from orionis.luminate.contracts.console.command_interface import ICommand
+
+class Command(ICommand):
+    """
+    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.
+    """
+
+    @staticmethod
+    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.
+        """
+        return CLIRunner.handle(signature, vars, *args, **kwargs)

orionis/luminate/console/command_filter.py

@@ -0,0 +1,40 @@
+from orionis.luminate.contracts.console.command_filter_interface import ICommandFilter
+
+# List of commands that should be excluded from output formatting
+EXCLUDED_COMMANDS = [
+    'schedule:work',   # Command to handle scheduled work
+    'help',            # Command to show help information
+    'version',         # Command to display version information
+    'tests:run'        # Command to run tests
+]
+
+class CommandFilter(ICommandFilter):
+    """
+    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.
+    """
+
+    @staticmethod
+    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.
+        """
+        return command in EXCLUDED_COMMANDS

orionis/luminate/console/commands/cache_clear.py

@@ -0,0 +1,56 @@
+import os
+import shutil
+from orionis.luminate.console.register import register
+from orionis.luminate.console.base.command import BaseCommand
+
+@register.command
+class CacheClearCommand(BaseCommand):
+    """
+    Clears Python bytecode caches (__pycache__) within the project directory.
+
+    This command recursively searches for and removes all `__pycache__` directories
+    in the project folder to ensure that no stale bytecode files persist.
+
+    Attributes
+    ----------
+    signature : str
+        The unique identifier for the command, used to trigger its execution.
+    description : str
+        A brief summary describing the purpose of the command.
+    """
+
+    # The command signature used to execute this command.
+    signature = 'cache:clear'
+
+    # A brief description of the command.
+    description = 'Clears the project cache by removing all __pycache__ directories.'
+
+    def handle(self) -> None:
+        """
+        Executes the cache clearing process.
+
+        This method performs the following actions:
+        - Recursively searches the project directory for `__pycache__` directories.
+        - Deletes all found `__pycache__` directories and their contents.
+        - Logs a success message if the process completes successfully, or an error message if an exception occurs.
+        """
+        try:
+
+            # Get the base project path
+            base_path = os.getcwd()
+
+            # Recursively traverse directories starting from the base path
+            for root, dirs, files in os.walk(base_path):
+                for dir in dirs:
+                    if dir == '__pycache__':
+                        # Form the path to the __pycache__ directory and remove it
+                        pycache_path = os.path.join(root, dir)
+                        shutil.rmtree(pycache_path)
+
+            # Log a success message once all caches are cleared
+            self.success(message='The application cache has been successfully cleared.', timestamp=True)
+
+        except Exception as e:
+
+            # Handle any unexpected error and display the error message
+            raise RuntimeError(f"An unexpected error occurred while clearing the cache: {e}") from e

orionis/luminate/console/commands/help.py

@@ -0,0 +1,59 @@
+from orionis.luminate.console.register import register
+from orionis.luminate.console.base.command import BaseCommand
+from orionis.luminate.cache.console.commands import CacheCommands
+
+@register.command
+class HelpCommand(BaseCommand):
+    """
+    Command class to display the list of available commands in the Orionis application.
+
+    This command fetches all registered commands from the cache and presents them in a table format.
+    """
+
+    # Command signature used for execution.
+    signature = "help"
+
+    # Brief description of the command.
+    description = "Prints the list of available commands along with their descriptions."
+
+    def handle(self) -> None:
+        """
+        Execute the help command.
+
+        This method retrieves all available commands from the cache, sorts them alphabetically,
+        and displays them in a structured table format.
+
+        Raises
+        ------
+        ValueError
+            If an unexpected error occurs during execution, a ValueError is raised
+            with the original exception message.
+        """
+        try:
+
+            # Display the available commands
+            self.newLine()
+            self.textSuccessBold(" (CLI Interpreter) Available Commands: ")
+
+            # Retrieve command cache
+            cache = CacheCommands()
+
+            # Fetch and store commands in a structured format
+            rows = [[command, cache.get(command)['description']] for command in cache.commands]
+
+            # Sort commands alphabetically
+            rows_sorted = sorted(rows, key=lambda x: x[0])
+
+            # Display the commands in a table format
+            self.table(
+                ["Signature", "Description"],
+                rows_sorted
+            )
+
+            # Add a new line after the table
+            self.newLine()
+
+        except Exception as e:
+
+            # Raise a ValueError if an unexpected error occurs.
+            raise ValueError(f"An unexpected error occurred: {e}") from e

orionis/luminate/console/commands/schedule_work.py

@@ -0,0 +1,50 @@
+from orionis.luminate.console.register import register
+from orionis.luminate.console.base.command import BaseCommand
+from orionis.luminate.console.tasks.scheduler import Schedule
+from orionis.luminate.contracts.console.task_manager_interface import ITaskManager
+
+@register.command
+class ScheduleWorkCommand(BaseCommand):
+    """
+    Command class to handle scheduled tasks within the Orionis application.
+
+    This command initializes the scheduling system, registers the schedule,
+    and starts the execution of scheduled tasks.
+    """
+
+    # The command signature used to execute this command.
+    signature = "schedule:work"
+
+    # A brief description of the command.
+    description = "Starts the scheduled tasks."
+
+    def handle(self) -> None:
+        """
+        Execute the scheduled tasks.
+
+        This method initializes a Schedule instance, creates a TaskManager (Kernel),
+        registers the schedule, and starts the execution of scheduled tasks.
+
+        Raises
+        ------
+        RuntimeError
+            If an unexpected error occurs during execution, a RuntimeError is raised
+            with the original exception message.
+        """
+        try:
+
+            # Initialize a new Schedule instance.
+            schedule = Schedule()
+
+            # Create an instance of the TaskManager to manage the scheduling.
+            from app.console.tasks_manager import TaskManager  # type: ignore
+            kernel: ITaskManager = TaskManager()
+            kernel.schedule(schedule)
+
+            # Start running the scheduled tasks using the schedule runner.
+            schedule.start()
+
+        except Exception as e:
+
+            # Raise a RuntimeError if an unexpected error occurs.
+            raise RuntimeError(f"An unexpected error occurred: {e}") from e

orionis/luminate/console/commands/tests.py

@@ -0,0 +1,40 @@
+from orionis.luminate.facades.tests import UnitTests
+from orionis.luminate.console.register import register
+from orionis.luminate.console.base.command import BaseCommand
+
+@register.command
+class TestsCommand(BaseCommand):
+    """
+    Command class to display the list of available commands in the Orionis application.
+
+    This command fetches all registered commands from the cache and presents them in a table format.
+    """
+
+    # Command signature used for execution.
+    signature = "tests:run"
+
+    # Brief description of the command.
+    description = "Prints the list of available commands along with their descriptions."
+
+    def handle(self) -> None:
+        """
+        Execute the help command.
+
+        This method retrieves all available commands from the cache, sorts them alphabetically,
+        and displays them in a structured table format.
+
+        Raises
+        ------
+        ValueError
+            If an unexpected error occurs during execution, a ValueError is raised
+            with the original exception message.
+        """
+        try:
+
+            # Initialize the test suite using the custom testing framework.
+            return UnitTests.execute()
+
+        except Exception as e:
+
+            # Raise a ValueError if an unexpected error occurs.
+            raise ValueError(f"An unexpected error occurred: {e}") from e

orionis/luminate/console/commands/version.py

@@ -0,0 +1,39 @@
+from orionis.framework import VERSION
+from orionis.luminate.console.register import register
+from orionis.luminate.console.base.command import BaseCommand
+
+@register.command
+class VersionCommand(BaseCommand):
+    """
+    Command class to display the current version of the Orionis framework.
+
+    This command prints the version number of the framework in use.
+    """
+
+    # Command signature used for execution.
+    signature = "version"
+
+    # Brief description of the command.
+    description = "Prints the version of the framework in use."
+
+    def handle(self) -> None:
+        """
+        Execute the version command.
+
+        This method retrieves and prints the version of the Orionis framework.
+
+        Raises
+        ------
+        ValueError
+            If an unexpected error occurs during execution, a ValueError is raised
+            with the original exception message.
+        """
+        try:
+
+            # Print the version number
+            self.textSuccessBold(f"Orionis Framework v{VERSION}")
+
+        except Exception as e:
+
+            # Raise a ValueError if an unexpected error occurs.
+            raise ValueError(f"An unexpected error occurred: {e}") from e

orionis/luminate/console/exceptions/cli_exception.py

@@ -0,0 +1,125 @@
+class CLIOrionisException(Exception):
+    """
+    Custom exception raised when there is an issue with dumping the Orionis data.
+
+    Parameters
+    ----------
+    response : str
+        The response message associated with the exception.
+
+    Attributes
+    ----------
+    response : str
+        Stores the response message passed during initialization.
+
+    Methods
+    -------
+    __str__()
+        Returns a string representation of the exception, including the response message.
+    """
+
+    def __init__(self, response: str):
+        """
+        Initializes the CLIOrionisException with the given response message.
+
+        Parameters
+        ----------
+        response : str
+            The response message associated with the exception.
+        """
+        self.response = response
+
+    def __str__(self):
+        """
+        Returns a string representation of the exception, including the response message.
+
+        Returns
+        -------
+        str
+            A string containing the exception name and the response message.
+        """
+        return f"CLIOrionisException: {self.response}"
+
+class CLIOrionisValueError(Exception):
+    """
+    Custom exception raised when there is an issue with dumping the Orionis data.
+
+    Parameters
+    ----------
+    response : str
+        The response message associated with the exception.
+
+    Attributes
+    ----------
+    response : str
+        Stores the response message passed during initialization.
+
+    Methods
+    -------
+    __str__()
+        Returns a string representation of the exception, including the response message.
+    """
+
+    def __init__(self, response: str):
+        """
+        Initializes the CLIOrionisValueError with the given response message.
+
+        Parameters
+        ----------
+        response : str
+            The response message associated with the exception.
+        """
+        self.response = response
+
+    def __str__(self):
+        """
+        Returns a string representation of the exception, including the response message.
+
+        Returns
+        -------
+        str
+            A string containing the exception name and the response message.
+        """
+        return f"CLIOrionisValueError: {self.response}"
+
+class CLIOrionisScheduleException(Exception):
+    """
+    Custom exception raised when there is an issue with dumping the Orionis data.
+
+    Parameters
+    ----------
+    response : str
+        The response message associated with the exception.
+
+    Attributes
+    ----------
+    response : str
+        Stores the response message passed during initialization.
+
+    Methods
+    -------
+    __str__()
+        Returns a string representation of the exception, including the response message.
+    """
+
+    def __init__(self, response: str):
+        """
+        Initializes the CLIOrionisValueError with the given response message.
+
+        Parameters
+        ----------
+        response : str
+            The response message associated with the exception.
+        """
+        self.response = response
+
+    def __str__(self):
+        """
+        Returns a string representation of the exception, including the response message.
+
+        Returns
+        -------
+        str
+            A string containing the exception name and the response message.
+        """
+        return f"CLIOrionisValueError: {self.response}"

orionis/luminate/console/kernel.py

@@ -0,0 +1,32 @@
+from typing import Any, Tuple
+from orionis.luminate.console.runner import CLIRunner
+from orionis.luminate.contracts.console.kernel_interface import ICLIKernel
+
+class CLIKernel(ICLIKernel):
+    """
+    CLIKernel acts as a bridge between the CLI entry point and the command runner.
+
+    This class provides a static method to handle command execution via `CLIRunner`.
+
+    Methods
+    -------
+    handle(*args: tuple[Any, ...]) -> Any
+        Processes CLI arguments and delegates execution to `CLIRunner`.
+    """
+
+    @staticmethod
+    def handle(*args: tuple[Any, ...]) -> Any:
+        """
+        Handles CLI command execution by forwarding arguments to `CLIRunner`.
+
+        Parameters
+        ----------
+        *args : tuple[Any, ...]
+            A tuple containing CLI arguments passed from the command line.
+
+        Returns
+        -------
+        Any
+            The result of the executed command.
+        """
+        return CLIRunner.handle(None, {}, *args)