Merge pull request #3 from Mathics3/fixing_nested_Timeout_contexts_using_signal-rocky

Bump version

Author: rocky

.github/workflows/pyodide.yml

@@ -50,12 +50,14 @@ jobs:
           pyodide venv .venv-pyodide
 
           # Activate the virtual environment
-          source .venv-pyodide/bin/activate
-
+          . .venv-pyodide/bin/activate
           pip install "setuptools>=70.0.0" PyYAML click packaging pytest
 
           pip install --no-build-isolation -v -v -v  -e .
       - name: Test stopit
         run: |
-          python -c "import sys; print(sys.path); import stopit"	
-          python tests.py
+          # Activate the virtual environment
+          . .venv-pyodide/bin/activate
+          echo $PATH
+          python -c "import sys; print(sys.path); import stopit"
+          # python tests.py

.gitignore

@@ -1,7 +1,9 @@
-.DS_Store
-build/
-dist/
+*.egg-info
 *.pyc
 *.pyo
-*.egg-info
+.DS_Store
+/.pyodide-xbuildenv*
+/.python-version
 __pycache__/
+build/
+dist/

setup.py

@@ -11,7 +11,7 @@
 import os
 from setuptools import setup, find_packages
 
-version = '1.2dev0'
+version = '1.1.3.dev0'
 
 this_directory = os.path.abspath(os.path.dirname(__file__))
 

src/stopit/signalstop.py

@@ -16,12 +16,16 @@
 ALARMS = []
 
 
-
 def handle_alarms(signum, frame):
     global ALARMS
-    new_alarms = [(ctx, max(0, remaining-1),)  for ctx, remaining in ALARMS]
-    expired = [ctx for ctx, remaining in new_alarms if remaining==0]
-    ALARMS = [(ctx, remaining,) for ctx, remaining in new_alarms if remaining>0]
+    new_alarms = [(ctx, max(0, remaining-1),) for ctx, remaining in ALARMS]
+    expired = [ctx for ctx, remaining in new_alarms if remaining == 0]
+    ALARMS = [
+        (
+         ctx,
+         remaining,
+        ) for ctx, remaining in new_alarms
+        if remaining > 0]
     if ALARMS:
         signal.alarm(1)
     for task in expired:
@@ -37,7 +41,11 @@ class SignalTimeout(BaseTimeout):
     """
 
     def __init__(self, seconds, swallow_exc=True):
-        seconds = int(seconds)  # alarm delay for signal MUST be int
+
+        # The alarm delay for a SIGALARM MUST be an integer
+        # greater than 1. Round up non-integer values.
+        seconds = max(1, int(seconds + 0.99))
+
         super(SignalTimeout, self).__init__(seconds, swallow_exc)
 
     def stop(self):
@@ -49,23 +57,31 @@ def stop(self):
     # Required overrides
     def setup_interrupt(self):
         global ALARMS
-        for ctx, remaining  in ALARMS:
-            if ctx is self:
-                return
-        if len(ALARMS)==0:
+
+        # If we have already registered ourself, do nothing and
+        # return.
+        if any(ctx is self for ctx, _ in ALARMS):
+            return
+
+        # If no ALARMS have been set up before, register
+        # signal.SIGALRM.
+        if len(ALARMS) == 0:
             signal.signal(signal.SIGALRM, handle_alarms)
             signal.alarm(1)
+
+        # Register our self.seconds value in the global
+        # ALARMS registry.
         ALARMS.append((self, int(self.seconds),))
 
     def suppress_interrupt(self):
         global ALARMS
         ALARMS = [(ctx, remaining) for ctx, remaining in ALARMS if ctx is not self]
-        if len(ALARMS)==0:
+        if len(ALARMS) == 0:
             signal.alarm(0)
             signal.signal(signal.SIGALRM, signal.SIG_DFL)
 
 
-class signal_timeoutable(base_timeoutable):  #noqa
+class signal_timeoutable(base_timeoutable):  # noqa
     """A function or method decorator that raises a ``TimeoutException`` to
     decorated functions that should not last a certain amount of time.
     this one uses ``SignalTimeout`` context manager.

src/stopit/utils.py

@@ -135,7 +135,7 @@ class base_timeoutable(object):  # noqa
     .. note::
 
        This is a base class that must be subclassed. subclasses must override
-       thz ``to_ctx_mgr`` with a timeout  context manager class which in turn
+       the ``to_ctx_mgr`` with a timeout  context manager class which in turn
        must subclasses of above ``BaseTimeout`` class.
     """
     to_ctx_mgr = None

tests.py

@@ -84,6 +84,12 @@ def test_nested_long_outer(self):
             self.assertEqual(self.check_nest(10.0, 1.0, 5.0, handler), "inner")
             self.assertEqual(self.check_nest_swallow(10.0, 1.0, 5.0, handler), "inner")
 
+    if os.name == "posix":  # Other OS have no support for signal.SIGALRM
+        def test_signal_handler(self):
+            for settime, expect_time in ((-1.5, 1), (0, 1), (0.5, 1), (3, 3),
+                                         (3.2, 4)):
+                self.assertEqual(SignalTimeout(settime).seconds, expect_time)
+
 
 def suite():  # Func for setuptools.setup(test_suite=xxx)
     test_suite = unittest.TestSuite()