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`.`xmlrpc`.`Handler``

class documentation

`class Handler: (source)`

Constructor: `Handler(resource, *args)`

View In Hierarchy

Handle a XML-RPC request and store the state for a request in progress.

Override the run() method and return result using self.result, a Deferred.

We require this class since we're not using threads, so we can't encapsulate state in a running function if we're going to have to wait for results.

For example, lets say we want to authenticate against twisted.cred, run a LDAP query and then pass its result to a database query, all as a result of a single XML-RPC command. We'd use a Handler instance to store the state of the running command.

Method | `__init__` | Undocumented
Method | `run` | Undocumented
Instance Variable | `resource` | Undocumented
Instance Variable | `result` | Undocumented

def __init__(self, resource, *args): (source)

Undocumented

def run(self, *args): (source)

Undocumented

resource = (source)

Undocumented

result = (source)

Undocumented