class documentation

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

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method add​Checker 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).
Class Variable comp​Data Undocumented
Class Variable longdesc Undocumented
Class Variable opt​Parameters Undocumented
Class Variable synopsis Undocumented
Instance Variable _using​Default​Auth Undocumented

Inherited from Options:

Method __str__ Undocumented
Method get​Synopsis Returns a string containing a description of these options and how to pass them to the executed file.
Method get​Usage Undocumented
Method opt​_help Display this help and exit.
Method opt​_version Display Twisted version and exit.
Method parse​Args I am called with any leftover arguments which were not options.
Method parse​Options The guts of the command-line parser.
Method post​Options I am called after the options are parsed.
Class Variable completion​Data Undocumented
Class Variable default​Sub​Command Undocumented
Class Variable parent Undocumented
Instance Variable defaults Undocumented
Instance Variable docs Undocumented
Instance Variable long​Opt Undocumented
Instance Variable opts Undocumented
Instance Variable short​Opt Undocumented
Instance Variable sub​Command Undocumented
Instance Variable sub​Options 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:

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 supports​Checker​Factory Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.
Method supports​Interface Returns whether a particular credentials interface is supported.
Class Variable auth​Output A writeable object to which this options class will send all help-related output. Default: sys.stdout
Class Variable supported​Interfaces An iterable object that returns credential interfaces which this application is able to support.
Method _checker​Factories​For​Opt​Help​Auth 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)

Undocumented

def addChecker(self, checker): (source)
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).
compData = (source)

Undocumented

longdesc: str = (source)

Undocumented

optParameters: list = (source)

Undocumented

synopsis: str = (source)

Undocumented

_usingDefaultAuth: bool = (source)

Undocumented