tornado.stack_context — Exception handling across asynchronous callbacks¶
StackContext allows applications to maintain threadlocal-like state
that follows execution as it moves to other execution contexts.
The motivating examples are to eliminate the need for explicit
async_callback wrappers (as in
tornado.web.RequestHandler), and to
allow some additional context to be kept for logging.
This is slightly magic, but it’s an extension of the idea that an
exception handler is a kind of stack-local state and when that stack
is suspended and resumed in a new context that state needs to be
StackContext shifts the burden of restoring that state
from each call site (e.g. wrapping each
async_callback) to the mechanisms that transfer control from
one context to another (e.g.
thread pools, etc).
@contextlib.contextmanager def die_on_error(): try: yield except Exception: logging.error("exception in asynchronous operation",exc_info=True) sys.exit(1) with StackContext(die_on_error): # Any exception thrown here *or in callback and its descendants* # will cause the process to exit instead of spinning endlessly # in the ioloop. http_client.fetch(url, callback) ioloop.start()
Most applications shouldn’t have to work with
Here are a few rules of thumb for when it’s necessary:
- If you’re writing an asynchronous library that doesn’t rely on a
stack_context-aware library like
tornado.iostream(for example, if you’re writing a thread pool), use
stack_context.wrap()before any asynchronous operations to capture the stack context from where the operation was started.
- If you’re writing an asynchronous library that has some shared
resources (such as a connection pool), create those shared resources
with stack_context.NullContext():block. This will prevent
StackContextsfrom leaking from one request to another.
- If you want to write something like an exception handler that will
persist across asynchronous calls, create a new
ExceptionStackContext), and make your asynchronous calls in a
withblock that references your
Deprecated since version 5.1: The
stack_context package is deprecated and will be removed in
Establishes the given context as a StackContext that will be transferred.
Note that the parameter is a callable that returns a context manager, not the context itself. That is, where for a non-transferable context manager you would say:
StackContext takes the function itself rather than its result:
The result of
with StackContext() as cb:is a deactivation callback. Run this callback when the StackContext is no longer needed to ensure that it is not propagated any further (note that deactivating a context does not affect any instances of that context that are currently pending). This is an advanced feature and not necessary in most applications.
Specialization of StackContext for exception handling.
exception_handlerfunction will be called in the event of an uncaught exception in this context. The semantics are similar to a try/finally clause, and intended use cases are to log an error, close a socket, or similar cleanup actions. The
(type, value, traceback)will be passed to the exception_handler function.
If the exception handler returns true, the exception will be consumed and will not be propagated to other exception handlers.
New in version 5.1: The
delay_warningargument can be used to delay the emission of DeprecationWarnings until an exception is caught by the
ExceptionStackContext, which facilitates certain transitional use cases.
Useful when creating a shared resource on demand (e.g. an
AsyncHTTPClient) where the stack that caused the creating is not relevant to future operations.
Returns a callable object that will restore the current
Use this whenever saving a callback to be executed later in a different execution context (either in a different thread or asynchronously in the same thread).
Run a coroutine
funcin the given
It is not safe to have a
yieldstatement within a
with StackContextblock, so it is difficult to use stack context with
gen.coroutine. This helper function runs the function in the correct context while keeping the
withstatements syntactically separate.
@gen.coroutine def incorrect(): with StackContext(ctx): # ERROR: this will raise StackContextInconsistentError yield other_coroutine() @gen.coroutine def correct(): yield run_with_stack_context(StackContext(ctx), other_coroutine)
New in version 3.1.