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

class documentation

`class _UnsafeForbiddenResource(_UnsafeErrorPage): (source)`

Constructor: `_UnsafeForbiddenResource(message)`

View In Hierarchy

`_UnsafeForbiddenResource`, publicly available via the deprecated alias `ForbiddenResource` is a specialization of `_UnsafeErrorPage` which returns the FORBIDDEN HTTP response code.

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

Method | `__init__` | Initialize.

Inherited from `_UnsafeErrorPage`:

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` (via `_UnsafeErrorPage`):

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, message='Sorry, resource is forbidden.'): (source)
overrides `twisted.web.resource._UnsafeErrorPage.__init__`

Initialize.