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

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/console/commands/scheduler_work.py

@@ -1,18 +1,41 @@
 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
-from rich.console import Console
-from rich.panel import Panel
-from rich.text import Text
-from datetime import datetime
 
 class ScheduleWorkCommand(BaseCommand):
     """
-    Command class to display usage information for the Orionis CLI.
+    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
@@ -25,44 +48,66 @@ class ScheduleWorkCommand(BaseCommand):
     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:
-
-            # Obtener la ruta absoluta del scheduler desde la configuración de la aplicación
+            # Get the absolute path to the scheduler module from the application configuration
             scheduler_path = orionis.path('console_scheduler')
 
-            # Obtener la base path desde la variable de entorno o desde la configuración local
+            # 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)
 
-            # Reemplazar los separadores por puntos y quitar la extensión .py
+            # Convert the relative path to a Python module name (dot notation, no .py extension)
             module_name = ".".join(rel_path.with_suffix('').parts)
 
-            # Importar el módulo del scheduler
+            # Dynamically import the scheduler module
             scheduler_module = importlib.import_module(module_name)
 
-            # Obtener la clase Scheduler del módulo importado
+            # Retrieve the Scheduler class from the imported module
             Scheduler = getattr(scheduler_module, "Scheduler", None)
-
-            # Check if the Scheduler class was found
             if Scheduler is None:
                 raise CLIOrionisRuntimeError(f"Scheduler class not found in module {module_name}")
 
-            # Obtener el método tasks de la clase Scheduler
+            # Retrieve the 'tasks' method from the Scheduler class
             task_method = getattr(Scheduler, "tasks", None)
-
-            # Check if the method exists
             if task_method is None:
                 raise CLIOrionisRuntimeError(f"Method 'tasks' not found in Scheduler class in module {module_name}")
 
-            # Crear una instancia de ISchedule
+            # Create an instance of the ISchedule service
             schedule_serice: ISchedule = orionis.make(ISchedule)
 
-            # Inicializar el metodo
+            # Register scheduled tasks using the Scheduler's tasks method
             task_method(schedule_serice)
 
-            # Display a professional start message for the scheduler worker
+            # 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(
@@ -79,10 +124,10 @@ class ScheduleWorkCommand(BaseCommand):
             )
             console.line()
 
-            # Iniciar el scheduler
+            # Start the scheduler worker asynchronously
             await schedule_serice.start()
+            return True
 
         except Exception as exc:
-
-            # Catch any unexpected exceptions and raise as a CLIOrionisRuntimeError
+            # Raise any unexpected exceptions as CLIOrionisRuntimeError
             raise CLIOrionisRuntimeError(f"An unexpected error occurred while clearing the cache: {exc}")

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/metadata/framework.py

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

{orionis-0.482.0.dist-info → orionis-0.483.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orionis
-Version: 0.482.0
+Version: 0.483.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.dist-info → orionis-0.483.0.dist-info}/RECORD

@@ -14,7 +14,8 @@ orionis/console/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 orionis/console/commands/cache.py,sha256=8DsYoRzSBLn0P9qkGVItRbo0R6snWBDBg0_Xa7tmVhs,2322
 orionis/console/commands/help.py,sha256=ooPoenP08ArMAWiL89_oUGD9l1Faen2QjLTG90i4zCQ,3187
 orionis/console/commands/publisher.py,sha256=FUg-EUzK7LLXsla10ZUZro8V0Z5S-KjmsaSdRHSSGbA,21381
-orionis/console/commands/scheduler_work.py,sha256=768TntiL2dguqJ2BlMVR7zEx_xlE71CCDsZ57ZXu9As,3573
+orionis/console/commands/scheduler_list.py,sha256=SXaD1XJFV1bbyjlDuQhlHz2y1kW-VVCxQxuKJMtQRtA,5956
+orionis/console/commands/scheduler_work.py,sha256=cymbGHaLmwv2WtEenZTtm7iNVfs8gG8_oWXU18Jtzd0,5746
 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
@@ -24,7 +25,7 @@ orionis/console/contracts/kernel.py,sha256=mh4LlhEYHh3FuGZZQ0GBhD6ZLa5YQvaNj2r01
 orionis/console/contracts/reactor.py,sha256=Xeq7Zrw6WE5MV_XOQfiQEchAFbb6-0TjLpjWOxYW--g,4554
 orionis/console/contracts/schedule.py,sha256=eGjcOH7kgdf0fWDZRfOFUQsIx4E8G38ayX5JwpkpN8E,4977
 orionis/console/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/console/core/reactor.py,sha256=v_y3LDydBeKmtCfA0rIi8Nicy38DEfflp_zwx2OM7NQ,30257
+orionis/console/core/reactor.py,sha256=XE4VvUPnOSQ_qmkLMYEDfwKaqDZyFxCiVtoSJVqpk_M,30372
 orionis/console/dumper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/dumper/dump.py,sha256=CATERiQ6XuIrKQsDaWcVxzTtlAJI9qLJX44fQxEX8ws,22443
 orionis/console/dumper/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -199,7 +200,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=_5YbwWTtix0nrC_iOD_3NIidY-aj0jZHYz4I8YgV7ME,4109
+orionis/metadata/framework.py,sha256=Omguwj98GlVjFh8nCMjYoLHSqVMJ57Duo0GXurO-QLk,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
@@ -371,7 +372,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.482.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
+orionis-0.483.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
@@ -518,8 +519,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.482.0.dist-info/METADATA,sha256=G2omW6axkClb2bZufamTZKGAw4zPQPxlI-QGmAzf_VE,4801
-orionis-0.482.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-orionis-0.482.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.482.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-orionis-0.482.0.dist-info/RECORD,,
+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,,