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

class documentation

`class FailureElement(Element): (source)`

View In Hierarchy

`FailureElement` is an `IRenderable` which can render detailed information about a `Failure`.

Present Since
12.1

Method | `__init__` | Undocumented
Method | `traceback` | Render all the frames in the wrapped `Failure`'s traceback stack, replacing `tag`.
Method | `type` | Render the exception type as a child of `tag`.
Method | `value` | Render the exception value as a child of `tag`.
Class Variable | `loader` | Undocumented
Instance Variable | `failure` | The `Failure` instance which will be rendered.

Inherited from `Element`:

Method | `lookupRenderMethod` | Look up and return the named render method.
Method | `render` | Implement `IRenderable` to allow one `Element` to be embedded in another's template or rendering output.

def __init__(self, failure, loader=None): (source)
overrides `twisted.web.template.Element.__init__`

Undocumented

@renderer
def traceback(self, request, tag): (source)

Render all the frames in the wrapped `Failure`'s traceback stack, replacing `tag`.

@renderer
def type(self, request, tag): (source)

Render the exception type as a child of `tag`.

@renderer
def value(self, request, tag): (source)

Render the exception value as a child of `tag`.

loader = (source)
overrides `twisted.web.template.Element.loader`

Undocumented

failure = (source)

The `Failure` instance which will be rendered.