mercurial-scm/hg: mercurial/thirdparty/concurrent/futures/

annotate mercurial/thirdparty/concurrent/futures/_base.py @ 46244:fb69b51b4daa

ci: avoid a global before_script definition This removes the implicit assumption that all jobs are test runs. Differential Revision: https://phab.mercurial-scm.org/D9723

author	Dan Villiom Podlaski Christiansen <danchr@gmail.com>
date	Mon, 11 Jan 2021 15:16:36 +0100
parents	0a9c0d3480b2
children

rev	line source
37623 eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1 # Copyright 2009 Brian Quinlan. All Rights Reserved.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	2 # Licensed to PSF under a Contributor Agreement.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3
37626 0a9c0d3480b2 futures: switch to absolute and relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37623 diff changeset	4 from __future__ import absolute_import
0a9c0d3480b2 futures: switch to absolute and relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37623 diff changeset	5
37623 eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 import collections
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	7 import logging
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	8 import threading
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	9 import itertools
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	10 import time
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	11 import types
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	12
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	13 __author__ = 'Brian Quinlan (brian@sweetapp.com)'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	14
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	15 FIRST_COMPLETED = 'FIRST_COMPLETED'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	16 FIRST_EXCEPTION = 'FIRST_EXCEPTION'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	17 ALL_COMPLETED = 'ALL_COMPLETED'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	18 _AS_COMPLETED = '_AS_COMPLETED'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	19
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	20 # Possible future states (for internal use by the futures package).
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	21 PENDING = 'PENDING'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	22 RUNNING = 'RUNNING'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	23 # The future was cancelled by the user...
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	24 CANCELLED = 'CANCELLED'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	25 # ...and _Waiter.add_cancelled() was called by a worker.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	26 CANCELLED_AND_NOTIFIED = 'CANCELLED_AND_NOTIFIED'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	27 FINISHED = 'FINISHED'
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	28
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	29 _FUTURE_STATES = [
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	30 PENDING,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	31 RUNNING,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	32 CANCELLED,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	33 CANCELLED_AND_NOTIFIED,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	34 FINISHED
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	35 ]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	36
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	37 _STATE_TO_DESCRIPTION_MAP = {
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	38 PENDING: "pending",
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39 RUNNING: "running",
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	40 CANCELLED: "cancelled",
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	41 CANCELLED_AND_NOTIFIED: "cancelled",
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	42 FINISHED: "finished"
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	43 }
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	44
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	45 # Logger for internal use by the futures package.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	46 LOGGER = logging.getLogger("concurrent.futures")
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	47
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	48 class Error(Exception):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	49 """Base class for all future-related exceptions."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	50 pass
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	51
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	52 class CancelledError(Error):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	53 """The Future was cancelled."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	54 pass
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	55
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	56 class TimeoutError(Error):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	57 """The operation exceeded the given deadline."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	58 pass
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	59
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	60 class _Waiter(object):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	61 """Provides the event that wait() and as_completed() block on."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	62 def __init__(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	63 self.event = threading.Event()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	64 self.finished_futures = []
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	65
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	66 def add_result(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	67 self.finished_futures.append(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	68
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	69 def add_exception(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	70 self.finished_futures.append(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	71
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	72 def add_cancelled(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	73 self.finished_futures.append(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	74
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	75 class _AsCompletedWaiter(_Waiter):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	76 """Used by as_completed()."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	77
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	78 def __init__(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	79 super(_AsCompletedWaiter, self).__init__()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	80 self.lock = threading.Lock()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	81
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	82 def add_result(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	83 with self.lock:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	84 super(_AsCompletedWaiter, self).add_result(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	85 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	86
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	87 def add_exception(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	88 with self.lock:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	89 super(_AsCompletedWaiter, self).add_exception(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	90 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	91
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	92 def add_cancelled(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	93 with self.lock:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	94 super(_AsCompletedWaiter, self).add_cancelled(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	95 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	96
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	97 class _FirstCompletedWaiter(_Waiter):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	98 """Used by wait(return_when=FIRST_COMPLETED)."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	99
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	100 def add_result(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	101 super(_FirstCompletedWaiter, self).add_result(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	102 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	103
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	104 def add_exception(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	105 super(_FirstCompletedWaiter, self).add_exception(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	106 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	107
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	108 def add_cancelled(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	109 super(_FirstCompletedWaiter, self).add_cancelled(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	110 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	111
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	112 class _AllCompletedWaiter(_Waiter):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	113 """Used by wait(return_when=FIRST_EXCEPTION and ALL_COMPLETED)."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	114
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	115 def __init__(self, num_pending_calls, stop_on_exception):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	116 self.num_pending_calls = num_pending_calls
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	117 self.stop_on_exception = stop_on_exception
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	118 self.lock = threading.Lock()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	119 super(_AllCompletedWaiter, self).__init__()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	120
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	121 def _decrement_pending_calls(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	122 with self.lock:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	123 self.num_pending_calls -= 1
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	124 if not self.num_pending_calls:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	125 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	126
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	127 def add_result(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	128 super(_AllCompletedWaiter, self).add_result(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	129 self._decrement_pending_calls()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	130
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	131 def add_exception(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	132 super(_AllCompletedWaiter, self).add_exception(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	133 if self.stop_on_exception:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	134 self.event.set()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	135 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	136 self._decrement_pending_calls()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	137
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	138 def add_cancelled(self, future):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	139 super(_AllCompletedWaiter, self).add_cancelled(future)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	140 self._decrement_pending_calls()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	141
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	142 class _AcquireFutures(object):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	143 """A context manager that does an ordered acquire of Future conditions."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	144
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	145 def __init__(self, futures):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	146 self.futures = sorted(futures, key=id)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	147
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	148 def __enter__(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	149 for future in self.futures:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	150 future._condition.acquire()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	151
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	152 def __exit__(self, *args):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	153 for future in self.futures:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	154 future._condition.release()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	155
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	156 def _create_and_install_waiters(fs, return_when):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	157 if return_when == _AS_COMPLETED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	158 waiter = _AsCompletedWaiter()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	159 elif return_when == FIRST_COMPLETED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	160 waiter = _FirstCompletedWaiter()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	161 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	162 pending_count = sum(
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	163 f._state not in [CANCELLED_AND_NOTIFIED, FINISHED] for f in fs)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	164
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	165 if return_when == FIRST_EXCEPTION:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	166 waiter = _AllCompletedWaiter(pending_count, stop_on_exception=True)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	167 elif return_when == ALL_COMPLETED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	168 waiter = _AllCompletedWaiter(pending_count, stop_on_exception=False)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	169 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	170 raise ValueError("Invalid return condition: %r" % return_when)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	171
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	172 for f in fs:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	173 f._waiters.append(waiter)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	174
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	175 return waiter
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	176
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	177
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	178 def _yield_finished_futures(fs, waiter, ref_collect):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	179 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	180 Iterate on the list fs, yielding finished futures one by one in
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	181 reverse order.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	182 Before yielding a future, waiter is removed from its waiters
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	183 and the future is removed from each set in the collection of sets
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	184 ref_collect.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	185
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	186 The aim of this function is to avoid keeping stale references after
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	187 the future is yielded and before the iterator resumes.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	188 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	189 while fs:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	190 f = fs[-1]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	191 for futures_set in ref_collect:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	192 futures_set.remove(f)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	193 with f._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	194 f._waiters.remove(waiter)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	195 del f
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	196 # Careful not to keep a reference to the popped value
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	197 yield fs.pop()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	198
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	199
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	200 def as_completed(fs, timeout=None):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	201 """An iterator over the given futures that yields each as it completes.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	202
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	203 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	204 fs: The sequence of Futures (possibly created by different Executors) to
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	205 iterate over.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	206 timeout: The maximum number of seconds to wait. If None, then there
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	207 is no limit on the wait time.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	208
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	209 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	210 An iterator that yields the given Futures as they complete (finished or
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	211 cancelled). If any given Futures are duplicated, they will be returned
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	212 once.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	213
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	214 Raises:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	215 TimeoutError: If the entire result iterator could not be generated
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	216 before the given timeout.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	217 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	218 if timeout is not None:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	219 end_time = timeout + time.time()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	220
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	221 fs = set(fs)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	222 total_futures = len(fs)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	223 with _AcquireFutures(fs):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	224 finished = set(
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	225 f for f in fs
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	226 if f._state in [CANCELLED_AND_NOTIFIED, FINISHED])
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	227 pending = fs - finished
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	228 waiter = _create_and_install_waiters(fs, _AS_COMPLETED)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	229 finished = list(finished)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	230 try:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	231 for f in _yield_finished_futures(finished, waiter,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	232 ref_collect=(fs,)):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	233 f = [f]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	234 yield f.pop()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	235
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	236 while pending:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	237 if timeout is None:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	238 wait_timeout = None
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	239 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	240 wait_timeout = end_time - time.time()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	241 if wait_timeout < 0:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	242 raise TimeoutError(
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	243 '%d (of %d) futures unfinished' % (
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	244 len(pending), total_futures))
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	245
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	246 waiter.event.wait(wait_timeout)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	247
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	248 with waiter.lock:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	249 finished = waiter.finished_futures
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	250 waiter.finished_futures = []
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	251 waiter.event.clear()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	252
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	253 # reverse to keep finishing order
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	254 finished.reverse()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	255 for f in _yield_finished_futures(finished, waiter,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	256 ref_collect=(fs, pending)):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	257 f = [f]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	258 yield f.pop()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	259
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	260 finally:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	261 # Remove waiter from unfinished futures
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	262 for f in fs:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	263 with f._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	264 f._waiters.remove(waiter)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	265
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	266 DoneAndNotDoneFutures = collections.namedtuple(
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	267 'DoneAndNotDoneFutures', 'done not_done')
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	268 def wait(fs, timeout=None, return_when=ALL_COMPLETED):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	269 """Wait for the futures in the given sequence to complete.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	270
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	271 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	272 fs: The sequence of Futures (possibly created by different Executors) to
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	273 wait upon.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	274 timeout: The maximum number of seconds to wait. If None, then there
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	275 is no limit on the wait time.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	276 return_when: Indicates when this function should return. The options
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	277 are:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	278
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	279 FIRST_COMPLETED - Return when any future finishes or is
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	280 cancelled.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	281 FIRST_EXCEPTION - Return when any future finishes by raising an
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	282 exception. If no future raises an exception
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	283 then it is equivalent to ALL_COMPLETED.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	284 ALL_COMPLETED - Return when all futures finish or are cancelled.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	285
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	286 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	287 A named 2-tuple of sets. The first set, named 'done', contains the
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	288 futures that completed (is finished or cancelled) before the wait
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	289 completed. The second set, named 'not_done', contains uncompleted
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	290 futures.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	291 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	292 with _AcquireFutures(fs):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	293 done = set(f for f in fs
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	294 if f._state in [CANCELLED_AND_NOTIFIED, FINISHED])
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	295 not_done = set(fs) - done
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	296
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	297 if (return_when == FIRST_COMPLETED) and done:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	298 return DoneAndNotDoneFutures(done, not_done)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	299 elif (return_when == FIRST_EXCEPTION) and done:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	300 if any(f for f in done
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	301 if not f.cancelled() and f.exception() is not None):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	302 return DoneAndNotDoneFutures(done, not_done)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	303
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	304 if len(done) == len(fs):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	305 return DoneAndNotDoneFutures(done, not_done)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	306
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	307 waiter = _create_and_install_waiters(fs, return_when)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	308
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	309 waiter.event.wait(timeout)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	310 for f in fs:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	311 with f._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	312 f._waiters.remove(waiter)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	313
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	314 done.update(waiter.finished_futures)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	315 return DoneAndNotDoneFutures(done, set(fs) - done)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	316
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	317 class Future(object):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	318 """Represents the result of an asynchronous computation."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	319
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	320 def __init__(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	321 """Initializes the future. Should not be called by clients."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	322 self._condition = threading.Condition()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	323 self._state = PENDING
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	324 self._result = None
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	325 self._exception = None
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	326 self._traceback = None
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	327 self._waiters = []
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	328 self._done_callbacks = []
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	329
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	330 def _invoke_callbacks(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	331 for callback in self._done_callbacks:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	332 try:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	333 callback(self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	334 except Exception:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	335 LOGGER.exception('exception calling callback for %r', self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	336 except BaseException:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	337 # Explicitly let all other new-style exceptions through so
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	338 # that we can catch all old-style exceptions with a simple
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	339 # "except:" clause below.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	340 #
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	341 # All old-style exception objects are instances of
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	342 # types.InstanceType, but "except types.InstanceType:" does
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	343 # not catch old-style exceptions for some reason. Thus, the
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	344 # only way to catch all old-style exceptions without catching
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	345 # any new-style exceptions is to filter out the new-style
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	346 # exceptions, which all derive from BaseException.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	347 raise
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	348 except:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	349 # Because of the BaseException clause above, this handler only
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	350 # executes for old-style exception objects.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	351 LOGGER.exception('exception calling callback for %r', self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	352
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	353 def __repr__(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	354 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	355 if self._state == FINISHED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	356 if self._exception:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	357 return '<%s at %#x state=%s raised %s>' % (
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	358 self.__class__.__name__,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	359 id(self),
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	360 _STATE_TO_DESCRIPTION_MAP[self._state],
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	361 self._exception.__class__.__name__)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	362 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	363 return '<%s at %#x state=%s returned %s>' % (
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	364 self.__class__.__name__,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	365 id(self),
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	366 _STATE_TO_DESCRIPTION_MAP[self._state],
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	367 self._result.__class__.__name__)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	368 return '<%s at %#x state=%s>' % (
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	369 self.__class__.__name__,
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	370 id(self),
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	371 _STATE_TO_DESCRIPTION_MAP[self._state])
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	372
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	373 def cancel(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	374 """Cancel the future if possible.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	375
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	376 Returns True if the future was cancelled, False otherwise. A future
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	377 cannot be cancelled if it is running or has already completed.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	378 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	379 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	380 if self._state in [RUNNING, FINISHED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	381 return False
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	382
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	383 if self._state in [CANCELLED, CANCELLED_AND_NOTIFIED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	384 return True
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	385
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	386 self._state = CANCELLED
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	387 self._condition.notify_all()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	388
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	389 self._invoke_callbacks()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	390 return True
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	391
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	392 def cancelled(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	393 """Return True if the future was cancelled."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	394 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	395 return self._state in [CANCELLED, CANCELLED_AND_NOTIFIED]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	396
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	397 def running(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	398 """Return True if the future is currently executing."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	399 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	400 return self._state == RUNNING
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	401
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	402 def done(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	403 """Return True of the future was cancelled or finished executing."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	404 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	405 return self._state in [CANCELLED, CANCELLED_AND_NOTIFIED, FINISHED]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	406
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	407 def __get_result(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	408 if self._exception:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	409 if isinstance(self._exception, types.InstanceType):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	410 # The exception is an instance of an old-style class, which
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	411 # means type(self._exception) returns types.ClassType instead
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	412 # of the exception's actual class type.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	413 exception_type = self._exception.__class__
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	414 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	415 exception_type = type(self._exception)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	416 raise exception_type, self._exception, self._traceback
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	417 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	418 return self._result
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	419
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	420 def add_done_callback(self, fn):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	421 """Attaches a callable that will be called when the future finishes.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	422
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	423 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	424 fn: A callable that will be called with this future as its only
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	425 argument when the future completes or is cancelled. The callable
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	426 will always be called by a thread in the same process in which
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	427 it was added. If the future has already completed or been
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	428 cancelled then the callable will be called immediately. These
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	429 callables are called in the order that they were added.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	430 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	431 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	432 if self._state not in [CANCELLED, CANCELLED_AND_NOTIFIED, FINISHED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	433 self._done_callbacks.append(fn)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	434 return
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	435 fn(self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	436
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	437 def result(self, timeout=None):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	438 """Return the result of the call that the future represents.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	439
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	440 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	441 timeout: The number of seconds to wait for the result if the future
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	442 isn't done. If None, then there is no limit on the wait time.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	443
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	444 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	445 The result of the call that the future represents.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	446
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	447 Raises:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	448 CancelledError: If the future was cancelled.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	449 TimeoutError: If the future didn't finish executing before the given
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	450 timeout.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	451 Exception: If the call raised then that exception will be raised.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	452 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	453 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	454 if self._state in [CANCELLED, CANCELLED_AND_NOTIFIED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	455 raise CancelledError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	456 elif self._state == FINISHED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	457 return self.__get_result()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	458
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	459 self._condition.wait(timeout)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	460
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	461 if self._state in [CANCELLED, CANCELLED_AND_NOTIFIED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	462 raise CancelledError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	463 elif self._state == FINISHED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	464 return self.__get_result()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	465 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	466 raise TimeoutError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	467
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	468 def exception_info(self, timeout=None):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	469 """Return a tuple of (exception, traceback) raised by the call that the
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	470 future represents.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	471
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	472 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	473 timeout: The number of seconds to wait for the exception if the
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	474 future isn't done. If None, then there is no limit on the wait
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	475 time.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	476
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	477 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	478 The exception raised by the call that the future represents or None
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	479 if the call completed without raising.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	480
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	481 Raises:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	482 CancelledError: If the future was cancelled.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	483 TimeoutError: If the future didn't finish executing before the given
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	484 timeout.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	485 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	486 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	487 if self._state in [CANCELLED, CANCELLED_AND_NOTIFIED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	488 raise CancelledError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	489 elif self._state == FINISHED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	490 return self._exception, self._traceback
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	491
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	492 self._condition.wait(timeout)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	493
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	494 if self._state in [CANCELLED, CANCELLED_AND_NOTIFIED]:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	495 raise CancelledError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	496 elif self._state == FINISHED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	497 return self._exception, self._traceback
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	498 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	499 raise TimeoutError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	500
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	501 def exception(self, timeout=None):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	502 """Return the exception raised by the call that the future represents.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	503
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	504 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	505 timeout: The number of seconds to wait for the exception if the
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	506 future isn't done. If None, then there is no limit on the wait
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	507 time.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	508
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	509 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	510 The exception raised by the call that the future represents or None
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	511 if the call completed without raising.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	512
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	513 Raises:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	514 CancelledError: If the future was cancelled.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	515 TimeoutError: If the future didn't finish executing before the given
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	516 timeout.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	517 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	518 return self.exception_info(timeout)[0]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	519
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	520 # The following methods should only be used by Executors and in tests.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	521 def set_running_or_notify_cancel(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	522 """Mark the future as running or process any cancel notifications.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	523
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	524 Should only be used by Executor implementations and unit tests.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	525
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	526 If the future has been cancelled (cancel() was called and returned
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	527 True) then any threads waiting on the future completing (though calls
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	528 to as_completed() or wait()) are notified and False is returned.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	529
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	530 If the future was not cancelled then it is put in the running state
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	531 (future calls to running() will return True) and True is returned.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	532
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	533 This method should be called by Executor implementations before
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	534 executing the work associated with this future. If this method returns
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	535 False then the work should not be executed.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	536
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	537 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	538 False if the Future was cancelled, True otherwise.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	539
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	540 Raises:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	541 RuntimeError: if this method was already called or if set_result()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	542 or set_exception() was called.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	543 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	544 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	545 if self._state == CANCELLED:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	546 self._state = CANCELLED_AND_NOTIFIED
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	547 for waiter in self._waiters:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	548 waiter.add_cancelled(self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	549 # self._condition.notify_all() is not necessary because
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	550 # self.cancel() triggers a notification.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	551 return False
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	552 elif self._state == PENDING:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	553 self._state = RUNNING
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	554 return True
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	555 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	556 LOGGER.critical('Future %s in unexpected state: %s',
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	557 id(self),
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	558 self._state)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	559 raise RuntimeError('Future in unexpected state')
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	560
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	561 def set_result(self, result):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	562 """Sets the return value of work associated with the future.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	563
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	564 Should only be used by Executor implementations and unit tests.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	565 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	566 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	567 self._result = result
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	568 self._state = FINISHED
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	569 for waiter in self._waiters:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	570 waiter.add_result(self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	571 self._condition.notify_all()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	572 self._invoke_callbacks()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	573
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	574 def set_exception_info(self, exception, traceback):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	575 """Sets the result of the future as being the given exception
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	576 and traceback.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	577
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	578 Should only be used by Executor implementations and unit tests.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	579 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	580 with self._condition:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	581 self._exception = exception
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	582 self._traceback = traceback
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	583 self._state = FINISHED
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	584 for waiter in self._waiters:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	585 waiter.add_exception(self)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	586 self._condition.notify_all()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	587 self._invoke_callbacks()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	588
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	589 def set_exception(self, exception):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	590 """Sets the result of the future as being the given exception.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	591
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	592 Should only be used by Executor implementations and unit tests.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	593 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	594 self.set_exception_info(exception, None)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	595
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	596 class Executor(object):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	597 """This is an abstract base class for concrete asynchronous executors."""
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	598
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	599 def submit(self, fn, args, *kwargs):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	600 """Submits a callable to be executed with the given arguments.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	601
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	602 Schedules the callable to be executed as fn(args, *kwargs) and returns
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	603 a Future instance representing the execution of the callable.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	604
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	605 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	606 A Future representing the given call.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	607 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	608 raise NotImplementedError()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	609
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	610 def map(self, fn, iterables, *kwargs):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	611 """Returns an iterator equivalent to map(fn, iter).
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	612
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	613 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	614 fn: A callable that will take as many arguments as there are
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	615 passed iterables.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	616 timeout: The maximum number of seconds to wait. If None, then there
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	617 is no limit on the wait time.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	618
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	619 Returns:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	620 An iterator equivalent to: map(func, *iterables) but the calls may
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	621 be evaluated out-of-order.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	622
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	623 Raises:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	624 TimeoutError: If the entire result iterator could not be generated
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	625 before the given timeout.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	626 Exception: If fn(*args) raises for any values.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	627 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	628 timeout = kwargs.get('timeout')
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	629 if timeout is not None:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	630 end_time = timeout + time.time()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	631
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	632 fs = [self.submit(fn, args) for args in itertools.izip(iterables)]
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	633
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	634 # Yield must be hidden in closure so that the futures are submitted
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	635 # before the first iterator value is required.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	636 def result_iterator():
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	637 try:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	638 # reverse to keep finishing order
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	639 fs.reverse()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	640 while fs:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	641 # Careful not to keep a reference to the popped future
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	642 if timeout is None:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	643 yield fs.pop().result()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	644 else:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	645 yield fs.pop().result(end_time - time.time())
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	646 finally:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	647 for future in fs:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	648 future.cancel()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	649 return result_iterator()
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	650
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	651 def shutdown(self, wait=True):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	652 """Clean-up the resources associated with the Executor.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	653
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	654 It is safe to call this method several times. Otherwise, no other
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	655 methods can be called after this one.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	656
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	657 Args:
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	658 wait: If True then shutdown will not return until all running
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	659 futures have finished executing and the resources used by the
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	660 executor have been reclaimed.
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	661 """
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	662 pass
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	663
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	664 def __enter__(self):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	665 return self
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	666
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	667 def __exit__(self, exc_type, exc_val, exc_tb):
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	668 self.shutdown(wait=True)
eb687c28a915 thirdparty: vendor futures 3.2.0 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	669 return False

Mercurial > public > mercurial-scm > hg

annotate mercurial/thirdparty/concurrent/futures/_base.py @ 46244:fb69b51b4daa