v1.3.10

--------
2022-04-26: add tests for thread lock

Author: bitranox

.docs/README_template.rst

@@ -2,7 +2,7 @@ wrapt_timeout_decorator
 =======================
 
 
-Version v1.3.9 as of 2022-04-26 see `Changelog`_
+Version v1.3.10 as of 2022-04-26 see `Changelog`_
 
 
 .. include:: ./badges.rst

CHANGES.rst

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+v1.3.10
+--------
+2022-04-26: add tests for thread lock
+
 v1.3.9
 --------
 2022-04-26: preserve Signature of the decorator

README.rst

@@ -2,7 +2,7 @@ wrapt_timeout_decorator
 =======================
 
 
-Version v1.3.9 as of 2022-04-26 see `Changelog`_
+Version v1.3.10 as of 2022-04-26 see `Changelog`_
 
 |build_badge| |license| |jupyter| |pypi| |pypi-downloads| |black|
 
@@ -848,6 +848,10 @@ This software is licensed under the `MIT license <http://en.wikipedia.org/wiki/M
 Changelog
 =========
 
+v1.3.10
+--------
+2022-04-26: add tests for thread lock
+
 v1.3.9
 --------
 2022-04-26: preserve Signature of the decorator

setup.py

@@ -84,7 +84,7 @@ def get_line_data(line: str) -> str:
 
 setup_kwargs: Dict[str, Any] = dict()
 setup_kwargs["name"] = "wrapt_timeout_decorator"
-setup_kwargs["version"] = "v1.3.9"
+setup_kwargs["version"] = "v1.3.10"
 setup_kwargs["url"] = "https://github.com/bitranox/wrapt_timeout_decorator"
 setup_kwargs["packages"] = find_packages()
 setup_kwargs["package_data"] = {"wrapt_timeout_decorator": ["py.typed", "*.pyi", "__init__.pyi"]}

tests/local_testscripts/run_testloop_pytest_and_mypy_only_no_setup.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+own_dir="$( cd "$(dirname "${BASH_SOURCE[0]}")" || exit && pwd -P )" # this gives the full path, even for sourced scripts
+
+# shellcheck disable=SC2050
+if [[ "True" != "True" ]]; then
+    echo "exit - ${BASH_SOURCE[0]} is not configured by PizzaCutter"
+    exit 0
+fi
+
+# shellcheck disable=SC1090
+source "${own_dir}/lib_bash_functions.sh"
+project_root_dir="${project_root_dir}"
+DO_FLAKE8_TESTS="True"
+DO_MYPY_TESTS="True"
+DO_PYTEST="True"
+DO_BLACK="True"
+# cleanup on cntrl-c
+trap cleanup EXIT
+
+# install dependencies
+install_dependencies
+
+function pytest_loop {
+    while true; do
+        banner "Project Root Dir: ${project_root_dir}"
+        cleanup
+
+        if [ "${DO_BLACK}" == "True" ]; then
+          if ! run_black; then continue; fi
+        fi
+
+        # we prefer to run tests on its own, not within pytest, due to shaky and outdated pytest plugins
+        if [ "${DO_FLAKE8_TESTS}" == "True" ]; then
+          if ! run_flake8_tests; then continue; fi
+        fi
+
+        if [ "${DO_PYTEST}" == "True" ]; then
+            if ! run_pytest --disable-warnings; then continue; fi
+        fi
+
+        # we prefer to run tests on its own, not within pytest, due to shaky and outdated pytest plugins
+        if [ "${DO_MYPY_TESTS}" == "True" ]; then
+            if ! run_mypy_tests; then continue; fi
+        fi
+
+        # if ! install_pip_requirements_venv; then continue; fi
+        # if ! setup_test_venv; then continue; fi
+        # if ! setup_install_venv; then continue; fi
+        if ! test_commandline_interface_venv; then continue; fi
+
+        banner "ALL TESTS PASSED for ${project_root_dir}"
+        banner "ALL TESTS PASSED for ${project_root_dir}"
+        banner "ALL TESTS PASSED for ${project_root_dir}"
+        sleep 5
+    done
+
+}
+
+# upgrade_pytest
+# upgrade_mypy
+pytest_loop

tests/test_wrapt_timeout_decorator.py

@@ -1,6 +1,7 @@
 """Timeout decorator tests."""
 # STDLIB
 import sys
+import threading
 from threading import Thread
 import time
 from typing import Any
@@ -30,6 +31,17 @@ def f() -> None:
         f()
 
 
+def test_timeout_decorator_thread_lock(use_signals: bool) -> None:
+    @timeout(0.2, use_signals=use_signals)  # type: ignore
+    def f() -> None:
+        my_lock = threading.Lock()
+        my_lock.acquire()
+        my_lock.acquire()
+
+    with pytest.raises(TimeoutError):
+        f()
+
+
 def test_timeout_class_method(use_signals: bool) -> None:
     with pytest.raises(TimeoutError, match=r"Function f timed out after 0\.3 seconds"):
         ClassTest1().f(use_signals=use_signals)

wrapt_timeout_decorator/__init__conf__.py

@@ -2,7 +2,7 @@
 
 name = "wrapt_timeout_decorator"
 title = "The better timout decorator"
-version = "v1.3.9"
+version = "v1.3.10"
 url = "https://github.com/bitranox/wrapt_timeout_decorator"
 author = "Robert Nowotny"
 author_email = "bitranox@gmail.com"
@@ -17,7 +17,7 @@ def print_info() -> None:
 
     The better timout decorator
 
-    Version : v1.3.9
+    Version : v1.3.10
     Url     : https://github.com/bitranox/wrapt_timeout_decorator
     Author  : Robert Nowotny
     Email   : bitranox@gmail.com"""

wrapt_timeout_decorator/wrap_helper.py

@@ -8,8 +8,8 @@
 from typing import Any, Callable, Dict, List, Type, Union, Optional
 
 # EXT
-import dill  # type: ignore
-import multiprocess  # type: ignore
+import dill
+import multiprocess
 
 # Types
 AlarmHandler = Union[Callable[[int, Optional[FrameType]], Any], int, signal.Handlers, None]
@@ -42,7 +42,7 @@ def __init__(
         self.args = args
         self.kwargs = kwargs
 
-        self.dec_timeout_float = 0.0  # type: float
+        self.dec_timeout_float: float = 0.0
         self.old_alarm_handler: AlarmHandler = None
         self.child_conn: "multiprocess.Pipe" = None
 
@@ -120,7 +120,7 @@ def detect_unpickable_objects_and_reraise(object_to_pickle: Any) -> None:
 def detect_unpickable_objects(object_to_pickle: Any, dill_trace: bool = True, log_warning: bool = True) -> Dict[str, Union[str, List[Any]]]:
     if log_warning:
         logger.warning('always remember that the "object_to_pickle" should not be defined within the main context')
-    dict_result = dict()  # type: Dict[str, Union[str, List[Any]]]
+    dict_result: Dict[str, Union[str, List[Any]]] = dict()
     dict_result["object_name"] = ""
     dict_result["bad_items"] = list()
     dict_result["bad_objects"] = list()
@@ -150,7 +150,7 @@ def get_object_name(object_to_pickle: object) -> str:
 
 
 def get_bad_pickling_types(object_to_pickle: object) -> List[Any]:
-    bad_types = list()  # type: List[Any]
+    bad_types: List[Any] = list()
     # noinspection PyBroadException
     try:
         bad_types = dill.detect.badtypes(object_to_pickle)
@@ -161,7 +161,7 @@ def get_bad_pickling_types(object_to_pickle: object) -> List[Any]:
 
 
 def get_bad_pickling_objects(object_to_pickle: Any) -> Any:
-    bad_objects = list()  # type: List[object]
+    bad_objects: List[object] = list()
     # noinspection PyBroadException
     try:
         bad_objects = dill.detect.badobjects(object_to_pickle)

wrapt_timeout_decorator/wrapt_timeout_decorator.py

@@ -9,7 +9,7 @@
 from typing import Any, Callable, Type, TypeVar, Union
 
 # EXT
-from dill import PicklingError  # type: ignore
+from dill import PicklingError
 import wrapt
 
 # OWN