orionis 0.516.0__tar.gz → 0.518.0__tar.gz

{orionis-0.516.0/orionis.egg-info → orionis-0.518.0}/PKG-INFO

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

orionis-0.518.0/orionis/console/base/scheduler.py

@@ -0,0 +1,195 @@
+from datetime import datetime
+from orionis.console.contracts.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
+from orionis.console.entities.scheduler_resumed import SchedulerResumed
+from orionis.console.entities.scheduler_shutdown import SchedulerShutdown
+from orionis.console.entities.scheduler_started import SchedulerStarted
+
+class BaseScheduler(IBaseScheduler):
+
+    # Pause Global Scheduler at a specific time
+    PAUSE_AT: datetime = None
+
+    # Resume Global Scheduler at a specific time
+    RESUME_AT: datetime = None
+
+    # Finalize Global Scheduler at a specific time
+    FINALIZE_AT: datetime = None
+
+    async def tasks(self, schedule: ISchedule):
+        """
+        Defines and registers scheduled tasks for the application.
+
+        This method is responsible for setting up the tasks that the scheduler will execute.
+        It uses the provided `schedule` object to define the properties and behavior of each task.
+
+        Parameters
+        ----------
+        schedule : ISchedule
+            The schedule object used to define and register scheduled commands.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used solely for task registration.
+
+        Notes
+        -----
+        Subclasses must override this method to implement their specific task scheduling logic.
+        The method should define the tasks, their execution intervals, and any additional
+        properties or constraints required for the tasks.
+        """
+
+        # Raise an error to enforce implementation in subclasses
+        raise NotImplementedError("Subclasses must implement the tasks method.")
+
+    async def onStarted(self, event: SchedulerStarted, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler has started successfully.
+
+        This method is invoked when the scheduler begins its operation. It processes
+        the `SchedulerStarted` event and performs any necessary initialization or logging
+        tasks associated with the start of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerStarted
+            The event object containing details about the scheduler start event.
+        schedule : ISchedule
+            The schedule instance associated with the started scheduler.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the
+            scheduler start event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onStarted` method to ensure that
+        any base functionality is executed.
+        """
+        pass
+
+    async def onPaused(self, event: SchedulerPaused, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler is paused.
+
+        This method is invoked when the scheduler pauses its operation. It processes
+        the `SchedulerPaused` event and performs any necessary actions or logging
+        tasks associated with the pause of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerPaused
+            The event object containing details about the scheduler pause event.
+        schedule : ISchedule
+            The schedule instance associated with the paused scheduler.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the
+            scheduler pause event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onPaused` method to ensure that
+        any base functionality is executed.
+        """
+        pass
+
+    async def onResumed(self, event: SchedulerResumed, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler is resumed.
+
+        This method is invoked when the scheduler resumes its operation after being paused.
+        It processes the `SchedulerResumed` event and performs any necessary actions or logging
+        tasks associated with the resumption of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerResumed
+            The event object containing details about the scheduler resumption, such as the
+            timestamp of the resumption and any relevant metadata.
+        schedule : ISchedule
+            The schedule instance associated with the resumed scheduler, which can be used
+            to interact with or modify the scheduler's tasks.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the scheduler
+            resumption event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onResumed` method to ensure that any base
+        functionality is executed. This allows the scheduler to maintain its default behavior
+        while enabling additional custom actions during the resumption process.
+        """
+        pass
+
+    async def onFinalized(self, event: SchedulerShutdown, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler has been finalized.
+
+        This method is invoked after the scheduler has completed its shutdown process.
+        It processes the `SchedulerShutdown` event and performs any necessary cleanup
+        or logging tasks associated with the finalization of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerShutdown
+            The event object containing details about the scheduler shutdown, such as
+            the timestamp of the shutdown and any relevant metadata.
+        schedule : ISchedule
+            The schedule instance associated with the finalized scheduler, which can be
+            used to interact with or inspect the scheduler's tasks.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the scheduler
+            shutdown event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onFinalized` method to ensure that any base
+        functionality is executed. This allows the scheduler to maintain its default behavior
+        while enabling additional custom actions during the finalization process.
+        """
+        pass
+
+    async def onError(self, event: JobError, schedule: ISchedule):
+        """
+        Handles the event triggered when a job encounters an error during execution.
+
+        This method is invoked when a job fails due to an exception. It processes the `JobError`
+        event and performs any necessary actions, such as logging the error details or notifying
+        relevant systems about the failure.
+
+        Parameters
+        ----------
+        event : JobError
+            The event object containing details about the job error, including the job ID,
+            the exception that occurred, and any relevant metadata.
+        schedule : ISchedule
+            The schedule instance associated with the job, which can be used to interact with
+            or modify the scheduler's tasks.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the job error event
+            and performing related actions, such as logging or cleanup.
+
+        Notes
+        -----
+        This method calls the parent class's `onError` method to ensure that any base functionality
+        is executed. This allows the scheduler to maintain its default behavior while enabling
+        additional custom actions during error handling.
+        """
+        pass

orionis-0.518.0/orionis/console/contracts/scheduler.py

@@ -0,0 +1,189 @@
+from abc import ABC, abstractmethod
+from orionis.console.contracts.schedule import ISchedule
+from orionis.console.entities.job_error import JobError
+from orionis.console.entities.scheduler_paused import SchedulerPaused
+from orionis.console.entities.scheduler_resumed import SchedulerResumed
+from orionis.console.entities.scheduler_shutdown import SchedulerShutdown
+from orionis.console.entities.scheduler_started import SchedulerStarted
+
+class IBaseScheduler(ABC):
+
+    @abstractmethod
+    async def tasks(self, schedule: ISchedule):
+        """
+        Defines and registers scheduled tasks for the application.
+
+        This method is responsible for setting up the tasks that the scheduler will execute.
+        It uses the provided `schedule` object to define the properties and behavior of each task.
+
+        Parameters
+        ----------
+        schedule : ISchedule
+            The schedule object used to define and register scheduled commands.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used solely for task registration.
+
+        Notes
+        -----
+        Subclasses must override this method to implement their specific task scheduling logic.
+        The method should define the tasks, their execution intervals, and any additional
+        properties or constraints required for the tasks.
+        """
+        pass
+
+    @abstractmethod
+    async def onStarted(self, event: SchedulerStarted, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler has started successfully.
+
+        This method is invoked when the scheduler begins its operation. It processes
+        the `SchedulerStarted` event and performs any necessary initialization or logging
+        tasks associated with the start of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerStarted
+            The event object containing details about the scheduler start event.
+        schedule : ISchedule
+            The schedule instance associated with the started scheduler.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the
+            scheduler start event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onStarted` method to ensure that
+        any base functionality is executed.
+        """
+        pass
+
+    @abstractmethod
+    async def onPaused(self, event: SchedulerPaused, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler is paused.
+
+        This method is invoked when the scheduler pauses its operation. It processes
+        the `SchedulerPaused` event and performs any necessary actions or logging
+        tasks associated with the pause of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerPaused
+            The event object containing details about the scheduler pause event.
+        schedule : ISchedule
+            The schedule instance associated with the paused scheduler.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the
+            scheduler pause event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onPaused` method to ensure that
+        any base functionality is executed.
+        """
+        pass
+
+    @abstractmethod
+    async def onResumed(self, event: SchedulerResumed, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler is resumed.
+
+        This method is invoked when the scheduler resumes its operation after being paused.
+        It processes the `SchedulerResumed` event and performs any necessary actions or logging
+        tasks associated with the resumption of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerResumed
+            The event object containing details about the scheduler resumption, such as the
+            timestamp of the resumption and any relevant metadata.
+        schedule : ISchedule
+            The schedule instance associated with the resumed scheduler, which can be used
+            to interact with or modify the scheduler's tasks.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the scheduler
+            resumption event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onResumed` method to ensure that any base
+        functionality is executed. This allows the scheduler to maintain its default behavior
+        while enabling additional custom actions during the resumption process.
+        """
+        pass
+
+    @abstractmethod
+    async def onFinalized(self, event: SchedulerShutdown, schedule: ISchedule):
+        """
+        Handles the event triggered when the scheduler has been finalized.
+
+        This method is invoked after the scheduler has completed its shutdown process.
+        It processes the `SchedulerShutdown` event and performs any necessary cleanup
+        or logging tasks associated with the finalization of the scheduler.
+
+        Parameters
+        ----------
+        event : SchedulerShutdown
+            The event object containing details about the scheduler shutdown, such as
+            the timestamp of the shutdown and any relevant metadata.
+        schedule : ISchedule
+            The schedule instance associated with the finalized scheduler, which can be
+            used to interact with or inspect the scheduler's tasks.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the scheduler
+            shutdown event and performing related actions.
+
+        Notes
+        -----
+        This method calls the parent class's `onFinalized` method to ensure that any base
+        functionality is executed. This allows the scheduler to maintain its default behavior
+        while enabling additional custom actions during the finalization process.
+        """
+        pass
+
+    @abstractmethod
+    async def onError(self, event: JobError, schedule: ISchedule):
+        """
+        Handles the event triggered when a job encounters an error during execution.
+
+        This method is invoked when a job fails due to an exception. It processes the `JobError`
+        event and performs any necessary actions, such as logging the error details or notifying
+        relevant systems about the failure.
+
+        Parameters
+        ----------
+        event : JobError
+            The event object containing details about the job error, including the job ID,
+            the exception that occurred, and any relevant metadata.
+        schedule : ISchedule
+            The schedule instance associated with the job, which can be used to interact with
+            or modify the scheduler's tasks.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is used for handling the job error event
+            and performing related actions, such as logging or cleanup.
+
+        Notes
+        -----
+        This method calls the parent class's `onError` method to ensure that any base functionality
+        is executed. This allows the scheduler to maintain its default behavior while enabling
+        additional custom actions during error handling.
+        """
+        pass

{orionis-0.516.0 → orionis-0.518.0}/orionis/console/tasks/schedule.py

@@ -3,6 +3,7 @@ from datetime import datetime
 import logging
 from typing import Dict, List, Optional, Union
 import pytz
+from apscheduler.triggers.date import DateTrigger
 from apscheduler.events import (
     EVENT_SCHEDULER_STARTED,
     EVENT_SCHEDULER_PAUSED,
@@ -524,10 +525,6 @@ class Scheduler(ISchedule):
         # Log an informational message indicating that the scheduler has been paused
         self.__logger.info(message)
 
-        # Display a paused message for the scheduler worker on console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # Check if a listener is registered for the scheduler started event
         self.__globalCallableListener(event, ListeningEvent.SCHEDULER_PAUSED)
 
@@ -565,10 +562,6 @@ class Scheduler(ISchedule):
         # Log an informational message indicating that the scheduler has resumed
         self.__logger.info(message)
 
-        # Display a resumed message for the scheduler worker on console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # Check if a listener is registered for the scheduler started event
         self.__globalCallableListener(event, ListeningEvent.SCHEDULER_RESUMED)
 
@@ -606,10 +599,6 @@ class Scheduler(ISchedule):
         # Log an informational message indicating that the scheduler has shut down
         self.__logger.info(message)
 
-        # Display a shutdown message for the scheduler worker on console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # Check if a listener is registered for the scheduler started event
         self.__globalCallableListener(event, ListeningEvent.SCHEDULER_SHUTDOWN)
 
@@ -644,10 +633,6 @@ class Scheduler(ISchedule):
         # Log an error message indicating that the job raised an exception
         self.__logger.error(message)
 
-        # If the application is in debug mode, display a message on the console
-        if self.__app.config('app.debug', False):
-            self.__console.error(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         self.__taskCallableListener(event, ListeningEvent.JOB_ON_FAILURE)
 
@@ -685,10 +670,6 @@ class Scheduler(ISchedule):
         # Log an informational message indicating that the job has been submitted
         self.__logger.info(message)
 
-        # If the application is in debug mode, display a message on the console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         self.__taskCallableListener(event, ListeningEvent.JOB_BEFORE)
 
@@ -724,10 +705,6 @@ class Scheduler(ISchedule):
         # Log an informational message indicating that the job has been executed
         self.__logger.info(message)
 
-        # If the application is in debug mode, display a message on the console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         self.__taskCallableListener(event, ListeningEvent.JOB_AFTER)
 
@@ -763,10 +740,6 @@ class Scheduler(ISchedule):
         # Log a warning indicating that the job was missed
         self.__logger.warning(message)
 
-        # If the application is in debug mode, report the missed job using the error reporter
-        if self.__app.config('app.debug', False):
-            self.__console.warning(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         self.__taskCallableListener(event, ListeningEvent.JOB_ON_MISSED)
 
@@ -802,10 +775,6 @@ class Scheduler(ISchedule):
         # Log an error message indicating that the job exceeded maximum instances
         self.__logger.error(message)
 
-        # If the application is in debug mode, display a message on the console
-        if self.__app.config('app.debug', False):
-            self.__console.error(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         self.__taskCallableListener(event, ListeningEvent.JOB_ON_MAXINSTANCES)
 
@@ -841,10 +810,6 @@ class Scheduler(ISchedule):
         # Log an informational message indicating that the job has been modified
         self.__logger.info(message)
 
-        # If the application is in debug mode, display a message on the console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         if event.next_run_time is None:
             self.__taskCallableListener(event, ListeningEvent.JOB_ON_PAUSED)
@@ -882,10 +847,6 @@ class Scheduler(ISchedule):
         # Log the removal of the job
         self.__logger.info(message)
 
-        # If the application is in debug mode, display the message on the console
-        if self.__app.config('app.debug', False):
-            self.__console.info(message)
-
         # If a listener is registered for this job ID, invoke the listener with the event details
         self.__taskCallableListener(event, ListeningEvent.JOB_ON_REMOVED)
 
@@ -1019,8 +980,7 @@ class Scheduler(ISchedule):
         # Add a job to the scheduler to pause it at the specified datetime
         self.__scheduler.add_job(
             func=self.__scheduler.pause,                    # Function to pause the scheduler
-            trigger='date',                                 # Trigger type is 'date' for one-time execution
-            run_date=at,                                    # The datetime at which the job will run
+            trigger=DateTrigger(run_date=at),               # Trigger type is 'date' for one-time execution
             id=f"pause_scheduler_at_{at.isoformat()}",      # Unique job ID based on the datetime
             name=f"Pause Scheduler at {at.isoformat()}",    # Descriptive name for the job
             replace_existing=True                           # Replace any existing job with the same ID
@@ -1062,8 +1022,7 @@ class Scheduler(ISchedule):
         # Add a job to the scheduler to resume it at the specified datetime
         self.__scheduler.add_job(
             func=self.__scheduler.resume,                   # Function to resume the scheduler
-            trigger='date',                                 # Trigger type is 'date' for one-time execution
-            run_date=at,                                    # The datetime at which the job will run
+            trigger=DateTrigger(run_date=at),               # Trigger type is 'date' for one-time execution
             id=f"resume_scheduler_at_{at.isoformat()}",     # Unique job ID based on the datetime
             name=f"Resume Scheduler at {at.isoformat()}",   # Descriptive name for the job
             replace_existing=True                           # Replace any existing job with the same ID
@@ -1105,8 +1064,7 @@ class Scheduler(ISchedule):
         # Add a job to the scheduler to shut it down at the specified datetime
         self.__scheduler.add_job(
             func=self.__scheduler.shutdown,                 # Function to shut down the scheduler
-            trigger='date',                                 # Trigger type is 'date' for one-time execution
-            run_date=at,                                    # The datetime at which the job will run
+            trigger=DateTrigger(run_date=at),               # Trigger type is 'date' for one-time execution
             id=f"shutdown_scheduler_at_{at.isoformat()}",   # Unique job ID based on the datetime
             name=f"Shutdown Scheduler at {at.isoformat()}", # Descriptive name for the job
             replace_existing=True                           # Replace any existing job with the same ID
@@ -1245,6 +1203,8 @@ class Scheduler(ISchedule):
 
             # Log the successful pausing of the job
             self.__logger.info(f"Job '{signature}' has been paused.")
+
+            # Return True to indicate the job was successfully paused
             return True
 
         except Exception:
@@ -1288,6 +1248,8 @@ class Scheduler(ISchedule):
 
             # Log the successful resumption of the job
             self.__logger.info(f"Job '{signature}' has been resumed.")
+
+            # Return True to indicate the job was successfully resumed
             return True
 
         except Exception:
@@ -1339,6 +1301,8 @@ class Scheduler(ISchedule):
 
             # Log the successful removal of the job
             self.__logger.info(f"Job '{signature}' has been removed from the scheduler.")
+
+            # Return True to indicate the job was successfully removed
             return True
 
         except Exception:

{orionis-0.516.0 → orionis-0.518.0}/orionis/metadata/framework.py

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

{orionis-0.516.0 → orionis-0.518.0/orionis.egg-info}/PKG-INFO

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