class documentation

class Options(usage.Options): (source)

View In Hierarchy

Undocumented

Method parse​Args I am called with any leftover arguments which were not options.
Class Variable comp​Data Undocumented
Class Variable opt​Parameters Undocumented
Class Variable synopsis Undocumented

Inherited from Options:

Method __init__ Undocumented
Method __str__ Undocumented
Method get​Synopsis Returns a string containing a description of these options and how to pass them to the executed file.
Method get​Usage Undocumented
Method opt​_help Display this help and exit.
Method opt​_version Display Twisted version and exit.
Method parse​Options The guts of the command-line parser.
Method post​Options I am called after the options are parsed.
Class Variable completion​Data Undocumented
Class Variable default​Sub​Command Undocumented
Class Variable parent Undocumented
Instance Variable defaults Undocumented
Instance Variable docs Undocumented
Instance Variable long​Opt Undocumented
Instance Variable opts Undocumented
Instance Variable short​Opt Undocumented
Instance Variable sub​Command Undocumented
Instance Variable sub​Options 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)

Undocumented

optParameters: list[tuple] = (source)

Undocumented

synopsis = (source)

Undocumented