aboutsummaryrefslogtreecommitdiff
path: root/tests/test_timeout_decorator.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_timeout_decorator.py')
-rw-r--r--tests/test_timeout_decorator.py120
1 files changed, 120 insertions, 0 deletions
diff --git a/tests/test_timeout_decorator.py b/tests/test_timeout_decorator.py
new file mode 100644
index 0000000..2c2d9c7
--- /dev/null
+++ b/tests/test_timeout_decorator.py
@@ -0,0 +1,120 @@
+"""Timeout decorator tests."""
+import time
+
+import pytest
+
+from timeout_decorator import timeout, TimeoutError
+
+
+@pytest.fixture(params=[False, True])
+def use_signals(request):
+ """Use signals for timing out or not."""
+ return request.param
+
+
+def test_timeout_decorator_arg(use_signals):
+ @timeout(1, use_signals=use_signals)
+ def f():
+ time.sleep(2)
+ with pytest.raises(TimeoutError):
+ f()
+
+
+def test_timeout_class_method(use_signals):
+ class c():
+ @timeout(1, use_signals=use_signals)
+ def f(self):
+ time.sleep(2)
+ with pytest.raises(TimeoutError):
+ c().f()
+
+
+def test_timeout_kwargs(use_signals):
+ @timeout(3, use_signals=use_signals)
+ def f():
+ time.sleep(2)
+ with pytest.raises(TimeoutError):
+ f(timeout=1)
+
+
+def test_timeout_alternate_exception(use_signals):
+ @timeout(3, use_signals=use_signals, timeout_exception=StopIteration)
+ def f():
+ time.sleep(2)
+ with pytest.raises(StopIteration):
+ f(timeout=1)
+
+
+def test_timeout_kwargs_with_initial_timeout_none(use_signals):
+ @timeout(use_signals=use_signals)
+ def f():
+ time.sleep(2)
+ with pytest.raises(TimeoutError):
+ f(timeout=1)
+
+
+def test_timeout_no_seconds(use_signals):
+ @timeout(use_signals=use_signals)
+ def f():
+ time.sleep(0.1)
+ f()
+
+
+def test_timeout_partial_seconds(use_signals):
+ @timeout(0.2, use_signals=use_signals)
+ def f():
+ time.sleep(0.5)
+ with pytest.raises(TimeoutError):
+ f()
+
+
+def test_timeout_ok(use_signals):
+ @timeout(seconds=2, use_signals=use_signals)
+ def f():
+ time.sleep(1)
+ f()
+
+
+def test_function_name(use_signals):
+ @timeout(seconds=2, use_signals=use_signals)
+ def func_name():
+ pass
+
+ assert func_name.__name__ == 'func_name'
+
+
+def test_timeout_pickle_error():
+ """Test that when a pickle error occurs a timeout error is raised."""
+ @timeout(seconds=1, use_signals=False)
+ def f():
+ time.sleep(0.1)
+
+ class Test(object):
+ pass
+ return Test()
+ with pytest.raises(TimeoutError):
+ f()
+
+
+def test_timeout_custom_exception_message():
+ @timeout(seconds=1, exception_message="Custom fail message")
+ def f():
+ time.sleep(2)
+ with pytest.raises(TimeoutError, match="Custom fail message"):
+ f()
+
+
+def test_timeout_custom_exception_with_message():
+ @timeout(seconds=1, timeout_exception=RuntimeError, exception_message="Custom fail message")
+ def f():
+ time.sleep(2)
+ with pytest.raises(RuntimeError, match="Custom fail message"):
+ f()
+
+
+def test_timeout_default_exception_message():
+ @timeout(seconds=1)
+ def f():
+ time.sleep(2)
+ with pytest.raises(TimeoutError, match="Timed Out"):
+ f()