Spaces:
Running
on
Zero
Running
on
Zero
File size: 8,431 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 |
from __future__ import annotations
import asyncio
import logging
import uuid
from collections import defaultdict
from contextlib import suppress
from tlz import merge
from dask.utils import parse_timedelta, stringify
from distributed.client import Future
from distributed.metrics import time
from distributed.utils import TimeoutError, log_errors
from distributed.worker import get_client
logger = logging.getLogger(__name__)
class VariableExtension:
"""An extension for the scheduler to manage Variables
This adds the following routes to the scheduler
* variable-set
* variable-get
* variable-delete
"""
def __init__(self, scheduler):
self.scheduler = scheduler
self.variables = dict()
self.waiting = defaultdict(set)
self.waiting_conditions = defaultdict(asyncio.Condition)
self.started = asyncio.Condition()
self.scheduler.handlers.update(
{"variable_set": self.set, "variable_get": self.get}
)
self.scheduler.stream_handlers["variable-future-release"] = self.future_release
self.scheduler.stream_handlers["variable_delete"] = self.delete
async def set(self, name=None, key=None, data=None, client=None):
if key is not None:
record = {"type": "Future", "value": key}
self.scheduler.client_desires_keys(keys=[key], client="variable-%s" % name)
else:
record = {"type": "msgpack", "value": data}
try:
old = self.variables[name]
except KeyError:
pass
else:
if old["type"] == "Future" and old["value"] != key:
asyncio.ensure_future(self.release(old["value"], name))
if name not in self.variables:
async with self.started:
self.started.notify_all()
self.variables[name] = record
async def release(self, key, name):
while self.waiting[key, name]:
async with self.waiting_conditions[name]:
await self.waiting_conditions[name].wait()
self.scheduler.client_releases_keys(keys=[key], client="variable-%s" % name)
del self.waiting[key, name]
async def future_release(self, name=None, key=None, token=None, client=None):
self.waiting[key, name].remove(token)
if not self.waiting[key, name]:
async with self.waiting_conditions[name]:
self.waiting_conditions[name].notify_all()
async def get(self, name=None, client=None, timeout=None):
start = time()
while name not in self.variables:
if timeout is not None:
left = timeout - (time() - start)
else:
left = None
if left and left < 0:
raise TimeoutError()
try:
async def _(): # Python 3.6 is odd and requires special help here
await self.started.acquire()
await self.started.wait()
await asyncio.wait_for(_(), timeout=left)
finally:
self.started.release()
record = self.variables[name]
if record["type"] == "Future":
key = record["value"]
token = uuid.uuid4().hex
ts = self.scheduler.tasks.get(key)
state = ts.state if ts is not None else "lost"
msg = {"token": token, "state": state}
if state == "erred":
msg["exception"] = ts.exception_blame.exception
msg["traceback"] = ts.exception_blame.traceback
record = merge(record, msg)
self.waiting[key, name].add(token)
return record
@log_errors
async def delete(self, name=None, client=None):
try:
old = self.variables[name]
except KeyError:
pass
else:
if old["type"] == "Future":
await self.release(old["value"], name)
with suppress(KeyError):
del self.waiting_conditions[name]
with suppress(KeyError):
del self.variables[name]
self.scheduler.remove_client("variable-%s" % name)
class Variable:
"""Distributed Global Variable
This allows multiple clients to share futures and data between each other
with a single mutable variable. All metadata is sequentialized through the
scheduler. Race conditions can occur.
Values must be either Futures or msgpack-encodable data (ints, lists,
strings, etc..) All data will be kept and sent through the scheduler, so
it is wise not to send too much. If you want to share a large amount of
data then ``scatter`` it and share the future instead.
.. warning::
This object is experimental and has known issues in Python 2
Parameters
----------
name: string (optional)
Name used by other clients and the scheduler to identify the variable.
If not given, a random name will be generated.
client: Client (optional)
Client used for communication with the scheduler.
If not given, the default global client will be used.
Examples
--------
>>> from dask.distributed import Client, Variable # doctest: +SKIP
>>> client = Client() # doctest: +SKIP
>>> x = Variable('x') # doctest: +SKIP
>>> x.set(123) # docttest: +SKIP
>>> x.get() # docttest: +SKIP
123
>>> future = client.submit(f, x) # doctest: +SKIP
>>> x.set(future) # doctest: +SKIP
See Also
--------
Queue: shared multi-producer/multi-consumer queue between clients
"""
def __init__(self, name=None, client=None):
try:
self.client = client or get_client()
except ValueError:
self.client = None
self.name = name or "variable-" + uuid.uuid4().hex
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."
)
async def _set(self, value):
if isinstance(value, Future):
await self.client.scheduler.variable_set(
key=stringify(value.key), name=self.name
)
else:
await self.client.scheduler.variable_set(data=value, name=self.name)
def set(self, value, **kwargs):
"""Set the value of this variable
Parameters
----------
value : Future or object
Must be either a Future or a msgpack-encodable value
"""
self._verify_running()
return self.client.sync(self._set, value, **kwargs)
async def _get(self, timeout=None):
d = await self.client.scheduler.variable_get(
timeout=timeout, name=self.name, client=self.client.id
)
if d["type"] == "Future":
value = Future(d["value"], self.client, inform=True, state=d["state"])
if d["state"] == "erred":
value._state.set_error(d["exception"], d["traceback"])
self.client._send_to_scheduler(
{
"op": "variable-future-release",
"name": self.name,
"key": d["value"],
"token": d["token"],
}
)
else:
value = d["value"]
return value
def get(self, timeout=None, **kwargs):
"""Get the value of this variable
Parameters
----------
timeout : number or string or timedelta, optional
Time in seconds to wait before timing out.
Instead of number of seconds, it is also possible to specify
a timedelta in string format, e.g. "200ms".
"""
self._verify_running()
timeout = parse_timedelta(timeout)
return self.client.sync(self._get, timeout=timeout, **kwargs)
def delete(self):
"""Delete this variable
Caution, this affects all clients currently pointing to this variable.
"""
self._verify_running()
if self.client.status == "running": # TODO: can leave zombie futures
self.client._send_to_scheduler({"op": "variable_delete", "name": self.name})
def __reduce__(self):
return Variable, (self.name,)
|