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
|
import asyncio
import functools
from inspect import iscoroutinefunction
import threading
from queue import Queue
from .client import Future, default_client
from .protocol import to_serialize
from .utils import thread_state, sync
from .utils_comm import WrappedKey
from .worker import get_worker
class Actor(WrappedKey):
"""Controls an object on a remote worker
An actor allows remote control of a stateful object living on a remote
worker. Method calls on this object trigger operations on the remote
object and return ActorFutures on which we can block to get results.
Examples
--------
>>> class Counter:
... def __init__(self):
... self.n = 0
... def increment(self):
... self.n += 1
... return self.n
>>> from dask.distributed import Client
>>> client = Client()
You can create an actor by submitting a class with the keyword
``actor=True``.
>>> future = client.submit(Counter, actor=True)
>>> counter = future.result()
>>> counter
<Actor: Counter, key=Counter-1234abcd>
Calling methods on this object immediately returns deferred ``ActorFuture``
objects. You can call ``.result()`` on these objects to block and get the
result of the function call.
>>> future = counter.increment()
>>> future.result()
1
>>> future = counter.increment()
>>> future.result()
2
"""
def __init__(self, cls, address, key, worker=None):
self._cls = cls
self._address = address
self.key = key
self._future = None
if worker:
self._worker = worker
self._client = None
else:
try:
self._worker = get_worker()
except ValueError:
self._worker = None
try:
self._client = default_client()
self._future = Future(key)
except ValueError:
self._client = None
def __repr__(self):
return "<Actor: %s, key=%s>" % (self._cls.__name__, self.key)
def __reduce__(self):
return (Actor, (self._cls, self._address, self.key))
@property
def _io_loop(self):
if self._worker:
return self._worker.io_loop
else:
return self._client.io_loop
@property
def _scheduler_rpc(self):
if self._worker:
return self._worker.scheduler
else:
return self._client.scheduler
@property
def _worker_rpc(self):
if self._worker:
return self._worker.rpc(self._address)
else:
if self._client.direct_to_workers:
return self._client.rpc(self._address)
else:
return ProxyRPC(self._client.scheduler, self._address)
@property
def _asynchronous(self):
if self._client:
return self._client.asynchronous
else:
return threading.get_ident() == self._worker.thread_id
def _sync(self, func, *args, **kwargs):
if self._client:
return self._client.sync(func, *args, **kwargs)
else:
# TODO support sync operation by checking against thread ident of loop
return sync(self._worker.loop, func, *args, **kwargs)
def __dir__(self):
o = set(dir(type(self)))
o.update(attr for attr in dir(self._cls) if not attr.startswith("_"))
return sorted(o)
def __getattr__(self, key):
if self._future and self._future.status not in ("finished", "pending"):
raise ValueError(
"Worker holding Actor was lost. Status: " + self._future.status
)
if (
self._worker
and self._worker.address == self._address
and getattr(thread_state, "actor", False)
):
# actor calls actor on same worker
actor = self._worker.actors[self.key]
attr = getattr(actor, key)
if iscoroutinefunction(attr):
return attr
elif callable(attr):
return lambda *args, **kwargs: ActorFuture(
None, None, result=attr(*args, **kwargs)
)
else:
return attr
attr = getattr(self._cls, key)
if callable(attr):
@functools.wraps(attr)
def func(*args, **kwargs):
async def run_actor_function_on_worker():
try:
result = await self._worker_rpc.actor_execute(
function=key,
actor=self.key,
args=[to_serialize(arg) for arg in args],
kwargs={k: to_serialize(v) for k, v in kwargs.items()},
)
except OSError:
if self._future:
await self._future
else:
raise OSError("Unable to contact Actor's worker")
return result["result"]
if self._asynchronous:
return asyncio.ensure_future(run_actor_function_on_worker())
else:
# TODO: this mechanism is error prone
# we should endeavor to make dask's standard code work here
q = Queue()
async def wait_then_add_to_queue():
x = await run_actor_function_on_worker()
q.put(x)
self._io_loop.add_callback(wait_then_add_to_queue)
return ActorFuture(q, self._io_loop)
return func
else:
async def get_actor_attribute_from_worker():
x = await self._worker_rpc.actor_attribute(
attribute=key, actor=self.key
)
return x["result"]
return self._sync(get_actor_attribute_from_worker)
@property
def client(self):
return self._future.client
class ProxyRPC:
"""
An rpc-like object that uses the scheduler's rpc to connect to a worker
"""
def __init__(self, rpc, address):
self.rpc = rpc
self._address = address
def __getattr__(self, key):
async def func(**msg):
msg["op"] = key
result = await self.rpc.proxy(worker=self._address, msg=msg)
return result
return func
class ActorFuture:
"""Future to an actor's method call
Whenever you call a method on an Actor you get an ActorFuture immediately
while the computation happens in the background. You can call ``.result``
to block and collect the full result
See Also
--------
Actor
"""
def __init__(self, q, io_loop, result=None):
self.q = q
self.io_loop = io_loop
if result:
self._cached_result = result
def __await__(self):
return self.result()
def result(self, timeout=None):
try:
return self._cached_result
except AttributeError:
self._cached_result = self.q.get(timeout=timeout)
return self._cached_result
def __repr__(self):
return "<ActorFuture>"
|