tornado.autoreload — Automatically detect code changes in development¶
Automatically restart the server when a source file is modified.
Most applications should not access this module directly. Instead,
pass the keyword argument
autoreload=True to the
tornado.web.Application constructor (or
enables this setting and several others). This will enable autoreload
mode as well as checking for changes to templates and static
resources. Note that restarting is a destructive operation and any
requests in progress will be aborted when the process restarts. (If
you want to disable autoreload while using other debug-mode features,
This module can also be used as a command-line wrapper around scripts
such as unit test runners. See the
main method for details.
The command-line wrapper and Application debug modes can be used together. This combination is encouraged as the wrapper catches syntax errors and other import-time failures, while debug mode catches changes once the server has started.
This module will not work correctly when
mode is used.
Reloading loses any Python interpreter command-line arguments (e.g.
because it re-executes Python using
Additionally, modifying these variables will cause reloading to behave
start(check_time: int = 500) → None¶
Begins watching source files for changes.
Changed in version 5.0: The
io_loopargument (deprecated since version 4.1) has been removed.
wait() → None¶
Wait for a watched file to change, then restart the process.
Intended to be used at the end of scripts like unit test runners, to run the tests again after any source file changes (but see also the command-line interface in
watch(filename: str) → None¶
Add a file to the watch list.
All imported modules are watched by default.
add_reload_hook(fn: Callable[, None]) → None¶
Add a function to be called before reloading the process.
Note that for open file and socket handles it is generally preferable to set the
tornado.platform.auto.set_close_exec) instead of using a reload hook to close them.
main() → None¶
Command-line wrapper to re-run a script whenever its source changes.
Scripts may be specified by filename or module name:
python -m tornado.autoreload -m tornado.test.runtests python -m tornado.autoreload tornado/test/runtests.py
Running a script with this wrapper is similar to calling
tornado.autoreload.waitat the end of the script, but this wrapper can catch import-time problems like syntax errors that would otherwise prevent the script from reaching its call to