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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
from __future__ import annotations
import atexit
import logging
import sys
import threading
from collections.abc import MutableMapping
from contextlib import ExitStack
from datetime import timedelta
from functools import partial
from logging import Logger
from types import TracebackType
from typing import Any, Callable, Iterable, Mapping
from uuid import UUID
from anyio import start_blocking_portal
from anyio.from_thread import BlockingPortal
from .. import Event, current_scheduler
from .._enums import CoalescePolicy, ConflictPolicy, RunState, SchedulerRole
from .._structures import JobResult, Schedule
from ..abc import DataStore, EventBroker, JobExecutor, Subscription, Trigger
from .async_ import AsyncScheduler
if sys.version_info >= (3, 11):
from typing import Self
else:
from typing_extensions import Self
class Scheduler:
"""A synchronous scheduler implementation."""
def __init__(
self,
data_store: DataStore | None = None,
event_broker: EventBroker | None = None,
*,
identity: str | None = None,
role: SchedulerRole = SchedulerRole.both,
job_executors: Mapping[str, JobExecutor] | None = None,
default_job_executor: str | None = None,
logger: Logger | None = None,
):
kwargs: dict[str, Any] = {}
if data_store is not None:
kwargs["data_store"] = data_store
if event_broker is not None:
kwargs["event_broker"] = event_broker
if not default_job_executor and not job_executors:
default_job_executor = "threadpool"
self._async_scheduler = AsyncScheduler(
identity=identity,
role=role,
job_executors=job_executors,
default_job_executor=default_job_executor,
logger=logger or logging.getLogger(__name__),
**kwargs,
)
self._exit_stack = ExitStack()
self._portal: BlockingPortal | None = None
self._lock = threading.RLock()
@property
def data_store(self) -> DataStore:
return self._async_scheduler.data_store
@property
def event_broker(self) -> EventBroker:
return self._async_scheduler.event_broker
@property
def identity(self) -> str:
return self._async_scheduler.identity
@property
def role(self) -> SchedulerRole:
return self._async_scheduler.role
@property
def job_executors(self) -> MutableMapping[str, JobExecutor]:
return self._async_scheduler.job_executors
@property
def state(self) -> RunState:
"""The current running state of the scheduler."""
return self._async_scheduler.state
def __enter__(self: Self) -> Self:
self._ensure_services_ready(self._exit_stack)
return self
def __exit__(
self,
exc_type: type[BaseException],
exc_val: BaseException,
exc_tb: TracebackType,
) -> None:
self._exit_stack.__exit__(exc_type, exc_val, exc_tb)
def _ensure_services_ready(self, exit_stack: ExitStack | None = None) -> None:
"""Ensure that the underlying asynchronous scheduler has been initialized."""
with self._lock:
if self._portal is None:
if exit_stack is None:
if self._exit_stack is None:
self._exit_stack = exit_stack = ExitStack()
atexit.register(self._exit_stack.close)
else:
exit_stack = self._exit_stack
# Set this scheduler as the current synchronous scheduler
token = current_scheduler.set(self)
exit_stack.callback(current_scheduler.reset, token)
self._portal = exit_stack.enter_context(start_blocking_portal())
exit_stack.callback(setattr, self, "_portal", None)
exit_stack.enter_context(
self._portal.wrap_async_context_manager(self._async_scheduler)
)
def subscribe(
self,
callback: Callable[[Event], Any],
event_types: Iterable[type[Event]] | None = None,
*,
one_shot: bool = False,
) -> Subscription:
"""
Subscribe to events.
To unsubscribe, call the :meth:`Subscription.unsubscribe` method on the returned
object.
:param callback: callable to be called with the event object when an event is
published
:param event_types: an iterable of concrete Event classes to subscribe to
:param one_shot: if ``True``, automatically unsubscribe after the first matching
event
"""
return self.data_store.event_broker.subscribe(
callback, event_types, is_async=False, one_shot=one_shot
)
def add_schedule(
self,
func_or_task_id: str | Callable,
trigger: Trigger,
*,
id: str | None = None,
args: Iterable | None = None,
kwargs: Mapping[str, Any] | None = None,
job_executor: str | None = None,
coalesce: CoalescePolicy = CoalescePolicy.latest,
misfire_grace_time: float | timedelta | None = None,
max_jitter: float | timedelta | None = None,
tags: Iterable[str] | None = None,
conflict_policy: ConflictPolicy = ConflictPolicy.do_nothing,
) -> str:
self._ensure_services_ready()
return self._portal.call(
partial(
self._async_scheduler.add_schedule,
func_or_task_id,
trigger,
id=id,
args=args,
kwargs=kwargs,
job_executor=job_executor,
coalesce=coalesce,
misfire_grace_time=misfire_grace_time,
max_jitter=max_jitter,
tags=tags,
conflict_policy=conflict_policy,
)
)
def get_schedule(self, id: str) -> Schedule:
self._ensure_services_ready()
return self._portal.call(self._async_scheduler.get_schedule, id)
def get_schedules(self) -> list[Schedule]:
self._ensure_services_ready()
return self._portal.call(self._async_scheduler.get_schedules)
def remove_schedule(self, id: str) -> None:
self._ensure_services_ready()
self._portal.call(self._async_scheduler.remove_schedule, id)
def add_job(
self,
func_or_task_id: str | Callable,
*,
args: Iterable | None = None,
kwargs: Mapping[str, Any] | None = None,
job_executor: str | None = None,
tags: Iterable[str] | None = None,
result_expiration_time: timedelta | float = 0,
) -> UUID:
self._ensure_services_ready()
return self._portal.call(
partial(
self._async_scheduler.add_job,
func_or_task_id,
args=args,
kwargs=kwargs,
job_executor=job_executor,
tags=tags,
result_expiration_time=result_expiration_time,
)
)
def get_job_result(self, job_id: UUID, *, wait: bool = True) -> JobResult:
self._ensure_services_ready()
return self._portal.call(
partial(self._async_scheduler.get_job_result, job_id, wait=wait)
)
def run_job(
self,
func_or_task_id: str | Callable,
*,
args: Iterable | None = None,
kwargs: Mapping[str, Any] | None = None,
job_executor: str | None = None,
tags: Iterable[str] | None = (),
) -> Any:
self._ensure_services_ready()
return self._portal.call(
partial(
self._async_scheduler.run_job,
func_or_task_id,
args=args,
kwargs=kwargs,
job_executor=job_executor,
tags=tags,
)
)
def start_in_background(self) -> None:
"""
Launch the scheduler in a new thread.
This method registers :mod:`atexit` hooks to shut down the scheduler and wait
for the thread to finish.
:raises RuntimeError: if the scheduler is not in the ``stopped`` state
"""
self._ensure_services_ready()
self._portal.call(self._async_scheduler.start_in_background)
def stop(self) -> None:
if self._portal is not None:
self._portal.call(self._async_scheduler.stop)
def wait_until_stopped(self) -> None:
if self._portal is not None:
self._portal.call(self._async_scheduler.wait_until_stopped)
def run_until_stopped(self) -> None:
with ExitStack() as exit_stack:
# Run the async scheduler
self._ensure_services_ready(exit_stack)
self._portal.call(self._async_scheduler.run_until_stopped)
|
