twisted.words.tap.Options

class documentation

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

Constructor: Options(*a, **kw)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method opt_group Specify a group which should exist
Method opt_passwd Name of a passwd-style file. (This is for backwards-compatibility only; you should use the --auth command instead.)
Class Variable compData Undocumented
Class Variable interfacePlugins Undocumented
Class Variable optParameters Undocumented
Class Variable plg Undocumented
Class Variable supportedInterfaces 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
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_group(self, name): (source)

Specify a group which should exist

def opt_passwd(self, filename): (source)

Name of a passwd-style file. (This is for backwards-compatibility only; you should use the --auth command instead.)

compData = (source)

Undocumented

interfacePlugins: dict = (source)

Undocumented

optParameters: List[Sequence[Optional[str]]] = (source)

Undocumented

plg = (source)

Undocumented

supportedInterfaces = (source)
overrides twisted.cred.strcred.AuthOptionMixin.supportedInterfaces

Undocumented