optimize usage

Author: dozysun

README.rst

@@ -10,18 +10,19 @@ Timeout Timer
  it support loop nesting, if use signal timer, outside timer will fired after the inside
  signal timer finish the work(raise exception or normal finish).
 
- Signal timer can only work on main thread, if not on main thread use thread timer, thread timer may cost
+ Support signal timer and thread timer, signal timer can only work on main thread, if not on main thread use thread timer, thread timer may cost
  longer time than time out seconds settled if the timer's sub thread(user's function) is busy in a
  system call (time.sleep(), socket.accept()...), exception will fired after system call done.
 
 Usage
 ============
 support nested loop
 ::
+ from timeout_timer import timeout, TimeoutInterrupt
  try:
- with TimeoutTimer(2, timer="signal") as f:
+ with timeout(2, timer="signal") as f:
  f(time.sleep, 0.5)
- with TimeoutTimer(1, timer="signal") as f2:
+ with timeout(1, timer="signal") as f2:
  f2(time.sleep, 2)
  except TimeoutInterrupt:
  print("timeout triggered")
@@ -30,14 +31,14 @@ support nested loop
 or use signal timer can simplify
 ::
  try:
- with TimeoutTimer(2) :
+ with timeout(2) :
  time.sleep(3)
  except TimeoutInterrupt:
  print("timeout triggered")
 
 or use as decorator
 ::
- @TimeoutTimer(2):
+ @timeout(2):
  def f():
  time.sleep(3)
  time.sleep(2)

tests/timeout_timer_test.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-from timeout_timer.timeout_timer import TimeoutTimer, TimeoutInterrupt
+from timeout_timer import timeout, TimeoutInterrupt
 import time
 
 import pytest
@@ -22,7 +22,7 @@ def sleep(s):
 def test_timeout_no_seconds(timer):
  is_timeout = None
  try:
- with TimeoutTimer(0, timer=timer) as f:
+ with timeout(0, timer=timer) as f:
  f(sleep, 1)
  except TimeoutInterrupt:
  is_timeout = True
@@ -32,7 +32,7 @@ def test_timeout_no_seconds(timer):
 def test_timeout_seconds(timer):
  is_timeout = None
  try:
- with TimeoutTimer(1, timer=timer) as f:
+ with timeout(1, timer=timer) as f:
  f(sleep, 2)
  except TimeoutInterrupt:
  is_timeout = True
@@ -43,12 +43,12 @@ def test_timeout_nested_loop_inside_timeout(timer):
  try:
  def s():
  try:
- with TimeoutTimer(2, timer=timer, exception=TimeoutInterruptNested) as f2:
+ with timeout(2, timer=timer, exception=TimeoutInterruptNested) as f2:
  f2(sleep, 3)
  except TimeoutInterruptNested:
  return True
 
- with TimeoutTimer(10, timer=timer) as f:
+ with timeout(10, timer=timer) as f:
  is_timeout = f(s)
 
  except TimeoutInterrupt:
@@ -60,12 +60,12 @@ def test_timeout_nested_loop_outsite_timeout(timer):
  try:
  def s():
  try:
- with TimeoutTimer(10, timer=timer, exception=TimeoutInterruptNested) as f2:
+ with timeout(10, timer=timer, exception=TimeoutInterruptNested) as f2:
  f2(sleep, 3)
  except TimeoutInterruptNested:
  return True
 
- with TimeoutTimer(2, timer=timer) as f:
+ with timeout(2, timer=timer) as f:
  is_timeout = f(s)
 
  except TimeoutInterrupt:
@@ -78,14 +78,14 @@ def test_timeout_nested_loop_both_timeout(timer):
  try:
  def s():
  try:
- with TimeoutTimer(2, timer=timer, exception=TimeoutInterruptNested) as f2:
+ with timeout(2, timer=timer, exception=TimeoutInterruptNested) as f2:
  f2(sleep, 2)
  except TimeoutInterruptNested:
  cnt.append(1)
  time.sleep(10)
  cnt.append(0)
 
- with TimeoutTimer(5, timer=timer) as f:
+ with timeout(5, timer=timer) as f:
  f(s)
  except TimeoutInterrupt:
  cnt.append(1)

timeout_timer/__init__.py

@@ -1,2 +1,5 @@
 # coding: utf-8
+from .timeout_timer import timeout, TimeoutInterrupt, TimeoutTimer, StoppableThread
+
+__all__ = ['timeout', 'TimeoutInterrupt']
 __version__ = "0.1.0"

timeout_timer/timeout_timer.py

@@ -10,8 +10,8 @@
 class TimeoutInterrupt(BaseException):
  """inherit from baseException in cased captured by board Exception（eg: except Exception） in user program"""
 
- def __init__(self, value=""):
- self.value = str(value)
+ def __init__(self):
+ self.value = "Timeout Interrupt"
 
  def __str__(self):
  return self.value
@@ -58,7 +58,7 @@ def __new__(cls, *args, **kwargs):
 
  raise NotImplementedError
 
- def __init__(self, seconds, timer="signal", exception=TimeoutInterrupt, message="", interval=1):
+ def __init__(self, seconds, timer="signal", exception=TimeoutInterrupt, interval=1):
  """
  :param seconds: seconds to raise a timeout exception if user func
  :param timer: the timeout timer to use signal or threading, "signal" or "thread"
@@ -68,7 +68,6 @@ def __init__(self, seconds, timer="signal", exception=TimeoutInterrupt, message=
  """
  self.timeout_seconds = seconds
  self.exception_class = exception
- self.exception_message = message
  self.timer = timer
  self.interval = interval
 
@@ -136,7 +135,7 @@ def cancel(self):
 
  def timeout_callback(self, signum, frame):
  """signal callback"""
- raise self.exception_class(self.exception_message or str(frame))
+ raise self.exception_class()
 
 
 class _ThreadTimeoutTimer(TimeoutTimer):
@@ -150,20 +149,22 @@ def __init__(self, *args, **kwargs):
  super(_ThreadTimeoutTimer, self).__init__(*args, **kwargs)
 
  def _exec_func(self, func, *args, **kwargs):
- _out_time = time.time() + self.timeout_seconds
  tt = _TimerThread(self.exception_class)
  tt.set_func(partial(func, *args, **kwargs))
  tt.setDaemon(True)
  tt.start()
+
+ _out_time = time.time() + self.timeout_seconds
  stop_fired = False
  # wait for task done, it stop may delayed when thread is busy in
  # a system call (time.sleep(), socket.accept(), ...)
  while not tt.func_done:
- if (not stop_fired) and _out_time <= time.time():
+ if not stop_fired and _out_time <= time.time():
  stop_fired = True
  tt.stop()
  else:
- time.sleep(self.interval)
+ remain_time = _out_time - time.time()
+ time.sleep(self.interval if remain_time > self.interval else remain_time if remain_time > 0 else 0.1)
 
  if tt.error:
  raise tt.error
@@ -309,6 +310,9 @@ def set_func(self, func):
  def stop(self, exception=None):
  super(_TimerThread, self).stop(exception or self.exception_class)
 
+
+timeout = TimeoutTimer
+
 if __name__ == "__main__":
  def f():
  while True:
@@ -319,7 +323,7 @@ def f():
  # cost 5s
  t = time.time()
  try:
- with TimeoutTimer(5) as ff:
+ with timeout(5) as ff:
  ff(f)
  except TimeoutInterrupt as e:
  print(e)
@@ -329,7 +333,7 @@ def f():
  # cost 10s
  try:
  t = time.time()
- with TimeoutTimer(5, timer="thread") as ff:
+ with timeout(5, timer="thread") as ff:
  ff(f)
  except TimeoutInterrupt as e:
  print(e)