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`.`tap`.`ftp`.`Options``

class documentation

`class Options(usage.Options, strcred.AuthOptionMixin): (source)`

Constructor: `Options(*a, **kw)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `opt_password_file` | Specify a file containing username:password login info for authenticated connections. (DEPRECATED; see --help-auth instead)
Class Variable | `compData` | Undocumented
Class Variable | `longdesc` | Undocumented
Class Variable | `optParameters` | Undocumented
Class Variable | `synopsis` | 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.
Method | `postOptions` | I am called after the options are parsed.
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

Inherited from `AuthOptionMixin` (via `Options`):

Method | `addChecker` | Supply a supplied credentials checker to the Options class.
Method | `opt_auth` | Specify an authentication method for the server.
Method | `opt_help_auth` | Show all authentication methods available.
Method | `opt_help_auth_type` | Show help for a particular authentication type.
Method | `supportsCheckerFactory` | Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.
Method | `supportsInterface` | Returns whether a particular credentials interface is supported.
Class Variable | `authOutput` | A writeable object to which this options class will send all help-related output. Default: `sys.stdout`
Class Variable | `supportedInterfaces` | An iterable object that returns credential interfaces which this application is able to support.
Method | `_checkerFactoriesForOptHelpAuth` | Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module.

def __init__(self, *a, **kw): (source)
overrides `twisted.python.usage.Options.__init__`

Undocumented

def opt_password_file(self, filename): (source)

Specify a file containing username:password login info for authenticated connections. (DEPRECATED; see --help-auth instead)

compData = (source)

Undocumented

longdesc: `str` = (source)

Undocumented

optParameters: `list` = (source)

Undocumented

synopsis: `str` = (source)

Undocumented