Inherit TimeoutError from TimeoutError

ei-grad · Mar 28, 2020 · d91fe7a · d91fe7a
1 parent 5f7c679
commit d91fe7a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ Usage
 -----
 
 ```python
-from kill_timeout import kill_timeout, TimeoutError
+from kill_timeout import kill_timeout
 
 
 limit_in_seconds = 5

diff --git a/kill_timeout.py b/kill_timeout.py
@@ -4,7 +4,12 @@
 from tblib.decorators import return_error, Error
 
 
-class TimeoutError(Exception):
+class TimeoutError(TimeoutError):
+    """Custom TimeoutError
+
+    To distinguish from TimeoutError's raised by functions wrapped in
+    kill_timeout decorator.
+    """
     pass
 
 

diff --git a/tests.py b/tests.py
@@ -3,7 +3,7 @@
 
 import pytest
 
-from kill_timeout import kill_timeout, TimeoutError
+from kill_timeout import kill_timeout, TimeoutError as KillTimeoutError
 
 
 @kill_timeout(0.1)
@@ -17,6 +17,8 @@ def test_simple():
 
 
 def test_timeout():
+    with pytest.raises(KillTimeoutError):
+        f(0.2)
     with pytest.raises(TimeoutError):
         f(0.2)