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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
|
# This file is part of Pebble.
# Copyright (c) 2013-2025, Matteo Cafasso
# Pebble is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License
# as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# Pebble is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with Pebble. If not, see <http://www.gnu.org/licenses/>.
import time
import logging
import itertools
from queue import Queue
from enum import IntEnum
from threading import RLock
from dataclasses import dataclass
from typing import Any, Callable, Optional
from concurrent.futures import Future, TimeoutError
from pebble.common import Result, ResultStatus
from pebble.common import PebbleFuture, ProcessFuture, CONSTS
class BasePool:
def __init__(self, max_workers: int,
max_tasks: int,
initializer: Optional[Callable],
initargs: list):
self._context = PoolContext(
max_workers, max_tasks, initializer, initargs)
self._loops = ()
self._task_counter = itertools.count()
def __enter__(self):
return self
def __exit__(self, *args):
self.close()
self.join()
@property
def active(self) -> bool:
self._update_pool_status()
return self._context.status in (PoolStatus.CLOSED, PoolStatus.RUNNING)
def close(self):
"""Closes the Pool preventing new tasks from being accepted.
Pending tasks will be completed.
"""
self._context.status = PoolStatus.CLOSED
def stop(self):
"""Stops the pool without performing any pending task."""
self._context.status = PoolStatus.STOPPED
def join(self, timeout: float = None):
"""Joins the pool waiting until all workers exited.
If *timeout* is set, it block until all workers are done
or raises TimeoutError.
"""
if self._context.status == PoolStatus.RUNNING:
raise RuntimeError('The Pool is still running')
if self._context.status == PoolStatus.CLOSED:
self._wait_queue_depletion(timeout)
self.stop()
self.join()
else:
self._context.task_queue.put(None) # Pool termination sentinel
self._stop_pool()
def _wait_queue_depletion(self, timeout: Optional[float]):
tick = time.time()
while self.active:
if timeout is not None and time.time() - tick > timeout:
raise TimeoutError("Tasks are still being executed")
elif self._context.task_queue.unfinished_tasks:
time.sleep(CONSTS.sleep_unit)
else:
return
def _check_pool_status(self):
self._update_pool_status()
if self._context.status == PoolStatus.ERROR:
raise RuntimeError('Unexpected error within the Pool')
elif self._context.status != PoolStatus.RUNNING:
raise RuntimeError('The Pool is not active')
def _update_pool_status(self):
if self._context.status == PoolStatus.CREATED:
self._start_pool()
for loop in self._loops:
if not loop.is_alive():
self._context.status = PoolStatus.ERROR
def _start_pool(self):
raise NotImplementedError("Not implemented")
def _stop_pool(self):
raise NotImplementedError("Not implemented")
class PoolContext:
def __init__(self, max_workers: int,
max_tasks: int,
initializer: Callable,
initargs: list):
self._status = PoolStatus.CREATED
self.status_mutex = RLock()
self.task_queue = Queue()
self.workers = max_workers
self.task_counter = itertools.count()
self.worker_parameters = Worker(max_tasks, initializer, initargs)
@property
def status(self) -> int:
return self._status
@status.setter
def status(self, status: int):
with self.status_mutex:
if self.alive:
self._status = status
@property
def alive(self) -> bool:
return self.status not in (PoolStatus.ERROR, PoolStatus.STOPPED)
class Task:
def __init__(self, identifier: int,
future: Future,
timeout: Optional[float],
payload: 'TaskPayload'):
self.id = identifier
self.future = future
self.timeout = timeout
self.payload = payload
self.timestamp = 0.0
self.worker_id = 0
@property
def started(self) -> bool:
return bool(self.timestamp > 0)
def set_running_or_notify_cancel(self):
if hasattr(self.future, 'map_future'):
if not self.future.map_future.done():
try:
self.future.map_future.set_running_or_notify_cancel()
except RuntimeError:
pass
try:
self.future.set_running_or_notify_cancel()
except RuntimeError:
pass
class MapFuture(PebbleFuture):
def __init__(self, futures: list):
super().__init__()
self._futures = futures
@property
def futures(self) -> list:
return self._futures
def cancel(self) -> bool:
"""Cancel the future.
Returns True if any of the elements of the iterables is cancelled.
False otherwise.
"""
super().cancel()
return any(tuple(f.cancel() for f in self._futures))
class ProcessMapFuture(ProcessFuture):
def __init__(self, futures: list):
super().__init__()
self._futures = futures
@property
def futures(self) -> list:
return self._futures
def cancel(self) -> bool:
"""Cancel the future.
Returns True if any of the elements of the iterables is cancelled.
False otherwise.
"""
super().cancel()
return any(tuple(f.cancel() for f in self._futures))
class MapResults:
def __init__(self, futures: list, timeout: float = None):
self._results = itertools.chain.from_iterable(
chunk_result(f, timeout) for f in futures)
def __iter__(self):
return self
def next(self):
result = next(self._results)
if isinstance(result, Result):
if result.status == ResultStatus.SUCCESS:
return result.value
result = result.value
raise result
__next__ = next
def map_results(map_future: MapFuture, timeout: Optional[float]) -> MapFuture:
futures = map_future.futures
if not futures:
map_future.set_result(MapResults(futures))
return map_future
def done_map(_):
if not map_future.done():
map_future.set_result(MapResults(futures, timeout=timeout))
for future in futures:
future.add_done_callback(done_map)
setattr(future, 'map_future', map_future)
return map_future
def iter_chunks(iterable: iter, chunksize: int) -> iter:
"""Iterates over zipped iterables in chunks."""
try:
yield from itertools.batched(iterable, chunksize)
except AttributeError: # < Python 3.12
while 1:
chunk = tuple(itertools.islice(iterable, chunksize))
if not chunk:
return
yield chunk
def chunk_result(future: ProcessFuture, timeout: Optional[float]) -> Any:
"""Returns the results of a processed chunk."""
try:
return future.result(timeout=timeout)
except BaseException as error:
return (error, )
def run_initializer(initializer: Callable, initargs: list) -> bool:
"""Runs the Pool initializer dealing with errors."""
try:
initializer(*initargs)
return True
except BaseException as error:
logging.exception(error)
return False
class PoolStatus(IntEnum):
"""Current status of the Pool."""
CREATED = 0
RUNNING = 1
CLOSED = 2
STOPPED = 3
ERROR = 4
@dataclass
class Worker:
"""Worker configuration."""
max_tasks: int
initializer: Callable
initargs: list
@dataclass
class TaskPayload:
"""The work item wrapped within a Task."""
function: Callable
args: list
kwargs: dict
|