orionis 0.539.0__tar.gz → 0.541.0__tar.gz

{orionis-0.539.0/orionis.egg-info → orionis-0.541.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.539.0
+Version: 0.541.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro

{orionis-0.539.0 → orionis-0.541.0}/orionis/console/base/command.py

@@ -2,7 +2,7 @@ from typing import Any, Dict, List
 from orionis.console.args.argument import CLIArgument
 from orionis.console.dynamic.progress_bar import ProgressBar
 from orionis.console.output.console import Console
-from orionis.console.contracts.command import IBaseCommand
+from orionis.console.contracts.base_command import IBaseCommand
 
 class BaseCommand(Console, ProgressBar, IBaseCommand):
     """

{orionis-0.539.0 → orionis-0.541.0}/orionis/console/base/scheduler.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from orionis.console.contracts.scheduler import IBaseScheduler
+from orionis.console.contracts.base_scheduler import IBaseScheduler
 from orionis.console.contracts.schedule import ISchedule
 from orionis.console.entities.job_error import JobError
 from orionis.console.entities.scheduler_paused import SchedulerPaused

orionis-0.541.0/orionis/console/contracts/cli_request.py

@@ -0,0 +1,85 @@
+from abc import ABC, abstractmethod
+from typing import Any
+
+class ICLIRequest(ABC):
+
+    @abstractmethod
+    def command(self) -> str:
+        """
+        Retrieve the command name associated with this CLI request.
+
+        This method provides access to the command string that was specified during
+        the initialization of the CLIRequest object. The command represents the
+        primary action or operation that should be executed based on the CLI input.
+
+        Returns
+        -------
+        str
+            The command name stored as a string. This is the exact command value
+            that was passed to the constructor during object initialization.
+
+        Notes
+        -----
+        The returned command string is immutable and represents the core action
+        identifier for this CLI request. This value is essential for determining
+        which operation should be performed by the CLI handler.
+        """
+        pass
+
+    @abstractmethod
+    def all(self) -> dict:
+        """
+        Retrieve all command line arguments as a complete dictionary.
+
+        This method provides access to the entire collection of command line arguments
+        that were passed during the initialization of the CLIRequest object. It returns
+        a reference to the internal arguments dictionary, allowing for comprehensive
+        access to all parsed CLI parameters.
+
+        Returns
+        -------
+        dict
+            A dictionary containing all the parsed command line arguments as key-value
+            pairs, where keys are argument names (str) and values are the corresponding
+            argument values of any type. If no arguments were provided during
+            initialization, returns an empty dictionary.
+
+        Notes
+        -----
+        This method returns a reference to the internal arguments dictionary rather
+        than a copy. Modifications to the returned dictionary will affect the
+        internal state of the CLIRequest object.
+        """
+        pass
+
+    @abstractmethod
+    def argument(self, name: str, default: Any = None):
+        """
+        Retrieve the value of a specific command line argument by its name.
+
+        This method provides access to individual command line arguments that were
+        passed during initialization. It safely retrieves argument values without
+        raising exceptions if the argument doesn't exist.
+
+        Parameters
+        ----------
+        name : str
+            The name of the command line argument to retrieve. This should match
+            the key used when the argument was originally parsed and stored.
+        default : Any, optional
+            The default value to return if the specified argument name does not
+            exist in the arguments dictionary. Defaults to None.
+
+        Returns
+        -------
+        Any or None
+            The value associated with the specified argument name if it exists
+            in the arguments dictionary. Returns None if the argument name is
+            not found or was not provided during CLI execution.
+
+        Notes
+        -----
+        This method uses the dictionary's get() method to safely access values,
+        ensuring that missing arguments return None rather than raising a KeyError.
+        """
+        pass

orionis-0.541.0/orionis/console/contracts/command.py

@@ -0,0 +1,105 @@
+from abc import ABC, abstractmethod
+from orionis.console.entities.command import Command as CommandEntity
+
+class ICommand(ABC):
+
+    @abstractmethod
+    def timestamp(self, enabled: bool = True) -> 'ICommand':
+        """
+        Configure whether timestamps should be included in command output.
+
+        This method allows enabling or disabling timestamp display for the command.
+        When enabled, timestamps will be shown alongside command execution results.
+
+        Parameters
+        ----------
+        enabled : bool, default=True
+            Flag to enable or disable timestamp display. True enables timestamps,
+            False disables them.
+
+        Returns
+        -------
+        Command
+            Returns the current Command instance to allow method chaining.
+
+        Raises
+        ------
+        TypeError
+            If the enabled parameter is not a boolean value.
+        """
+        pass
+
+    @abstractmethod
+    def description(self, desc: str) -> 'ICommand':
+        """
+        Set the description for the command.
+
+        This method allows setting a descriptive text that explains what the command
+        does. The description is used for help text and documentation purposes when
+        displaying command information to users.
+
+        Parameters
+        ----------
+        desc : str
+            The description text for the command. Must be a non-empty string that
+            describes the command's purpose and functionality.
+
+        Returns
+        -------
+        Command
+            Returns the current Command instance to allow method chaining.
+
+        Raises
+        ------
+        TypeError
+            If the desc parameter is not a string value.
+        """
+        pass
+
+    @abstractmethod
+    def arguments(self, args: list) -> 'ICommand':
+        """
+        Set the list of CLI arguments for the command.
+
+        This method configures the command-line arguments that the command will accept.
+        Each argument must be a properly configured CLIArgument instance that defines
+        the argument's name, type, validation rules, and other properties. The arguments
+        are used during command parsing to validate and process user input.
+
+        Parameters
+        ----------
+        args : list
+            A list of CLIArgument instances that define the command's accepted arguments.
+            Each element in the list must be a valid CLIArgument object with proper
+            configuration for argument parsing and validation.
+
+        Returns
+        -------
+        Command
+            Returns the current Command instance to allow method chaining and enable
+            fluent interface pattern for command configuration.
+
+        Raises
+        ------
+        TypeError
+            If the args parameter is not a list, or if any element in the list
+            is not an instance of CLIArgument.
+        """
+        pass
+
+    @abstractmethod
+    def get(self) -> tuple[str, CommandEntity]:
+        """
+        Retrieve the configured Command entity.
+
+        This method constructs and returns a Command entity object that encapsulates
+        all the configuration details of the command, including its signature, concrete
+        class, method, description, arguments, and timestamp setting. The returned
+        Command entity can be used for command execution and management.
+
+        Returns
+        -------
+        CommandEntity
+            A Command entity object containing all the command's configuration details.
+        """
+        pass

{orionis-0.539.0 → orionis-0.541.0}/orionis/console/contracts/event.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from datetime import datetime
 from orionis.console.contracts.schedule_event_listener import IScheduleEventListener
-from orionis.console.enums.event import Event as EventEntity
+from orionis.console.entities.event import Event as EventEntity
 
 class IEvent(ABC):
 

{orionis-0.539.0 → orionis-0.541.0}/orionis/console/contracts/reactor.py

@@ -1,8 +1,48 @@
 from abc import ABC, abstractmethod
 from typing import Any, List, Optional
+from orionis.console.contracts.command import ICommand
 
 class IReactor(ABC):
 
+    @abstractmethod
+    def command(
+        self,
+        signature: str,
+        handler: Any
+    ) -> ICommand:
+        """
+        Define a new command using a fluent interface.
+
+        This method allows defining a new command with a specified signature and handler
+        function using a fluent interface pattern. The command can be further configured
+        by chaining additional method calls to set properties such as timestamps,
+        description, and arguments.
+
+        Parameters
+        ----------
+        signature : str
+            The unique signature identifier for the command. Must follow naming conventions
+            (alphanumeric characters, underscores, colons, cannot start/end with underscore
+            or colon, cannot start with a number).
+        handler : Any
+            The function or callable that will be executed when the command is invoked.
+            This should be a valid function that accepts parameters matching the command's
+            defined arguments.
+
+        Returns
+        -------
+        ICommand
+            Returns an instance of ICommand that allows further configuration of the command
+            through method chaining.
+
+        Raises
+        ------
+        TypeError
+            If the signature is not a string or if the handler is not callable.
+        ValueError
+            If the signature does not meet the required naming conventions.
+        """
+
     @abstractmethod
     def info(self) -> List[dict]:
         """