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

class documentation

`class _ErrorPage(Resource): (source)`

Constructor: `_ErrorPage(code, brief, detail)`

View In Hierarchy

`_ErrorPage` is a resource that responds to all requests with a particular (parameterized) HTTP status code and an HTML body containing some descriptive text. This is useful for rendering simple error pages.

See Also
`twisted.web.pages.errorPage`

Method | `__init__` | Initialize.
Method | `getChild` | Handle all requests for which `_ErrorPage` lacks a child by returning this error page.
Method | `render` | Respond to all requests with the given HTTP status code and an HTML document containing the explanatory strings.
Instance Variable | `_brief` | A short string which will be included in the response body as the page title.
Instance Variable | `_code` | An integer HTTP status code which will be used for the response.
Instance Variable | `_detail` | A longer string which will be included in the response body.

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, code: `int`, brief: `str`, detail: `str`): (source)
overrides `twisted.web.resource.Resource.__init__`

Initialize.

def getChild(self, path: `bytes`, request: `IRequest`) -> `Resource`: (source)
overrides `twisted.web.resource.Resource.getChild`

Handle all requests for which `_ErrorPage` lacks a child by returning this error page.

Parameters
path:`bytes` | A path segment.
request:`IRequest` | HTTP request
Returns
`Resource` | Undocumented

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

Respond to all requests with the given HTTP status code and an HTML document containing the explanatory strings.

_brief: `str` = (source)

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

_code: `int` = (source)

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

_detail: `str` = (source)

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