t.s.m.FirstPassOptions(usage.Options) : class documentation

Part of twisted.scripts.mktap View Source View In Hierarchy

Method init Undocumented
Method parseArgs I am called with any leftover arguments which were not options.
Method postOptions I am called after the options are parsed.
Method _reportDebug Undocumented
Method _reportProgress Undocumented

Inherited from Options:

Method __init__ Undocumented
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 __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.
def init(self, tapLookup): (source)
def parseArgs(self, *rest): (source)

I am called with any leftover arguments which were not options.

Override me to do something with the remaining arguments on the command line, those which were not flags or options. e.g. interpret them as a list of files to operate on.

Note that if there more arguments on the command line than this method accepts, parseArgs will blow up with a getopt.error. This means if you don't override me, parseArgs will blow up if I am passed any arguments at all!
def _reportDebug(self, info): (source)
def _reportProgress(self, info): (source)
def postOptions(self): (source)

I am called after the options are parsed.

Override this method in your subclass to do something after the options have been parsed and assigned, like validate that all options are sane.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:12:41.