cw: Added withTimeout to Coroutine

Charles Weir · Charles Weir · commit 2cf0c8738923 · 2014-04-20T15:58:35.000+01:00
diff --git a/BrickPython/Coroutine.py b/BrickPython/Coroutine.py
@@ -16,7 +16,6 @@ class StopCoroutineException( Exception ):
 
 class Coroutine( threading.Thread ):
     def __init__(self, func, *args, **kwargs):
-        print "Coroutine: %r %r" % (args, kwargs)
         threading.Thread.__init__(self)
         self.args = args
         self.kwargs = kwargs
@@ -98,7 +97,7 @@ def waitMilliseconds(timeMillis):
     @staticmethod
     def runTillFirstCompletes(*coroutines):
         def runTillFirstCompletesFunc(*coroutineList):
-            while True:
+            while all(c.is_alive() for c in coroutineList):
                 for c in coroutineList:
                     c.call()
                     if not c.is_alive():
@@ -111,6 +110,25 @@ def runTillFirstCompletesFunc(*coroutineList):
         result = Coroutine(runTillFirstCompletesFunc, *coroutines)
         return result
 
+    @staticmethod
+    def runTillAllComplete(*coroutines):
+        def runTillAllCompleteFunc(*coroutineList):
+            while any(c.is_alive() for c in coroutineList):
+                for c in coroutineList:
+                    c.call()
+                Coroutine.wait()
+
+        result = Coroutine(runTillAllCompleteFunc, *coroutines)
+        return result
+
+    def withTimeout(self, timeoutMillis):
+        '''Answers this coroutine, decorated with a timeout that stops it if called after timeoutMillis has elapsed.
+        '''
+        def timeoutFunc(timeoutMillis):
+            Coroutine.waitMilliseconds(timeoutMillis)
+        result = Coroutine.runTillFirstCompletes(self, Coroutine(timeoutFunc, timeoutMillis))
+        return result
+
 #
 #         self.scheduler.coroutines.remove( self )
 #         self.scheduler.semaphore.release()
diff --git a/test/TestCoroutine.py b/test/TestCoroutine.py
@@ -22,7 +22,6 @@ class TestCoroutine(unittest.TestCase):
     coroutineCalls = []
     @staticmethod
     def dummyCoroutineFunc(start=1, end=5):
-        logging.debug( "in dummyCoroutineFunc %d %d" %(start, end) )
         for i in range(start, end):
             TestCoroutine.coroutineCalls.append(i)
             Coroutine.wait();
@@ -100,7 +99,7 @@ def dummyCoroutineFuncWaiting1Sec():
 
     def testCoroutineCanHaveParameters(self):
         def func(*args, **kwargs):
-            self.assertEquals(args, (1))
+            self.assertEquals(args, (1,))
             self.assertEquals(kwargs, {"extra": 2})
         coroutine = Coroutine(func, 1, extra=2)
         coroutine.call()
@@ -118,13 +117,27 @@ def cofunc():
         #And running it has caused the result parameter to be checked correctly before the coroutine terminated
         self.assertFalse(coroutine.is_alive())
 
-    def testRunCoroutinesUntilFirstCompletesOrAllComplete(self):
+    def testRunCoroutinesUntilFirstCompletes(self):
         coroutine = Coroutine.runTillFirstCompletes(Coroutine(TestCoroutine.dummyCoroutineFunc,1,3),
                                                     Coroutine(TestCoroutine.dummyCoroutineFunc,1,6))
         for i in range(1,10):
             coroutine.call()
         self.assertEquals(TestCoroutine.coroutineCalls, [1,1,2,2])
 
+    def testRunCoroutinesUntilAllComplete(self):
+        coroutine = Coroutine.runTillAllComplete(Coroutine(TestCoroutine.dummyCoroutineFunc,1,3),
+                                                    Coroutine(TestCoroutine.dummyCoroutineFunc,1,6))
+        for i in range(1,10):
+            coroutine.call()
+        self.assertEquals(TestCoroutine.coroutineCalls, [1,1,2,2,3,4,5])
+
+    def testWithTimeout(self):
+        Coroutine.currentTimeMillis = Mock(side_effect = [1,10,500,1200])
+        coroutine = Coroutine(TestCoroutine.dummyCoroutineFunc,1,20).withTimeout(1000)
+        for i in range(1,20):
+            coroutine.call()
+        self.assertEquals(TestCoroutine.coroutineCalls, [1,2,3])
+
 
 
 
