class documentation
class Options(usage.Options, strcred.AuthOptionMixin): (source)
Constructor: Options(*a, **kw)
Undocumented
Method | __init__ |
Undocumented |
Method | opt |
Specify a file containing username:password login info for authenticated connections. (DEPRECATED; see --help-auth instead) |
Class Variable | comp |
Undocumented |
Class Variable | longdesc |
Undocumented |
Class Variable | opt |
Undocumented |
Class Variable | synopsis |
Undocumented |
Inherited from Options
:
Method | __str__ |
Undocumented |
Method | get |
Returns a string containing a description of these options and how to pass them to the executed file. |
Method | get |
Undocumented |
Method | opt |
Display this help and exit. |
Method | opt |
Display Twisted version and exit. |
Method | parse |
I am called with any leftover arguments which were not options. |
Method | parse |
The guts of the command-line parser. |
Method | post |
I am called after the options are parsed. |
Class Variable | completion |
Undocumented |
Class Variable | default |
Undocumented |
Class Variable | parent |
Undocumented |
Instance Variable | defaults |
Undocumented |
Instance Variable | docs |
Undocumented |
Instance Variable | long |
Undocumented |
Instance Variable | opts |
Undocumented |
Instance Variable | short |
Undocumented |
Instance Variable | sub |
Undocumented |
Instance Variable | sub |
Undocumented |
Instance Variable | synonyms |
Undocumented |
Method | _gather |
Gather up boolean (flag) options. |
Method | _gather |
Gather up options with their own handler methods. |
Method | _gather |
Gather options which take a value. |
Method | _generic |
Undocumented |
Instance Variable | _dispatch |
Undocumented |
Inherited from AuthOptionMixin
(via Options
):
Method | add |
Supply a supplied credentials checker to the Options class. |
Method | opt |
Specify an authentication method for the server. |
Method | opt |
Show all authentication methods available. |
Method | opt |
Show help for a particular authentication type. |
Method | supports |
Returns whether a checker factory will provide at least one of the credentials interfaces that we care about. |
Method | supports |
Returns whether a particular credentials interface is supported. |
Class Variable | auth |
A writeable object to which this options class will send all help-related output. Default: sys.stdout |
Class Variable | supported |
An iterable object that returns credential interfaces which this application is able to support. |
Method | _checker |
Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module. |