orionis 0.566.0__py3-none-any.whl → 0.568.0__py3-none-any.whl

orionis/console/entities/job_event_data.py

@@ -1,40 +0,0 @@
-from dataclasses import dataclass
-from typing import Optional
-from orionis.console.entities.scheduler_event_data import SchedulerEventData
-
-@dataclass(kw_only=True)
-class JobEventData(SchedulerEventData):
-    """
-    Represents the base class for events related to jobs in the scheduler system.
-
-    This class extends `SchedulerEventData` and provides additional attributes
-    specific to job-related events, such as the job's identifier and the job store
-    where it resides.
-
-    Attributes
-    ----------
-    code : int
-        A numeric code that uniquely identifies the type of event within the
-        scheduler system. (Inherited from `SchedulerEventData`)
-    alias : str, optional
-        An optional string providing additional context or identifying specific
-        components (e.g., executors or job stores) related to the event.
-        (Inherited from `SchedulerEventData`)
-    job_id : str
-        The unique identifier of the job associated with the event.
-    jobstore : str, optional
-        The name of the job store where the job is located. If not specified,
-        it defaults to `None`.
-
-    Returns
-    -------
-    JobEventData
-        An instance of the `JobEventData` class containing information about
-        the job-related event.
-    """
-
-    # The unique identifier of the job
-    job_id: str
-
-    # The name of the job store where the job resides (optional)
-    jobstore: Optional[str] = None

orionis/console/entities/job_executed.py

@@ -1,31 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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.
-    """
-
-    next_run_time: str | None = None

orionis/console/entities/job_pause.py

@@ -1,22 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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