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`.`error`.`FlattenerError``

exception documentation

`class FlattenerError(Exception): (source)`

View In Hierarchy

An error occurred while flattening an object.

Method | `__init__` | Undocumented
Method | `__repr__` | Present a string representation which includes a template traceback, so we can tell where this error occurred in the template, as well as in Python.
Method | `__str__` | Undocumented
Method | `_formatRoot` | Convert an object from `self._roots` to a string suitable for inclusion in a render-traceback (like a normal Python traceback, but can include "frame" source locations which are not in Python source files).
Instance Variable | `_exception` | Undocumented
Instance Variable | `_roots` | A list of the objects on the flattener's stack at the time the unflattenable object was encountered. The first element is least deeply nested object and the last element is the most deeply nested.
Instance Variable | `_traceback` | Undocumented

def __init__(self, exception, roots, traceback): (source)

Undocumented

def __repr__(self): (source)

Present a string representation which includes a template traceback, so we can tell where this error occurred in the template, as well as in Python.

Returns
`str` | Undocumented

def __str__(self): (source)

Undocumented

Returns
`str` | Undocumented

def _formatRoot(self, obj): (source)

Convert an object from `self._roots` to a string suitable for inclusion in a render-traceback (like a normal Python traceback, but can include "frame" source locations which are not in Python source files).

Parameters
obj | Any object which can be a render step root. Typically, `Tag`s, strings, and other simple Python types.
Returns
`str` | A string representation of `obj`.

_exception = (source)

Undocumented

_roots = (source)

A list of the objects on the flattener's stack at the time the unflattenable object was encountered. The first element is least deeply nested object and the last element is the most deeply nested.

_traceback = (source)

Undocumented