twisted.conch.tap.Options(usage.Options, strcred.AuthOptionMixin) class documentationtwisted.conch.tap
View Source
(View In Hierarchy)
| Class Variable | synopsis | Undocumented |
| Class Variable | longdesc | Undocumented |
| Class Variable | optParameters | Undocumented |
| Class Variable | compData | Undocumented |
| Method | __init__ | Undocumented |
| Method | addChecker | Add the checker specified. If any checkers are added, the default checkers are automatically cleared and the only checkers will be the specified one(s). |
| Instance Variable | _usingDefaultAuth | Undocumented |
Inherited from Options:
| Instance Variable | subCommand | Undocumented |
| Class Variable | defaultSubCommand | Undocumented |
| Class Variable | parent | Undocumented |
| Class Variable | completionData | Undocumented |
| Instance Variable | opts | Undocumented |
| Instance Variable | defaults | Undocumented |
| Instance Variable | longOpt | Undocumented |
| Instance Variable | shortOpt | Undocumented |
| Instance Variable | docs | Undocumented |
| Instance Variable | synonyms | Undocumented |
| Method | opt_help | Display this help and exit. |
| Method | opt_version | Display Twisted version and exit. |
| Method | parseOptions | The guts of the command-line parser. |
| Instance Variable | subOptions | Undocumented |
| Method | postOptions | I am called after the options are parsed. |
| Method | parseArgs | I am called with any leftover arguments which were not 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 |
| Instance Variable | _dispatch | Undocumented |
| Method | _generic_flag | Undocumented |
| Method | _gather_flags | Gather up boolean (flag) options. |
| Method | _gather_parameters | Gather options which take a value. |
| Method | _gather_handlers | Gather up options with their own handler methods. |
Inherited from AuthOptionMixin:
| Class Variable | supportedInterfaces | An iterable object that returns credential interfaces which this application is able to support. |
| Class Variable | authOutput | A writeable object to which this options class will send all help-related output. Default: sys.stdout |
| Method | supportsInterface | Returns whether a particular credentials interface is supported. |
| Method | supportsCheckerFactory | Returns whether a checker factory will provide at least one of the credentials interfaces that we care about. |
| 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 | _checkerFactoriesForOptHelpAuth | Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module. |
Add the checker specified. If any checkers are added, the default checkers are automatically cleared and the only checkers will be the specified one(s).