Skip to content

Commit

Permalink
Documentation: Application(debug=True); autoreload limitations.
Browse files Browse the repository at this point in the history
Application: Document debug=True and cross-link to the overview.
autoreload: Note that this can lose flags and fail if you touch sys.argv.
  • Loading branch information
evanj committed Jun 14, 2012
1 parent 489997d commit 753bbbf
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
5 changes: 5 additions & 0 deletions tornado/autoreload.py
Expand Up @@ -24,6 +24,11 @@
This module depends on IOLoop, so it will not work in WSGI applications
and Google AppEngine. It also will not work correctly when HTTPServer's
multi-process mode is used.
Reloading loses any Python interpreter command-line arguments (e.g. ``-u``)
because it re-executes Python using ``sys.executable`` and ``sys.argv``.
Additionally, modifying these variables will cause reloading to behave
incorrectly.
"""

from __future__ import absolute_import, division, with_statement
Expand Down
8 changes: 7 additions & 1 deletion tornado/web.py
Expand Up @@ -1208,9 +1208,15 @@ class Application(object):
.. attribute:: settings
Additonal keyword arguments passed to the constructor are saved in the
Additional keyword arguments passed to the constructor are saved in the
`settings` dictionary, and are often referred to in documentation as
"application settings".
.. attribute:: debug
If `True` the application runs in debug mode, described in
:ref:`debug-mode`. This is an application setting in the `settings`
dictionary, so handlers can access it.
"""
def __init__(self, handlers=None, default_host="", transforms=None,
wsgi=False, **settings):
Expand Down
8 changes: 8 additions & 0 deletions website/sphinx/overview.rst
Expand Up @@ -957,6 +957,8 @@ the Google credentials in a cookie for later access:

See the `tornado.auth` module documentation for more details.

.. _debug-mode:

Debug mode and automatic reloading
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -976,6 +978,12 @@ The automatic reloading feature of debug mode is available as a
standalone module in ``tornado.autoreload``, and is optionally used by
the test runner in ``tornado.testing.main``.

Reloading loses any Python interpreter command-line arguments (e.g. ``-u``)
because it re-executes Python using ``sys.executable`` and ``sys.argv``.
Additionally, modifying these variables will cause reloading to behave
incorrectly.


Running Tornado in production
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 753bbbf

Please sign in to comment.