Add a warning label to WSGIContainer.

This commit is contained in:
Ben Darnell 2014-02-22 23:25:51 -05:00
parent 559514de8c
commit f55f9d0745
1 changed files with 10 additions and 0 deletions

View File

@ -215,6 +215,16 @@ class HTTPRequest(object):
class WSGIContainer(object): class WSGIContainer(object):
r"""Makes a WSGI-compatible function runnable on Tornado's HTTP server. r"""Makes a WSGI-compatible function runnable on Tornado's HTTP server.
.. warning::
WSGI is a *synchronous* interface, while Tornado's concurrency model
is based on single-threaded asynchronous execution. This means that
running a WSGI app with Tornado's `WSGIContainer` is *less scalable*
than running the same app in a multi-threaded WSGI server like
``gunicorn`` or ``uwsgi``. Use `WSGIContainer` only when there are
benefits to combining Tornado and WSGI in the same process that
outweigh the reduced scalability.
Wrap a WSGI function in a `WSGIContainer` and pass it to `.HTTPServer` to Wrap a WSGI function in a `WSGIContainer` and pass it to `.HTTPServer` to
run it. For example:: run it. For example::