Given the name of an option, construct
and return the name of the method to handle it.
optionHandler_q
optionHandler_q ( self )
Turn on quiet mode.
showVerboseSyntaxHelp
showVerboseSyntaxHelp ( self )
Show a full description of all options and arguments.
optionHandler_v
optionHandler_v ( self )
Increment the verbose level.
Higher levels are more verbose.
The default is 1.
main
main ( self, *args )
Main body of your application.
This is the main portion of the app, and is run after all of
the arguments are processed. Override this method to implment
the primary processing section of your application.
Given the information learned through self.__learnValidOpts__,
construct a list to be passed to getopt to set the valid
long form option syntax.
infoForOption
infoForOption ( self, option )
Get the stored information about an option.
__learnValidOpts__
__learnValidOpts__ ( self )
Derive the options which are valid for this application.
Examine the methods defined for this class to
learn what options the developer wants to use. Options
can be added by defining an optionHandler method with a
name like optionHandler_
getVerboseSyntaxHelpString
getVerboseSyntaxHelpString ( self )
Return the full description of the options and arguments.
Show a full description of the options and arguments to the
command in something like UNIX man page format. This includes
a description of each option and argument, taken from the
__doc__ string for the optionHandler method for
the option
a description of what additional arguments will be processed,
taken from the class member argumentsDescription
Return an info tuple for an option handler method.
Given a method name, return the information tuple
for that option to the program. The tuple contains:
(option name,
flag showing whether the option takes a value,
flag indicating long or short form option,
help string for option)
getSimpleSyntaxHelpString
getSimpleSyntaxHelpString ( self )
Return syntax statement.
Return a simplified form of help including only the
syntax of the command.
shortOptionsStringGet
shortOptionsStringGet ( self )
Given the information learned through self.__learnValidOpts__,
construct a string to be passed to getopt to set the valid
single character option syntax.
showVerboseHelp
showVerboseHelp ( self )
Show a verbose help message explaining how to use the program.
This includes:
a verbose description of the program, taken from the __doc__
string for the class
an explanation of each option, produced by
showVerboseSyntaxHelp()
examples of how to use the program for specific tasks,
taken from the class member examplesDescription