task results in wait_completed

README.md

@@ -91,20 +91,27 @@ task_supervisor.stop()
 ### Background task
 
 ```python
-from atasker import background_task, TASK_LOW, TASK_HIGH
+from atasker import background_task, TASK_LOW, TASK_HIGH, wait_completed
 
 # with annotation
 @background_task
 def mytask():
     print('I am working in the background!')
+    return 777
 
-mytask()
+task = mytask()
+
+# optional
+result = wait_completed(task)
+
+print(task.result) # 777
+print(result) # 777
 
 # with manual decoration
 def mytask2():
     print('I am working in the background too!')
 
-background_task(mytask2, priority=TASK_HIGH)()
+task = background_task(mytask2, priority=TASK_HIGH)()
 ```
 ### Async tasks
 
@@ -120,10 +127,12 @@ async def calc(a):
 
 # call from sync code
 
-# put coroutine and forget
-background_task(calc)(1)
+# put coroutine
+task = background_task(calc)(1)
+
+wait_completed(task)
 
-# get coroutine result
+# run coroutine and wait for result
 result = a1.run(calc(1))
 ```
 

atasker/__init__.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 from atasker.supervisor import TaskSupervisor
 from atasker.supervisor import TASK_LOW

atasker/co.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 from atasker import task_supervisor
 

atasker/f.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 import traceback
 import threading

atasker/supervisor.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 import threading
 import multiprocessing

atasker/threads.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 import threading
 import time
@@ -16,7 +16,7 @@
 from atasker import TASK_NORMAL
 from atasker import TT_THREAD, TT_MP, TT_COROUTINE
 
-from atasker.supervisor import ALoop
+from atasker.supervisor import ALoop, Task
 
 
 class LocalProxy(threading.local):
@@ -205,13 +205,17 @@ def _background_task_thread_runner(f, supervisor, task_id, *args, **kwargs):
 
 
 def wait_completed(tasks, timeout=None):
+    '''
+    raises TimeoutError
+    '''
     t_to = (time.time() + timeout) if timeout else None
-    for t in tasks:
+    for t in [tasks] if isinstance(tasks, Task) else tasks:
         if timeout:
             t_wait = t_to - time.time()
-            if t_wait <= 0: return False
+            if t_wait <= 0: raise TimeoutError
         else:
             t_wait = None
         if not t.completed.wait(timeout=t_wait):
-            return False
-    return True
+            raise TimeoutError
+    return tasks.result if isinstance(tasks,
+                                      Task) else [x.result for x in tasks]

atasker/workers.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 import threading
 import logging

doc/tasks.rst

@@ -125,5 +125,8 @@ You may wait until pack of tasks is completed with the following method:
 
    wait_completed([task1, task2, task3 .... ], timeout=None)
 
-The method return *True* if all tasks are finished, or *False* if timeout was
-specified but some tasks are not finished.
+The method return list of task results if all tasks are finished, or raises
+*TimeoutError* if timeout was specified but some tasks are not finished.
+
+If you call method with a single task instead of list or tuple, single result
+is returned.

setup.py

@@ -1,4 +1,4 @@
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 import setuptools
 

tests/mp.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 def test(*args, **kwargs):
     print('test mp method {} {}'.format(args, kwargs))

tests/mpworker.py

@@ -1,7 +1,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 from atasker import BackgroundIntervalWorker
 

tests/test.py

@@ -3,7 +3,7 @@
 __author__ = "Altertech Group, https://www.altertech.com/"
 __copyright__ = "Copyright (C) 2018-2019 Altertech Group"
 __license__ = "Apache License 2.0"
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 from pathlib import Path
 
@@ -264,19 +264,19 @@ def test_result_thread(self):
         def t1():
             return 777
 
-        t = background_task(t1)()
-        wait_completed([t])
-        self.assertEqual(t.result, 777)
+        def t2():
+            return 111
+
+        task1 = background_task(t1)()
+        task2 = background_task(t2)()
+        self.assertEqual(wait_completed((task1, task2)), [777, 111])
 
     def test_result_mp(self):
 
         from mp import test2
 
         t = background_task(test2, tt=TT_MP)()
-        wait_completed([t])
-        self.assertEqual(t.result, 999)
-
-
+        self.assertEqual(wait_completed(t), 999)
 
     def test_aloop_run(self):