init

Author: dozysun

.gitignore

@@ -0,0 +1,24 @@
+# middle file
+*.py[cod]
+*.swp
+*~
+venv
+.env
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021- DozySun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.rst

@@ -0,0 +1,48 @@
+Installation
+============
+::
+
+ python setup.py install
+
+Timeout Timer
+============
+ Add a timeout function to a function or statement and raise a exception if time limit runs out ,
+ it support loop nesting when timer worked as loop nesting, if use signal timer, it will fire after the inside
+ signal timer finish the work.
+
+ Signal timer can only work on main thread, if not use thread timer, thread timer may cost longer time than
+ time out seconds 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
+::
+ try:
+ with TimeoutTimer(2, timer="signal") as f:
+ f(time.sleep, 0.5)
+ with TimeoutTimer(1, timer="signal") as f2:
+ f2(time.sleep, 2)
+ except TimeoutInterrupt:
+ print("timeout triggered")
+
+
+or use signal timer can simplify
+::
+ try:
+ with TimeoutTimer(2) :
+ time.sleep(3)
+ except TimeoutInterrupt:
+ print("timeout triggered")
+
+or use as decorator
+::
+ @TimeoutTimer(2):
+ def f():
+ time.sleep(3)
+ time.sleep(2)
+
+License
+-------
+
+Code released under the `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_

setup.py

@@ -0,0 +1,38 @@
+"""Setuptools entry point."""
+import os
+
+try:
+ from setuptools import setup
+except ImportError:
+ from distutils.core import setup
+
+CLASSIFIERS = """
+Development Status :: 1 - Beta
+Intended Audience :: Developers
+License :: OSI Approved :: MIT License
+Programming Language :: C
+Programming Language :: Python :: 3
+Programming Language :: Python :: 3.6
+Programming Language :: Python :: 3.7
+Programming Language :: Python :: 3.8
+Programming Language :: Python :: 3.9
+Programming Language :: Python :: 3 :: Only
+"""
+
+
+def long_description():
+ with open(os.path.abspath(os.path.join(os.path.dirname(__file__), 'README.rst'))) as f:
+ return f.read()
+
+
+setup(
+ name='timeout-timer',
+ version='0.1.0',
+ description='Timeout timer use signal or thread module, support nested loop',
+ long_description=long_description(),
+ author='dozysun',
+ author_email='dozysun@gmail.com',
+ url='https://github.com/dozysun/timeout-timer',
+ packages=['timeout_timer'],
+ install_requires=[],
+ classifiers=CLASSIFIERS)

tests/__init__.py

@@ -0,0 +1 @@
+# coding: utf-8

tests/timeout_timer_test.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+from timeout_timer.timeout_timer import TimeoutTimer, TimeoutInterrupt
+import time
+
+import pytest
+
+
+class TimeoutInterruptNested(TimeoutInterrupt):
+ pass
+
+
+@pytest.fixture(params=["signal", "thread"])
+def timer(request):
+ return request.param
+
+
+def sleep(s):
+ time.sleep(s)
+ time.sleep(s)
+
+
+def test_timeout_no_seconds(timer):
+ is_timeout = None
+ try:
+ with TimeoutTimer(0, timer=timer) as f:
+ f(sleep, 1)
+ except TimeoutInterrupt:
+ is_timeout = True
+ assert not is_timeout
+
+
+def test_timeout_seconds(timer):
+ is_timeout = None
+ try:
+ with TimeoutTimer(1, timer=timer) as f:
+ f(sleep, 2)
+ except TimeoutInterrupt:
+ is_timeout = True
+ assert is_timeout
+
+
+def test_timeout_nested_loop_inside_timeout(timer):
+ try:
+ def s():
+ try:
+ with TimeoutTimer(2, timer=timer, exception=TimeoutInterruptNested) as f2:
+ f2(sleep, 3)
+ except TimeoutInterruptNested:
+ return True
+
+ with TimeoutTimer(10, timer=timer) as f:
+ is_timeout = f(s)
+
+ except TimeoutInterrupt:
+ is_timeout = "out alert"
+ assert is_timeout is True
+
+
+def test_timeout_nested_loop_outsite_timeout(timer):
+ try:
+ def s():
+ try:
+ with TimeoutTimer(10, timer=timer, exception=TimeoutInterruptNested) as f2:
+ f2(sleep, 3)
+ except TimeoutInterruptNested:
+ return True
+
+ with TimeoutTimer(2, timer=timer) as f:
+ is_timeout = f(s)
+
+ except TimeoutInterrupt:
+ is_timeout = False
+ assert is_timeout is False
+
+
+def test_timeout_nested_loop_both_timeout(timer):
+ cnt = []
+ try:
+ def s():
+ try:
+ with TimeoutTimer(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:
+ f(s)
+ except TimeoutInterrupt:
+ cnt.append(1)
+ assert sum(cnt) == 2

timeout_timer/__init__.py

@@ -0,0 +1,2 @@
+# coding: utf-8
+__version__ = "0.1.0"