Skip to content

futures_executor_mixin

FuturesExecutorMixin

Bases: ABC

Source code in griptape/mixins/futures_executor_mixin.py 
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
@define(slots=False, kw_only=True)
class FuturesExecutorMixin(ABC):
    create_futures_executor: Callable[[], futures.Executor] = field(
        default=Factory(lambda: lambda: futures.ThreadPoolExecutor()),
    )

    _futures_executor: futures.Executor = field(
        default=Factory(
            lambda self: self.create_futures_executor(),
            takes_self=True,
        ),
        alias="futures_executor",
    )

    @property
    def futures_executor(self) -> futures.Executor:
        self.__raise_deprecation_warning()
        return self._futures_executor

    @futures_executor.setter
    def futures_executor(self, value: futures.Executor) -> None:
        self.__raise_deprecation_warning()
        self._futures_executor = value

    def __raise_deprecation_warning(self) -> None:
        warnings.warn(
            "`FuturesExecutorMixin.futures_executor` is deprecated and will be removed in a future release. Use `FuturesExecutorMixin.create_futures_executor` instead.",
            DeprecationWarning,
            stacklevel=2,
        )

_futures_executor = field(default=Factory(lambda self: self.create_futures_executor(), takes_self=True), alias='futures_executor') class-attribute instance-attribute

create_futures_executor = field(default=Factory(lambda: lambda: futures.ThreadPoolExecutor())) class-attribute instance-attribute

futures_executor property writable

__raise_deprecation_warning()

Source code in griptape/mixins/futures_executor_mixin.py 
35
36
37
38
39
40
def __raise_deprecation_warning(self) -> None:
    warnings.warn(
        "`FuturesExecutorMixin.futures_executor` is deprecated and will be removed in a future release. Use `FuturesExecutorMixin.create_futures_executor` instead.",
        DeprecationWarning,
        stacklevel=2,
    )