/usr/lib/python2.7/dist-packages/pykka/future.py is in python-pykka 1.2.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | import collections
import functools
from pykka import compat
__all__ = [
'Future',
'get_all',
]
def _is_iterable(x):
return (
isinstance(x, collections.Iterable) and
not isinstance(x, compat.string_types))
def _map(func, *iterables):
if len(iterables) == 1 and not _is_iterable(iterables[0]):
return func(iterables[0])
else:
return list(map(func, *iterables))
class Future(object):
"""
A :class:`Future` is a handle to a value which are available or will be
available in the future.
Typically returned by calls to actor methods or accesses to actor fields.
To get hold of the encapsulated value, call :meth:`Future.get`.
"""
def __init__(self):
super(Future, self).__init__()
self._get_hook = None
def get(self, timeout=None):
"""
Get the value encapsulated by the future.
If the encapsulated value is an exception, it is raised instead of
returned.
If ``timeout`` is :class:`None`, as default, the method will block
until it gets a reply, potentially forever. If ``timeout`` is an
integer or float, the method will wait for a reply for ``timeout``
seconds, and then raise :exc:`pykka.Timeout`.
The encapsulated value can be retrieved multiple times. The future will
only block the first time the value is accessed.
:param timeout: seconds to wait before timeout
:type timeout: float or :class:`None`
:raise: :exc:`pykka.Timeout` if timeout is reached
:raise: encapsulated value if it is an exception
:return: encapsulated value if it is not an exception
"""
if self._get_hook is not None:
return self._get_hook(timeout)
raise NotImplementedError
def set(self, value=None):
"""
Set the encapsulated value.
:param value: the encapsulated value or nothing
:type value: any picklable object or :class:`None`
:raise: an exception if set is called multiple times
"""
raise NotImplementedError
def set_exception(self, exc_info=None):
"""
Set an exception as the encapsulated value.
You can pass an ``exc_info`` three-tuple, as returned by
:func:`sys.exc_info`. If you don't pass ``exc_info``,
:func:`sys.exc_info` will be called and the value returned by it used.
In other words, if you're calling :meth:`set_exception`, without any
arguments, from an except block, the exception you're currently
handling will automatically be set on the future.
.. versionchanged:: 0.15
Previously, :meth:`set_exception` accepted an exception
instance as its only argument. This still works, but it is
deprecated and will be removed in a future release.
:param exc_info: the encapsulated exception
:type exc_info: three-tuple of (exc_class, exc_instance, traceback)
"""
raise NotImplementedError
def set_get_hook(self, func):
"""
Set a function to be executed when :meth:`get` is called.
The function will be called when :meth:`get` is called, with the
``timeout`` value as the only argument. The function's return value
will be returned from :meth:`get`.
.. versionadded:: 1.2
:param func: called to produce return value of :meth:`get`
:type func: function accepting a timeout value
"""
self._get_hook = func
def filter(self, func):
"""
Return a new future with only the items passing the predicate function.
If the future's value is an iterable, :meth:`filter` will return a new
future whose value is another iterable with only the items from the
first iterable for which ``func(item)`` is true. If the future's value
isn't an iterable, a :exc:`TypeError` will be raised when :meth:`get`
is called.
Example::
>>> import pykka
>>> f = pykka.ThreadingFuture()
>>> g = f.filter(lambda x: x > 10)
>>> g
<pykka.future.ThreadingFuture at ...>
>>> f.set(range(5, 15))
>>> f.get()
[5, 6, 7, 8, 9, 10, 11, 12, 13, 14]
>>> g.get()
[11, 12, 13, 14]
.. versionadded:: 1.2
"""
future = self.__class__()
future.set_get_hook(lambda timeout: list(filter(
func, self.get(timeout))))
return future
def join(self, *futures):
"""
Return a new future with a list of the result of multiple futures.
One or more futures can be passed as arguments to :meth:`join`. The new
future returns a list with the results from all the joined futures.
Example::
>>> import pykka
>>> a = pykka.ThreadingFuture()
>>> b = pykka.ThreadingFuture()
>>> c = pykka.ThreadingFuture()
>>> f = a.join(b, c)
>>> a.set('def')
>>> b.set(123)
>>> c.set(False)
>>> f.get()
['def', 123, False]
.. versionadded:: 1.2
"""
future = self.__class__()
future.set_get_hook(lambda timeout: [
f.get(timeout) for f in [self] + list(futures)])
return future
def map(self, func):
"""
Return a new future with the result of the future passed through a
function.
If the future's result is a single value, it is simply passed to the
function. If the future's result is an iterable, the function is
applied to each item in the iterable.
Example::
>>> import pykka
>>> f = pykka.ThreadingFuture()
>>> g = f.map(lambda x: x + 10)
>>> f.set(30)
>>> g.get()
40
>>> f = pykka.ThreadingFuture()
>>> g = f.map(lambda x: x + 10)
>>> f.set([30, 300, 3000])
>>> g.get()
[40, 310, 3010]
.. versionadded:: 1.2
"""
future = self.__class__()
future.set_get_hook(lambda timeout: _map(func, self.get(timeout)))
return future
def reduce(self, func, *args):
"""
reduce(func[, initial])
Return a new future with the result of reducing the future's iterable
into a single value.
The function of two arguments is applied cumulatively to the items of
the iterable, from left to right. The result of the first function call
is used as the first argument to the second function call, and so on,
until the end of the iterable. If the future's value isn't an iterable,
a :exc:`TypeError` is raised.
:meth:`reduce` accepts an optional second argument, which will be used
as an initial value in the first function call. If the iterable is
empty, the initial value is returned.
Example::
>>> import pykka
>>> f = pykka.ThreadingFuture()
>>> g = f.reduce(lambda x, y: x + y)
>>> f.set(['a', 'b', 'c'])
>>> g.get()
'abc'
>>> f = pykka.ThreadingFuture()
>>> g = f.reduce(lambda x, y: x + y)
>>> f.set([1, 2, 3])
>>> (1 + 2) + 3
6
>>> g.get()
6
>>> f = pykka.ThreadingFuture()
>>> g = f.reduce(lambda x, y: x + y, 5)
>>> f.set([1, 2, 3])
>>> ((5 + 1) + 2) + 3
11
>>> g.get()
11
>>> f = pykka.ThreadingFuture()
>>> g = f.reduce(lambda x, y: x + y, 5)
>>> f.set([])
>>> g.get()
5
.. versionadded:: 1.2
"""
future = self.__class__()
future.set_get_hook(lambda timeout: functools.reduce(
func, self.get(timeout), *args))
return future
def get_all(futures, timeout=None):
"""
Collect all values encapsulated in the list of futures.
If ``timeout`` is not :class:`None`, the method will wait for a reply for
``timeout`` seconds, and then raise :exc:`pykka.Timeout`.
:param futures: futures for the results to collect
:type futures: list of :class:`pykka.Future`
:param timeout: seconds to wait before timeout
:type timeout: float or :class:`None`
:raise: :exc:`pykka.Timeout` if timeout is reached
:returns: list of results
"""
return [future.get(timeout=timeout) for future in futures]
|