Source code for traits_futures.i_parallel_context

# (C) Copyright 2018-2024 Enthought, Inc., Austin, TX
# All rights reserved.
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at
# Thanks for using Enthought open source!

Interface for the parallelism context needed by the TraitsExecutor

import abc

[docs] class IParallelContext(abc.ABC): """ Interface for the parallelism context needed by the TraitsExecutor. A class implementing this interface provides a worker pool, message router and other concurrency primitives suitable for a particular form of parallelism, for example multithreading or multiprocessing. """
[docs] @abc.abstractmethod def worker_pool(self, *, max_workers=None): """ Provide a worker pool suitable for this context. Parameters ---------- max_workers : int, optional Maximum number of workers in the worker pool. If not given, it's up to the worker pool to choose a suitable number of workers, perhaps dependent on the number of logical cores present on the target machine. Returns ------- executor : concurrent.futures.Executor """
[docs] @abc.abstractmethod def event(self): """ Return a shareable event suitable for this context. Returns ------- event : object An event that can be shared safely with workers. The event should have the same API as :class:`threading.Event` and :class:`multiprocessing.Event`, providing at a minimum the ``set`` and ``is_set`` methods from that API. """
[docs] @abc.abstractmethod def message_router(self, event_loop): """ Return a message router suitable for use in this context. Parameters ---------- event_loop : IEventLoop The event loop to interact with. Returns ------- message_router : IMessageRouter """
[docs] @abc.abstractmethod def close(self): """ Do any cleanup necessary before disposal of the context. """
@property @abc.abstractmethod def closed(self): """ True if this context is closed, else False. """