p2pool/util/deferral.py

   1 from __future__ import division
   2
   3 import itertools
   4 import random
   5 import sys
   6
   7 from twisted.internet import defer, reactor
   8 from twisted.python import failure, log
   9
  10 def sleep(t):
  11     d = defer.Deferred()
  12     reactor.callLater(t, d.callback, None)
  13     return d
  14
  15 def run_repeatedly(f, *args, **kwargs):
  16     current_dc = [None]
  17     def step():
  18         delay = f(*args, **kwargs)
  19         current_dc[0] = reactor.callLater(delay, step)
  20     step()
  21     def stop():
  22         current_dc[0].cancel()
  23     return stop
  24
  25 class RetrySilentlyException(Exception):
  26     pass
  27
  28 def retry(message='Error:', delay=3, max_retries=None, traceback=True):
  29     '''
  30     @retry('Error getting block:', 1)
  31     @defer.inlineCallbacks
  32     def get_block(hash):
  33         ...
  34     '''
  35
  36     def retry2(func):
  37         @defer.inlineCallbacks
  38         def f(*args, **kwargs):
  39             for i in itertools.count():
  40                 try:
  41                     result = yield func(*args, **kwargs)
  42                 except Exception, e:
  43                     if i == max_retries:
  44                         raise
  45                     if not isinstance(e, RetrySilentlyException):
  46                         if traceback:
  47                             log.err(None, message)
  48                         else:
  49                             print >>sys.stderr, message, e
  50                     yield sleep(delay)
  51                 else:
  52                     defer.returnValue(result)
  53         return f
  54     return retry2
  55
  56 class ReplyMatcher(object):
  57     '''
  58     Converts request/got response interface to deferred interface
  59     '''
  60
  61     def __init__(self, func, timeout=5):
  62         self.func = func
  63         self.timeout = timeout
  64         self.map = {}
  65
  66     def __call__(self, id):
  67         if id not in self.map:
  68             self.func(id)
  69         df = defer.Deferred()
  70         def timeout():
  71             self.map[id].remove((df, timer))
  72             if not self.map[id]:
  73                 del self.map[id]
  74             df.errback(failure.Failure(defer.TimeoutError('in ReplyMatcher')))
  75         timer = reactor.callLater(self.timeout, timeout)
  76         self.map.setdefault(id, set()).add((df, timer))
  77         return df
  78
  79     def got_response(self, id, resp):
  80         if id not in self.map:
  81             return
  82         for df, timer in self.map.pop(id):
  83             df.callback(resp)
  84             timer.cancel()
  85
  86 class GenericDeferrer(object):
  87     '''
  88     Converts query with identifier/got response interface to deferred interface
  89     '''
  90
  91     def __init__(self, max_id, func, timeout=5, on_timeout=lambda: None):
  92         self.max_id = max_id
  93         self.func = func
  94         self.timeout = timeout
  95         self.on_timeout = on_timeout
  96         self.map = {}
  97
  98     def __call__(self, *args, **kwargs):
  99         while True:
 100             id = random.randrange(self.max_id)
 101             if id not in self.map:
 102                 break
 103         df = defer.Deferred()
 104         def timeout():
 105             self.map.pop(id)
 106             df.errback(failure.Failure(defer.TimeoutError('in GenericDeferrer')))
 107             self.on_timeout()
 108         timer = reactor.callLater(self.timeout, timeout)
 109         self.func(id, *args, **kwargs)
 110         self.map[id] = df, timer
 111         return df
 112
 113     def got_response(self, id, resp):
 114         if id not in self.map:
 115             return
 116         df, timer = self.map.pop(id)
 117         timer.cancel()
 118         df.callback(resp)
 119
 120     def respond_all(self, resp):
 121         while self.map:
 122             id, (df, timer) = self.map.popitem()
 123             timer.cancel()
 124             df.errback(resp)
 125
 126 class NotNowError(Exception):
 127     pass
 128
 129 class DeferredCacher(object):
 130     '''
 131     like memoize, but for functions that return Deferreds
 132
 133     @DeferredCacher
 134     def f(x):
 135         ...
 136         return df
 137
 138     @DeferredCacher.with_backing(bsddb.hashopen(...))
 139     def f(x):
 140         ...
 141         return df
 142     '''
 143
 144     @classmethod
 145     def with_backing(cls, backing):
 146         return lambda func: cls(func, backing)
 147
 148     def __init__(self, func, backing=None):
 149         if backing is None:
 150             backing = {}
 151
 152         self.func = func
 153         self.backing = backing
 154         self.waiting = {}
 155
 156     @defer.inlineCallbacks
 157     def __call__(self, key):
 158         if key in self.waiting:
 159             yield self.waiting[key]
 160
 161         if key in self.backing:
 162             defer.returnValue(self.backing[key])
 163         else:
 164             self.waiting[key] = defer.Deferred()
 165             try:
 166                 value = yield self.func(key)
 167             finally:
 168                 self.waiting.pop(key).callback(None)
 169
 170         self.backing[key] = value
 171         defer.returnValue(value)
 172
 173     _nothing = object()
 174     def call_now(self, key, default=_nothing):
 175         if key in self.backing:
 176             return self.backing[key]
 177         if key not in self.waiting:
 178             self.waiting[key] = defer.Deferred()
 179             def cb(value):
 180                 self.backing[key] = value
 181                 self.waiting.pop(key).callback(None)
 182             def eb(fail):
 183                 self.waiting.pop(key).callback(None)
 184                 if fail.check(RetrySilentlyException):
 185                     return
 186                 print
 187                 print 'Error when requesting noncached value:'
 188                 fail.printTraceback()
 189                 print
 190             self.func(key).addCallback(cb).addErrback(eb)
 191         if default is not self._nothing:
 192             return default
 193         raise NotNowError(key)