orionis 0.483.0__tar.gz → 0.484.0__tar.gz

{orionis-0.483.0/orionis.egg-info → orionis-0.484.0}/PKG-INFO

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

{orionis-0.483.0 → orionis-0.484.0}/orionis/console/commands/scheduler_work.py

@@ -96,6 +96,9 @@ class ScheduleWorkCommand(BaseCommand):
             if Scheduler is None:
                 raise CLIOrionisRuntimeError(f"Scheduler class not found in module {module_name}")
 
+            # Create an instance of the Scheduler class
+            Scheduler = Scheduler()
+
             # Retrieve the 'tasks' method from the Scheduler class
             task_method = getattr(Scheduler, "tasks", None)
             if task_method is None:
@@ -107,6 +110,11 @@ class ScheduleWorkCommand(BaseCommand):
             # Register scheduled tasks using the Scheduler's tasks method
             task_method(schedule_serice)
 
+            # Register event listeners for the scheduler
+            onSchedulerStarted = getattr(Scheduler, "onSchedulerStarted", None)
+            if onSchedulerStarted:
+                schedule_serice.addListenerOnSchedulerStarted(onSchedulerStarted)
+
             # Display a start message for the scheduler worker
             console.line()
             start_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')

orionis-0.484.0/orionis/console/entities/listeners.py

@@ -0,0 +1,241 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any
+
+# ==============================================================
+# Base Events
+# ==============================================================
+
+@dataclass
+class SchedulerEventData:
+    """
+    Base class for scheduler-related events.
+
+    Attributes
+    ----------
+    code : int
+        The numeric event code indicating the event type.
+    """
+    code: int
+
+
+@dataclass
+class JobEventData(SchedulerEventData):
+    """
+    Base class for job-related events.
+
+    Attributes
+    ----------
+    code : int
+        The numeric event code indicating the event type.
+    job_id : str
+        The identifier of the job.
+    jobstore : str
+        The name of the job store where the job is located.
+    """
+    job_id: str
+    jobstore: str
+
+
+# ==============================================================
+# Scheduler Lifecycle Events
+# ==============================================================
+
+@dataclass
+class SchedulerStarted(SchedulerEventData):
+    """
+    Event triggered when the scheduler starts running.
+    """
+
+
+@dataclass
+class SchedulerShutdown(SchedulerEventData):
+    """
+    Event triggered when the scheduler shuts down.
+    """
+
+
+@dataclass
+class SchedulerPaused(SchedulerEventData):
+    """
+    Event triggered when the scheduler is paused.
+    """
+
+
+@dataclass
+class SchedulerResumed(SchedulerEventData):
+    """
+    Event triggered when the scheduler is resumed.
+    """
+
+
+# ==============================================================
+# Executor and JobStore Events
+# ==============================================================
+
+@dataclass
+class ExecutorAdded(SchedulerEventData):
+    """
+    Event triggered when an executor is added.
+
+    Attributes
+    ----------
+    alias : str
+        The alias of the added executor.
+    """
+    alias: str
+
+
+@dataclass
+class ExecutorRemoved(SchedulerEventData):
+    """
+    Event triggered when an executor is removed.
+
+    Attributes
+    ----------
+    alias : str
+        The alias of the removed executor.
+    """
+    alias: str
+
+
+@dataclass
+class JobstoreAdded(SchedulerEventData):
+    """
+    Event triggered when a job store is added.
+
+    Attributes
+    ----------
+    alias : str
+        The alias of the added job store.
+    """
+    alias: str
+
+
+@dataclass
+class JobstoreRemoved(SchedulerEventData):
+    """
+    Event triggered when a job store is removed.
+
+    Attributes
+    ----------
+    alias : str
+        The alias of the removed job store.
+    """
+    alias: str
+
+
+@dataclass
+class AllJobsRemoved(SchedulerEventData):
+    """
+    Event triggered when all jobs are removed from a job store.
+
+    Attributes
+    ----------
+    jobstore : str
+        The alias of the job store from which jobs were removed.
+    """
+    jobstore: str
+
+
+# ==============================================================
+# Job Management Events
+# ==============================================================
+
+@dataclass
+class JobAdded(JobEventData):
+    """
+    Event triggered when a job is added to a job store.
+    """
+
+
+@dataclass
+class JobRemoved(JobEventData):
+    """
+    Event triggered when a job is removed from a job store.
+    """
+
+
+@dataclass
+class JobModified(JobEventData):
+    """
+    Event triggered when a job is modified in a job store.
+    """
+
+
+@dataclass
+class JobSubmitted(JobEventData):
+    """
+    Event triggered when a job is submitted to an executor.
+
+    Attributes
+    ----------
+    run_time : datetime
+        The datetime when the job was scheduled to run.
+    """
+    run_time: datetime
+
+
+@dataclass
+class JobMaxInstances(JobEventData):
+    """
+    Event triggered when a job exceeds its maximum allowed instances.
+
+    Attributes
+    ----------
+    run_time : datetime
+        The datetime when the job was scheduled to run.
+    """
+    run_time: datetime
+
+
+# ==============================================================
+# Job Execution Events
+# ==============================================================
+
+@dataclass
+class JobExecuted(JobEventData):
+    """
+    Event triggered when a job finishes successfully.
+
+    Attributes
+    ----------
+    scheduled_run_time : datetime
+        The datetime when the job was scheduled to run.
+    retval : Any
+        The return value of the job function.
+    """
+    scheduled_run_time: datetime
+    retval: Any
+
+
+@dataclass
+class JobError(JobEventData):
+    """
+    Event triggered when a job raises an exception during execution.
+
+    Attributes
+    ----------
+    scheduled_run_time : datetime
+        The datetime when the job was scheduled to run.
+    exception : Exception
+        The exception raised by the job.
+    traceback : str
+        The traceback of the exception.
+    """
+    scheduled_run_time: datetime
+    exception: Exception
+    traceback: str
+
+
+@dataclass
+class JobMissed(JobEventData):
+    """
+    Event triggered when a job run is missed due to scheduler constraints.
+
+    Attributes
+    ----------
+    scheduled_run_time : datetime
+        The datetime when the job was originally scheduled to run.
+    """
+    scheduled_run_time: datetime

{orionis-0.483.0 → orionis-0.484.0}/orionis/console/tasks/schedule.py

@@ -2,7 +2,7 @@ import asyncio
 import logging
 from typing import Dict, List, Optional
 import pytz
-from apscheduler.events import EVENT_JOB_MISSED, EVENT_JOB_ERROR
+from apscheduler.events import EVENT_JOB_MISSED, EVENT_JOB_ERROR, EVENT_ALL, EVENT_SCHEDULER_STARTED
 from apscheduler.schedulers.asyncio import AsyncIOScheduler as APSAsyncIOScheduler
 from orionis.console.contracts.reactor import IReactor
 from orionis.console.contracts.schedule import ISchedule
@@ -80,7 +80,7 @@ class Scheduler(ISchedule):
         self.__jobs: List[dict] = []
 
         # Add a listener to the scheduler to capture job events such as missed jobs or errors.
-        self.__scheduler.add_listener(self.__listener, EVENT_JOB_MISSED | EVENT_JOB_ERROR)
+        self.__scheduler.add_listener(self.__listener, EVENT_ALL)
 
         # Log the initialization of the Scheduler.
         self.__logger.info("Orionis scheduler initialized.")
@@ -313,6 +313,26 @@ class Scheduler(ISchedule):
         # Return the Event instance for further scheduling configuration
         return self.__events[signature]
 
+    def addListenerOnSchedulerStarted(
+        self,
+        listener: callable
+    ) -> None:
+        """
+        Add a listener for the scheduler started event.
+
+        This method allows you to register a callback function that will be called
+        when the scheduler starts. The callback should accept a single argument, which
+        is the event object containing details about the scheduler start event.
+
+        Parameters
+        ----------
+        listener : callable
+            A function that will be called when the scheduler starts.
+            It should accept one parameter, which is the event object.
+        """
+        # Register the listener for the scheduler started event
+        self.__scheduler.add_listener(listener, EVENT_SCHEDULER_STARTED)
+
     async def start(self) -> None:
         """
         Start the AsyncIO scheduler instance and keep it running.

{orionis-0.483.0 → orionis-0.484.0}/orionis/metadata/framework.py

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

{orionis-0.483.0 → orionis-0.484.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.483.0 → orionis-0.484.0}/orionis.egg-info/SOURCES.txt

@@ -44,6 +44,8 @@ orionis/console/dynamic/__init__.py
 orionis/console/dynamic/progress_bar.py
 orionis/console/dynamic/contracts/__init__.py
 orionis/console/dynamic/contracts/progress_bar.py
+orionis/console/entities/__init__.py
+orionis/console/entities/listeners.py
 orionis/console/enums/__init__.py
 orionis/console/enums/command.py
 orionis/console/enums/event.py