webtools.helpers

webtools.helpers.get_app()

Returns the active app instance.

Returns:A WSGIApplication instance.

webtools.helpers.get_request()

Returns the active request instance.

Returns:A Request instance.

webtools.helpers.uri_for(_name, _request=None, *args, **kwargs)

A standalone uri_for version that can be passed to templates.

See also

Router.build().

webtools.helpers.redirect(uri, permanent=False, abort=False, code=None, body=None, request=None, response=None)

Issues an HTTP redirect to the given relative URI.

This won’t stop code execution unless abort is True. A common practice is to return when calling this method:

return redirect('/some-path')

Parameters:

• uri – A relative or absolute URI (e.g., '../flowers.html').
• permanent – If True, uses a 301 redirect instead of a 302 redirect.
• abort – If True, raises an exception to perform the redirect.
• code – The redirect status code. Supported codes are 301, 302, 303, 305, and 307. 300 is not supported because it’s not a real redirect and 304 because it’s the answer for a request with defined If-Modified-Since headers.
• body – Response body, if any.
• request – Optional request object. If not set, uses get_request().
• response – Optional response object. If not set, a new response is created.

Returns:

A Response instance.

webtools.helpers.redirect_to(_name, _permanent=False, _abort=False, _code=None, _body=None, _request=None, _response=None, *args, **kwargs)

Convenience function mixing redirect() and uri_for().

Issues an HTTP redirect to a named URI built using uri_for().

Parameters:

• _name – The route name to redirect to.
• args – Positional arguments to build the URI.
• kwargs – Keyword arguments to build the URI.

Returns:

A Response instance.

The other arguments are described in redirect().