Rooba
/
tornado
mirror of https://github.com/tornadoweb/tornado.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tornado/website/sphinx/web.rst

121 lines
3.6 KiB
ReStructuredText
Raw Normal View History

Add titles to table of contents
2011-06-11 21:48:46 +00:00
``tornado.web`` --- ``RequestHandler`` and ``Application`` classes
==================================================================
Skeletal autogenerated reference documentation
2011-06-09 06:58:58 +00:00
.. automodule:: tornado.web
Fix up docs for web.py
2011-06-09 08:15:56 +00:00
Request handlers
----------------
.. autoclass:: RequestHandler
Use real section headers
2011-06-11 21:35:54 +00:00
Entry points
^^^^^^^^^^^^
Refactor template namespace from render_string to its own method. This method may be overridden as an alternative to overriding render_string and adding to kwargs, or may be used directly to render templates without going through render_string (as when templates are constructed directly; see https://github.com/facebook/tornado/issues/564)
2012-08-27 00:43:38 +00:00
Use real section headers
2011-06-11 21:35:54 +00:00
.. automethod:: RequestHandler.initialize
.. automethod:: RequestHandler.prepare
Doc updates
2012-01-23 01:52:43 +00:00
.. automethod:: RequestHandler.on_finish
Use real section headers
2011-06-11 21:35:54 +00:00
Implement any of the following methods to handle the corresponding
HTTP method.
.. automethod:: RequestHandler.get
.. automethod:: RequestHandler.post
.. automethod:: RequestHandler.put
.. automethod:: RequestHandler.delete
.. automethod:: RequestHandler.head
.. automethod:: RequestHandler.options
Input
^^^^^
.. automethod:: RequestHandler.get_argument
.. automethod:: RequestHandler.get_arguments
.. automethod:: RequestHandler.decode_argument
More doc updates
2011-06-17 05:36:33 +00:00
.. attribute:: RequestHandler.request
The `tornado.httpserver.HTTPRequest` object containing additional
request parameters including e.g. headers and body data.
Use real section headers
2011-06-11 21:35:54 +00:00
Output
^^^^^^
.. automethod:: RequestHandler.set_status
.. automethod:: RequestHandler.set_header
Update docs with new methods
2011-09-04 22:39:55 +00:00
.. automethod:: RequestHandler.add_header
Add RequestHandler.set_default_headers, which may be overridden to set headers that will not be reset during error handling.
2011-07-04 17:17:32 +00:00
.. automethod:: RequestHandler.set_default_headers
Use real section headers
2011-06-11 21:35:54 +00:00
.. automethod:: RequestHandler.write
.. automethod:: RequestHandler.flush
.. automethod:: RequestHandler.finish
.. automethod:: RequestHandler.render
.. automethod:: RequestHandler.render_string
Refactor template namespace from render_string to its own method. This method may be overridden as an alternative to overriding render_string and adding to kwargs, or may be used directly to render templates without going through render_string (as when templates are constructed directly; see https://github.com/facebook/tornado/issues/564)
2012-08-27 00:43:38 +00:00
.. automethod:: RequestHandler.get_template_namespace
Use real section headers
2011-06-11 21:35:54 +00:00
.. automethod:: RequestHandler.redirect
.. automethod:: RequestHandler.send_error
Revamp error handling: replace get_error_html with write_error.
2011-07-04 19:16:50 +00:00
.. automethod:: RequestHandler.write_error
Use real section headers
2011-06-11 21:35:54 +00:00
.. automethod:: RequestHandler.clear
Cookies
^^^^^^^
.. autoattribute:: RequestHandler.cookies
.. automethod:: RequestHandler.get_cookie
.. automethod:: RequestHandler.set_cookie
.. automethod:: RequestHandler.clear_cookie
.. automethod:: RequestHandler.clear_all_cookies
.. automethod:: RequestHandler.get_secure_cookie
.. automethod:: RequestHandler.set_secure_cookie
.. automethod:: RequestHandler.create_signed_value
Other
^^^^^
More doc updates
2011-06-17 05:36:33 +00:00
.. attribute:: RequestHandler.application
The `Application` object serving this request
Use real section headers
2011-06-11 21:35:54 +00:00
.. automethod:: RequestHandler.async_callback
.. automethod:: RequestHandler.check_xsrf_cookie
.. automethod:: RequestHandler.compute_etag
.. automethod:: RequestHandler.get_browser_locale
.. automethod:: RequestHandler.get_current_user
.. automethod:: RequestHandler.get_login_url
.. automethod:: RequestHandler.get_status
.. automethod:: RequestHandler.get_template_path
.. automethod:: RequestHandler.get_user_locale
.. automethod:: RequestHandler.on_connection_close
.. automethod:: RequestHandler.require_setting
Run coverage check and fill in the blanks
2011-06-19 18:23:53 +00:00
.. automethod:: RequestHandler.reverse_url
More doc updates
2011-06-17 05:36:33 +00:00
.. autoattribute:: RequestHandler.settings
Use real section headers
2011-06-11 21:35:54 +00:00
.. automethod:: RequestHandler.static_url
.. automethod:: RequestHandler.xsrf_form_html
Use coverage checker instead of automatic member extraction
2011-06-09 18:03:49 +00:00
Fix up docs for web.py
2011-06-09 08:15:56 +00:00
Application configuration
-----------------------------
.. autoclass:: Application
Use coverage checker instead of automatic member extraction
2011-06-09 18:03:49 +00:00
:members:
Fix up docs for web.py
2011-06-09 08:15:56 +00:00
.. autoclass:: URLSpec
The ``URLSpec`` class is also available under the name ``tornado.web.url``.
Decorators
----------
.. autofunction:: asynchronous
.. autofunction:: authenticated
.. autofunction:: addslash
.. autofunction:: removeslash
Everything else
---------------
Use coverage checker instead of automatic member extraction
2011-06-09 18:03:49 +00:00
.. autoexception:: HTTPError
.. autoclass:: UIModule
:members:
.. autoclass:: ErrorHandler
.. autoclass:: FallbackHandler
.. autoclass:: RedirectHandler
.. autoclass:: StaticFileHandler
:members: