summaryrefslogtreecommitdiff
path: root/src/apscheduler/events.py
blob: f38c12e2962b6459c5acdee368cc1b0d1b2533cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
from __future__ import annotations

from datetime import datetime, timezone
from functools import partial
from uuid import UUID

import attrs
from attrs.converters import optional

from .converters import as_aware_datetime, as_uuid
from .enums import JobOutcome


@attrs.define(kw_only=True, frozen=True)
class Event:
    timestamp: datetime = attrs.field(factory=partial(datetime.now, timezone.utc),
                                      converter=as_aware_datetime)


#
# Data store events
#

@attrs.define(kw_only=True, frozen=True)
class DataStoreEvent(Event):
    pass


@attrs.define(kw_only=True, frozen=True)
class TaskAdded(DataStoreEvent):
    task_id: str


@attrs.define(kw_only=True, frozen=True)
class TaskUpdated(DataStoreEvent):
    task_id: str


@attrs.define(kw_only=True, frozen=True)
class TaskRemoved(DataStoreEvent):
    task_id: str


@attrs.define(kw_only=True, frozen=True)
class ScheduleAdded(DataStoreEvent):
    schedule_id: str
    next_fire_time: datetime | None = attrs.field(converter=optional(as_aware_datetime))


@attrs.define(kw_only=True, frozen=True)
class ScheduleUpdated(DataStoreEvent):
    schedule_id: str
    next_fire_time: datetime | None = attrs.field(converter=optional(as_aware_datetime))


@attrs.define(kw_only=True, frozen=True)
class ScheduleRemoved(DataStoreEvent):
    schedule_id: str


@attrs.define(kw_only=True, frozen=True)
class JobAdded(DataStoreEvent):
    job_id: UUID = attrs.field(converter=as_uuid)
    task_id: str
    schedule_id: str | None
    tags: frozenset[str] = attrs.field(converter=frozenset)


@attrs.define(kw_only=True, frozen=True)
class JobRemoved(DataStoreEvent):
    job_id: UUID = attrs.field(converter=as_uuid)


@attrs.define(kw_only=True, frozen=True)
class ScheduleDeserializationFailed(DataStoreEvent):
    schedule_id: str
    exception: BaseException


@attrs.define(kw_only=True, frozen=True)
class JobDeserializationFailed(DataStoreEvent):
    job_id: UUID = attrs.field(converter=as_uuid)
    exception: BaseException


#
# Scheduler events
#

@attrs.define(kw_only=True, frozen=True)
class SchedulerEvent(Event):
    pass


@attrs.define(kw_only=True, frozen=True)
class SchedulerStarted(SchedulerEvent):
    pass


@attrs.define(kw_only=True, frozen=True)
class SchedulerStopped(SchedulerEvent):
    exception: BaseException | None = None


#
# Worker events
#

@attrs.define(kw_only=True, frozen=True)
class WorkerEvent(Event):
    pass


@attrs.define(kw_only=True, frozen=True)
class WorkerStarted(WorkerEvent):
    pass


@attrs.define(kw_only=True, frozen=True)
class WorkerStopped(WorkerEvent):
    exception: BaseException | None = None


@attrs.define(kw_only=True, frozen=True)
class JobAcquired(WorkerEvent):
    """Signals that a worker has acquired a job for processing."""

    job_id: UUID = attrs.field(converter=as_uuid)
    worker_id: str


@attrs.define(kw_only=True, frozen=True)
class JobReleased(WorkerEvent):
    """Signals that a worker has finished processing of a job."""

    job_id: UUID = attrs.field(converter=as_uuid)
    worker_id: str
    outcome: JobOutcome