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 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
|
import os
import time
import pickle
import signal
import asyncio
import unittest
import threading
import dataclasses
import multiprocessing
from concurrent.futures import CancelledError, TimeoutError
from pebble import asynchronous, ProcessExpired, ProcessPool
# set start method
supported = False
mp_context = None
methods = multiprocessing.get_all_start_methods()
if 'fork' in methods:
try:
mp_context = multiprocessing.get_context('fork')
if mp_context.get_start_method() == 'fork':
supported = True
else:
raise Exception(mp_context.get_start_method())
except RuntimeError: # child process
pass
else:
mp_context = multiprocessing.get_context()
def not_decorated(argument, keyword_argument=0):
return argument + keyword_argument
@asynchronous.process(context=mp_context)
def decorated(argument, keyword_argument=0):
"""A docstring."""
return argument + keyword_argument
@asynchronous.process(context=mp_context)
def error_decorated():
raise RuntimeError("BOOM!")
@asynchronous.process(context=mp_context)
def error_returned():
return RuntimeError("BOOM!")
@asynchronous.process(context=mp_context)
def pickling_error_decorated():
event = threading.Event()
return event
@dataclasses.dataclass(frozen=True)
class FrozenError(Exception):
pass
@asynchronous.process(context=mp_context)
def frozen_error_decorated():
raise FrozenError()
@asynchronous.process(context=mp_context)
def critical_decorated():
os._exit(123)
@asynchronous.process(context=mp_context)
def decorated_cancel():
time.sleep(10)
@asynchronous.process(timeout=0.1, context=mp_context)
def long_decorated():
time.sleep(10)
@asynchronous.process(timeout=0.1, context=mp_context)
def sigterm_decorated():
signal.signal(signal.SIGTERM, signal.SIG_IGN)
time.sleep(10)
@asynchronous.process(context=mp_context)
def name_keyword_argument(name='function_kwarg'):
return name
@asynchronous.process(name='asynchronous_process_name', context=mp_context)
def name_keyword_decorated():
return multiprocessing.current_process().name
@asynchronous.process(name='decorator_kwarg', context=mp_context)
def name_keyword_decorated_and_argument(name='bar'):
return (multiprocessing.current_process().name, name)
@asynchronous.process(daemon=False, context=mp_context)
def daemon_keyword_decorated():
return multiprocessing.current_process().daemon
@asynchronous.process(pool=ProcessPool(1, context=mp_context))
def pool_decorated(_argument, _keyword_argument=0):
return multiprocessing.current_process().pid
class ProcessAsynchronousObj:
a = 0
def __init__(self):
self.b = 1
@classmethod
@asynchronous.process(context=mp_context)
def clsmethod(cls):
return cls.a
@asynchronous.process(context=mp_context)
def instmethod(self):
return self.b
@staticmethod
@asynchronous.process(context=mp_context)
def stcmethod():
return 2
class ProcessAsynchronousSub1(ProcessAsynchronousObj):
@classmethod
@asynchronous.process(context=mp_context)
def clsmethod(cls):
return cls.a + 1
@asynchronous.process(context=mp_context)
def instmethod(self):
return self.b + 1
@staticmethod
@asynchronous.process(context=mp_context)
def stcmethod():
return 2 + 1
class ProcessAsynchronousSub2(ProcessAsynchronousObj):
@classmethod
@asynchronous.process(context=mp_context)
def clsmethod(cls):
return cls.a + 2
@asynchronous.process(context=mp_context)
def instmethod(self):
return self.b + 2
@staticmethod
@asynchronous.process(context=mp_context)
def stcmethod():
return 2 + 2
class CallableClass:
def __call__(self, argument, keyword_argument=0):
return argument + keyword_argument
@unittest.skipIf(not supported, "Start method is not supported")
class TestProcessAsynchronous(unittest.TestCase):
def setUp(self):
self.results = 0
self.exception = None
self.event = None
self.asynchronousobj = ProcessAsynchronousObj()
self.asynchronousobj1 = ProcessAsynchronousSub1()
self.asynchronousobj2 = ProcessAsynchronousSub2()
def callback(self, future):
try:
self.results = future.result()
except (ProcessExpired, RuntimeError, TimeoutError) as error:
self.exception = error
finally:
self.event.set()
def test_docstring(self):
"""Process Fork docstring is preserved."""
self.assertEqual(decorated.__doc__, "A docstring.")
def test_wrong_timeout(self):
"""Process Fork TypeError is raised if timeout is not number."""
with self.assertRaises(TypeError):
@asynchronous.process(timeout='Foo', context=mp_context)
def function():
return
def test_class_method(self):
"""Process Fork decorated classmethods."""
async def test0():
return await ProcessAsynchronousObj.clsmethod()
self.assertEqual(asyncio.run(test0()), 0)
async def test1():
return await ProcessAsynchronousSub1.clsmethod()
self.assertEqual(asyncio.run(test1()), 1)
async def test2():
return await ProcessAsynchronousSub2.clsmethod()
self.assertEqual(asyncio.run(test2()), 2)
def test_instance_method(self):
"""Process Fork decorated instance methods."""
async def test0():
return await self.asynchronousobj.instmethod()
self.assertEqual(asyncio.run(test0()), 1)
async def test1():
return await self.asynchronousobj1.instmethod()
self.assertEqual(asyncio.run(test1()), 2)
async def test2():
return await self.asynchronousobj2.instmethod()
self.assertEqual(asyncio.run(test2()), 3)
def test_static_method(self):
"""Process Fork decorated static methods (Fork startmethod only)."""
async def test0():
return await self.asynchronousobj.stcmethod()
self.assertEqual(asyncio.run(test0()), 2)
async def test1():
return await self.asynchronousobj1.stcmethod()
self.assertEqual(asyncio.run(test1()), 3)
async def test2():
return await self.asynchronousobj2.stcmethod()
self.assertEqual(asyncio.run(test2()), 4)
def test_not_decorated_results(self):
"""Process Fork results are produced."""
non_decorated = asynchronous.process(not_decorated, context=mp_context)
async def test():
return await non_decorated(1, 1)
self.assertEqual(asyncio.run(test()), 2)
def test_decorated_results(self):
"""Process Fork results are produced."""
async def test():
return await decorated(1, 1)
self.assertEqual(asyncio.run(test()), 2)
def test_decorated_results_callback(self):
"""Process Fork results are forwarded to the callback."""
async def test():
self.event = asyncio.Event()
self.event.clear()
future = decorated(1, 1)
future.add_done_callback(self.callback)
await self.event.wait()
asyncio.run(test())
self.assertEqual(self.results, 2)
def test_error_decorated(self):
"""Process Fork errors are raised by future.result."""
async def test():
return await error_decorated()
with self.assertRaises(RuntimeError):
asyncio.run(test())
def test_error_returned(self):
"""Process Fork errors are returned by future.result."""
async def test():
return await error_returned()
self.assertIsInstance(asyncio.run(test()), RuntimeError)
def test_error_decorated_callback(self):
"""Process Fork errors are forwarded to callback."""
async def test():
self.event = asyncio.Event()
self.event.clear()
future = error_decorated()
future.add_done_callback(self.callback)
await self.event.wait()
asyncio.run(test())
self.assertTrue(isinstance(self.exception, RuntimeError),
msg=str(self.exception))
def test_pickling_error_decorated(self):
"""Process Fork pickling errors are raised by future.result."""
async def test():
return await pickling_error_decorated()
with self.assertRaises((pickle.PicklingError, TypeError)):
asyncio.run(test())
def test_frozen_error_decorated(self):
"""Process Fork frozen errors are raised by future.result."""
async def test():
return await frozen_error_decorated()
with self.assertRaises(FrozenError):
asyncio.run(test())
def test_timeout_decorated(self):
"""Process Fork raises TimeoutError if so."""
async def test():
return await long_decorated()
with self.assertRaises(TimeoutError):
asyncio.run(test())
def test_timeout_decorated_callback(self):
"""Process Fork TimeoutError is forwarded to callback."""
async def test():
self.event = asyncio.Event()
self.event.clear()
future = long_decorated()
future.add_done_callback(self.callback)
await self.event.wait()
asyncio.run(test())
self.assertTrue(isinstance(self.exception, TimeoutError),
msg=str(self.exception))
def test_decorated_dead_process(self):
"""Process Fork ProcessExpired is raised if process dies."""
async def test():
return await critical_decorated()
with self.assertRaises(ProcessExpired) as exc_ctx:
asyncio.run(test())
self.assertEqual(exc_ctx.exception.exitcode, 123)
self.assertIsInstance(exc_ctx.exception.pid, int)
def test_timeout_decorated_callback(self):
"""Process Fork ProcessExpired is forwarded to callback."""
async def test():
self.event = asyncio.Event()
self.event.clear()
future = critical_decorated()
future.add_done_callback(self.callback)
await self.event.wait()
asyncio.run(test())
self.assertTrue(isinstance(self.exception, ProcessExpired),
msg=str(self.exception))
def test_cancel_decorated(self):
"""Process Fork raises CancelledError if future was cancelled."""
async def test():
future = decorated_cancel()
future.cancel()
return await future
with self.assertRaises(asyncio.CancelledError):
asyncio.run(test())
@unittest.skipIf(os.name == 'nt', "Test won't run on Windows.")
def test_decorated_ignoring_sigterm(self):
"""Process Fork Asynchronous ignored SIGTERM signal are handled on Unix."""
async def test():
return await sigterm_decorated()
with self.assertRaises(TimeoutError):
asyncio.run(test())
def test_name_keyword_argument(self):
"""name keyword can be passed to a decorated function process without name"""
async def test():
return await name_keyword_argument()
self.assertEqual(asyncio.run(test()), "function_kwarg")
def test_name_keyword_decorated(self):
"""
Check that a simple use case of the name keyword passed to the decorator works
"""
async def test():
return await name_keyword_decorated()
self.assertEqual(asyncio.run(test()), "asynchronous_process_name")
def test_name_keyword_decorated_result_colision(self):
"""name kwarg is handled without modifying the function kwargs"""
async def test():
return await name_keyword_decorated_and_argument(
name="function_kwarg")
dec_out, fn_out = asyncio.run(test())
self.assertEqual(dec_out, "decorator_kwarg")
self.assertEqual(fn_out, "function_kwarg")
def test_daemon_keyword_decorated(self):
"""Daemon keyword can be passed to a decorated function and spawns correctly."""
async def test():
return await daemon_keyword_decorated()
self.assertEqual(asyncio.run(test()), False)
def test_callable_objects(self):
"""Callable objects are correctly handled."""
callable_object = asynchronous.process(context=mp_context)(CallableClass())
async def test():
return await callable_object(1)
self.assertEqual(asyncio.run(test()), 1)
def test_pool_decorated(self):
"""Process Fork pool decorated function."""
async def test():
return await pool_decorated(1, 1)
self.assertEqual(asyncio.run(test()), asyncio.run(test()))
|