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`.`protocols`.`memcache`.`Command``

class documentation

`class Command: (source)`

Constructor: `Command(command, **kwargs)`

View In Hierarchy

Wrap a client action into an object, that holds the values used in the protocol.

Method | `__init__` | Create a command.
Method | `fail` | Make the underlying deferred fails.
Method | `success` | Shortcut method to fire the underlying deferred.
Instance Variable | `command` | name of the command sent to the server.
Instance Variable | `_deferred` | the `Deferred` object that will be fired when the result arrives.

def __init__(self, command, **kwargs): (source)

Create a command.

Parameters
command:`bytes` | the name of the command.
**kwargs | this values will be stored as attributes of the object for future use

def fail(self, error): (source)

Make the underlying deferred fails.

def success(self, value): (source)

Shortcut method to fire the underlying deferred.

command: `bytes` = (source)

name of the command sent to the server.

_deferred: `Deferred` = (source)

the `Deferred` object that will be fired when the result arrives.