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

class documentation

`class Request: (source)`

View In Hierarchy

I am an abstract representation of a request for an entity.

I also function as the response. The request is responded to by calling self.write(data) until there is no data left and then calling self.finish().

Method | `finish` | The response to this request is finished; flush all data to the network stream.
Method | `write` | Add some data to the response to this request.
Class Variable | `wireProtocol` | Undocumented

def finish(self): (source)

The response to this request is finished; flush all data to the network stream.

def write(self, data): (source)

Add some data to the response to this request.

wireProtocol = (source)

Undocumented