tornado.concurrent — Work with threads and futures

Utilities for working with threads and Futures.

Futures are a pattern for concurrent programming introduced in Python 3.2 in the concurrent.futures package (this package has also been backported to older versions of Python and can be installed with pip install futures). Tornado will use concurrent.futures.Future if it is available; otherwise it will use a compatible class defined in this module.

class tornado.concurrent.Future

A Future encapsulates the result of an asynchronous operation. In synchronous applications Futures are used to wait for the result from a thread or process pool; in Tornado they are normally used with IOLoop.add_future or by yielding them in a gen.coroutine.

If the concurrent.futures package is available, tornado.concurrent.Future is simply an alias for concurrent.futures.Future. Otherwise, we support the same interface with a few limitations:

• It is an error to call result or exception before the Future has completed.
• Cancellation is not supported.

result()

If the operation succeeded, return its result. If it failed, re-raise its exception.

exception()

If the operation raised an exception, return the Exception object. Otherwise returns None.

add_done_callback(fn)

Attaches the given callback to the Future. It will be invoked with the Future as its argument when it has finished running and its result is available. In Tornado consider using IOLoop.add_future instead of calling add_done_callback directly.

done()

Returns True if the future has finished running and its result and exception methods are available.

class tornado.concurrent.TracebackFuture

Subclass of Future which can store a traceback with exceptions.

The traceback is automatically available in Python 3, but in the Python 2 futures backport this information is discarded.

set_exc_info(exc_info)

Traceback-aware replacement for set_exception.

tornado.concurrent.run_on_executor(fn)

Decorator to run a synchronous method asynchronously on an executor.

The decorated method may be called with a callback keyword argument and returns a future.

tornado.concurrent.return_future(f)

Decorator to make a function that returns via callback return a Future.

The wrapped function should take a callback keyword argument and invoke it with one argument when it has finished. To signal failure, the function can simply raise an exception (which will be captured by the StackContext and passed along to the Future).

From the caller’s perspective, the callback argument is optional. If one is given, it will be invoked when the function is complete with Future.result() as an argument. If the function fails, the callback will not be run and an exception will be raised into the surrounding StackContext.

If no callback is given, the caller should use the Future to wait for the function to complete (perhaps by yielding it in a gen.engine function, or passing it to IOLoop.add_future).

Usage:

@return_future
def future_func(arg1, arg2, callback):
    # Do stuff (possibly asynchronous)
    callback(result)

@gen.engine
def caller(callback):
    yield future_func(arg1, arg2)
    callback()

Note that @return_future and @gen.engine can be applied to the same function, provided @return_future appears first. However, consider using @gen.coroutine instead of this combination.

tornado.concurrent.chain_future(a, b)

Chain two futures together so that when one completes, so does the other.

The result (success or failure) of a will be copied to b.