optimize thread timeout module, maintaining consistent like the signal module, create a sub thread as timer, and call main thread's stop to interrupt,

Author: dozysun

README.rst

@@ -13,39 +13,39 @@ Installation
 
 Timeout Timer
 --------------
- Add a timeout function to a function or statement and raise a exception if time limit runs out ,
- 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).
+ Add a timeout function to a function or statement and raise a exception if time limit runs out, can work as
+ a context or decorator, support loop nesting and should use diff exception class, if use signal timer,
+ outside timer will fired after the inside signal timer finish the work(raise exception or normal finish).
 
- 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.
+ 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 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 timeout(2, timer="signal") as f:
- f(time.sleep, 0.5)
- with timeout(1, timer="signal") as f2:
- f2(time.sleep, 2)
- except TimeoutInterrupt:
- print("timeout triggered")
 
-
-or use signal timer can simplify
-::
-
- try:
- with timeout(2) :
- time.sleep(3)
- except TimeoutInterrupt:
- print("timeout triggered")
-
-or use as decorator
+ class TimeoutInterruptNested(TimeoutInterrupt):
+ pass
+
+ def test_timeout_nested_loop_both_timeout(timer):
+ cnt = 0
+ try:
+ with timeout(5, timer=timer):
+ try:
+ with timeout(2, timer=timer, exception=TimeoutInterruptNested):
+ sleep(2)
+ except TimeoutInterruptNested:
+ cnt += 1
+ time.sleep(10)
+ except TimeoutInterrupt:
+ cnt += 1
+ assert cnt == 2
+
+use as decorator
 ::
 
  @timeout(2):

setup.py

@@ -23,7 +23,7 @@ def long_description():
 
 setup(
  name='timeout-timer',
- version='0.1.1',
+ version='0.2.0',
  description='Timeout timer use signal or thread module, support nested loop',
  long_description=long_description(),
  author='dozysun',

tests/timeout_timer_test.py

@@ -22,8 +22,8 @@ def sleep(s):
 def test_timeout_no_seconds(timer):
  is_timeout = None
  try:
- with timeout(0, timer=timer) as f:
- f(sleep, 1)
+ with timeout(0, timer=timer):
+ sleep(1)
  except TimeoutInterrupt:
  is_timeout = True
  assert not is_timeout
@@ -32,61 +32,51 @@ def test_timeout_no_seconds(timer):
 def test_timeout_seconds(timer):
  is_timeout = None
  try:
- with timeout(1, timer=timer) as f:
- f(sleep, 2)
+ with timeout(1, timer=timer):
+ sleep(2)
  except TimeoutInterrupt:
  is_timeout = True
  assert is_timeout
 
 
 def test_timeout_nested_loop_inside_timeout(timer):
+ is_timeout = None
  try:
- def s():
+ with timeout(10, timer=timer):
  try:
- with timeout(2, timer=timer, exception=TimeoutInterruptNested) as f2:
- f2(sleep, 3)
+ with timeout(2, timer=timer, exception=TimeoutInterruptNested):
+ sleep(3)
  except TimeoutInterruptNested:
- return True
-
- with timeout(10, timer=timer) as f:
- is_timeout = f(s)
-
+ is_timeout = True
  except TimeoutInterrupt:
- is_timeout = "out alert"
+ is_timeout = False
  assert is_timeout is True
 
 
-def test_timeout_nested_loop_outsite_timeout(timer):
+def test_timeout_nested_loop_outside_timeout(timer):
  try:
- def s():
+ with timeout(2, timer=timer):
  try:
- with timeout(10, timer=timer, exception=TimeoutInterruptNested) as f2:
- f2(sleep, 3)
+ with timeout(10, timer=timer, exception=TimeoutInterruptNested):
+ sleep(3)
  except TimeoutInterruptNested:
- return True
-
- with timeout(2, timer=timer) as f:
- is_timeout = f(s)
+ is_timeout = True
 
  except TimeoutInterrupt:
  is_timeout = False
  assert is_timeout is False
 
 
 def test_timeout_nested_loop_both_timeout(timer):
- cnt = []
+ cnt = 0
  try:
- def s():
+ with timeout(5, timer=timer):
  try:
- with timeout(2, timer=timer, exception=TimeoutInterruptNested) as f2:
- f2(sleep, 2)
+ with timeout(2, timer=timer, exception=TimeoutInterruptNested):
+ sleep(2)
  except TimeoutInterruptNested:
- cnt.append(1)
+ cnt += 1
  time.sleep(10)
- cnt.append(0)
-
- with timeout(5, timer=timer) as f:
- f(s)
  except TimeoutInterrupt:
- cnt.append(1)
- assert sum(cnt) == 2
+ cnt += 1
+ assert cnt == 2

timeout_timer/__init__.py

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