orionis 0.482.0__tar.gz → 0.484.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.482.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.484.0/orionis/console/commands/scheduler_list.py

@@ -0,0 +1,139 @@
+import importlib
+import os
+from pathlib import Path
+from rich.console import Console
+from rich.panel import Panel
+from rich.table import Table
+from orionis.console.base.command import BaseCommand
+from orionis.console.contracts.schedule import ISchedule
+from orionis.console.exceptions import CLIOrionisRuntimeError
+from orionis.foundation.contracts.application import IApplication
+
+class ScheduleListCommand(BaseCommand):
+    """
+    Command class to display usage information for the Orionis CLI.
+
+    Methods
+    -------
+    handle(orionis: IApplication, console: Console) -> bool
+        Displays a table of scheduled tasks defined in the application.
+        Imports the scheduler module, retrieves scheduled jobs, and prints them
+        in a formatted table using the rich library.
+
+    Returns
+    -------
+    bool
+        Returns True if the scheduled jobs are listed successfully or if no jobs are found.
+        Raises CLIOrionisRuntimeError if an error occurs during execution.
+    """
+
+    # Indicates whether timestamps will be shown in the command output
+    timestamps: bool = False
+
+    # Command signature and description
+    signature: str = "schedule:list"
+
+    # Command description
+    description: str = "Executes the scheduled tasks defined in the application."
+
+    def handle(self, orionis: IApplication, console: Console) -> bool:
+        """
+        Displays a table of scheduled jobs defined in the application.
+
+        This method dynamically imports the scheduler module, retrieves the list of
+        scheduled jobs using the ISchedule service, and prints the jobs in a formatted
+        table. If no jobs are found, a message is displayed. Handles and reports errors
+        encountered during the process.
+
+        Parameters
+        ----------
+        orionis : IApplication
+            The application instance providing configuration and service resolution.
+        console : Console
+            The rich Console instance used for output.
+
+        Returns
+        -------
+        bool
+            Returns True if the scheduled jobs are listed successfully or if no jobs are found.
+            Raises CLIOrionisRuntimeError if an error occurs during execution.
+        """
+
+        try:
+
+            # Get the absolute path of the scheduler from the application configuration
+            scheduler_path = orionis.path('console_scheduler')
+
+            # Get the base path from the current working directory
+            base_path = Path(os.getcwd()).resolve()
+            scheduler_path = Path(scheduler_path).resolve()
+            rel_path = scheduler_path.relative_to(base_path)
+
+            # Convert the path to a module name (replace separators with dots, remove .py)
+            module_name = ".".join(rel_path.with_suffix('').parts)
+
+            # Dynamically import the scheduler module
+            scheduler_module = importlib.import_module(module_name)
+
+            # Retrieve the Scheduler class from the imported module
+            Scheduler = getattr(scheduler_module, "Scheduler", None)
+
+            # Raise an error if the Scheduler class is not found
+            if Scheduler is None:
+                raise CLIOrionisRuntimeError(f"Scheduler class not found in module {module_name}")
+
+            # Retrieve the 'tasks' method from the Scheduler class
+            task_method = getattr(Scheduler, "tasks", None)
+
+            # Raise an error if the 'tasks' method is not found
+            if task_method is None:
+                raise CLIOrionisRuntimeError(f"Method 'tasks' not found in Scheduler class in module {module_name}")
+
+            # Create an instance of ISchedule using the application container
+            schedule_serice: ISchedule = orionis.make(ISchedule)
+
+            # Initialize the scheduled tasks by calling the 'tasks' method
+            task_method(schedule_serice)
+
+            # Retrieve the list of scheduled jobs/events
+            list_tasks = schedule_serice.events()
+
+            # Display a message if no scheduled jobs are found
+            if not list_tasks:
+                console.line()
+                console.print(Panel("No scheduled jobs found.", border_style="green"))
+                console.line()
+                return True
+
+            # Create and configure a table to display scheduled jobs
+            table = Table(title="Scheduled Jobs", show_lines=True)
+            table.add_column("Signature", style="cyan", no_wrap=True)
+            table.add_column("Arguments", style="magenta")
+            table.add_column("Purpose", style="green")
+            table.add_column("Random Delay", style="yellow")
+            table.add_column("Start Date", style="white")
+            table.add_column("End Date", style="white")
+            table.add_column("Details", style="dim")
+
+            # Populate the table with job details
+            for job in list_tasks:
+                signature = str(job.get("signature", ""))
+                args = ", ".join(map(str, job.get("args", [])))
+                purpose = str(job.get("purpose", ""))
+                random_delay = str(job.get("random_delay", ""))
+                start_date = str(job.get("start_date", "")) if job.get("start_date") else "-"
+                end_date = str(job.get("end_date", "")) if job.get("end_date") else "-"
+                details = str(job.get("details", ""))
+
+                table.add_row(signature, args, purpose, random_delay, start_date, end_date, details)
+
+            # Print the table to the console
+            console.line()
+            console.print(table)
+            console.line()
+            return True
+
+        except Exception as exc:
+
+            # Catch any unexpected exceptions and raise as a CLIOrionisRuntimeError
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred while clearing the cache: {exc}")

orionis-0.484.0/orionis/console/commands/scheduler_work.py

@@ -0,0 +1,141 @@
+import importlib
+import os
+from datetime import datetime
+from pathlib import Path
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+from orionis.console.base.command import BaseCommand
+from orionis.console.contracts.schedule import ISchedule
+from orionis.console.exceptions import CLIOrionisRuntimeError
+from orionis.foundation.contracts.application import IApplication
+
+class ScheduleWorkCommand(BaseCommand):
+    """
+    Executes the scheduled tasks defined in the application's scheduler.
+
+    This command dynamically loads the scheduler module specified in the application's configuration,
+    retrieves the `Scheduler` class and its `tasks` method, registers the scheduled tasks with the
+    ISchedule service, and starts the scheduler worker. It provides user feedback via the console and
+    handles errors by raising CLIOrionisRuntimeError exceptions.
+
+    Parameters
+    ----------
+    orionis : IApplication
+        The application instance providing configuration and service resolution.
+    console : Console
+        The Rich console instance used for displaying output to the user.
+
+    Returns
+    -------
+    bool
+        Returns True if the scheduler worker starts successfully. If an error occurs during the process,
+        a CLIOrionisRuntimeError is raised.
+
+    Raises
+    ------
+    CLIOrionisRuntimeError
+        If the scheduler module, class, or tasks method cannot be found, or if any unexpected error occurs.
+    """
+
+    # Indicates whether timestamps will be shown in the command output
+    timestamps: bool = False
+
+    # Command signature and description
+    signature: str = "schedule:work"
+
+    # Command description
+    description: str = "Executes the scheduled tasks defined in the application."
+
+    async def handle(self, orionis: IApplication, console: Console) -> bool:
+        """
+        Executes the scheduled tasks defined in the application's scheduler.
+
+        This method dynamically loads the scheduler module specified in the application's configuration,
+        retrieves the `Scheduler` class and its `tasks` method, registers the scheduled tasks with the
+        ISchedule service, and starts the scheduler worker. It provides user feedback via the console and
+        handles errors by raising CLIOrionisRuntimeError exceptions.
+
+        Parameters
+        ----------
+        orionis : IApplication
+            The application instance providing configuration and service resolution.
+        console : Console
+            The Rich console instance used for displaying output to the user.
+
+        Returns
+        -------
+        bool
+            Returns True if the scheduler worker starts successfully. If an error occurs during the process,
+            a CLIOrionisRuntimeError is raised.
+
+        Raises
+        ------
+        CLIOrionisRuntimeError
+            If the scheduler module, class, or tasks method cannot be found, or if any unexpected error occurs.
+        """
+        try:
+            # Get the absolute path to the scheduler module from the application configuration
+            scheduler_path = orionis.path('console_scheduler')
+
+            # Resolve the base path (current working directory)
+            base_path = Path(os.getcwd()).resolve()
+            scheduler_path = Path(scheduler_path).resolve()
+
+            # Compute the relative path from the base path to the scheduler module
+            rel_path = scheduler_path.relative_to(base_path)
+
+            # Convert the relative path to a Python module name (dot notation, no .py extension)
+            module_name = ".".join(rel_path.with_suffix('').parts)
+
+            # Dynamically import the scheduler module
+            scheduler_module = importlib.import_module(module_name)
+
+            # Retrieve the Scheduler class from the imported module
+            Scheduler = getattr(scheduler_module, "Scheduler", None)
+            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:
+                raise CLIOrionisRuntimeError(f"Method 'tasks' not found in Scheduler class in module {module_name}")
+
+            # Create an instance of the ISchedule service
+            schedule_serice: ISchedule = orionis.make(ISchedule)
+
+            # 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')
+            panel_content = Text.assemble(
+                (" Orionis Scheduler Worker ", "bold white on green"),
+                ("\n\n", ""),
+                ("The scheduled tasks worker has started successfully.\n", "white"),
+                (f"Started at: {start_time}\n", "dim"),
+                ("To stop the worker, press ", "white"),
+                ("Ctrl+C", "bold yellow"),
+                (".", "white")
+            )
+            console.print(
+                Panel(panel_content, border_style="green", padding=(1, 2))
+            )
+            console.line()
+
+            # Start the scheduler worker asynchronously
+            await schedule_serice.start()
+            return True
+
+        except Exception as exc:
+            # Raise any unexpected exceptions as CLIOrionisRuntimeError
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred while clearing the cache: {exc}")

{orionis-0.482.0 → orionis-0.484.0}/orionis/console/core/reactor.py

@@ -112,6 +112,7 @@ class Reactor(IReactor):
         from orionis.console.commands.workflow import WorkFlowGithubCommand
         from orionis.console.commands.cache import CacheClearCommand
         from orionis.console.commands.scheduler_work import ScheduleWorkCommand
+        from orionis.console.commands.scheduler_list import ScheduleListCommand
 
         # List of core command classes to load (extend this list as more core commands are added)
         core_commands = [
@@ -121,7 +122,8 @@ class Reactor(IReactor):
             PublisherCommand,
             WorkFlowGithubCommand,
             CacheClearCommand,
-            ScheduleWorkCommand
+            ScheduleWorkCommand,
+            ScheduleListCommand
         ]
 
         # Iterate through the core command classes and register them

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.482.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.482.0 → orionis-0.484.0}/orionis/metadata/framework.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.482.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.482.0 → orionis-0.484.0}/orionis.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ orionis/console/commands/__init__.py
 orionis/console/commands/cache.py
 orionis/console/commands/help.py
 orionis/console/commands/publisher.py
+orionis/console/commands/scheduler_list.py
 orionis/console/commands/scheduler_work.py
 orionis/console/commands/test.py
 orionis/console/commands/version.py
@@ -43,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