Subclass this class and define `get()` or `post()` to make a handler. If you want to support more methods than the standard GET/HEAD/POST, you should override the class variable ``SUPPORTED_METHODS`` in your `RequestHandler` subclass.
def rosbridge_tools.tornado.web.RequestHandler.__init__ | ( | self, | |
application, | |||
request, | |||
kwargs | |||
) |
Reimplemented in rosbridge_tools.tornado.websocket.WebSocketHandler.
def rosbridge_tools.tornado.web.RequestHandler._clear_headers_for_304 | ( | self | ) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._convert_header_value | ( | self, | |
value | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._decode_xsrf_token | ( | self, | |
cookie | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._execute | ( | self, | |
transforms, | |||
args, | |||
kwargs | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._get_argument | ( | self, | |
name, | |||
default, | |||
source, | |||
strip = True |
|||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._get_arguments | ( | self, | |
name, | |||
source, | |||
strip = True |
|||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._get_raw_xsrf_token | ( | self | ) | [private] |
Read or generate the xsrf token in its raw form. The raw_xsrf_token is a tuple containing: * version: the version of the cookie from which this token was read, or None if we generated a new token in this request. * token: the raw token data; random (non-ascii) bytes. * timestamp: the time this token was generated (will not be accurate for version 1 cookies)
def rosbridge_tools.tornado.web.RequestHandler._handle_request_exception | ( | self, | |
e | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._log | ( | self | ) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._request_summary | ( | self | ) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._stack_context_handle_exception | ( | self, | |
type, | |||
value, | |||
traceback | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._ui_method | ( | self, | |
method | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler._ui_module | ( | self, | |
name, | |||
module | |||
) | [private] |
def rosbridge_tools.tornado.web.RequestHandler.add_header | ( | self, | |
name, | |||
value | |||
) |
Checks the ``Etag`` header against requests's ``If-None-Match``. Returns ``True`` if the request's Etag matches and a 304 should be returned. For example:: self.set_etag_header() if self.check_etag_header(): self.set_status(304) return This method is called automatically when the request is finished, but may be called earlier for applications that override `compute_etag` and want to do an early check for ``If-None-Match`` before completing the request. The ``Etag`` header should be set (perhaps with `set_etag_header`) before calling this method.
Verifies that the ``_xsrf`` cookie matches the ``_xsrf`` argument. To prevent cross-site request forgery, we set an ``_xsrf`` cookie and include the same value as a non-cookie field with all ``POST`` requests. If the two do not match, we reject the form submission as a potential forgery. The ``_xsrf`` value may be set as either a form field named ``_xsrf`` or in a custom HTTP header named ``X-XSRFToken`` or ``X-CSRFToken`` (the latter is accepted for compatibility with Django). See http://en.wikipedia.org/wiki/Cross-site_request_forgery Prior to release 1.1.1, this check was ignored if the HTTP header ``X-Requested-With: XMLHTTPRequest`` was present. This exception has been shown to be insecure and has been removed. For more information please see http://www.djangoproject.com/weblog/2011/feb/08/security/ http://weblog.rubyonrails.org/2011/2/8/csrf-protection-bypass-in-ruby-on-rails .. versionchanged:: 3.2.2 Added support for cookie version 2. Both versions 1 and 2 are supported.
Reimplemented in rosbridge_tools.tornado.web.ErrorHandler.
def rosbridge_tools.tornado.web.RequestHandler.clear | ( | self | ) |
def rosbridge_tools.tornado.web.RequestHandler.clear_all_cookies | ( | self, | |
path = "/" , |
|||
domain = None |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.clear_cookie | ( | self, | |
name, | |||
path = "/" , |
|||
domain = None |
|||
) |
Deletes the cookie with the given name. Due to limitations of the cookie protocol, you must pass the same path and domain to clear a cookie as were used when that cookie was set (but there is no way to find out on the server side which values were used for a given cookie).
def rosbridge_tools.tornado.web.RequestHandler.clear_header | ( | self, | |
name | |||
) |
Computes the etag header to be used for this request. By default uses a hash of the content written so far. May be overridden to provide custom etag implementations, or may return None to disable tornado's default etag support.
Reimplemented in rosbridge_tools.tornado.web.StaticFileHandler.
def rosbridge_tools.tornado.web.RequestHandler.create_signed_value | ( | self, | |
name, | |||
value, | |||
version = None |
|||
) |
Signs and timestamps a string so it cannot be forged. Normally used via set_secure_cookie, but provided as a separate method for non-cookie uses. To decode a value not stored as a cookie use the optional value argument to get_secure_cookie. .. versionchanged:: 3.2.1 Added the ``version`` argument. Introduced cookie version 2 and made it the default.
def rosbridge_tools.tornado.web.RequestHandler.create_template_loader | ( | self, | |
template_path | |||
) |
Returns a new template loader for the given path. May be overridden by subclasses. By default returns a directory-based loader on the given path, using the ``autoescape`` application setting. If a ``template_loader`` application setting is supplied, uses that instead.
The authenticated user for this request. This is a cached version of `get_current_user`, which you can override to set the user based on, e.g., a cookie. If that method is not overridden, this method always returns None. We lazy-load the current user the first time this method is called and cache the result after that.
def rosbridge_tools.tornado.web.RequestHandler.current_user | ( | self, | |
value | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.data_received | ( | self, | |
chunk | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.decode_argument | ( | self, | |
value, | |||
name = None |
|||
) |
Decodes an argument from the request. The argument has been percent-decoded and is now a byte string. By default, this method decodes the argument as utf-8 and returns a unicode string, but this may be overridden in subclasses. This method is used as a filter for both `get_argument()` and for values extracted from the url and passed to `get()`/`post()`/etc. The name of the argument is provided if known, but may be None (e.g. for unnamed groups in the url regex).
def rosbridge_tools.tornado.web.RequestHandler.delete | ( | self, | |
args, | |||
kwargs | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.finish | ( | self, | |
chunk = None |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.flush | ( | self, | |
include_footers = False , |
|||
callback = None |
|||
) |
Flushes the current output buffer to the network. The ``callback`` argument, if given, can be used for flow control: it will be run when all flushed data has been written to the socket. Note that only one flush callback can be outstanding at a time; if another flush occurs before the previous flush's callback has been run, the previous callback will be discarded. .. versionchanged:: 4.0 Now returns a `.Future` if no callback is given.
def rosbridge_tools.tornado.web.RequestHandler.get | ( | self, | |
args, | |||
kwargs | |||
) |
Reimplemented in rosbridge_tools.tornado.web.StaticFileHandler, and rosbridge_tools.tornado.websocket.WebSocketHandler.
def rosbridge_tools.tornado.web.RequestHandler.get_argument | ( | self, | |
name, | |||
default = _ARG_DEFAULT , |
|||
strip = True |
|||
) |
Returns the value of the argument with the given name. If default is not provided, the argument is considered to be required, and we raise a `MissingArgumentError` if it is missing. If the argument appears in the url more than once, we return the last value. The returned value is always unicode.
def rosbridge_tools.tornado.web.RequestHandler.get_arguments | ( | self, | |
name, | |||
strip = True |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.get_body_argument | ( | self, | |
name, | |||
default = _ARG_DEFAULT , |
|||
strip = True |
|||
) |
Returns the value of the argument with the given name from the request body. If default is not provided, the argument is considered to be required, and we raise a `MissingArgumentError` if it is missing. If the argument appears in the url more than once, we return the last value. The returned value is always unicode. .. versionadded:: 3.2
def rosbridge_tools.tornado.web.RequestHandler.get_body_arguments | ( | self, | |
name, | |||
strip = True |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.get_browser_locale | ( | self, | |
default = "en_US" |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.get_cookie | ( | self, | |
name, | |||
default = None |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.get_query_argument | ( | self, | |
name, | |||
default = _ARG_DEFAULT , |
|||
strip = True |
|||
) |
Returns the value of the argument with the given name from the request query string. If default is not provided, the argument is considered to be required, and we raise a `MissingArgumentError` if it is missing. If the argument appears in the url more than once, we return the last value. The returned value is always unicode. .. versionadded:: 3.2
def rosbridge_tools.tornado.web.RequestHandler.get_query_arguments | ( | self, | |
name, | |||
strip = True |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.get_secure_cookie | ( | self, | |
name, | |||
value = None , |
|||
max_age_days = 31 , |
|||
min_version = None |
|||
) |
Returns the given signed cookie if it validates, or None. The decoded cookie value is returned as a byte string (unlike `get_cookie`). .. versionchanged:: 3.2.1 Added the ``min_version`` argument. Introduced cookie version 2; both versions 1 and 2 are accepted by default.
Returns a dictionary to be used as the default template namespace. May be overridden by subclasses to add or modify values. The results of this method will be combined with additional defaults in the `tornado.template` module and keyword arguments to `render` or `render_string`.
def rosbridge_tools.tornado.web.RequestHandler.head | ( | self, | |
args, | |||
kwargs | |||
) |
Hook for subclass initialization. A dictionary passed as the third argument of a url spec will be supplied as keyword arguments to initialize(). Example:: class ProfileHandler(RequestHandler): def initialize(self, database): self.database = database def get(self, username): ... app = Application([ (r'/user/(.*)', ProfileHandler, dict(database=database)), ])
def rosbridge_tools.tornado.web.RequestHandler.log_exception | ( | self, | |
typ, | |||
value, | |||
tb | |||
) |
Override to customize logging of uncaught exceptions. By default logs instances of `HTTPError` as warnings without stack traces (on the ``tornado.general`` logger), and all other exceptions as errors with stack traces (on the ``tornado.application`` logger). .. versionadded:: 3.1
Called in async handlers if the client closed the connection. Override this to clean up resources associated with long-lived connections. Note that this method is called only if the connection was closed during asynchronous processing; if you need to do cleanup after every request override `on_finish` instead. Proxies may keep a connection open for a time (perhaps indefinitely) after the client has gone away, so this method may not be called promptly after the end user closes their connection.
Reimplemented in rosbridge_tools.tornado.websocket.WebSocketHandler.
def rosbridge_tools.tornado.web.RequestHandler.options | ( | self, | |
args, | |||
kwargs | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.patch | ( | self, | |
args, | |||
kwargs | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.post | ( | self, | |
args, | |||
kwargs | |||
) |
Called at the beginning of a request before `get`/`post`/etc. Override this method to perform common initialization regardless of the request method. Asynchronous support: Decorate this method with `.gen.coroutine` or `.return_future` to make it asynchronous (the `asynchronous` decorator cannot be used on `prepare`). If this method returns a `.Future` execution will not proceed until the `.Future` is done. .. versionadded:: 3.1 Asynchronous support.
Reimplemented in rosbridge_tools.tornado.web.FallbackHandler, and rosbridge_tools.tornado.web.ErrorHandler.
def rosbridge_tools.tornado.web.RequestHandler.put | ( | self, | |
args, | |||
kwargs | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.redirect | ( | self, | |
url, | |||
permanent = False , |
|||
status = None |
|||
) |
Sends a redirect to the given (optionally relative) URL. If the ``status`` argument is specified, that value is used as the HTTP status code; otherwise either 301 (permanent) or 302 (temporary) is chosen based on the ``permanent`` argument. The default is 302 (temporary).
def rosbridge_tools.tornado.web.RequestHandler.render | ( | self, | |
template_name, | |||
kwargs | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.render_string | ( | self, | |
template_name, | |||
kwargs | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.require_setting | ( | self, | |
name, | |||
feature = "this feature" |
|||
) |
def rosbridge_tools.tornado.web.RequestHandler.reverse_url | ( | self, | |
name, | |||
args | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.send_error | ( | self, | |
status_code = 500 , |
|||
kwargs | |||
) |
Sends the given HTTP error code to the browser. If `flush()` has already been called, it is not possible to send an error, so this method will simply terminate the response. If output has been written but not yet flushed, it will be discarded and replaced with the error page. Override `write_error()` to customize the error page that is returned. Additional keyword arguments are passed through to `write_error`.
def rosbridge_tools.tornado.web.RequestHandler.set_cookie | ( | self, | |
name, | |||
value, | |||
domain = None , |
|||
expires = None , |
|||
path = "/" , |
|||
expires_days = None , |
|||
kwargs | |||
) |
Override this to set HTTP headers at the beginning of the request. For example, this is the place to set a custom ``Server`` header. Note that setting such headers in the normal flow of request processing may not do what you want, since headers may be reset during error handling.
def rosbridge_tools.tornado.web.RequestHandler.set_header | ( | self, | |
name, | |||
value | |||
) |
def rosbridge_tools.tornado.web.RequestHandler.set_secure_cookie | ( | self, | |
name, | |||
value, | |||
expires_days = 30 , |
|||
version = None , |
|||
kwargs | |||
) |
Signs and timestamps a cookie so it cannot be forged. You must specify the ``cookie_secret`` setting in your Application to use this method. It should be a long, random sequence of bytes to be used as the HMAC secret for the signature. To read a cookie set with this method, use `get_secure_cookie()`. Note that the ``expires_days`` parameter sets the lifetime of the cookie in the browser, but is independent of the ``max_age_days`` parameter to `get_secure_cookie`. Secure cookies may contain arbitrary byte values, not just unicode strings (unlike regular cookies) .. versionchanged:: 3.2.1 Added the ``version`` argument. Introduced cookie version 2 and made it the default.
def rosbridge_tools.tornado.web.RequestHandler.set_status | ( | self, | |
status_code, | |||
reason = None |
|||
) |
Sets the status code for our response. :arg int status_code: Response status code. If ``reason`` is ``None``, it must be present in `httplib.responses <http.client.responses>`. :arg string reason: Human-readable reason phrase describing the status code. If ``None``, it will be filled in from `httplib.responses <http.client.responses>`.
def rosbridge_tools.tornado.web.RequestHandler.static_url | ( | self, | |
path, | |||
include_host = None , |
|||
kwargs | |||
) |
Returns a static URL for the given relative static file path. This method requires you set the ``static_path`` setting in your application (which specifies the root directory of your static files). This method returns a versioned url (by default appending ``?v=<signature>``), which allows the static files to be cached indefinitely. This can be disabled by passing ``include_version=False`` (in the default implementation; other static file implementations are not required to support this, but they may support other options). By default this method returns URLs relative to the current host, but if ``include_host`` is true the URL returned will be absolute. If this handler has an ``include_host`` attribute, that value will be used as the default for all `static_url` calls that do not pass ``include_host`` as a keyword argument.
def rosbridge_tools.tornado.web.RequestHandler.write | ( | self, | |
chunk | |||
) |
Writes the given chunk to the output buffer. To write the output to the network, use the flush() method below. If the given chunk is a dictionary, we write it as JSON and set the Content-Type of the response to be ``application/json``. (if you want to send JSON as a different ``Content-Type``, call set_header *after* calling write()). Note that lists are not converted to JSON because of a potential cross-site security vulnerability. All JSON output should be wrapped in a dictionary. More details at http://haacked.com/archive/2009/06/25/json-hijacking.aspx/ and https://github.com/facebook/tornado/issues/1009
def rosbridge_tools.tornado.web.RequestHandler.write_error | ( | self, | |
status_code, | |||
kwargs | |||
) |
Override to implement custom error pages. ``write_error`` may call `write`, `render`, `set_header`, etc to produce output as usual. If this error was caused by an uncaught exception (including HTTPError), an ``exc_info`` triple will be available as ``kwargs["exc_info"]``. Note that this exception may not be the "current" exception for purposes of methods like ``sys.exc_info()`` or ``traceback.format_exc``.
An HTML ``<input/>`` element to be included with all POST forms. It defines the ``_xsrf`` input value, which we check on all POST requests to prevent cross-site request forgery. If you have set the ``xsrf_cookies`` application setting, you must include this HTML within all of your HTML forms. In a template, this method should be called with ``{% module xsrf_form_html() %}`` See `check_xsrf_cookie()` above for more information.
The XSRF-prevention token for the current user/session. To prevent cross-site request forgery, we set an '_xsrf' cookie and include the same '_xsrf' value as an argument with all POST requests. If the two do not match, we reject the form submission as a potential forgery. See http://en.wikipedia.org/wiki/Cross-site_request_forgery .. versionchanged:: 3.2.2 The xsrf token will now be have a random mask applied in every request, which makes it safe to include the token in pages that are compressed. See http://breachattack.com for more information on the issue fixed by this change. Old (version 1) cookies will be converted to version 2 when this method is called unless the ``xsrf_cookie_version`` `Application` setting is set to 1.
list rosbridge_tools::tornado::web.RequestHandler::_ARG_DEFAULT = [] [static, private] |
Reimplemented in rosbridge_tools.tornado.web.FallbackHandler.
tuple rosbridge_tools::tornado::web.RequestHandler::_INVALID_HEADER_CHAR_RE = re.compile(br"[\x00-\x1f]") [static, private] |
tuple rosbridge_tools::tornado::web.RequestHandler::_remove_control_chars_regex = re.compile(r"[\x00-\x08\x0e-\x1f]") [static, private] |
tuple rosbridge_tools::tornado::web.RequestHandler::_template_loader_lock = threading.Lock() [static, private] |
dictionary rosbridge_tools::tornado::web.RequestHandler::_template_loaders = {} [static, private] |