eventlet/eventlet/hubs/timer.py

   1 import traceback
   2
   3 from eventlet.support import greenlets as greenlet, six
   4 from eventlet.hubs import get_hub
   5
   6 """ If true, captures a stack trace for each timer when constructed.  This is
   7 useful for debugging leaking timers, to find out where the timer was set up. """
   8 _g_debug = False
   9
  10
  11 class Timer(object):
  12     def __init__(self, seconds, cb, *args, **kw):
  13         """Create a timer.
  14             seconds: The minimum number of seconds to wait before calling
  15             cb: The callback to call when the timer has expired
  16             *args: The arguments to pass to cb
  17             **kw: The keyword arguments to pass to cb
  18
  19         This timer will not be run unless it is scheduled in a runloop by
  20         calling timer.schedule() or runloop.add_timer(timer).
  21         """
  22         self.seconds = seconds
  23         self.tpl = cb, args, kw
  24         self.called = False
  25         if _g_debug:
  26             self.traceback = six.StringIO()
  27             traceback.print_stack(file=self.traceback)
  28
  29     @property
  30     def pending(self):
  31         return not self.called
  32
  33     def __repr__(self):
  34         secs = getattr(self, 'seconds', None)
  35         cb, args, kw = getattr(self, 'tpl', (None, None, None))
  36         retval = "Timer(%s, %s, *%s, **%s)" % (
  37             secs, cb, args, kw)
  38         if _g_debug and hasattr(self, 'traceback'):
  39             retval += '\n' + self.traceback.getvalue()
  40         return retval
  41
  42     def copy(self):
  43         cb, args, kw = self.tpl
  44         return self.__class__(self.seconds, cb, *args, **kw)
  45
  46     def schedule(self):
  47         """Schedule this timer to run in the current runloop.
  48         """
  49         self.called = False
  50         self.scheduled_time = get_hub().add_timer(self)
  51         return self
  52
  53     def __call__(self, *args):
  54         if not self.called:
  55             self.called = True
  56             cb, args, kw = self.tpl
  57             try:
  58                 cb(*args, **kw)
  59             finally:
  60                 try:
  61                     del self.tpl
  62                 except AttributeError:
  63                     pass
  64
  65     def cancel(self):
  66         """Prevent this timer from being called. If the timer has already
  67         been called or canceled, has no effect.
  68         """
  69         if not self.called:
  70             self.called = True
  71             get_hub().timer_canceled(self)
  72             try:
  73                 del self.tpl
  74             except AttributeError:
  75                 pass
  76
  77     # No default ordering in 3.x. heapq uses <
  78     # FIXME should full set be added?
  79     def __lt__(self, other):
  80         return id(self) < id(other)
  81
  82
  83 class LocalTimer(Timer):
  84
  85     def __init__(self, *args, **kwargs):
  86         self.greenlet = greenlet.getcurrent()
  87         Timer.__init__(self, *args, **kwargs)
  88
  89     @property
  90     def pending(self):
  91         if self.greenlet is None or self.greenlet.dead:
  92             return False
  93         return not self.called
  94
  95     def __call__(self, *args):
  96         if not self.called:
  97             self.called = True
  98             if self.greenlet is not None and self.greenlet.dead:
  99                 return
 100             cb, args, kw = self.tpl
 101             cb(*args, **kw)
 102
 103     def cancel(self):
 104         self.greenlet = None
 105         Timer.cancel(self)