Skip to content
Newer
Older
100644 120 lines (93 sloc) 3.5 KB
8fd9413 @bdarnell Add titles to table of contents
bdarnell authored Jun 11, 2011
1 ``tornado.web`` --- ``RequestHandler`` and ``Application`` classes
2 ==================================================================
4fec6ae @bdarnell Skeletal autogenerated reference documentation
bdarnell authored Jun 8, 2011
3
4 .. automodule:: tornado.web
53f5f3c @bdarnell Fix up docs for web.py
bdarnell authored Jun 9, 2011
5
6 Request handlers
7 ----------------
8 .. autoclass:: RequestHandler
9
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
10 Entry points
11 ^^^^^^^^^^^^
12
13 .. automethod:: RequestHandler.initialize
14 .. automethod:: RequestHandler.prepare
e04957d @bdarnell Doc updates
bdarnell authored Jan 22, 2012
15 .. automethod:: RequestHandler.on_finish
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
16
17 Implement any of the following methods to handle the corresponding
18 HTTP method.
19
20 .. automethod:: RequestHandler.get
21 .. automethod:: RequestHandler.post
22 .. automethod:: RequestHandler.put
23 .. automethod:: RequestHandler.delete
24 .. automethod:: RequestHandler.head
25 .. automethod:: RequestHandler.options
26
27 Input
28 ^^^^^
29
30 .. automethod:: RequestHandler.get_argument
31 .. automethod:: RequestHandler.get_arguments
32 .. automethod:: RequestHandler.decode_argument
cdc76f2 @bdarnell More doc updates
bdarnell authored Jun 16, 2011
33 .. attribute:: RequestHandler.request
34
35 The `tornado.httpserver.HTTPRequest` object containing additional
36 request parameters including e.g. headers and body data.
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
37
38 Output
39 ^^^^^^
40
41 .. automethod:: RequestHandler.set_status
42 .. automethod:: RequestHandler.set_header
b2de4b8 @bdarnell Update docs with new methods
bdarnell authored Sep 4, 2011
43 .. automethod:: RequestHandler.add_header
9481ce1 @bdarnell Add RequestHandler.set_default_headers, which may be overridden to set
bdarnell authored Jul 4, 2011
44 .. automethod:: RequestHandler.set_default_headers
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
45 .. automethod:: RequestHandler.write
46 .. automethod:: RequestHandler.flush
47 .. automethod:: RequestHandler.finish
48 .. automethod:: RequestHandler.render
49 .. automethod:: RequestHandler.render_string
50 .. automethod:: RequestHandler.redirect
51 .. automethod:: RequestHandler.send_error
5de8684 @bdarnell Revamp error handling: replace get_error_html with write_error.
bdarnell authored Jul 4, 2011
52 .. automethod:: RequestHandler.write_error
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
53 .. automethod:: RequestHandler.clear
54
55
56 Cookies
57 ^^^^^^^
58
59 .. autoattribute:: RequestHandler.cookies
60 .. automethod:: RequestHandler.get_cookie
61 .. automethod:: RequestHandler.set_cookie
62 .. automethod:: RequestHandler.clear_cookie
63 .. automethod:: RequestHandler.clear_all_cookies
64 .. automethod:: RequestHandler.get_secure_cookie
65 .. automethod:: RequestHandler.set_secure_cookie
66 .. automethod:: RequestHandler.create_signed_value
67
68 Other
69 ^^^^^
70
cdc76f2 @bdarnell More doc updates
bdarnell authored Jun 17, 2011
71 .. attribute:: RequestHandler.application
72
73 The `Application` object serving this request
74
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
75 .. automethod:: RequestHandler.async_callback
76 .. automethod:: RequestHandler.check_xsrf_cookie
77 .. automethod:: RequestHandler.compute_etag
78 .. automethod:: RequestHandler.get_browser_locale
79 .. automethod:: RequestHandler.get_current_user
80 .. automethod:: RequestHandler.get_login_url
81 .. automethod:: RequestHandler.get_status
82 .. automethod:: RequestHandler.get_template_path
83 .. automethod:: RequestHandler.get_user_locale
84 .. automethod:: RequestHandler.on_connection_close
85 .. automethod:: RequestHandler.require_setting
55d3be1 @bdarnell Run coverage check and fill in the blanks
bdarnell authored Jun 19, 2011
86 .. automethod:: RequestHandler.reverse_url
cdc76f2 @bdarnell More doc updates
bdarnell authored Jun 17, 2011
87 .. autoattribute:: RequestHandler.settings
0747607 @bdarnell Use real section headers
bdarnell authored Jun 11, 2011
88 .. automethod:: RequestHandler.static_url
89 .. automethod:: RequestHandler.xsrf_form_html
050797c @bdarnell Use coverage checker instead of automatic member extraction
bdarnell authored Jun 9, 2011
90
53f5f3c @bdarnell Fix up docs for web.py
bdarnell authored Jun 9, 2011
91
92
93 Application configuration
94 -----------------------------
95 .. autoclass:: Application
050797c @bdarnell Use coverage checker instead of automatic member extraction
bdarnell authored Jun 9, 2011
96 :members:
53f5f3c @bdarnell Fix up docs for web.py
bdarnell authored Jun 9, 2011
97
98 .. autoclass:: URLSpec
99
100 The ``URLSpec`` class is also available under the name ``tornado.web.url``.
101
102 Decorators
103 ----------
104 .. autofunction:: asynchronous
105 .. autofunction:: authenticated
106 .. autofunction:: addslash
107 .. autofunction:: removeslash
108
109 Everything else
110 ---------------
050797c @bdarnell Use coverage checker instead of automatic member extraction
bdarnell authored Jun 9, 2011
111 .. autoexception:: HTTPError
112 .. autoclass:: UIModule
113 :members:
114
115 .. autoclass:: ErrorHandler
116 .. autoclass:: FallbackHandler
117 .. autoclass:: RedirectHandler
118 .. autoclass:: StaticFileHandler
119 :members:
Something went wrong with that request. Please try again.