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

module documentation
(source)

Implementation of the lowest-level Resource class.

See `twisted.web.pages` for some utility implementations.

Interface | `IResource` | A web resource.
Class | `EncodingResourceWrapper` | Wrap a `IResource`, potentially applying an encoding to the response body generated.
Class | `Resource` | Define a web-accessible resource.
Function | `getChildForRequest` | Traverse resource tree to find who will handle the request.
Interface | `_IEncodingResource` | A resource which knows about `_IRequestEncoderFactory`.
Class | `_UnsafeErrorPage` | `_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...
Class | `_UnsafeForbiddenResource` | `_UnsafeForbiddenResource`, publicly available via the deprecated alias `ForbiddenResource` is a specialization of `_UnsafeErrorPage` which returns the FORBIDDEN HTTP response code.
Class | `_UnsafeNoResource` | `_UnsafeNoResource`, publicly available via the deprecated alias `NoResource`, is a specialization of `_UnsafeErrorPage` which returns the HTTP response code NOT FOUND.
Function | `_computeAllowedMethods` | Compute the allowed methods on a `Resource` based on defined render_FOO methods. Used when raising `UnsupportedMethod` but `Resource` does not define `allowedMethods` attribute.

def getChildForRequest(resource, request): (source)

Traverse resource tree to find who will handle the request.

def _computeAllowedMethods(resource): (source)

Compute the allowed methods on a `Resource` based on defined render_FOO methods. Used when raising `UnsupportedMethod` but `Resource` does not define `allowedMethods` attribute.