twisted.web.util module documentation

Part of twisted.web

An assortment of web server-related utilities.

Function redirectTo Generate a redirect to the given location.
Class Redirect Undocumented
Class ChildRedirector Undocumented
Class ParentRedirect I redirect to URLPath.here().
Class DeferredResource I wrap up a Deferred that will eventually result in a Resource object.
Class FailureElement FailureElement is an IRenderable which can render detailed information about a Failure.
Function formatFailure Construct an HTML representation of the given failure.
Function _PRE Wraps <pre> tags around some text and HTML-escape it.
Class _SourceLineElement _SourceLineElement is an IRenderable which can render a single line of source code.
Class _SourceFragmentElement _SourceFragmentElement is an IRenderable which can render several lines of source code near the line number of a particular frame object.
Class _FrameElement _FrameElement is an IRenderable which can render details about one frame from a Failure.
Class _StackElement _StackElement renders an IRenderable which can render a list of frames.
def _PRE(text):

Wraps <pre> tags around some text and HTML-escape it.

This is here since once twisted.web.html was deprecated it was hard to migrate the html.PRE from current code to twisted.web.template.

For new code consider using twisted.web.template.

ReturnsEscaped text wrapped in <pre> tags. (type: str)
def redirectTo(URL, request):

Generate a redirect to the given location.

ParametersURLA bytes giving the location to which to redirect. (type: bytes)
requestThe request object to use to generate the redirect. (type: IRequest provider)
ReturnsA bytes containing HTML which tries to convince the client agent to visit the new location even if it doesn't respect the FOUND response code. This is intended to be returned from a render method, eg: 
   def render_GET(self, request):
       return redirectTo(b"http://example.com/", request)
RaisesTypeErrorIf the type of URL a unicode instead of bytes.
def formatFailure(myFailure):

Construct an HTML representation of the given failure.

Consider using FailureElement instead.

ReturnsA string containing the HTML representation of the given failure. (type: bytes)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.