Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`web`.`resource`.`_UnsafeErrorPage``

class documentation

`class _UnsafeErrorPage(Resource): (source)`

Known subclasses: `twisted.web.resource._UnsafeForbiddenResource`, `twisted.web.resource._UnsafeNoResource`

Constructor: `_UnsafeErrorPage(status, brief, detail)`

View In Hierarchy

`_UnsafeErrorPage`, publicly available via the deprecated alias `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.

Deprecated in Twisted 22.10.0 because it permits HTML injection; use `twisted.web.pages.errorPage` instead.

Method | `__init__` | Initialize.
Method | `getChild` | Retrieve a 'child' resource from me.
Method | `render` | Render a given resource. See `IResource`'s render method.
Instance Variable | `brief` | A short string which will be included in the response body as the page title.
Instance Variable | `code` | An integer status code which will be used for the response.
Instance Variable | `detail` | A longer string which will be included in the response body.
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:

Inherited from `Resource`:

Method | `delEntity` | Undocumented
Method | `getChildForRequest` | Deprecated in favor of `getChildForRequest`.
Method | `getChildWithDefault` | Retrieve a static or dynamically generated child resource from me.
Method | `getDynamicEntity` | Undocumented
Method | `getStaticEntity` | Undocumented
Method | `listDynamicEntities` | Undocumented
Method | `listDynamicNames` | Undocumented
Method | `listEntities` | Undocumented
Method | `listNames` | Undocumented
Method | `listStaticEntities` | Undocumented
Method | `listStaticNames` | Undocumented
Method | `putChild` | Register a static child.
Method | `reallyPutEntity` | Undocumented
Method | `render_HEAD` | Default handling of HEAD method.
Class Variable | `allowedMethods` | Undocumented
Class Variable | `isLeaf` | Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
Class Variable | `server` | Undocumented
Instance Variable | `children` | Undocumented

def __init__(self, status, brief, detail): (source)
overrides `twisted.web.resource.Resource.__init__`
overridden in `twisted.web.resource._UnsafeForbiddenResource`, `twisted.web.resource._UnsafeNoResource`

Initialize.

def getChild(self, chnam, request): (source)
overrides `twisted.web.resource.Resource.getChild`

Retrieve a 'child' resource from me.

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`.

def render(self, request): (source)
from `twisted.web.resource.IResource`
overrides `twisted.web.resource.Resource.render`

Render a given resource. See `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`

brief: `str` = (source)

A short string which will be included in the response body as the page title.

code: `int` = (source)

An integer status code which will be used for the response.

detail: `str` = (source)

A longer string which will be included in the response body.

template: `str` = (source)

A native string which will have a dictionary interpolated into it to generate the response body. The dictionary has the following keys:

- `"code"`: The status code passed to `_UnsafeErrorPage.__init__`.
- `"brief"`: The brief description passed to `_UnsafeErrorPage.__init__`.
- `"detail"`: The detailed description passed to `_UnsafeErrorPage.__init__`.