Web framework¶

• tornado.web — RequestHandler and Application classes
  • Thread-safety notes
  • Request handlers
    • RequestHandler
    • Entry points
      • RequestHandler.initialize()
      • RequestHandler.prepare()
      • RequestHandler.on_finish()
      • RequestHandler.get()
      • RequestHandler.head()
      • RequestHandler.post()
      • RequestHandler.delete()
      • RequestHandler.patch()
      • RequestHandler.put()
      • RequestHandler.options()
    • Input
      • RequestHandler.get_argument()
      • RequestHandler.get_arguments()
      • RequestHandler.get_query_argument()
      • RequestHandler.get_query_arguments()
      • RequestHandler.get_body_argument()
      • RequestHandler.get_body_arguments()
      • RequestHandler.decode_argument()
      • RequestHandler.request
      • RequestHandler.path_args
      • RequestHandler.path_kwargs
      • RequestHandler.data_received()
    • Output
      • RequestHandler.set_status()
      • RequestHandler.set_header()
      • RequestHandler.add_header()
      • RequestHandler.clear_header()
      • RequestHandler.set_default_headers()
      • RequestHandler.write()
      • RequestHandler.flush()
      • RequestHandler.finish()
      • RequestHandler.render()
      • RequestHandler.render_string()
      • RequestHandler.get_template_namespace()
      • RequestHandler.redirect()
      • RequestHandler.send_error()
      • RequestHandler.write_error()
      • RequestHandler.clear()
      • RequestHandler.render_linked_js()
      • RequestHandler.render_embed_js()
      • RequestHandler.render_linked_css()
      • RequestHandler.render_embed_css()
    • Cookies
      • RequestHandler.cookies
      • RequestHandler.get_cookie()
      • RequestHandler.set_cookie()
      • RequestHandler.clear_cookie()
      • RequestHandler.clear_all_cookies()
      • RequestHandler.get_signed_cookie()
      • RequestHandler.get_signed_cookie_key_version()
      • RequestHandler.set_signed_cookie()
      • RequestHandler.get_secure_cookie()
      • RequestHandler.get_secure_cookie_key_version()
      • RequestHandler.set_secure_cookie()
      • RequestHandler.create_signed_value()
      • MIN_SUPPORTED_SIGNED_VALUE_VERSION
      • MAX_SUPPORTED_SIGNED_VALUE_VERSION
      • DEFAULT_SIGNED_VALUE_VERSION
      • DEFAULT_SIGNED_VALUE_MIN_VERSION
    • Other
      • RequestHandler.application
      • RequestHandler.check_etag_header()
      • RequestHandler.check_xsrf_cookie()
      • RequestHandler.compute_etag()
      • RequestHandler.create_template_loader()
      • RequestHandler.current_user
      • RequestHandler.detach()
      • RequestHandler.get_browser_locale()
      • RequestHandler.get_current_user()
      • RequestHandler.get_login_url()
      • RequestHandler.get_status()
      • RequestHandler.get_template_path()
      • RequestHandler.get_user_locale()
      • RequestHandler.locale
      • RequestHandler.log_exception()
      • RequestHandler.on_connection_close()
      • RequestHandler.require_setting()
      • RequestHandler.reverse_url()
      • RequestHandler.set_etag_header()
      • RequestHandler.settings
      • RequestHandler.static_url()
      • RequestHandler.xsrf_form_html()
      • RequestHandler.xsrf_token
  • Application configuration
    • Application
      • Application.settings
      • Application.listen()
      • Application.add_handlers()
      • Application.get_handler_delegate()
      • Application.reverse_url()
      • Application.log_request()
    • URLSpec
  • Decorators
    • authenticated()
    • addslash()
    • removeslash()
    • stream_request_body()
  • Everything else
    • HTTPError
    • Finish
    • MissingArgumentError
    • UIModule
      • UIModule.render()
      • UIModule.embedded_javascript()
      • UIModule.javascript_files()
      • UIModule.embedded_css()
      • UIModule.css_files()
      • UIModule.html_head()
      • UIModule.html_body()
      • UIModule.render_string()
    • ErrorHandler
    • FallbackHandler
    • RedirectHandler
    • StaticFileHandler
      • StaticFileHandler.compute_etag()
      • StaticFileHandler.set_headers()
      • StaticFileHandler.should_return_304()
      • StaticFileHandler.get_absolute_path()
      • StaticFileHandler.validate_absolute_path()
      • StaticFileHandler.get_content()
      • StaticFileHandler.get_content_version()
      • StaticFileHandler.get_content_size()
      • StaticFileHandler.get_modified_time()
      • StaticFileHandler.get_content_type()
      • StaticFileHandler.set_extra_headers()
      • StaticFileHandler.get_cache_time()
      • StaticFileHandler.make_static_url()
      • StaticFileHandler.parse_url_path()
      • StaticFileHandler.get_version()
• tornado.template — Flexible output generation
  • Syntax Reference
  • Class reference
    • Template
      • Template.generate()
    • BaseLoader
      • BaseLoader.reset()
      • BaseLoader.resolve_path()
      • BaseLoader.load()
    • Loader
    • DictLoader
    • ParseError
    • filter_whitespace()
• tornado.routing — Basic routing implementation
  • Router
    • Router.find_handler()
  • ReversibleRouter
    • ReversibleRouter.reverse_url()
  • RuleRouter
    • RuleRouter.add_rules()
    • RuleRouter.process_rule()
    • RuleRouter.get_target_delegate()
  • ReversibleRuleRouter
  • Rule
  • Matcher
    • Matcher.match()
    • Matcher.reverse()
  • AnyMatches
  • HostMatches
  • DefaultHostMatches
  • PathMatches
  • URLSpec
• tornado.escape — Escaping and string manipulation
  • Escaping functions
    • xhtml_escape()
    • xhtml_unescape()
    • url_escape()
    • url_unescape()
    • json_encode()
    • json_decode()
  • Byte/unicode conversions
    • utf8()
    • to_unicode()
    • native_str()
    • to_basestring()
    • recursive_unicode()
  • Miscellaneous functions
    • linkify()
    • squeeze()
• tornado.locale — Internationalization support
  • get()
  • set_default_locale()
  • load_translations()
  • load_gettext_translations()
  • get_supported_locales()
  • Locale
    • Locale.get_closest()
    • Locale.get()
    • Locale.translate()
    • Locale.format_date()
    • Locale.format_day()
    • Locale.list()
    • Locale.friendly_number()
  • CSVLocale
  • GettextLocale
    • GettextLocale.pgettext()
• tornado.websocket — Bidirectional communication to the browser
  • WebSocketHandler
  • Event handlers
    • WebSocketHandler.open()
    • WebSocketHandler.on_message()
    • WebSocketHandler.on_close()
    • WebSocketHandler.select_subprotocol()
    • WebSocketHandler.selected_subprotocol
    • WebSocketHandler.on_ping()
  • Output
    • WebSocketHandler.write_message()
    • WebSocketHandler.close()
  • Configuration
    • WebSocketHandler.check_origin()
    • WebSocketHandler.get_compression_options()
    • WebSocketHandler.set_nodelay()
  • Other
    • WebSocketHandler.ping()
    • WebSocketHandler.on_pong()
    • WebSocketClosedError
  • Client-side support
    • websocket_connect()
    • WebSocketClientConnection
      • WebSocketClientConnection.close()
      • WebSocketClientConnection.write_message()
      • WebSocketClientConnection.read_message()
      • WebSocketClientConnection.ping()
      • WebSocketClientConnection.selected_subprotocol