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

class documentation

`class _FrameElement(Element): (source)`

Constructor: `_FrameElement(loader, frame)`

View In Hierarchy

`_FrameElement` is an `IRenderable` which can render details about one frame from a `Failure`.

Method | `__init__` | Undocumented
Method | `filename` | Render the name of the file this frame references as a child of `tag`.
Method | `function` | Render the function name this frame references as a child of `tag`.
Method | `lineNumber` | Render the source line number this frame references as a child of `tag`.
Method | `source` | Render the source code surrounding the line this frame references, replacing `tag`.
Instance Variable | `frame` | A `Failure`-style frame object for which to load a source line to render. This is really a tuple holding some information from a frame object. See `Failure.frames` for specifics.

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.
Instance Variable | `loader` | The factory which will be used to load documents to return from `render`.

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

Undocumented

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

Render the name of the file this frame references as a child of `tag`.

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

Render the function name this frame references as a child of `tag`.

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

Render the source line number this frame references as a child of `tag`.

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

Render the source code surrounding the line this frame references, replacing `tag`.

frame = (source)

A `Failure`-style frame object for which to load a source line to render. This is really a tuple holding some information from a frame object. See `Failure.frames` for specifics.