File: C:/Users/fred/anaconda3/Lib/site-packages/distributed/shuffle/_buffer.py
from __future__ import annotations
import abc
import asyncio
import logging
from collections import defaultdict
from collections.abc import Sized
from typing import TYPE_CHECKING, Any, Generic, TypeVar
from distributed.metrics import context_meter, time
from distributed.shuffle._limiter import ResourceLimiter
from distributed.sizeof import sizeof
logger = logging.getLogger("distributed.shuffle")
if TYPE_CHECKING:
# TODO import from collections.abc (requires Python >=3.12)
from typing_extensions import Buffer
else:
Buffer = Sized
ShardType = TypeVar("ShardType", bound=Buffer)
T = TypeVar("T")
class ShardsBuffer(Generic[ShardType]):
"""A buffer for P2P shuffle
The objects to buffer are typically bytes belonging to certain shards.
Typically the buffer is implemented on sending and receiving end.
The buffer allows for concurrent writing and buffers shards to reduce overhead of writing.
The shards are typically provided in a format like::
{
"bucket-0": [b"shard1", b"shard2"],
"bucket-1": [b"shard1", b"shard2"],
}
Buckets typically correspond to output partitions.
If exceptions occur during writing, the buffer is automatically closed. Subsequent attempts to write will raise the same exception.
Flushing will not raise an exception. To ensure that the buffer finished successfully, please call `ShardsBuffer.raise_on_exception`
"""
shards: defaultdict[str, list[ShardType]]
sizes: defaultdict[str, int]
sizes_detail: defaultdict[str, list[int]]
concurrency_limit: int
memory_limiter: ResourceLimiter
max_message_size: int
bytes_total: int
bytes_memory: int
bytes_written: int
bytes_read: int
avg_size: float
avg_duration: float
_accepts_input: bool
_inputs_done: bool
_exception: None | Exception
_tasks: list[asyncio.Task]
_shards_available: asyncio.Condition
_flush_lock: asyncio.Lock
def __init__(
self,
memory_limiter: ResourceLimiter,
concurrency_limit: int = 2,
max_message_size: int = -1,
) -> None:
self._accepts_input = True
self.shards = defaultdict(list)
self.sizes = defaultdict(int)
self.sizes_detail = defaultdict(list)
self._exception = None
self.concurrency_limit = concurrency_limit
self._inputs_done = False
self.memory_limiter = memory_limiter
self._tasks = [
asyncio.create_task(self._background_task())
for _ in range(concurrency_limit)
]
self._shards_available = asyncio.Condition()
self._flush_lock = asyncio.Lock()
self.max_message_size = max_message_size
self.bytes_total = 0
self.bytes_memory = 0
self.bytes_written = 0
self.bytes_read = 0
self.avg_size = 0.0
self.avg_duration = 0.0
def heartbeat(self) -> dict[str, Any]:
return {
"memory": self.bytes_memory,
"total": self.bytes_total,
"buckets": len(self.shards),
"written": self.bytes_written,
"read": self.bytes_read,
"avg_size": self.avg_size,
"avg_duration": self.avg_duration,
"memory_limit": self.memory_limiter.limit,
}
async def process(self, id: str, shards: list[ShardType], size: int) -> None:
try:
start = time()
with context_meter.meter("process"):
await self._process(id, shards)
context_meter.digest_metric("process", size, "bytes")
context_meter.digest_metric("process", 1, "count")
self.bytes_written += size
stop = time()
self.avg_size = 0.98 * self.avg_size + 0.02 * size
self.avg_duration = 0.98 * self.avg_duration + 0.02 * (stop - start)
except Exception as e:
self._exception = e
self._inputs_done = True
finally:
await self.memory_limiter.decrease(size)
self.bytes_memory -= size
@abc.abstractmethod
async def _process(self, id: str, shards: list[ShardType]) -> None:
...
def read(self, id: str) -> ShardType:
raise NotImplementedError() # pragma: nocover
@property
def empty(self) -> bool:
return not self.shards
async def _background_task(self) -> None:
def _continue() -> bool:
return bool(self.shards or self._inputs_done)
while True:
with context_meter.meter("idle"):
async with self._shards_available:
await self._shards_available.wait_for(_continue)
if self._inputs_done and not self.shards:
break
part_id = max(self.sizes, key=self.sizes.__getitem__)
if self.max_message_size > 0:
size = 0
shards = []
while size < self.max_message_size:
try:
shard = self.shards[part_id].pop()
shards.append(shard)
s = self.sizes_detail[part_id].pop()
size += s
self.sizes[part_id] -= s
except IndexError:
break
finally:
if not self.shards[part_id]:
del self.shards[part_id]
assert not self.sizes[part_id]
del self.sizes[part_id]
assert not self.sizes_detail[part_id]
del self.sizes_detail[part_id]
else:
shards = self.shards.pop(part_id)
size = self.sizes.pop(part_id)
self._shards_available.notify_all()
await self.process(part_id, shards, size)
async def write(self, data: dict[str, ShardType]) -> None:
"""
Writes objects into the local buffers, blocks until ready for more
Parameters
----------
data: dict
A dictionary mapping destinations to the object that should
be written to that destination
Notes
-----
If this buffer has a memory limiter configured, then it will
apply back-pressure to the sender (blocking further receives)
if local resource usage hits the limit, until such time as the
resource usage drops.
"""
if self._exception:
raise self._exception
if not self._accepts_input or self._inputs_done:
raise RuntimeError(f"Trying to put data in closed {self}.")
if not data:
return
sizes = {worker: sizeof(shard) for worker, shard in data.items()}
total_batch_size = sum(sizes.values())
self.bytes_memory += total_batch_size
self.bytes_total += total_batch_size
self.memory_limiter.increase(total_batch_size)
async with self._shards_available:
for worker, shard in data.items():
self.shards[worker].append(shard)
self.sizes_detail[worker].append(sizes[worker])
self.sizes[worker] += sizes[worker]
self._shards_available.notify()
await self.memory_limiter.wait_for_available()
del data
assert total_batch_size
def raise_on_exception(self) -> None:
"""Raises an exception if something went wrong during writing"""
if self._exception:
raise self._exception
async def flush(self) -> None:
"""Wait until all writes are finished.
This closes the buffer such that no new writes are allowed
"""
async with self._flush_lock:
self._accepts_input = False
async with self._shards_available:
self._shards_available.notify_all()
await self._shards_available.wait_for(
lambda: not self.shards or self._exception or self._inputs_done
)
self._inputs_done = True
self._shards_available.notify_all()
await asyncio.gather(*self._tasks)
if not self._exception:
assert not self.bytes_memory, (type(self), self.bytes_memory)
async def close(self) -> None:
"""Flush and close the buffer.
This cleans up all allocated resources.
"""
await self.flush()
if not self._exception:
assert not self.bytes_memory, (type(self), self.bytes_memory)
for t in self._tasks:
t.cancel()
self._accepts_input = False
self._inputs_done = True
self.shards.clear()
self.bytes_memory = 0
async with self._shards_available:
self._shards_available.notify_all()
await asyncio.gather(*self._tasks)
async def __aenter__(self) -> ShardsBuffer:
return self
async def __aexit__(self, exc: Any, typ: Any, traceback: Any) -> None:
await self.close()