orionis 0.619.0__py3-none-any.whl → 0.621.0__py3-none-any.whl

orionis/console/commands/scheduler_work.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 from rich.console import Console
 from rich.panel import Panel
 from orionis.console.base.command import BaseCommand
@@ -6,6 +5,7 @@ from orionis.console.contracts.schedule import ISchedule
 from orionis.console.enums.listener import ListeningEvent
 from orionis.console.exceptions import CLIOrionisRuntimeError
 from orionis.foundation.contracts.application import IApplication
+from orionis.services.introspection.instances.reflection import ReflectionInstance
 
 class ScheduleWorkCommand(BaseCommand):
     """
@@ -74,60 +74,57 @@ class ScheduleWorkCommand(BaseCommand):
             # Retrieve the Scheduler instance from the application
             scheduler = app.getScheduler()
 
+            # Create an instance of ReflectionInstance
+            rf_scheduler = ReflectionInstance(scheduler)
+
+            # If the Scheduler class does not define the 'tasks' method, raise an error
+            if not rf_scheduler.hasMethod("tasks"):
+                raise CLIOrionisRuntimeError(
+                    "The 'tasks' method was not found in the Scheduler class. "
+                    "Please ensure your Scheduler class defines a 'tasks(self, schedule: ISchedule)' method "
+                    "to register scheduled tasks."
+                )
+
             # Create an instance of the ISchedule service
             schedule_service: ISchedule = app.make(ISchedule)
 
             # Register scheduled tasks using the Scheduler's tasks method
-            await scheduler.tasks(schedule_service)
+            app.call(scheduler, 'tasks', schedule_service)
 
             # Retrieve the list of scheduled jobs/events
             list_tasks = schedule_service.events()
 
             # Display a message if no scheduled jobs are found
             if not list_tasks:
+
+                # Print a message indicating no scheduled jobs are found
                 console.line()
                 console.print(Panel("No scheduled jobs found.", border_style="green"))
                 console.line()
+
+                # Return True indicating the command completed successfully
                 return True
 
             # If there are scheduled jobs and the scheduler has an onStarted method
-            if hasattr(scheduler, "onStarted") and callable(scheduler.onStarted):
+            if rf_scheduler.hasMethod("onStarted"):
                 schedule_service.setListener(ListeningEvent.SCHEDULER_STARTED, scheduler.onStarted)
 
             # If the scheduler has an onPaused method
-            if hasattr(scheduler, "onPaused") and callable(scheduler.onPaused):
+            if rf_scheduler.hasMethod("onPaused"):
                 schedule_service.setListener(ListeningEvent.SCHEDULER_PAUSED, scheduler.onPaused)
 
             # If the scheduler has an onResumed method
-            if hasattr(scheduler, "onResumed") and callable(scheduler.onResumed):
+            if rf_scheduler.hasMethod("onResumed"):
                 schedule_service.setListener(ListeningEvent.SCHEDULER_RESUMED, scheduler.onResumed)
 
             # If the scheduler has an onFinalized method
-            if hasattr(scheduler, "onFinalized") and callable(scheduler.onFinalized):
+            if rf_scheduler.hasMethod("onFinalized"):
                 schedule_service.setListener(ListeningEvent.SCHEDULER_SHUTDOWN, scheduler.onFinalized)
 
             # If the scheduler has an onError method
-            if hasattr(scheduler, "onError") and callable(scheduler.onError):
+            if rf_scheduler.hasMethod("onError"):
                 schedule_service.setListener(ListeningEvent.SCHEDULER_ERROR, scheduler.onError)
 
-            # If the scheduler has FINALIZE_AT and it is not None
-            if hasattr(scheduler, "FINALIZE_AT") and scheduler.FINALIZE_AT is not None:
-                if not isinstance(scheduler.FINALIZE_AT, datetime):
-                    raise CLIOrionisRuntimeError("FINALIZE_AT must be a datetime instance.")
-                schedule_service.shutdownEverythingAt(scheduler.FINALIZE_AT)
-
-            # If the scheduler has RESUME_AT and it is not None
-            if hasattr(scheduler, "RESUME_AT") and scheduler.RESUME_AT is not None:
-                if not isinstance(scheduler.RESUME_AT, datetime):
-                    raise CLIOrionisRuntimeError("RESUME_AT must be a datetime instance.")
-                schedule_service.resumeEverythingAt(scheduler.RESUME_AT)
-
-            # If the scheduler has PAUSE_AT and it is not None
-            if hasattr(scheduler, "PAUSE_AT") and scheduler.PAUSE_AT is not None:
-                if not isinstance(scheduler.PAUSE_AT, datetime):
-                    raise CLIOrionisRuntimeError("PAUSE_AT must be a datetime instance.")
-                schedule_service.pauseEverythingAt(scheduler.PAUSE_AT)
-
             # Start the scheduler worker asynchronously
             await schedule_service.start()
 

orionis/console/contracts/command.py

@@ -1,4 +1,5 @@
 from abc import ABC, abstractmethod
+from orionis.console.entities.command import Command as CommandEntity
 
 class ICommand(ABC):
 
@@ -84,4 +85,21 @@ class ICommand(ABC):
             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/console/contracts/schedule.py

@@ -80,7 +80,7 @@ class ISchedule(ABC):
         pass
 
     @abstractmethod
-    def pauseEverythingAt(
+    def pause(
         self,
         at: datetime
     ) -> None:
@@ -111,7 +111,7 @@ class ISchedule(ABC):
         pass
 
     @abstractmethod
-    def resumeEverythingAt(
+    def resume(
         self,
         at: datetime
     ) -> None:
@@ -141,37 +141,6 @@ class ISchedule(ABC):
         """
         pass
 
-    @abstractmethod
-    def shutdownEverythingAt(
-        self,
-        at: datetime
-    ) -> None:
-        """
-        Schedule the scheduler to shut down all operations at a specific datetime.
-
-        This method allows you to schedule a job that will shut down the AsyncIOScheduler
-        at the specified datetime. The job is added to the scheduler with a 'date'
-        trigger, ensuring it executes exactly at the given time.
-
-        Parameters
-        ----------
-        at : datetime
-            The datetime at which the scheduler should be shut down. Must be a valid
-            datetime object.
-
-        Returns
-        -------
-        None
-            This method does not return any value. It schedules a job to shut down the
-            scheduler at the specified datetime.
-
-        Raises
-        ------
-        ValueError
-            If the 'at' parameter is not a valid datetime object.
-        """
-        pass
-
     @abstractmethod
     async def start(self) -> None:
         """
@@ -326,57 +295,6 @@ class ISchedule(ABC):
         """
         pass
 
-    @abstractmethod
-    def cancelScheduledPause(self) -> bool:
-        """
-        Cancel a previously scheduled pause operation.
-
-        This method attempts to remove a job from the scheduler that was set to pause
-        the scheduler at a specific time. If the job exists, it is removed, and a log entry
-        is created to indicate the cancellation. If no such job exists, the method returns False.
-
-        Returns
-        -------
-        bool
-            True if the scheduled pause job was successfully cancelled.
-            False if no pause job was found or an error occurred during the cancellation process.
-        """
-        pass
-
-    @abstractmethod
-    def cancelScheduledResume(self) -> bool:
-        """
-        Cancel a previously scheduled resume operation.
-
-        This method attempts to remove a job from the scheduler that was set to resume
-        the scheduler at a specific time. If the job exists, it is removed, and a log entry
-        is created to indicate the cancellation. If no such job exists, the method returns False.
-
-        Returns
-        -------
-        bool
-            True if the scheduled resume job was successfully cancelled.
-            False if no resume job was found or an error occurred during the cancellation process.
-        """
-        pass
-
-    @abstractmethod
-    def cancelScheduledShutdown(self) -> bool:
-        """
-        Cancel a previously scheduled shutdown operation.
-
-        This method attempts to remove a job from the scheduler that was set to shut down
-        the scheduler at a specific time. If the job exists, it is removed, and a log entry
-        is created to indicate the cancellation. If no such job exists, the method returns False.
-
-        Returns
-        -------
-        bool
-            True if the scheduled shutdown job was successfully cancelled.
-            False if no shutdown job was found or an error occurred during the cancellation process.
-        """
-        pass
-
     @abstractmethod
     def isRunning(self) -> bool:
         """

orionis/console/entities/scheduler_error.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from datetime import datetime
 from typing import Optional
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
@@ -7,16 +8,17 @@ class SchedulerError(SchedulerEventData):
     """
     Represents an error event triggered by the scheduler.
 
-    This data class extends `SchedulerEventData` and is used to encapsulate
-    information related to errors that occur during scheduler operations.
-    It stores the exception that caused the error and the associated traceback
-    for debugging and logging purposes.
+    This data class extends `SchedulerEventData` and encapsulates information about errors
+    that occur during scheduler operations. It stores the exception that caused the error,
+    the traceback for debugging, and the time the error occurred.
 
     Attributes
     ----------
-    exception : Optional[BaseException]
+    time : str or datetime, optional
+        The time when the error occurred. Can be a string or a datetime object.
+    exception : BaseException, optional
         The exception instance that caused the scheduler error, if any.
-    traceback : Optional[str]
+    traceback : str, optional
         The traceback string providing details about where the error occurred.
 
     Returns
@@ -25,6 +27,9 @@ class SchedulerError(SchedulerEventData):
         An instance containing details about the scheduler error event.
     """
 
+    # The time when the error occurred (string or datetime)
+    time: str | datetime = None
+
     # Exception that caused the scheduler error, if present
     exception: Optional[BaseException] = None
 

orionis/console/entities/scheduler_event_data.py

@@ -3,11 +3,11 @@ from dataclasses import dataclass
 @dataclass(kw_only=True)
 class SchedulerEventData:
     """
-    Base data structure for scheduler-related events.
+    Base data structure for events in the scheduler system.
 
-    This class encapsulates information about events that occur within the scheduler system.
-    It provides a numeric event code to identify the event type and can be extended for
-    additional context as needed.
+    This class serves as a foundational data container for events triggered within the scheduler.
+    It holds a numeric event code that uniquely identifies the event type. Subclasses can extend
+    this class to include additional event-specific context.
 
     Parameters
     ----------
@@ -17,8 +17,8 @@ class SchedulerEventData:
     Returns
     -------
     SchedulerEventData
-        An instance of SchedulerEventData containing the event code.
+        An instance of SchedulerEventData with the specified event code.
     """
 
-    # Numeric code representing the type of event
+    # Numeric code representing the type of event in the scheduler
     code: int

orionis/console/entities/scheduler_paused.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from datetime import datetime
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
 @dataclass(kw_only=True)
@@ -9,17 +10,24 @@ class SchedulerPaused(SchedulerEventData):
     This data class extends `SchedulerEventData` and encapsulates information
     related to the scheduler pause event, such as the time at which the pause occurred.
 
+    Parameters
+    ----------
+    time : str or datetime, optional
+        The time when the scheduler was paused. Can be a string or a `datetime` object.
+        Defaults to None.
+    (Other parameters are inherited from SchedulerEventData.)
+
     Attributes
     ----------
-    time : str
-        The time when the scheduler was paused, formatted as a string.
+    time : str or datetime
+        The time when the scheduler was paused.
     (Other attributes are inherited from SchedulerEventData.)
 
     Returns
     -------
     SchedulerPaused
-        An instance of SchedulerPaused containing information about the pause event.
+        An instance of `SchedulerPaused` containing information about the pause event.
     """
 
-    # The time when the scheduler was paused
-    time: str
+    # The time when the scheduler was paused; can be a string or datetime object
+    time: str | datetime = None

orionis/console/entities/scheduler_resumed.py

@@ -1,24 +1,25 @@
 from dataclasses import dataclass
+from datetime import datetime
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
 @dataclass(kw_only=True)
 class SchedulerResumed(SchedulerEventData):
     """
-    Represents an event triggered when the scheduler is resumed.
+    Represents an event that is triggered when the scheduler is resumed.
 
-    This data class extends `SchedulerEventData` and is used to encapsulate
+    This data class extends `SchedulerEventData` and encapsulates
     information about the scheduler's resumption event.
 
     Attributes
     ----------
-    time : str
-        The time when the scheduler was resumed.
+    time : str or datetime, optional
+        The time when the scheduler was resumed. Can be a string or a datetime object.
 
     Returns
     -------
     SchedulerResumed
-        An instance containing information about the resumed scheduler event.
+        An instance of `SchedulerResumed` containing information about the resumed scheduler event.
     """
 
-    # The time when the scheduler was resumed
-    time: str
+    # The time when the scheduler was resumed; can be a string or datetime object
+    time: str | datetime = None

orionis/console/entities/scheduler_shutdown.py

@@ -1,4 +1,5 @@
-from dataclasses import dataclass, field
+from dataclasses import dataclass
+from datetime import datetime
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
 @dataclass(kw_only=True)
@@ -6,26 +7,21 @@ class SchedulerShutdown(SchedulerEventData):
     """
     Represents an event triggered when the scheduler shuts down.
 
-    This class extends `SchedulerEventData` and is used to encapsulate
-    information related to the shutdown of the scheduler, such as the
-    shutdown time and the list of tasks present at shutdown.
+    This dataclass extends `SchedulerEventData` and encapsulates information
+    related to the shutdown of the scheduler, such as the shutdown time and
+    the list of tasks present at shutdown.
 
     Attributes
     ----------
-    time : str
-        The time when the scheduler was shut down.
-    tasks : list
-        The list of tasks that were scheduled at the time of shutdown.
+    time : str or datetime, optional
+        The time when the scheduler was shut down. Can be a string or a datetime object.
 
     Returns
     -------
     SchedulerShutdown
-        An instance representing the scheduler shutdown event, containing
-        the shutdown time and the list of scheduled tasks.
+        An instance of SchedulerShutdown containing the shutdown time and
+        any additional event data inherited from SchedulerEventData.
     """
 
-    # The time when the scheduler was shut down
-    time: str = ""
-
-    # List of tasks scheduled at the time of shutdown
-    tasks: list = field(default_factory=list)
+    # The time when the scheduler was shut down; can be a string or datetime object
+    time: str | datetime = None

orionis/console/entities/scheduler_started.py

@@ -1,4 +1,5 @@
-from dataclasses import dataclass, field
+from dataclasses import dataclass
+from datetime import datetime
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
 @dataclass(kw_only=True)
@@ -6,25 +7,21 @@ class SchedulerStarted(SchedulerEventData):
     """
     Represents the event data generated when the scheduler starts.
 
-    This data class extends `SchedulerEventData` and encapsulates information
-    about the scheduler's start event, such as the start time and the list of
-    tasks scheduled at that moment.
+    This data class extends `SchedulerEventData` and encapsulates information about the scheduler's
+    start event, such as the start time and the list of tasks scheduled at that moment.
 
-    Attributes
+    Parameters
     ----------
-    time : str
-        The time when the scheduler started.
-    tasks : list
+    time : str or datetime, optional
+        The time when the scheduler started. Can be a string or a `datetime` object.
+    tasks : list, optional
         The list of tasks that were scheduled at the time the scheduler started.
 
     Returns
     -------
     SchedulerStarted
-        An instance containing the scheduler start event data.
+        An instance of `SchedulerStarted` containing the scheduler start event data.
     """
 
-    # The time when the scheduler started
-    time: str = ""
-
-    # List of tasks scheduled at the time of start
-    tasks: list = field(default_factory=list)
+    # The time when the scheduler started; can be a string or datetime object
+    time: str | datetime = None

orionis/console/fluent/command.py

@@ -1,9 +1,10 @@
 from typing import Any, Callable
 from orionis.console.args.argument import CLIArgument
+from orionis.console.contracts.command import ICommand
 from orionis.console.entities.command import Command as CommandEntity
 from orionis.services.introspection.concretes.reflection import ReflectionConcrete
 
-class Command:
+class Command(ICommand):
 
     def __init__(
         self,