orionis 0.199.0__py3-none-any.whl → 0.200.0__py3-none-any.whl

orionis/framework.py

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

orionis/luminate/console/base/command.py

@@ -1,6 +1,7 @@
-from orionis.luminate.contracts.console.base.command import IBaseCommand
+import argparse
 from orionis.luminate.console.output.console import Console
 from orionis.luminate.console.output.progress_bar import ProgressBar
+from orionis.luminate.contracts.console.base.command import IBaseCommand
 
 class BaseCommand(IBaseCommand):
     """
@@ -16,73 +17,73 @@ class BaseCommand(IBaseCommand):
     """
     args = {}
 
-    def success(self, message: str, timestamp: bool = True):
+    def success(self, message: str, timestamp: bool = True) -> None:
         """
         Prints a success message with a green background.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         timestamp : bool, optional
             Whether to include a timestamp (default is True).
         """
         Console.success(message, timestamp)
 
-    def textSuccess(self, message: str):
+    def textSuccess(self, message: str) -> None:
         """
         Prints a success message in green.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textSuccess(message)
 
-    def textSuccessBold(self, message: str):
+    def textSuccessBold(self, message: str) -> None:
         """
         Prints a bold success message in green.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textSuccessBold(message)
 
-    def info(self, message: str, timestamp: bool = True):
+    def info(self, message: str, timestamp: bool = True) -> None:
         """
         Prints an informational message with a blue background.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         timestamp : bool, optional
             Whether to include a timestamp (default is True).
         """
         Console.info(message, timestamp)
 
-    def textInfo(self, message: str):
+    def textInfo(self, message: str) -> None:
         """
         Prints an informational message in blue.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textInfo(message)
 
-    def textInfoBold(self, message: str):
+    def textInfoBold(self, message: str) -> None:
         """
         Prints a bold informational message in blue.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textInfoBold(message)
 
@@ -92,140 +93,135 @@ class BaseCommand(IBaseCommand):
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         timestamp : bool, optional
             Whether to include a timestamp (default is True).
         """
         Console.warning(message, timestamp)
 
-    def textWarning(self, message: str):
+    def textWarning(self, message: str) -> None:
         """
         Prints a warning message in yellow.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textWarning(message)
 
-    def textWarningBold(self, message: str):
+    def textWarningBold(self, message: str) -> None:
         """
         Prints a bold warning message in yellow.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textWarningBold(message)
 
-    def fail(self, message: str, timestamp: bool = True):
+    def fail(self, message: str, timestamp: bool = True) -> None:
         """
         Prints a failure message with a red background.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         timestamp : bool, optional
             Whether to include a timestamp (default is True).
         """
         Console.fail(message, timestamp)
 
-    def error(self, message: str, timestamp: bool = True):
+    def error(self, message: str, timestamp: bool = True) -> None:
         """
         Prints an error message with a red background.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         timestamp : bool, optional
             Whether to include a timestamp (default is True).
         """
         Console.error(message, timestamp)
 
-    def textError(self, message: str):
+    def textError(self, message: str) -> None:
         """
         Prints an error message in red.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textError(message)
 
-    def textErrorBold(self, message: str):
+    def textErrorBold(self, message: str) -> None:
         """
         Prints a bold error message in red.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textErrorBold(message)
 
-    def textMuted(self, message: str):
+    def textMuted(self, message: str) -> None:
         """
         Prints a muted (gray) message.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textMuted(message)
 
-    def textMutedBold(self, message: str):
+    def textMutedBold(self, message: str) -> None:
         """
         Prints a bold muted (gray) message.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textMutedBold(message)
 
-    def textUnderline(self, message: str):
+    def textUnderline(self, message: str) -> None:
         """
         Prints an underlined message.
 
         Parameters
         ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        message : str
+            The message to display.
         """
         Console.textUnderline(message)
 
-    def clear(self):
+    def clear(self) -> None:
         """
         Clears the console screen.
         """
         Console.clear()
 
-    def clearLine(self):
+    def clearLine(self) -> None:
         """
         Clears the current console line.
         """
         Console.clearLine()
 
-    def line(self, message: str):
+    def line(self) -> None:
         """
-        Prints a line of text.
-
-        Parameters
-        ----------
-        message : str, optional
-            The message to display (default is an empty string).
+        Prints a line empty.
         """
-        Console.line(message)
+        Console.line()
 
-    def newLine(self, count: int = 1):
+    def newLine(self, count: int = 1) -> None:
         """
         Prints multiple new lines.
 
@@ -236,18 +232,18 @@ class BaseCommand(IBaseCommand):
         """
         Console.newLine(count)
 
-    def write(self, message: str):
+    def write(self, message: str) -> None:
         """
         Prints a message without moving to the next line.
 
         Parameters
         ----------
         message : str, optional
-            The message to display (default is an empty string).
+            The message to display.
         """
         Console.write(message)
 
-    def writeLine(self, message: str):
+    def writeLine(self, message: str) -> None:
         """
         Prints a message and moves to the next line.
 
@@ -272,7 +268,7 @@ class BaseCommand(IBaseCommand):
         str
             The user's input.
         """
-        return Console.ask(question)
+        return Console.ask(question).strip()
 
     def confirm(self, question: str, default: bool = False) -> bool:
         """
@@ -290,7 +286,7 @@ class BaseCommand(IBaseCommand):
         bool
             The user's response.
         """
-        return Console.ask(question, default)
+        return Console.confirm(question, default)
 
     def secret(self, question: str) -> str:
         """
@@ -397,21 +393,6 @@ class BaseCommand(IBaseCommand):
         """
         return ProgressBar(total=total, width=width)
 
-    def setArgs(self, args):
-        """
-        Define the logic of setting command arguments.
-
-        Parameters
-        ----------
-        args : argparse.Namespace
-            Contain the arguments to be set for the command.
-        """
-        try:
-            self.args = vars(args)
-        except TypeError:
-            self.args = {}
-
-
     def handle(self, **kwargs):
         """
         Abstract method to define the logic of the command.
@@ -425,4 +406,31 @@ class BaseCommand(IBaseCommand):
             NotImplementedError: If the method is not implemented in a subclass. This ensures that all command classes
                                 adhere to the expected structure.
         """
-        raise NotImplementedError("The 'handle' method must be implemented in the child class.")
+        raise NotImplementedError("The 'handle' method must be implemented in the child class.")
+
+    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.
+        """
+        if isinstance(args, argparse.Namespace):
+            self.args = vars(args)
+        elif isinstance(args, dict):
+            self.args = args
+        else:
+            raise ValueError("Invalid argument type. Expected 'argparse.Namespace' or 'dict'.")
+
+    def getArgs(self) -> dict:
+        """
+        Get the command arguments.
+
+        Returns
+        -------
+        dict
+            The command arguments.
+        """
+        return self.args

orionis/luminate/console/command_filter.py

@@ -33,5 +33,4 @@ class CommandFilter(ICommandFilter):
             '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
         ]

orionis/luminate/console/commands/cache_clear.py

@@ -1,7 +1,7 @@
 import os
 import shutil
 from orionis.luminate.console.base.command import BaseCommand
-from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
+from orionis.luminate.console.exceptions.cli_runtime_error import CLIOrionisRuntimeError
 
 class CacheClearCommand(BaseCommand):
     """
@@ -9,21 +9,29 @@ class CacheClearCommand(BaseCommand):
 
     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 __init__(self) -> None:
+        """
+        Initializes the command instance, setting the list of directories to exclude from the cache clearing process.
+        """
+        self.exclude_dirs = [
+            'venv',
+            'env',
+            'virtualenv',
+            'venv3',
+            'env3',
+            'venv2',
+            'env2',
+            'vendor',
+            'node_modules',
+            'environment'
+        ]
+
     def handle(self) -> None:
         """
         Executes the cache clearing process.
@@ -45,7 +53,7 @@ class CacheClearCommand(BaseCommand):
             for root, dirs, files in os.walk(base_path, topdown=True):
 
                 # Skip common environment directories (e.g., venv, env, vendor, node_modules)
-                for env_dir in ['venv', 'env', 'virtualenv', 'venv3', 'env3', 'venv2', 'env2', 'vendor', 'node_modules', 'environment']:
+                for env_dir in self.exclude_dirs:
                     if env_dir in dirs:
                         dirs.remove(env_dir)
 

orionis/luminate/console/commands/help.py

@@ -1,24 +1,29 @@
+from orionis.framework import NAME
 from orionis.luminate.console.base.command import BaseCommand
-from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
+from orionis.luminate.console.exceptions.cli_runtime_error import CLIOrionisRuntimeError
 from orionis.luminate.contracts.application import IApplication
-from orionis.framework import NAME
 
 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.
     """
-    def __init__(self, app : IApplication):
-        # Get the list of commands from the container
-        self._commands : dict = app._commands if hasattr(app, '_commands') else {}
 
-    # Command signature used for execution.
     signature = "help"
 
-    # Brief description of the command.
     description = "Prints the list of available commands along with their descriptions."
 
+    def __init__(self, app : IApplication):
+        """
+        Initialize the HelpCommand class.
+
+        Parameters
+        ----------
+        app : IApplication
+            The application instance that is passed to the command class.
+        """
+        self._commands : dict = app._commands if hasattr(app, '_commands') else {}
+
     def handle(self) -> None:
         """
         Execute the help command.
@@ -41,14 +46,18 @@ class HelpCommand(BaseCommand):
             # Initialize an empty list to store the rows.
             rows = []
             for signature, command_data in self._commands.items():
-                rows.append([signature, command_data['description']])
+                rows.append([
+                    signature,
+                    command_data['description'],
+                    'Core Command' if 'orionis.luminate.console.commands' in command_data['concrete'].__module__ else 'User Command'
+                ])
 
             # Sort commands alphabetically
             rows_sorted = sorted(rows, key=lambda x: x[0])
 
             # Display the commands in a table format
             self.table(
-                ["Signature", "Description"],
+                ["Signature", "Description", "Type"],
                 rows_sorted
             )
 

orionis/luminate/console/commands/schedule_work.py

@@ -1,10 +1,9 @@
 import importlib
 from orionis.luminate.console.base.command import BaseCommand
-from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
+from orionis.luminate.console.exceptions.cli_runtime_error import CLIOrionisRuntimeError
 from orionis.luminate.contracts.console.task_manager import ITaskManager
 from orionis.luminate.facades.commands.scheduler_facade import Schedule
 
-
 class ScheduleWorkCommand(BaseCommand):
     """
     Command class to handle scheduled tasks within the Orionis application.
@@ -13,10 +12,8 @@ class ScheduleWorkCommand(BaseCommand):
     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 __init__(self, schedule : Schedule) -> None:

orionis/luminate/console/commands/version.py

@@ -1,6 +1,6 @@
 from orionis.framework import VERSION
 from orionis.luminate.console.base.command import BaseCommand
-from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
+from orionis.luminate.console.exceptions.cli_runtime_error import CLIOrionisRuntimeError
 
 class VersionCommand(BaseCommand):
     """
@@ -9,10 +9,8 @@ class VersionCommand(BaseCommand):
     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:

orionis/luminate/console/exceptions/cli-orionis-value-error.py

@@ -0,0 +1,41 @@
+class CLIOrionisValueError(ValueError):
+    """
+    Custom exception raised when there is a value error in Orionis data processing.
+
+    Parameters
+    ----------
+    message : str
+        The response message associated with the exception.
+
+    Attributes
+    ----------
+    message : str
+        Stores the response message passed during initialization.
+
+    Methods
+    -------
+    __str__()
+        Returns a string representation of the exception, including the response message.
+    """
+
+    def __init__(self, message: str):
+        """
+        Initializes the CLIOrionisValueError with the given response message.
+
+        Parameters
+        ----------
+        message : str
+            The response message associated with the exception.
+        """
+        super().__init__(message)
+
+    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.args[0]}"