Spaces:
Running
on
Zero
Running
on
Zero
File size: 8,417 Bytes
d1ed09d |
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 |
from __future__ import annotations
import asyncio
import logging
import uuid
from collections import defaultdict
from contextlib import suppress
from dask.utils import parse_timedelta
from distributed.utils import TimeoutError, log_errors
from distributed.worker import get_client
logger = logging.getLogger(__name__)
class EventExtension:
"""An extension for the scheduler to manage Events
This adds the following routes to the scheduler
* event_wait
* event_set
* event_clear
* event_is_set
In principle, the implementation logic is quite simple
as we can reuse the asyncio.Event as much as possible:
we keep a mapping from name to an asyncio.Event and call
every function (wait, set, clear, is_set) directly on these
events.
However, this would cause a memory leak: created events in the
dictionary are never removed.
For this, we also keep a counter for the number of waiters on
a specific event.
If an event is set, we need to keep track of this state so
we can not remove it (the default flag is false).
If it is unset but there are waiters, we can also not remove
it, as those waiters would then have dangling futures.
Therefore the only time we can remove the event from our dict
is when the number of waiters is 0 and the event flag is cleared.
"""
def __init__(self, scheduler):
self.scheduler = scheduler
# Keep track of all current events, identified by their name
self._events = defaultdict(asyncio.Event)
# Keep track on how many waiters are present, so we know when
# we can remove the event
self._waiter_count = defaultdict(int)
self.scheduler.handlers.update(
{
"event_wait": self.event_wait,
"event_set": self.event_set,
"event_clear": self.event_clear,
"event_is_set": self.event_is_set,
}
)
@log_errors
async def event_wait(self, name=None, timeout=None):
"""Wait until the event is set to true.
Returns false, when this did not happen in the given time
and true otherwise.
"""
name = self._normalize_name(name)
event = self._events[name]
future = event.wait()
if timeout is not None:
future = asyncio.wait_for(future, timeout)
self._waiter_count[name] += 1
try:
await future
except TimeoutError:
return False
finally:
self._waiter_count[name] -= 1
if not self._waiter_count[name] and not event.is_set():
# No one is waiting for this
# and as the default flag for an event is false
# we can safely remove it
self._delete_event(name)
return True
@log_errors
def event_set(self, name=None):
"""Set the event with the given name to true.
All waiters on this event will be notified.
"""
name = self._normalize_name(name)
# No matter if someone is listening or not,
# we set the event to true
self._events[name].set()
@log_errors
def event_clear(self, name=None):
"""Set the event with the given name to false."""
name = self._normalize_name(name)
if not self._waiter_count[name]:
# No one is waiting for this
# and as the default flag for an event is false
# we can safely remove it
self._delete_event(name)
else:
# There are waiters
# This can happen if an event is "double-cleared"
# In principle, the event should be unset at this point
# (because if it is set, all waiters should have been
# notified). But to prevent race conditions
# due to unlucky timing, we clear anyways
assert name in self._events
event = self._events[name]
event.clear()
@log_errors
def event_is_set(self, name=None):
name = self._normalize_name(name)
# the default flag value is false
# we could also let the defaultdict
# create a new event for us, but that
# could produce many unused events
if name not in self._events:
return False
return self._events[name].is_set()
def _normalize_name(self, name):
"""Helper function to normalize an event name"""
if isinstance(name, list):
name = tuple(name)
return name
def _delete_event(self, name):
"""Helper function to delete an event"""
# suppress key errors to make calling this method
# also possible if we do not even have such an event
with suppress(KeyError):
del self._waiter_count[name]
with suppress(KeyError):
del self._events[name]
class Event:
"""Distributed Centralized Event equivalent to asyncio.Event
An event stores a single flag, which is set to false on start.
The flag can be set to true (using the set() call) or back to false
(with the clear() call).
Every call to wait() blocks until the event flag is set to true.
Parameters
----------
name: string (optional)
Name of the event. Choosing the same name allows two
disconnected processes to coordinate an event.
If not given, a random name will be generated.
client: Client (optional)
Client to use for communication with the scheduler.
If not given, the default global client will be used.
Examples
--------
>>> event_1 = Event('a') # doctest: +SKIP
>>> event_1.wait(timeout=1) # doctest: +SKIP
>>> # in another process
>>> event_2 = Event('a') # doctest: +SKIP
>>> event_2.set() # doctest: +SKIP
>>> # now event_1 will stop waiting
"""
def __init__(self, name=None, client=None):
try:
self.client = client or get_client()
except ValueError:
self.client = None
self.name = name or "event-" + uuid.uuid4().hex
def __await__(self):
"""async constructor
Make it possible to write
>>> event = await Event("x") # doctest: +SKIP
even though no waiting is implied
"""
async def _():
return self
return _().__await__()
def _verify_running(self):
if not self.client:
raise RuntimeError(
f"{type(self)} object not properly initialized. This can happen"
" if the object is being deserialized outside of the context of"
" a Client or Worker."
)
def wait(self, timeout=None):
"""Wait until the event is set.
Parameters
----------
timeout : number or string or timedelta, optional
Seconds to wait on the event in the scheduler. This does not
include local coroutine time, network transfer time, etc..
Instead of number of seconds, it is also possible to specify
a timedelta in string format, e.g. "200ms".
Examples
--------
>>> event = Event('a') # doctest: +SKIP
>>> event.wait(timeout="1s") # doctest: +SKIP
Returns
-------
True if the event was set of false, if a timeout happened
"""
self._verify_running()
timeout = parse_timedelta(timeout)
result = self.client.sync(
self.client.scheduler.event_wait, name=self.name, timeout=timeout
)
return result
def clear(self):
"""Clear the event (set its flag to false).
All waiters will now block.
"""
self._verify_running()
return self.client.sync(self.client.scheduler.event_clear, name=self.name)
def set(self):
"""Set the event (set its flag to false).
All waiters will now be released.
"""
self._verify_running()
result = self.client.sync(self.client.scheduler.event_set, name=self.name)
return result
def is_set(self):
"""Check if the event is set"""
self._verify_running()
result = self.client.sync(self.client.scheduler.event_is_set, name=self.name)
return result
def __reduce__(self):
return (Event, (self.name,))
|