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`.`python`.`roots`.`Entity``

class documentation

`class Entity: (source)`

View In Hierarchy

I am a terminal object in a hierarchy, with no children.

I represent a null interface; certain non-instance objects (strings and integers, notably) are Entities.

Methods on this class are suggested to be implemented, but are not required, and will be emulated on a per-protocol basis for types which do not handle them.

Method | `render` | I produce a stream of bytes for the request, by calling request.write() and request.finish().

def render(self, request): (source)

I produce a stream of bytes for the request, by calling request.write() and request.finish().