orionis 0.524.0__tar.gz → 0.526.0__tar.gz

{orionis-0.524.0/orionis.egg-info → orionis-0.526.0}/PKG-INFO

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

orionis-0.526.0/orionis/console/base/scheduler_event_listener.py

@@ -0,0 +1,164 @@
+from orionis.console.contracts.schedule_event_listener import IScheduleEventListener
+from orionis.console.entities.event_job import EventJob
+
+class BaseScheduleEventListener(IScheduleEventListener):
+    """
+    Base implementation of the IScheduleEventListener interface.
+
+    This class provides method definitions for handling various job events in a
+    scheduling system. Subclasses should override these methods to implement
+    specific behavior for each event type.
+    """
+
+    async def before(self, event: EventJob, schedule):
+        """
+        Called before processing a job submission event.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job submission event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for pre-job submission logic
+
+    async def after(self, event: EventJob, schedule):
+        """
+        Called after processing a job execution event.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job execution event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for post-job execution logic
+
+    async def onSuccess(self, event: EventJob, schedule):
+        """
+        Called when a job is successfully executed.
+
+        Parameters
+        ----------
+        event : EventJob
+            The successful job execution event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle successful job execution
+
+    async def onFailure(self, event: EventJob, schedule):
+        """
+        Called when a job execution fails.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job error event containing details about the failure.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle job execution failure
+
+    async def onMissed(self, event: EventJob, schedule):
+        """
+        Called when a job execution is missed.
+
+        Parameters
+        ----------
+        event : EventJob
+            The missed job event containing details about the missed execution.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle missed job execution
+
+    async def onMaxInstances(self, event: EventJob, schedule):
+        """
+        Called when a job exceeds the maximum allowed instances.
+
+        Parameters
+        ----------
+        event : EventJob
+            The max instances event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle max instances exceeded
+
+    async def onPaused(self, event: EventJob, schedule):
+        """
+        Called when the scheduler is paused.
+
+        Parameters
+        ----------
+        event : EventJob
+            The pause event containing details about the scheduler state.
+        schedule : ISchedule
+            The associated schedule instance managing the jobs.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle scheduler pause
+
+    async def onResumed(self, event: EventJob, schedule):
+        """
+        Called when the scheduler is resumed.
+
+        Parameters
+        ----------
+        event : EventJob
+            The resume event containing details about the scheduler state.
+        schedule : ISchedule
+            The associated schedule instance managing the jobs.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle scheduler resume
+
+    async def onRemoved(self, event: EventJob, schedule):
+        """
+        Called when a job is removed from the scheduler.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job removal event containing details about the removed job.
+        schedule : ISchedule
+            The associated schedule instance managing the jobs.
+
+        Returns
+        -------
+        None
+        """
+        pass  # Placeholder for logic to handle job removal

orionis-0.526.0/orionis/console/contracts/schedule_event_listener.py

@@ -0,0 +1,170 @@
+from abc import ABC, abstractmethod
+
+from orionis.console.entities.event_job import EventJob
+
+class IScheduleEventListener(ABC):
+    """
+    Interface for event listeners that handle various stages of event processing.
+    """
+
+    @abstractmethod
+    async def before(self, event: EventJob, schedule):
+        """
+        Called before processing a job submission event.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job submission event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def after(self, event: EventJob, schedule):
+        """
+        Called after processing a job execution event.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job execution event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onSuccess(self, event: EventJob, schedule):
+        """
+        Called when a job is successfully executed.
+
+        Parameters
+        ----------
+        event : EventJob
+            The successful job execution event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onFailure(self, event: EventJob, schedule):
+        """
+        Called when a job execution fails.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job error event containing details about the failure.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onMissed(self, event: EventJob, schedule):
+        """
+        Called when a job execution is missed.
+
+        Parameters
+        ----------
+        event : EventJob
+            The missed job event containing details about the missed execution.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onMaxInstances(self, event: EventJob, schedule):
+        """
+        Called when a job exceeds the maximum allowed instances.
+
+        Parameters
+        ----------
+        event : EventJob
+            The max instances event containing details about the job.
+        schedule : ISchedule
+            The associated schedule instance managing the job.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onPaused(self, event: EventJob, schedule):
+        """
+        Called when the scheduler is paused.
+
+        Parameters
+        ----------
+        event : EventJob
+            The pause event containing details about the scheduler state.
+        schedule : ISchedule
+            The associated schedule instance managing the jobs.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onResumed(self, event: EventJob, schedule):
+        """
+        Called when the scheduler is resumed.
+
+        Parameters
+        ----------
+        event : EventJob
+            The resume event containing details about the scheduler state.
+        schedule : ISchedule
+            The associated schedule instance managing the jobs.
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    @abstractmethod
+    async def onRemoved(self, event: EventJob, schedule):
+        """
+        Called when a job is removed from the scheduler.
+
+        Parameters
+        ----------
+        event : EventJob
+            The job removal event containing details about the removed job.
+        schedule : ISchedule
+            The associated schedule instance managing the jobs.
+
+        Returns
+        -------
+        None
+        """
+        pass

orionis-0.526.0/orionis/console/entities/event_job.py

@@ -0,0 +1,60 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Callable, Dict, Optional, Tuple
+
+@dataclass(kw_only=True)
+class EventJob:
+    """
+    Represents the main properties of a job in APScheduler.
+
+    Attributes
+    ----------
+    id : str
+        Unique identifier for the job.
+    name : Optional[str]
+        Human-readable name for the job. Can be None if not specified.
+    func : Callable[..., Any]
+        The function or coroutine to be executed by the job.
+    args : Tuple[Any, ...]
+        Positional arguments to be passed to the function.
+    trigger : Any
+        The trigger that determines the job's execution schedule
+        (e.g., IntervalTrigger, CronTrigger, etc.).
+    executor : str
+        Alias of the executor that will run the job.
+    jobstore : str
+        Alias of the job store where the job is stored.
+    misfire_grace_time : Optional[int]
+        Grace period in seconds for handling missed executions.
+        If None, no grace period is applied.
+    max_instances : int
+        Maximum number of concurrent instances of the job allowed.
+    coalesce : bool
+        Whether to merge pending executions into a single execution.
+    next_run_time : Optional[datetime]
+        The next scheduled execution time of the job. Can be None if the job is paused or unscheduled.
+
+    Returns
+    -------
+    None
+        This class is a data container and does not return any value.
+    """
+    id: str
+    code: int = 0
+    name: Optional[str] = None
+    func: Callable[..., Any] = None
+    args: Tuple[Any, ...] = ()
+    trigger: Any = None
+    executor: str = 'default'
+    jobstore: str = 'default'
+    misfire_grace_time: Optional[int] = None
+    max_instances: int = 1
+    coalesce: bool = False
+    next_run_time: Optional[datetime] = None
+    exception: Optional[BaseException] = None
+    traceback: Optional[str] = None
+    retval: Optional[Any] = None
+    purpose: Optional[str] = None
+    start_date: Optional[datetime] = None
+    end_date: Optional[datetime] = None
+    details: Optional[str] = None

orionis-0.526.0/orionis/console/entities/scheduler_error.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass
+from typing import Optional
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerError(SchedulerEventData):
+    """
+    Represents an event triggered when the scheduler is paused.
+
+    This class is a data structure that inherits from `SchedulerEventData` 
+    and is used to encapsulate information related to the scheduler pause event.
+
+    Attributes
+    ----------
+    (Inherited from SchedulerEventData)
+    """
+
+    exception: Optional[BaseException] = None  # Exception that caused the scheduler error
+    traceback: Optional[str] = None  # Traceback information related to the scheduler error

{orionis-0.524.0 → orionis-0.526.0}/orionis/console/entities/scheduler_event_data.py

@@ -16,9 +16,6 @@ class SchedulerEventData:
     code : int
         A numeric code that uniquely identifies the type of event within the
         scheduler system.
-    alias : str, optional
-        An optional string providing additional context or identifying specific
-        components (e.g., executors or job stores) related to the event.
 
     Returns
     -------
@@ -26,8 +23,6 @@ class SchedulerEventData:
         An instance of the `SchedulerEventData` class containing the event code
         and optional alias.
     """
+
     # Numeric code representing the type of event
     code: int
-
-    # Optional alias for additional context about the event
-    alias: Optional[str] = None

{orionis-0.524.0 → orionis-0.526.0}/orionis/console/entities/scheduler_paused.py

@@ -13,5 +13,5 @@ class SchedulerPaused(SchedulerEventData):
     ----------
     (Inherited from SchedulerEventData)
     """
-    # No additional attributes or methods are defined here, as this class 
-    # serves as a specialized event marker for when the scheduler is paused.
+
+    time: str  # Time when the scheduler was paused

{orionis-0.524.0 → orionis-0.526.0}/orionis/console/entities/scheduler_resumed.py

@@ -20,5 +20,5 @@ class SchedulerResumed(SchedulerEventData):
         An instance of the `SchedulerResumed` class representing
         the resumed scheduler event.
     """
-    # No additional fields or methods are defined here, as this class
-    # serves as a marker for the resumed scheduler event.
+
+    time: str  # The time when the scheduler was resumed

{orionis-0.524.0 → orionis-0.526.0}/orionis/console/entities/scheduler_shutdown.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
 @dataclass(kw_only=True)
@@ -19,5 +19,5 @@ class SchedulerShutdown(SchedulerEventData):
     SchedulerShutdown
         An instance of the `SchedulerShutdown` class representing the shutdown event.
     """
-    # This class does not define additional attributes or methods. It serves as a
-    # specific type of event data for the scheduler shutdown event.
+    time: str = ""                              # The time when the scheduler started
+    tasks: list = field(default_factory=list)   # List of tasks scheduled at the time of start

{orionis-0.524.0 → orionis-0.526.0}/orionis/console/entities/scheduler_started.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from orionis.console.entities.scheduler_event_data import SchedulerEventData
 
 @dataclass(kw_only=True)
@@ -18,4 +18,5 @@ class SchedulerStarted(SchedulerEventData):
     SchedulerStarted
         An instance of the `SchedulerStarted` class, representing the scheduler start event.
     """
-    # This class does not define additional attributes or methods; it serves as a marker for the event.
+    time: str = ""                              # The time when the scheduler started
+    tasks: list = field(default_factory=list)   # List of tasks scheduled at the time of start