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`.`usage`.`CompleteUsernames``

class documentation

`class CompleteUsernames(Completer): (source)`

View In Hierarchy

Complete usernames

Method | `_shellCode` | Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py

Inherited from `Completer`:

Method | `__init__` | No summary
Method | `_description` | Undocumented
Instance Variable | `_descr` | Undocumented
Instance Variable | `_repeat` | Undocumented
Property | `_repeatFlag` | Undocumented

def _shellCode(self, optName, shellType): (source)
overrides `twisted.python.usage.Completer._shellCode`

Fetch a fragment of shell code representing this action which is suitable for use by the completion system in _shellcomp.py

Parameters
optName:`str` | The long name of the option this action is being used for.
shellType:`str` | One of the supported shell constants e.g. `twisted.python.usage._ZSH`