Make gen.Task a function returning a Future instead of a YieldPoint subclass.

This improves performance of applications that mix Tasks and Futures
by only entering a stack context for the duration of the Tasks. It
also fixes an obscure regression (#1058).  This might get reverted before
the final release if any backwards-compatibility issues turn up, but
since the status quo also had a regression it's worth a try.

Closes #1058.

diff --git a/docs/gen.rst b/docs/gen.rst
index da3366d4b9c026d9efd385a730de7e8d8a12803f..5380dae593043b37a1fec5225a4a53fb7a829ca1 100644 (file)
--- a/docs/gen.rst
+++ b/docs/gen.rst
@@ -21,7 +21,7 @@
    in the same order. Yielding dicts with these objects in values will
    return dict with results at the same keys.
 
-   .. autoclass:: Task
+   .. autofunction:: Task
 
    .. autoclass:: Callback
 

diff --git a/tornado/gen.py b/tornado/gen.py
index bff8b75cac2fd9ae091054a6434875fd33e63783..7b6cf0ce9a69d5280e1939d247de17f8c39fc52e 100644 (file)
--- a/tornado/gen.py
+++ b/tornado/gen.py
@@ -340,7 +340,7 @@ class WaitAll(YieldPoint):
         return [self.runner.pop_result(key) for key in self.keys]
 
 
-class Task(YieldPoint):
+def Task(func, *args, **kwargs):
     """Runs a single asynchronous operation.
 
     Takes a function (and optional additional arguments) and runs it with
@@ -354,25 +354,25 @@ class Task(YieldPoint):
 
         func(args, callback=(yield gen.Callback(key)))
         result = yield gen.Wait(key)
-    """
-    def __init__(self, func, *args, **kwargs):
-        assert "callback" not in kwargs
-        self.args = args
-        self.kwargs = kwargs
-        self.func = func
-
-    def start(self, runner):
-        self.runner = runner
-        self.key = object()
-        runner.register_callback(self.key)
-        self.kwargs["callback"] = runner.result_callback(self.key)
-        self.func(*self.args, **self.kwargs)
 
-    def is_ready(self):
-        return self.runner.is_ready(self.key)
-
-    def get_result(self):
-        return self.runner.pop_result(self.key)
+    .. versionchanged:: 3.3
+       ``gen.Task`` is now a function that returns a `.Future`, instead of
+       a subclass of `YieldPoint`.  It still behaves the same way when
+       yielded.
+    """
+    future = Future()
+    def handle_exception(typ, value, tb):
+        if future.done():
+            return False
+        future.set_exc_info((typ, value, tb))
+        return True
+    def set_result(result):
+        if future.done():
+            return
+        future.set_result(result)
+    with stack_context.ExceptionStackContext(handle_exception):
+        func(*args, callback=_argument_adapter(set_result), **kwargs)
+    return future
 
 
 class YieldFuture(YieldPoint):
@@ -673,15 +673,8 @@ class Runner(object):
 
 
     def result_callback(self, key):
-        def inner(*args, **kwargs):
-            if kwargs or len(args) > 1:
-                result = Arguments(args, kwargs)
-            elif args:
-                result = args[0]
-            else:
-                result = None
-            self.set_result(key, result)
-        return stack_context.wrap(inner)
+        return stack_context.wrap(_argument_adapter(
+            functools.partial(self.set_result, key)))
 
     def handle_exception(self, typ, value, tb):
         if not self.running and not self.finished:
@@ -698,3 +691,19 @@ class Runner(object):
             self.stack_context_deactivate = None
 
 Arguments = collections.namedtuple('Arguments', ['args', 'kwargs'])
+
+def _argument_adapter(callback):
+    """Returns a function that when invoked runs ``callback`` with one arg.
+
+    If the function returned by this function is called with exactly
+    one argument, that argument is passed to ``callback``.  Otherwise
+    the args tuple and kwargs dict are wrapped in an `Arguments` object.
+    """
+    def wrapper(*args, **kwargs):
+        if kwargs or len(args) > 1:
+            callback(Arguments(args, kwargs))
+        elif args:
+            callback(args[0])
+        else:
+            callback(None)
+    return wrapper

diff --git a/tornado/test/gen_test.py b/tornado/test/gen_test.py
index 20750cd18ddf29cf4194375cd54473988f81f42e..b00ff735eef053c8715f7e8beef764e6d40031f5 100644 (file)
--- a/tornado/test/gen_test.py
+++ b/tornado/test/gen_test.py
@@ -741,10 +741,11 @@ class GenCoroutineTest(AsyncTestCase):
         # Note that this test and the following are for behavior that is
         # not really supported any more:  coroutines no longer create a
         # stack context automatically; but one is created after the first
-        # yield point.
+        # YieldPoint (i.e. not a Future).
         @gen.coroutine
         def f2():
-            yield gen.Task(self.io_loop.add_callback)
+            (yield gen.Callback(1))()
+            yield gen.Wait(1)
             self.io_loop.add_callback(lambda: 1 / 0)
             try:
                 yield gen.Task(self.io_loop.add_timeout,
@@ -763,7 +764,8 @@ class GenCoroutineTest(AsyncTestCase):
         # can be caught and ignored.
         @gen.coroutine
         def f2():
-            yield gen.Task(self.io_loop.add_callback)
+            (yield gen.Callback(1))()
+            yield gen.Wait(1)
             self.io_loop.add_callback(lambda: 1 / 0)
             try:
                 yield gen.Task(self.io_loop.add_timeout,