orionis 0.511.0__py3-none-any.whl → 0.513.0__py3-none-any.whl

orionis/console/entities/job_executed.py

@@ -0,0 +1,31 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobExecuted(JobEventData):
+    """
+    Represents an event triggered when a job completes successfully.
+
+    This class is used to encapsulate information about a successfully executed job, 
+    including the time it was scheduled to run and the return value of the job function.
+
+    Attributes
+    ----------
+    scheduled_run_time : datetime
+        The datetime when the job was scheduled to execute.
+    retval : Any
+        The return value produced by the job function upon successful execution.
+
+    Returns
+    -------
+    JobExecuted
+        An instance of the `JobExecuted` class containing details about the executed job.
+    """
+
+    # The datetime when the job was scheduled to run
+    scheduled_run_time: datetime
+
+    # The return value of the job function
+    retval: Any

orionis/console/entities/job_max_instances.py

@@ -0,0 +1,27 @@
+from dataclasses import dataclass
+from datetime import datetime
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobMaxInstances(JobEventData):
+    """
+    Represents an event triggered when a job exceeds its maximum allowed instances.
+
+    This class is a specialized event data structure that inherits from `JobEventData`. 
+    It is used to capture and store information about the event when a job exceeds 
+    the maximum number of instances it is allowed to run.
+
+    Attributes
+    ----------
+    run_time : datetime
+        The datetime when the job was scheduled to run. This indicates the time 
+        the job was supposed to execute before exceeding the instance limit.
+
+    Returns
+    -------
+    JobMaxInstances
+        An instance of the `JobMaxInstances` class containing the event details.
+    """
+
+    # The time the job was scheduled to run
+    run_time: datetime

orionis/console/entities/job_missed.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+from datetime import datetime
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobMissed(JobEventData):
+    """
+    Represents an event triggered when a scheduled job run is missed due to scheduler constraints.
+
+    This class extends `JobEventData` and provides additional information about the missed job event, 
+    specifically the time the job was originally scheduled to run.
+
+    Attributes
+    ----------
+    scheduled_run_time : datetime
+        The datetime when the job was originally scheduled to execute.
+
+    Returns
+    -------
+    None
+        This class does not return a value; it is used to encapsulate event data.
+    """
+
+    # The datetime when the job was supposed to run but was missed
+    scheduled_run_time: datetime

orionis/console/entities/job_modified.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobModified(JobEventData):
+    """
+    Represents an event triggered when a job is modified in a job store.
+
+    This class is a data structure that extends `JobEventData` to provide
+    additional context or functionality specific to job modification events.
+
+    Attributes
+    ----------
+    (Inherited from JobEventData)
+
+    Returns
+    -------
+    None
+        This class does not return a value; it is used as a data container.
+    """
+
+    # This class inherits from JobEventData and does not add additional fields or methods.
+    # It serves as a specific type of event for job modifications.

orionis/console/entities/job_pause.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobPause(JobEventData):
+    """
+    Represents an event triggered when a job is paused in the job store.
+
+    This class extends `JobEventData` to provide additional context or
+    functionality specific to the pausing of a job.
+
+    Attributes
+    ----------
+    (Inherited from JobEventData)
+
+    Returns
+    -------
+    JobPause
+        An instance of the `JobPause` class representing the pause event.
+    """
+    # This class does not define additional attributes or methods.
+    # It serves as a specialized event type for job pausing.

orionis/console/entities/job_removed.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobRemoved(JobEventData):
+    """
+    Represents an event triggered when a job is removed from a job store.
+
+    This class extends `JobEventData` to provide additional context or 
+    functionality specific to the removal of a job.
+
+    Attributes
+    ----------
+    (Inherited from JobEventData)
+
+    Returns
+    -------
+    JobRemoved
+        An instance of the `JobRemoved` class representing the removal event.
+    """
+    # No additional attributes or methods are defined here; this class 
+    # serves as a specialized event type for job removal.

orionis/console/entities/job_resume.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobResume(JobEventData):
+    """
+    Represents an event triggered when a job is resumed from a paused state.
+
+    This class extends `JobEventData` to provide additional context or 
+    functionality specific to the resumption of a job.
+
+    Attributes
+    ----------
+    (Inherited from JobEventData)
+        All attributes from the parent class `JobEventData` are available 
+        in this class.
+
+    Returns
+    -------
+    JobResume
+        An instance of the `JobResume` class representing the resumption event.
+    """
+
+    # This class does not define additional attributes or methods.
+    # It serves as a specialized event type for job resumption.

orionis/console/entities/job_store_added.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class JobstoreAdded(SchedulerEventData):
+    """
+    Event triggered when a job store is added to the scheduler.
+
+    This event is used to notify that a new job store has been successfully added to the scheduler. 
+    It provides the alias of the added job store, which can be used to identify it.
+
+    Attributes
+    ----------
+    alias : str
+        The alias (name) of the added job store.
+
+    Returns
+    -------
+    None
+        This class does not return a value; it is used to encapsulate event data.
+    """
+
+    # The alias of the added job store
+    alias: str

orionis/console/entities/job_store_removed.py

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class JobstoreRemoved(SchedulerEventData):
+    """
+    Represents an event triggered when a job store is removed.
+
+    This event is typically used to notify the system or other components
+    that a specific job store has been removed, allowing for any necessary
+    cleanup or updates.
+
+    Attributes
+    ----------
+    alias : str
+        The alias (unique identifier) of the removed job store.
+
+    Returns
+    -------
+    None
+        This class does not return a value; it is used to encapsulate event data.
+    """
+
+    # The alias of the removed job store
+    alias: str

orionis/console/entities/job_submitted.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass
+from datetime import datetime
+from orionis.console.entities.job_event_data import JobEventData
+
+@dataclass(kw_only=True)
+class JobSubmitted(JobEventData):
+    """
+    Represents an event triggered when a job is submitted to an executor.
+
+    This class extends `JobEventData` and includes additional information 
+    about the scheduled execution time of the job.
+
+    Attributes
+    ----------
+    run_time : datetime
+        The datetime when the job is scheduled to run.
+
+    Returns
+    -------
+    None
+        This class does not return a value; it is used to encapsulate event data.
+    """
+    # The datetime when the job is scheduled to run
+    run_time: datetime

orionis/console/entities/scheduler_event_data.py

@@ -0,0 +1,33 @@
+from dataclasses import dataclass
+from typing import Optional
+
+@dataclass(kw_only=True)
+class SchedulerEventData:
+    """
+    Represents the data associated with scheduler-related events.
+
+    This class serves as a base structure for encapsulating information about
+    events occurring within the scheduler system. It includes a numeric event
+    code to identify the type of event and an optional alias for additional
+    context.
+
+    Attributes
+    ----------
+    code : int
+        A numeric code that uniquely identifies the type of event within the
+        scheduler system.
+    alias : str, optional
+        An optional string providing additional context or identifying specific
+        components (e.g., executors or job stores) related to the event.
+
+    Returns
+    -------
+    SchedulerEventData
+        An instance of the `SchedulerEventData` class containing the event code
+        and optional alias.
+    """
+    # Numeric code representing the type of event
+    code: int
+
+    # Optional alias for additional context about the event
+    alias: Optional[str] = None

orionis/console/entities/scheduler_paused.py

@@ -0,0 +1,17 @@
+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 class is a data structure that inherits from `SchedulerEventData` 
+    and is used to encapsulate information related to the scheduler pause event.
+
+    Attributes
+    ----------
+    (Inherited from SchedulerEventData)
+    """
+    # No additional attributes or methods are defined here, as this class 
+    # serves as a specialized event marker for when the scheduler is paused.

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 class is a specialized data structure that inherits from
+    `SchedulerEventData` and is used to encapsulate information
+    about the resumption of the scheduler.
+
+    Attributes
+    ----------
+    (Inherited from SchedulerEventData)
+
+    Returns
+    -------
+    SchedulerResumed
+        An instance of the `SchedulerResumed` class representing
+        the resumed scheduler event.
+    """
+    # No additional fields or methods are defined here, as this class
+    # serves as a marker for the resumed scheduler event.

orionis/console/entities/scheduler_shutdown.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+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 is a specialized type of `SchedulerEventData` that is used to
+    encapsulate information related to the shutdown of the scheduler.
+
+    Attributes
+    ----------
+    (No additional attributes are defined in this class. It inherits all attributes
+    from `SchedulerEventData`.)
+
+    Returns
+    -------
+    SchedulerShutdown
+        An instance of the `SchedulerShutdown` class representing the shutdown event.
+    """
+    # This class does not define additional attributes or methods. It serves as a
+    # specific type of event data for the scheduler shutdown event.

orionis/console/entities/scheduler_started.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from orionis.console.entities.scheduler_event_data import SchedulerEventData
+
+@dataclass(kw_only=True)
+class SchedulerStarted(SchedulerEventData):
+    """
+    Represents an event triggered when the scheduler starts running.
+
+    This class is a data structure that inherits from `SchedulerEventData`
+    and is used to encapsulate information about the scheduler's start event.
+
+    Attributes
+    ----------
+    (No additional attributes are defined in this class; it inherits all attributes from `SchedulerEventData`.)
+
+    Returns
+    -------
+    SchedulerStarted
+        An instance of the `SchedulerStarted` class, representing the scheduler start event.
+    """
+    # This class does not define additional attributes or methods; it serves as a marker for the event.

orionis/console/enums/listener.py

@@ -0,0 +1,75 @@
+from enum import Enum
+
+class ListeningEvent(Enum):
+    """
+    Enum representing global listener events.
+
+    Attributes
+    ----------
+    SCHEDULER_STARTED : str
+        Event triggered when the scheduler starts.
+    SCHEDULER_SHUTDOWN : str
+        Event triggered when the scheduler shuts down.
+    SCHEDULER_PAUSED : str
+        Event triggered when the scheduler is paused.
+    SCHEDULER_RESUMED : str
+        Event triggered when the scheduler resumes.
+    SCHEDULER_ERROR : str
+        Event triggered when the scheduler encounters an error.
+    SCHEDULER_STARTED : str
+        Event triggered when the scheduler starts.
+    SCHEDULER_SHUTDOWN : str
+        Event triggered when the scheduler shuts down.
+    SCHEDULER_PAUSED : str
+        Event triggered when the scheduler is paused.
+    SCHEDULER_RESUMED : str
+        Event triggered when the scheduler resumes.
+    EXECUTOR_ADDED : str
+        Event triggered when an executor is added.
+    EXECUTOR_REMOVED : str
+        Event triggered when an executor is removed.
+    JOBSTORE_ADDED : str
+        Event triggered when a job store is added.
+    JOBSTORE_REMOVED : str
+        Event triggered when a job store is removed.
+    ALL_JOBS_REMOVED : str
+        Event triggered when all jobs are removed.
+    JOB_ADDED : str
+        Event triggered when a job is added.
+    JOB_REMOVED : str
+        Event triggered when a job is removed.
+    JOB_MODIFIED : str
+        Event triggered when a job is modified.
+    JOB_EXECUTED : str
+        Event triggered when a job is executed.
+    JOB_ERROR : str
+        Event triggered when a job encounters an error.
+    JOB_MISSED : str
+        Event triggered when a job is missed.
+    JOB_SUBMITTED : str
+        Event triggered when a job is submitted.
+    JOB_MAX_INSTANCES : str
+        Event triggered when a job exceeds max instances.
+    ALL : str
+        Event triggered for all events.
+    """
+
+    SCHEDULER_STARTED = "X-ORIONIS-EVENT-SCHEDULER-STARTED"
+    SCHEDULER_SHUTDOWN = "X-ORIONIS-EVENT-SCHEDULER-SHUTDOWN"
+    SCHEDULER_PAUSED = "X-ORIONIS-EVENT-SCHEDULER-PAUSED"
+    SCHEDULER_RESUMED = "X-ORIONIS-EVENT-SCHEDULER-RESUMED"
+    SCHEDULER_ERROR = "X-ORIONIS-SCHEDULER-ERROR"
+    EXECUTOR_ADDED = "X-ORIONIS-EVENT-EXECUTOR-ADDED"
+    EXECUTOR_REMOVED = "X-ORIONIS-EVENT-EXECUTOR-REMOVED"
+    JOBSTORE_ADDED = "X-ORIONIS-EVENT-JOBSTORE-ADDED"
+    JOBSTORE_REMOVED = "X-ORIONIS-EVENT-JOBSTORE-REMOVED"
+    ALL_JOBS_REMOVED = "X-ORIONIS-EVENT-ALL-JOBS-REMOVED"
+    JOB_ADDED = "X-ORIONIS-EVENT-JOB-ADDED"
+    JOB_REMOVED = "X-ORIONIS-EVENT-JOB-REMOVED"
+    JOB_MODIFIED = "X-ORIONIS-EVENT-JOB-MODIFIED"
+    JOB_EXECUTED = "X-ORIONIS-EVENT-JOB-EXECUTED"
+    JOB_ERROR = "X-ORIONIS-EVENT-JOB-ERROR"
+    JOB_MISSED = "X-ORIONIS-EVENT-JOB-MISSED"
+    JOB_SUBMITTED = "X-ORIONIS-EVENT-JOB-SUBMITTED"
+    JOB_MAX_INSTANCES = "X-ORIONIS-EVENT-JOB-MAX-INSTANCES"
+    ALL = "X-ORIONIS-EVENT-ALL"