class documentation

class Options(usage.Options): (source)

View In Hierarchy


Method parseArgs I am called with any leftover arguments which were not options.
Class Variable compData Undocumented
Class Variable optParameters Undocumented
Class Variable synopsis Undocumented

Inherited from Options:

Method __init__ Undocumented
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 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
def parseArgs(self, filename): (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!

compData = (source)


optParameters: list[tuple] = (source)


synopsis = (source)