orionis 0.565.0__tar.gz → 0.567.0__tar.gz

{orionis-0.565.0/orionis.egg-info → orionis-0.567.0}/PKG-INFO

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

{orionis-0.565.0 → orionis-0.567.0}/orionis/console/base/scheduler.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from orionis.console.contracts.base_scheduler import IBaseScheduler
 from orionis.console.contracts.schedule import ISchedule
-from orionis.console.entities.job_error import JobError
+from orionis.console.entities.scheduler_error import SchedulerError
 from orionis.console.entities.scheduler_paused import SchedulerPaused
 from orionis.console.entities.scheduler_resumed import SchedulerResumed
 from orionis.console.entities.scheduler_shutdown import SchedulerShutdown
@@ -163,17 +163,17 @@ class BaseScheduler(IBaseScheduler):
         """
         pass
 
-    async def onError(self, event: JobError, schedule: ISchedule):
+    async def onError(self, event: SchedulerError, 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`
+        This method is invoked when a job fails due to an exception. It processes the `SchedulerError`
         event and performs any necessary actions, such as logging the error details or notifying
         relevant systems about the failure.
 
         Parameters
         ----------
-        event : JobError
+        event : SchedulerError
             The event object containing details about the job error, including the job ID,
             the exception that occurred, and any relevant metadata.
         schedule : ISchedule

{orionis-0.565.0 → orionis-0.567.0}/orionis/console/contracts/base_scheduler.py

@@ -1,6 +1,6 @@
 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_error import SchedulerError
 from orionis.console.entities.scheduler_paused import SchedulerPaused
 from orionis.console.entities.scheduler_resumed import SchedulerResumed
 from orionis.console.entities.scheduler_shutdown import SchedulerShutdown
@@ -157,17 +157,17 @@ class IBaseScheduler(ABC):
         pass
 
     @abstractmethod
-    async def onError(self, event: JobError, schedule: ISchedule):
+    async def onError(self, event: SchedulerError, 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`
+        This method is invoked when a job fails due to an exception. It processes the `SchedulerError`
         event and performs any necessary actions, such as logging the error details or notifying
         relevant systems about the failure.
 
         Parameters
         ----------
-        event : JobError
+        event : SchedulerError
             The event object containing details about the job error, including the job ID,
             the exception that occurred, and any relevant metadata.
         schedule : ISchedule

{orionis-0.565.0 → orionis-0.567.0}/orionis/console/entities/command.py

@@ -12,14 +12,16 @@ class Command(BaseEntity):
     ----------
     obj : Type
         The type or class associated with the command.
-    timestamps : bool
-        Whether timestamps are enabled for this command.
+    method : str, optional
+        The method name to be invoked on the object. Defaults to 'hanldle'.
+    timestamps : bool, optional
+        Whether timestamps are enabled for this command. Defaults to True.
     signature : str
         The signature string representing the command usage.
     description : str
         A brief description of what the command does.
     args : Optional[argparse.ArgumentParser], optional
-        Optional argument parser for command-line arguments.
+        Optional argument parser for command-line arguments. Defaults to None.
 
     Returns
     -------
@@ -30,11 +32,11 @@ class Command(BaseEntity):
     # The type or class associated with the command
     obj: Type
 
-    # The method name to be invoked on the object
+    # The method name to be invoked on the object (default: 'hanldle')
     method: str = 'hanldle'
 
-    # Indicates if timestamps are enabled for this command
-    timestamps: bool
+    # Indicates if timestamps are enabled for this command (default: True)
+    timestamps: bool = True
 
     # The command usage signature
     signature: str
@@ -42,5 +44,5 @@ class Command(BaseEntity):
     # Description of the command's purpose
     description: str
 
-    # Optional argument parser for command-line arguments
+    # Optional argument parser for command-line arguments (default: None)
     args: Optional[argparse.ArgumentParser] = None

{orionis-0.565.0 → orionis-0.567.0}/orionis/console/entities/event.py

@@ -9,30 +9,37 @@ from orionis.console.contracts.schedule_event_listener import IScheduleEventList
 @dataclass(kw_only=True)
 class Event:
     """
-    Represents an event with scheduling and execution details.
+    Represents a scheduled event with configuration for execution, timing, and event handling.
 
-    Attributes
+    Parameters
     ----------
     signature : str
-        The unique identifier or signature of the event, used to distinguish it from other events.
-    args : Optional[List[str]]
-        A list of arguments associated with the event. Defaults to an empty list if not provided.
-    purpose : Optional[str]
-        A brief description of the event's purpose or intent. Can be None if not specified.
-    random_delay : Optional[int]
-        An optional random delay (in seconds) to be applied before the event is triggered. Can be None.
-    start_date : Optional[datetime]
-        The start date and time for the event. If None, the event starts immediately or based on the trigger.
-    end_date : Optional[datetime]
-        The end date and time for the event. If None, the event does not have a defined end time.
-    trigger : Optional[Union[CronTrigger, DateTrigger, IntervalTrigger]]
-        The trigger mechanism for the event, which determines when and how the event is executed.
-        Can be a CronTrigger, DateTrigger, or IntervalTrigger. Defaults to None.
-    details : Optional[str]
-        Additional details or metadata about the event. Can be None if not specified.
-    listener : Optional[IScheduleEventListener]
-        An optional listener object that implements the IScheduleEventListener interface.
-        This listener can handle event-specific logic. Defaults to None.
+        Unique identifier or signature for the event.
+    args : Optional[List[str]], default: []
+        List of arguments to be passed to the event.
+    purpose : Optional[str], default: None
+        Short description of the event's purpose.
+    random_delay : Optional[int], default: None
+        Random delay in seconds before the event is triggered.
+    start_date : Optional[datetime], default: None
+        The date and time when the event becomes active.
+    end_date : Optional[datetime], default: None
+        The date and time when the event is no longer active.
+    trigger : Optional[Union[CronTrigger, DateTrigger, IntervalTrigger]], default: None
+        Trigger mechanism that determines when the event is executed.
+    details : Optional[str], default: None
+        Additional metadata or information about the event.
+    listener : Optional[IScheduleEventListener], default: None
+        Listener object implementing IScheduleEventListener for event-specific logic.
+    max_instances : int, default: 1
+        Maximum number of concurrent instances allowed for the event.
+    misfire_grace_time : Optional[int], default: None
+        Grace period in seconds for handling misfired events.
+
+    Returns
+    -------
+    Event
+        An instance of the Event class with the specified configuration.
     """
 
     # Unique identifier for the event
@@ -66,4 +73,4 @@ class Event:
     max_instances: int = 1
 
     # Grace time in seconds for misfired events
-    misfire_grace_time : Optional[int] = None
+    misfire_grace_time: Optional[int] = None

orionis-0.567.0/orionis/console/entities/event_job.py

@@ -0,0 +1,74 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Callable, Optional, Tuple
+
+@dataclass(kw_only=True)
+class EventJob:
+    """
+    Represents the main properties and configuration of a scheduled job in APScheduler.
+
+    Parameters
+    ----------
+    id : str
+        Unique identifier for the job.
+    code : int, optional
+        Numeric code representing the job status or type. Defaults to 0.
+    name : Optional[str], optional
+        Human-readable name for the job. Defaults to None.
+    func : Callable[..., Any], optional
+        The function or coroutine to be executed by the job. Defaults to None.
+    args : Tuple[Any, ...], optional
+        Positional arguments to be passed to the function. Defaults to empty tuple.
+    trigger : Any, optional
+        The trigger that determines the job's execution schedule (e.g., IntervalTrigger, CronTrigger). Defaults to None.
+    executor : str, optional
+        Alias of the executor that will run the job. Defaults to 'default'.
+    jobstore : str, optional
+        Alias of the job store where the job is stored. Defaults to 'default'.
+    misfire_grace_time : Optional[int], optional
+        Grace period in seconds for handling missed executions. If None, no grace period is applied. Defaults to None.
+    max_instances : int, optional
+        Maximum number of concurrent instances of the job allowed. Defaults to 1.
+    coalesce : bool, optional
+        Whether to merge pending executions into a single execution. Defaults to False.
+    next_run_time : Optional[datetime], optional
+        The next scheduled execution time of the job. Can be None if the job is paused or unscheduled. Defaults to None.
+    exception : Optional[BaseException], optional
+        Exception raised during the last job execution, if any. Defaults to None.
+    traceback : Optional[str], optional
+        String representation of the traceback if an exception occurred. Defaults to None.
+    retval : Optional[Any], optional
+        Return value from the last job execution. Defaults to None.
+    purpose : Optional[str], optional
+        Description of the job's purpose. Defaults to None.
+    start_date : Optional[datetime], optional
+        The earliest possible run time for the job. Defaults to None.
+    end_date : Optional[datetime], optional
+        The latest possible run time for the job. Defaults to None.
+    details : Optional[str], optional
+        Additional details or metadata about the job. Defaults to None.
+
+    Returns
+    -------
+    None
+        This class is a data container and does not return any value upon instantiation.
+    """
+    id: str                                         # Unique identifier for the job
+    code: int = 0                                   # Numeric code for job status/type
+    name: Optional[str] = None                      # Human-readable job name
+    func: Callable[..., Any] = None                 # Function or coroutine to execute
+    args: Tuple[Any, ...] = ()                      # Positional arguments for the function
+    trigger: Any = None                             # Scheduling trigger (e.g., interval, cron)
+    executor: str = 'default'                       # Executor alias
+    jobstore: str = 'default'                       # Job store alias
+    misfire_grace_time: Optional[int] = None        # Grace period for missed executions
+    max_instances: int = 1                          # Max concurrent job instances
+    coalesce: bool = False                          # Merge pending executions if True
+    next_run_time: Optional[datetime] = None        # Next scheduled execution time
+    exception: Optional[BaseException] = None       # Exception from last execution
+    traceback: Optional[str] = None                 # Traceback string if exception occurred
+    retval: Optional[Any] = None                    # Return value from last execution
+    purpose: Optional[str] = None                   # Description of job's purpose
+    start_date: Optional[datetime] = None           # Earliest run time
+    end_date: Optional[datetime] = None             # Latest run time
+    details: Optional[str] = None                   # Additional job details or metadata

orionis-0.567.0/orionis/console/entities/scheduler_error.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass
+from typing import Optional
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerError(SchedulerEventData):
+    """
+    Represents an error event triggered by the scheduler.
+
+    This data class extends `SchedulerEventData` and is used to encapsulate
+    information related to errors that occur during scheduler operations.
+    It stores the exception that caused the error and the associated traceback
+    for debugging and logging purposes.
+
+    Attributes
+    ----------
+    exception : Optional[BaseException]
+        The exception instance that caused the scheduler error, if any.
+    traceback : Optional[str]
+        The traceback string providing details about where the error occurred.
+
+    Returns
+    -------
+    SchedulerError
+        An instance containing details about the scheduler error event.
+    """
+
+    # Exception that caused the scheduler error, if present
+    exception: Optional[BaseException] = None
+
+    # Traceback information related to the scheduler error, if available
+    traceback: Optional[str] = None

orionis-0.567.0/orionis/console/entities/scheduler_event_data.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+
+@dataclass(kw_only=True)
+class SchedulerEventData:
+    """
+    Base data structure for scheduler-related events.
+
+    This class encapsulates information about events that occur within the scheduler system.
+    It provides a numeric event code to identify the event type and can be extended for
+    additional context as needed.
+
+    Parameters
+    ----------
+    code : int
+        Numeric code that uniquely identifies the type of event within the scheduler system.
+
+    Returns
+    -------
+    SchedulerEventData
+        An instance of SchedulerEventData containing the event code.
+    """
+
+    # Numeric code representing the type of event
+    code: int

orionis-0.567.0/orionis/console/entities/scheduler_paused.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerPaused(SchedulerEventData):
+    """
+    Represents an event triggered when the scheduler is paused.
+
+    This data class extends `SchedulerEventData` and encapsulates information
+    related to the scheduler pause event, such as the time at which the pause occurred.
+
+    Attributes
+    ----------
+    time : str
+        The time when the scheduler was paused, formatted as a string.
+    (Other attributes are inherited from SchedulerEventData.)
+
+    Returns
+    -------
+    SchedulerPaused
+        An instance of SchedulerPaused containing information about the pause event.
+    """
+
+    # The time when the scheduler was paused
+    time: str

orionis-0.567.0/orionis/console/entities/scheduler_resumed.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerResumed(SchedulerEventData):
+    """
+    Represents an event triggered when the scheduler is resumed.
+
+    This data class extends `SchedulerEventData` and is used to encapsulate
+    information about the scheduler's resumption event.
+
+    Attributes
+    ----------
+    time : str
+        The time when the scheduler was resumed.
+
+    Returns
+    -------
+    SchedulerResumed
+        An instance containing information about the resumed scheduler event.
+    """
+
+    # The time when the scheduler was resumed
+    time: str

orionis-0.567.0/orionis/console/entities/scheduler_shutdown.py

@@ -0,0 +1,31 @@
+from dataclasses import dataclass, field
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerShutdown(SchedulerEventData):
+    """
+    Represents an event triggered when the scheduler shuts down.
+
+    This class extends `SchedulerEventData` and is used to encapsulate
+    information related to the shutdown of the scheduler, such as the
+    shutdown time and the list of tasks present at shutdown.
+
+    Attributes
+    ----------
+    time : str
+        The time when the scheduler was shut down.
+    tasks : list
+        The list of tasks that were scheduled at the time of shutdown.
+
+    Returns
+    -------
+    SchedulerShutdown
+        An instance representing the scheduler shutdown event, containing
+        the shutdown time and the list of scheduled tasks.
+    """
+
+    # The time when the scheduler was shut down
+    time: str = ""
+
+    # List of tasks scheduled at the time of shutdown
+    tasks: list = field(default_factory=list)

orionis-0.567.0/orionis/console/entities/scheduler_started.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass, field
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerStarted(SchedulerEventData):
+    """
+    Represents the event data generated when the scheduler starts.
+
+    This data class extends `SchedulerEventData` and encapsulates information
+    about the scheduler's start event, such as the start time and the list of
+    tasks scheduled at that moment.
+
+    Attributes
+    ----------
+    time : str
+        The time when the scheduler started.
+    tasks : list
+        The list of tasks that were scheduled at the time the scheduler started.
+
+    Returns
+    -------
+    SchedulerStarted
+        An instance containing the scheduler start event data.
+    """
+
+    # The time when the scheduler started
+    time: str = ""
+
+    # List of tasks scheduled at the time of start
+    tasks: list = field(default_factory=list)

orionis-0.567.0/orionis/console/stub/command.stub

@@ -0,0 +1,42 @@
+from orionis.console.base.command import BaseCommand
+from orionis.console.args.argument import CLIArgument
+from orionis.console.exceptions.cli_runtime_error import CLIOrionisRuntimeError
+
+class {{class_name}}(BaseCommand):
+    """
+    Command: {{signature}}
+    {{description}}
+    """
+
+    # Enable timestamps
+    timestamps: bool = True
+
+    # Command signature
+    signature: str = "{{signature}}"
+
+    # Command description
+    description: str = "{{description}}"
+
+    # Arguments (edit as needed)
+    arguments = [
+        CLIArgument(
+            flags=["--example", "-e"],
+            type=str,
+            help="Example argument for {{class_name}}",
+            default=None,
+            required=False,
+            metavar="EXAMPLE",
+            dest="example",
+            action="store",
+        ),
+    ]
+
+    async def handle(self, *args, **kwargs) -> None:
+        try:
+            self.textSuccessBold("{{class_name}} executed successfully!")
+            example_value = self.argument("example")
+            if example_value:
+                self.info(f"Received argument: {example_value}")
+
+        except Exception as e:
+            raise CLIOrionisRuntimeError(f"An error occurred: {str(e)}") from e

{orionis-0.565.0 → orionis-0.567.0}/orionis/console/stub/listener.stub

@@ -40,24 +40,6 @@ class {{name-listener}}(BaseScheduleEventListener):
         """
         pass
 
-    async def onSuccess(self, event: EventJob, schedule: ISchedule) -> None:
-        """
-        Called when a job is successfully executed.
-
-        Parameters
-        ----------
-        event : EventJob
-            The event containing details about the successful job execution.
-        schedule : ISchedule
-            The associated schedule instance managing the job.
-
-        Returns
-        -------
-        None
-            This method does not return any value.
-        """
-        pass
-
     async def onFailure(self, event: EventJob, schedule: ISchedule) -> None:
         """
         Called when a job execution fails.

{orionis-0.565.0 → orionis-0.567.0}/orionis/foundation/providers/dumper_provider.py

@@ -1,4 +1,4 @@
-from orionis.console.dumper.dump import Debug
+from orionis.console.dumper.debug import Debug
 from orionis.console.contracts.debug import IDebug
 from orionis.container.providers.service_provider import ServiceProvider
 

{orionis-0.565.0 → orionis-0.567.0}/orionis/metadata/framework.py

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

{orionis-0.565.0 → orionis-0.567.0}/orionis/test/output/dumper.py

@@ -1,6 +1,6 @@
 import os
 import sys
-from orionis.console.dumper.dump import Debug
+from orionis.console.dumper.debug import Debug
 from orionis.test.exceptions import OrionisTestRuntimeError
 from orionis.test.contracts.dumper import ITestDumper
 

{orionis-0.565.0 → orionis-0.567.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.565.0 → orionis-0.567.0}/orionis.egg-info/SOURCES.txt

@@ -45,29 +45,13 @@ orionis/console/contracts/schedule_event_listener.py
 orionis/console/core/__init__.py
 orionis/console/core/reactor.py
 orionis/console/dumper/__init__.py
-orionis/console/dumper/dump.py
+orionis/console/dumper/debug.py
 orionis/console/dynamic/__init__.py
 orionis/console/dynamic/progress_bar.py
 orionis/console/entities/__init__.py
-orionis/console/entities/all_jobs_removed.py
 orionis/console/entities/command.py
 orionis/console/entities/event.py
 orionis/console/entities/event_job.py
-orionis/console/entities/executor_added.py
-orionis/console/entities/executor_removed.py
-orionis/console/entities/job_added.py
-orionis/console/entities/job_error.py
-orionis/console/entities/job_event_data.py
-orionis/console/entities/job_executed.py
-orionis/console/entities/job_max_instances.py
-orionis/console/entities/job_missed.py
-orionis/console/entities/job_modified.py
-orionis/console/entities/job_pause.py
-orionis/console/entities/job_removed.py
-orionis/console/entities/job_resume.py
-orionis/console/entities/job_store_added.py
-orionis/console/entities/job_store_removed.py
-orionis/console/entities/job_submitted.py
 orionis/console/entities/scheduler_error.py
 orionis/console/entities/scheduler_event_data.py
 orionis/console/entities/scheduler_paused.py

orionis-0.565.0/orionis/console/entities/all_jobs_removed.py

@@ -1,23 +0,0 @@
-from dataclasses import dataclass
-from orionis.console.entities.scheduler_event_data import SchedulerEventData
-
-@dataclass(kw_only=True)
-class AllJobsRemoved(SchedulerEventData):
-    """
-    Represents an event triggered when all jobs are removed from a specific job store.
-
-    This event is typically used to notify that a job store has been cleared of all its jobs.
-
-    Attributes
-    ----------
-    jobstore : str
-        The alias or identifier of the job store from which all jobs were removed.
-
-    Returns
-    -------
-    None
-        This class does not return a value; it is used to encapsulate event data.
-    """
-
-    # The alias of the job store from which jobs were removed
-    jobstore: str

orionis-0.565.0/orionis/console/entities/event_job.py

@@ -1,60 +0,0 @@
-from dataclasses import dataclass
-from datetime import datetime
-from typing import Any, Callable, Optional, Tuple
-
-@dataclass(kw_only=True)
-class EventJob:
-    """
-    Represents the main properties of a job in APScheduler.
-
-    Attributes
-    ----------
-    id : str
-        Unique identifier for the job.
-    name : Optional[str]
-        Human-readable name for the job. Can be None if not specified.
-    func : Callable[..., Any]
-        The function or coroutine to be executed by the job.
-    args : Tuple[Any, ...]
-        Positional arguments to be passed to the function.
-    trigger : Any
-        The trigger that determines the job's execution schedule
-        (e.g., IntervalTrigger, CronTrigger, etc.).
-    executor : str
-        Alias of the executor that will run the job.
-    jobstore : str
-        Alias of the job store where the job is stored.
-    misfire_grace_time : Optional[int]
-        Grace period in seconds for handling missed executions.
-        If None, no grace period is applied.
-    max_instances : int
-        Maximum number of concurrent instances of the job allowed.
-    coalesce : bool
-        Whether to merge pending executions into a single execution.
-    next_run_time : Optional[datetime]
-        The next scheduled execution time of the job. Can be None if the job is paused or unscheduled.
-
-    Returns
-    -------
-    None
-        This class is a data container and does not return any value.
-    """
-    id: str
-    code: int = 0
-    name: Optional[str] = None
-    func: Callable[..., Any] = None
-    args: Tuple[Any, ...] = ()
-    trigger: Any = None
-    executor: str = 'default'
-    jobstore: str = 'default'
-    misfire_grace_time: Optional[int] = None
-    max_instances: int = 1
-    coalesce: bool = False
-    next_run_time: Optional[datetime] = None
-    exception: Optional[BaseException] = None
-    traceback: Optional[str] = None
-    retval: Optional[Any] = None
-    purpose: Optional[str] = None
-    start_date: Optional[datetime] = None
-    end_date: Optional[datetime] = None
-    details: Optional[str] = None