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`.`conch`.`manhole_tap`.`Options``

class documentation

`class Options(usage.Options): (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `postOptions` | I am called after the options are parsed.
Class Variable | `optParameters` | Undocumented

Inherited from `Options`:

Method | `__str__` | Undocumented
Method | `getSynopsis` | Returns a string containing a description of these options and how to pass them to the executed file.
Method | `getUsage` | Undocumented
Method | `opt_help` | Display this help and exit.
Method | `opt_version` | Display Twisted version and exit.
Method | `parseArgs` | I am called with any leftover arguments which were not options.
Method | `parseOptions` | The guts of the command-line parser.
Class Variable | `completionData` | Undocumented
Class Variable | `defaultSubCommand` | Undocumented
Class Variable | `parent` | Undocumented
Instance Variable | `defaults` | Undocumented
Instance Variable | `docs` | Undocumented
Instance Variable | `longOpt` | Undocumented
Instance Variable | `opts` | Undocumented
Instance Variable | `shortOpt` | Undocumented
Instance Variable | `subCommand` | Undocumented
Instance Variable | `subOptions` | Undocumented
Instance Variable | `synonyms` | Undocumented
Method | `_gather_flags` | Gather up boolean (flag) options.
Method | `_gather_handlers` | Gather up options with their own handler methods.
Method | `_gather_parameters` | Gather options which take a value.
Method | `_generic_flag` | Undocumented
Instance Variable | `_dispatch` | Undocumented

def __init__(self): (source)
overrides `twisted.python.usage.Options.__init__`

Undocumented

def postOptions(self): (source)
overrides `twisted.python.usage.Options.postOptions`

I am called after the options are parsed.

Override this method in your subclass to do something after the options have been parsed and assigned, like validate that all options are sane.

optParameters: `list` = (source)

Undocumented