orionis 0.483.0__py3-none-any.whl → 0.484.0__py3-none-any.whl

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/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/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/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.dist-info → orionis-0.484.0.dist-info}/METADATA

@@ -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.dist-info → orionis-0.484.0.dist-info}/RECORD

@@ -15,7 +15,7 @@ orionis/console/commands/cache.py,sha256=8DsYoRzSBLn0P9qkGVItRbo0R6snWBDBg0_Xa7t
 orionis/console/commands/help.py,sha256=ooPoenP08ArMAWiL89_oUGD9l1Faen2QjLTG90i4zCQ,3187
 orionis/console/commands/publisher.py,sha256=FUg-EUzK7LLXsla10ZUZro8V0Z5S-KjmsaSdRHSSGbA,21381
 orionis/console/commands/scheduler_list.py,sha256=SXaD1XJFV1bbyjlDuQhlHz2y1kW-VVCxQxuKJMtQRtA,5956
-orionis/console/commands/scheduler_work.py,sha256=cymbGHaLmwv2WtEenZTtm7iNVfs8gG8_oWXU18Jtzd0,5746
+orionis/console/commands/scheduler_work.py,sha256=eRd-IbburgcitIOpDo757F6lY_KQqO9oyKxszdQZsuU,6102
 orionis/console/commands/test.py,sha256=_Tb-I9vabiqhqGeLfRbV5Y1LEVCdhZhBAwoEQZCzQuM,2435
 orionis/console/commands/version.py,sha256=SUuNDJ40f2uq69OQUmPQXJKaa9Bm_iVRDPmBd7zc1Yc,3658
 orionis/console/commands/workflow.py,sha256=NYOmjTSvm2o6AE4h9LSTZMFSYPQreNmEJtronyOxaYk,2451
@@ -34,6 +34,8 @@ orionis/console/dynamic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG
 orionis/console/dynamic/progress_bar.py,sha256=iK1kAf9vJIgk6BbdlGvlJkGc1m7Ck4euNqQpg5aarW8,2880
 orionis/console/dynamic/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/dynamic/contracts/progress_bar.py,sha256=NYebL2h-vg2t2H6IhJjuC37gglRkpT-MW71wbJtpLNg,1784
+orionis/console/entities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+orionis/console/entities/listeners.py,sha256=I5JbbnwKz-ZQhQgS2r1wqfUTwagg8Os6qzfEY8FzVzg,5345
 orionis/console/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/enums/command.py,sha256=lCfVp2vnDojJN2gjdVxE_XU3mRjZZgOIxPfBVQYo9w4,1278
 orionis/console/enums/event.py,sha256=XRV7N14N5HHt-c0HqYhrbKv4n2P7ZOCcBT_3OAQzenU,1929
@@ -53,7 +55,7 @@ orionis/console/output/enums/styles.py,sha256=6a4oQCOBOKMh2ARdeq5GlIskJ3wjiylYmh
 orionis/console/tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/tasks/event.py,sha256=NdOht_yXqKW0EIsIVrctIgOhQDWAR5fuMPEF05zTWtI,12029
 orionis/console/tasks/exception_report.py,sha256=IN1PCQ08ZHs1sivUpzi2f9U9eW8ydZyb8GO6KiT56LY,3643
-orionis/console/tasks/schedule.py,sha256=yfKg0GPKEogAdndcqPJBak0NrIJ_Z-Fzpza34S-mIcc,19498
+orionis/console/tasks/schedule.py,sha256=3bELvGlYzsvPdwkUKrkMd_UxXT8Xp2bpOaMY1bRGwGY,20301
 orionis/container/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/container/container.py,sha256=aF_b6lTUpG4YCo9yFJEzsntTdIzgMMXFW5LyWqAJVBQ,87987
 orionis/container/context/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -200,7 +202,7 @@ orionis/foundation/providers/scheduler_provider.py,sha256=72SoixFog9IOE9Ve9Xcfw6
 orionis/foundation/providers/testing_provider.py,sha256=SrJRpdvcblx9WvX7x9Y3zc7OQfiTf7la0HAJrm2ESlE,3725
 orionis/foundation/providers/workers_provider.py,sha256=oa_2NIDH6UxZrtuGkkoo_zEoNIMGgJ46vg5CCgAm7wI,3926
 orionis/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/metadata/framework.py,sha256=Omguwj98GlVjFh8nCMjYoLHSqVMJ57Duo0GXurO-QLk,4109
+orionis/metadata/framework.py,sha256=QHaUaU9LFBgHK8Xe_11Y_EDNM2zMoDL5Jq7FviFSCIg,4109
 orionis/metadata/package.py,sha256=k7Yriyp5aUcR-iR8SK2ec_lf0_Cyc-C7JczgXa-I67w,16039
 orionis/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/services/asynchrony/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -372,7 +374,7 @@ orionis/test/validators/web_report.py,sha256=n9BfzOZz6aEiNTypXcwuWbFRG0OdHNSmCNu
 orionis/test/validators/workers.py,sha256=rWcdRexINNEmGaO7mnc1MKUxkHKxrTsVuHgbnIfJYgc,1206
 orionis/test/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/view/render.py,sha256=f-zNhtKSg9R5Njqujbg2l2amAs2-mRVESneLIkWOZjU,4082
-orionis-0.483.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
+orionis-0.484.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/container/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/container/context/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -519,8 +521,8 @@ tests/testing/validators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 tests/testing/validators/test_testing_validators.py,sha256=WPo5GxTP6xE-Dw3X1vZoqOMpb6HhokjNSbgDsDRDvy4,16588
 tests/testing/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/testing/view/test_render.py,sha256=tnnMBwS0iKUIbogLvu-7Rii50G6Koddp3XT4wgdFEYM,1050
-orionis-0.483.0.dist-info/METADATA,sha256=3XeBNGAmPP22h8aO4LHXJ9ynNTdYmmYjWQzrzLe5KhA,4801
-orionis-0.483.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-orionis-0.483.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.483.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-orionis-0.483.0.dist-info/RECORD,,
+orionis-0.484.0.dist-info/METADATA,sha256=JmsYHngCZy4ZwPJhAEqLVHng4Z58Mih5g6baeieDABQ,4801
+orionis-0.484.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+orionis-0.484.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.484.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+orionis-0.484.0.dist-info/RECORD,,