# -*- coding: utf-8 -*-
"""
Introduces the Executor class that wraps the standard ThreadPoolExecutor,
ProcessPoolExecutor, and the new SerialExecutor with a common interface and a
backend that changes dynamically. This makes is easy to test if your code
benefits from parallism, how much it benefits, and gives you the ability to
disable if if you need to.
Example:
>>> # xdoctest: +SKIP
>>> # Note: while this works in IPython, this does not work when running
>>> # in xdoctest. https://github.com/Erotemic/xdoctest/issues/101
>>> # xdoctest: +REQUIRES(module:timerit)
>>> # Does my function benefit from parallelism?
>>> def my_function(arg1, arg2):
... return (arg1 + arg2) * 3
>>> #
>>> def run_process(inputs, mode='serial', max_workers=0):
... from concurrent.futures import as_completed
... import ubelt as ub
... # The executor interface is the same regardless of modes
... executor = ub.Executor(mode=mode, max_workers=max_workers)
... # submit returns a Future object
... jobs = [executor.submit(my_function, *args) for args in inputs]
... # future objects will contain results when they are done
... results = [job.result() for job in as_completed(jobs)]
... return results
>>> # The same code tests our method in serial, thread, or process mode
>>> import timerit
>>> ti = timerit.Timerit(100, bestof=10, verbose=2)
>>> # Setup test data
>>> import random
>>> rng = random.Random(0)
>>> max_workers = 4
>>> inputs = [(rng.random(), rng.random()) for _ in range(100)]
>>> for mode in ['serial', 'process', 'thread']:
>>> for timer in ti.reset('mode={} max_workers={}'.format(mode, max_workers)):
>>> with timer:
>>> run_process(inputs, mode=mode, max_workers=max_workers)
>>> print(ub.repr2(ti))
"""
from __future__ import absolute_import, division, print_function, unicode_literals
import concurrent.futures
from concurrent.futures import as_completed
__all__ = ['Executor', 'JobPool']
class SerialFuture(concurrent.futures.Future):
"""
Non-threading / multiprocessing version of future for drop in compatibility
with concurrent.futures.
"""
def __init__(self, func, *args, **kw):
super(SerialFuture, self).__init__()
self.func = func
self.args = args
self.kw = kw
# self._condition = FakeCondition()
self._run_count = 0
# fake being finished to cause __get_result to be called
self._state = concurrent.futures._base.FINISHED
def _run(self):
result = self.func(*self.args, **self.kw)
self.set_result(result)
self._run_count += 1
def set_result(self, result):
"""
Overrides the implementation to revert to pre python3.8 behavior
Example:
>>> # Just for coverage
>>> from ubelt.util_futures import SerialFuture # NOQA
>>> self = SerialFuture(print, 'arg1', 'arg2')
>>> self.add_done_callback(lambda x: print('done callback got x = {}'.format(x)))
>>> print('result() before set_result()')
>>> ret = self.result()
>>> print('ret = {!r}'.format(ret))
>>> self.set_result(1)
>>> ret = self.result()
>>> print('ret = {!r}'.format(ret))
>>> #
>>> print('set_result() before result()')
>>> self = SerialFuture(print, 'arg1', 'arg2')
>>> self.add_done_callback(lambda x: print('done callback got x = {}'.format(x)))
>>> self.set_result(1)
>>> ret = self.result()
>>> print('ret = {!r}'.format(ret))
"""
with self._condition:
self._result = result
self._state = concurrent.futures._base.FINISHED
# I'm cheating a little by not covering this.
# Lets call it, cheating in good faith. *shifty eyes*
# I don't know how to test it, and its not a critical pieces of the
# library. Consider it a bug. help wanted.
for waiter in self._waiters: # nocover
waiter.add_result(self)
self._condition.notify_all()
self._invoke_callbacks()
def _Future__get_result(self):
# overrides private __getresult method
if not self._run_count:
self._run()
return self._result
class SerialExecutor(object):
"""
Implements the concurrent.futures API around a single-threaded backend
Example:
>>> from ubelt.util_futures import SerialExecutor # NOQA
>>> import concurrent.futures
>>> with SerialExecutor() as executor:
>>> futures = []
>>> for i in range(100):
>>> f = executor.submit(lambda x: x + 1, i)
>>> futures.append(f)
>>> for f in concurrent.futures.as_completed(futures):
>>> assert f.result() > 0
>>> for i, f in enumerate(futures):
>>> assert i + 1 == f.result()
"""
def __enter__(self):
self.max_workers = 0
return self
def __exit__(self, ex_type, ex_value, tb):
pass
def submit(self, func, *args, **kw):
return SerialFuture(func, *args, **kw)
def shutdown(self):
pass
[docs]class Executor(object):
"""
Wrapper around a specific executor.
Abstracts Serial, Thread, and Process Executor via arguments.
Args:
mode (str, default='thread'): either thread, serial, or process
max_workers (int, default=0): number of workers. If 0, serial is forced.
Example:
>>> import platform
>>> # The process backend breaks pyp3 when using coverage
>>> if 'pypy' in platform.python_implementation().lower():
... import pytest
... pytest.skip('not testing process on pypy')
>>> import ubelt as ub
>>> # Fork before threading!
>>> # https://pybay.com/site_media/slides/raymond2017-keynote/combo.html
>>> self1 = ub.Executor(mode='serial', max_workers=0)
>>> self1.__enter__()
>>> self2 = ub.Executor(mode='process', max_workers=2)
>>> self2.__enter__()
>>> self3 = ub.Executor(mode='thread', max_workers=2)
>>> self3.__enter__()
>>> jobs = []
>>> jobs.append(self1.submit(sum, [1, 2, 3]))
>>> jobs.append(self1.submit(sum, [1, 2, 3]))
>>> jobs.append(self2.submit(sum, [10, 20, 30]))
>>> jobs.append(self2.submit(sum, [10, 20, 30]))
>>> jobs.append(self3.submit(sum, [4, 5, 5]))
>>> jobs.append(self3.submit(sum, [4, 5, 5]))
>>> for job in jobs:
>>> result = job.result()
>>> print('result = {!r}'.format(result))
>>> self1.__exit__(None, None, None)
>>> self2.__exit__(None, None, None)
>>> self3.__exit__(None, None, None)
Example:
>>> import ubelt as ub
>>> self1 = ub.Executor(mode='serial', max_workers=0)
>>> with self1:
>>> jobs = []
>>> for i in range(10):
>>> jobs.append(self1.submit(sum, [i + 1, i]))
>>> for job in jobs:
>>> job.add_done_callback(lambda x: print('done callback got x = {}'.format(x)))
>>> result = job.result()
>>> print('result = {!r}'.format(result))
"""
def __init__(self, mode='thread', max_workers=0):
from concurrent import futures
if mode == 'serial' or max_workers == 0:
backend = SerialExecutor()
elif mode == 'thread':
backend = futures.ThreadPoolExecutor(max_workers=max_workers)
elif mode == 'process':
backend = futures.ProcessPoolExecutor(max_workers=max_workers)
else:
raise KeyError(mode)
self.backend = backend
def __enter__(self):
return self.backend.__enter__()
def __exit__(self, ex_type, ex_value, tb):
return self.backend.__exit__(ex_type, ex_value, tb)
[docs] def submit(self, func, *args, **kw):
return self.backend.submit(func, *args, **kw)
[docs] def shutdown(self):
return self.backend.shutdown()
[docs]class JobPool(object):
"""
Abstracts away boilerplate of submitting and collecting jobs
Example:
>>> import ubelt as ub
>>> def worker(data):
>>> return data + 1
>>> pool = ub.JobPool('thread', max_workers=16)
>>> with pool:
>>> for data in ub.ProgIter(range(10), desc='submit jobs'):
>>> job = pool.submit(worker, data)
>>> final = []
>>> for job in ub.ProgIter(pool.as_completed(), total=len(pool), desc='collect jobs'):
>>> info = job.result()
>>> final.append(info)
>>> print('final = {!r}'.format(final))
>>> pool.shutdown()
"""
def __init__(self, mode='thread', max_workers=0):
self.executor = Executor(mode=mode, max_workers=max_workers)
self.jobs = []
def __len__(self):
return len(self.jobs)
[docs] def submit(self, func, *args, **kwargs):
job = self.executor.submit(func, *args, **kwargs)
self.jobs.append(job)
return job
[docs] def shutdown(self):
self.jobs = None
return self.executor.shutdown()
def __enter__(self):
self.executor.__enter__()
return self
def __exit__(self, a, b, c):
self.executor.__exit__(a, b, c)
[docs] def as_completed(self):
"""
Generates completed jobs in an arbitrary order
Yields:
concurrent.futures.Future
CommandLine:
xdoctest -m ubelt.util_futures JobPool.as_completed
Example:
>>> import ubelt as ub
>>> pool = ub.JobPool('thread', max_workers=8)
>>> text = ub.paragraph(
... '''
... UDP is a cool protocol, check out the wiki:
...
... UDP-based Data Transfer Protocol (UDT), is a high-performance
... data transfer protocol designed for transferring large
... volumetric datasets over high-speed wide area networks. Such
... settings are typically disadvantageous for the more common TCP
... protocol.
... ''')
>>> for word in text.split(' '):
... pool.submit(print, word)
>>> for _ in pool.as_completed():
... pass
>>> pool.shutdown()
"""
for job in as_completed(self.jobs):
yield job
def __iter__(self):
"""
An alternative to as completed
Example:
>>> import ubelt as ub
>>> pool = ub.JobPool('serial')
>>> assert len(list(iter(pool))) == 0
>>> pool.submit(print, 'hi')
>>> assert len(list(iter(pool))) == 1
"""
for job in self.as_completed():
yield job