summaryrefslogtreecommitdiff
path: root/smart_future.py
blob: 604c149520464bcd9d8c5a55cf8905acd5ec34d4 (plain)
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
#!/usr/bin/env python3

from __future__ import annotations
import concurrent
import concurrent.futures as fut
import logging
import traceback
from typing import Callable, List, TypeVar

from overrides import overrides

# This module is commonly used by others in here and should avoid
# taking any unnecessary dependencies back on them.
from deferred_operand import DeferredOperand
import id_generator

logger = logging.getLogger(__name__)

T = TypeVar('T')


def wait_any(
    futures: List[SmartFuture],
    *,
    callback: Callable = None,
    log_exceptions: bool = True,
):
    real_futures = []
    smart_future_by_real_future = {}
    completed_futures = set()
    for f in futures:
        assert type(f) == SmartFuture
        real_futures.append(f.wrapped_future)
        smart_future_by_real_future[f.wrapped_future] = f

    while len(completed_futures) != len(real_futures):
        newly_completed_futures = concurrent.futures.as_completed(real_futures)
        for f in newly_completed_futures:
            if callback is not None:
                callback()
            completed_futures.add(f)
            if log_exceptions and not f.cancelled():
                exception = f.exception()
                if exception is not None:
                    logger.warning(
                        f'Future {id(f)} raised an unhandled exception and exited.'
                    )
                    logger.exception(exception)
                    raise exception
            yield smart_future_by_real_future[f]
    if callback is not None:
        callback()
    return


def wait_all(
    futures: List[SmartFuture],
    *,
    log_exceptions: bool = True,
) -> None:
    real_futures = []
    for f in futures:
        assert type(f) == SmartFuture
        real_futures.append(f.wrapped_future)

    (done, not_done) = concurrent.futures.wait(
        real_futures, timeout=None, return_when=concurrent.futures.ALL_COMPLETED
    )
    if log_exceptions:
        for f in real_futures:
            if not f.cancelled():
                exception = f.exception()
                if exception is not None:
                    logger.warning(
                        f'Future {id(f)} raised an unhandled exception and exited.'
                    )
                    logger.exception(exception)
                    raise exception
    assert len(done) == len(real_futures)
    assert len(not_done) == 0


class SmartFuture(DeferredOperand):
    """This is a SmartFuture, a class that wraps a normal Future and can
    then be used, mostly, like a normal (non-Future) identifier.

    Using a FutureWrapper in expressions will block and wait until
    the result of the deferred operation is known.
    """

    def __init__(self, wrapped_future: fut.Future) -> None:
        assert type(wrapped_future) == fut.Future
        self.wrapped_future = wrapped_future
        self.id = id_generator.get("smart_future_id")

    def get_id(self) -> int:
        return self.id

    def is_ready(self) -> bool:
        return self.wrapped_future.done()

    # You shouldn't have to call this; instead, have a look at defining a
    # method on DeferredOperand base class.
    @overrides
    def _resolve(self, *, timeout=None) -> T:
        return self.wrapped_future.result(timeout)