Part of twisted.web.resource View Source View In Hierarchy
Known subclasses: twisted.web.resource.ForbiddenResource, twisted.web.resource.NoResource
ErrorPage
is a resource which responds with a particular (parameterized) status and a
body consisting of HTML containing some descriptive text. This is useful
for rendering simple error pages.| Instance Variable | template | A native string which will have a dictionary interpolated into it to
generate the response body. The dictionary has the following keys:
|
| Instance Variable | code | An integer status code which will be used for the response. |
| Instance Variable | brief | A short string which will be included in the response body. (type: str) |
| Instance Variable | detail 0 | A longer string which will be included in the response body. |
| Instance Variable | detail | str |
| Method | __init__ | Initialize. |
| Method | render | Render a given resource. See IResource's
render method. |
| Method | getChild | Retrieve a 'child' resource from me. |
Inherited from Resource:
| Method | listStaticNames | Undocumented |
| Method | listStaticEntities | Undocumented |
| Method | listNames | Undocumented |
| Method | listEntities | Undocumented |
| Method | listDynamicNames | Undocumented |
| Method | listDynamicEntities | Undocumented |
| Method | getStaticEntity | Undocumented |
| Method | getDynamicEntity | Undocumented |
| Method | delEntity | Undocumented |
| Method | reallyPutEntity | Undocumented |
| Method | getChildWithDefault | Retrieve a static or dynamically generated child resource from me. |
| Method | getChildForRequest | Undocumented |
| Method | putChild | Register a static child. |
| Method | render_HEAD | Default handling of HEAD method. |
"code": The status code passed to ErrorPage.__init__.
"brief": The brief description passed to ErrorPage.__init__.
"detail": The detailed description passed to ErrorPage.__init__.
IResource's
render method.
I delegate to methods of self with the form 'render_METHOD' where METHOD is the HTTP that was used to make the request. Examples: render_GET, render_HEAD, render_POST, and so on. Generally you should implement those methods instead of overriding this one.
render_METHOD methods are expected to return a byte string which will be
the rendered page, unless the return value is
server.NOT_DONE_YET, in which case it is this class's
responsibility to write the results using request.write(data)
and then call request.finish().
Old code that overrides render() directly is likewise expected to return a byte string or NOT_DONE_YET.
| See Also | IResource.render | |
Implement this to create dynamic resource generation -- resources which are always available may be registered with self.putChild().
This will not be called if the class-level variable 'isLeaf' is set in your subclass; instead, the 'postpath' attribute of the request will be left as a list of the remaining path elements.
For example, the URL /foo/bar/baz will normally be:
| site.resource.getChild('foo').getChild('bar').getChild('baz').
However, if the resource returned by 'bar' has isLeaf set to true, then the getChild call will never be made on it.
Parameters and return value have the same meaning and requirements as
those defined by IResource.getChildWithDefault.