t.w.t.Options(usage.Options, strcred.AuthOptionMixin) : class documentation

Part of twisted.words.tap View Source View In Hierarchy

No class docstring
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.)

Inherited from Options:

Method __hash__ Define a custom hash function so that Options instances can be used as dictionary keys. This is an internal feature used to implement the parser. Do not rely on it in application code.
Method opt_help Display this help and exit.
Method opt_version Undocumented
Method parseOptions The guts of the command-line parser.
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
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:

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 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 _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.)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.