twisted.application.twist._options.TwistOptions : API documentation

Method	__init__	Undocumented
Method	getSynopsis	Returns a string containing a description of these options and how to pass them to the executed file.
Method	opt_version	Print version and exit.
Method	opt_reactor	The name of the reactor to use. (options: {options})
Method	installReactor	Install the reactor.
Method	opt_log_level	Set default log level. (options: {options}; default: "{default}")
Method	opt_log_file	Log to file. ("-" for stdout, "+" for stderr; default: "-")
Method	opt_log_format	Log file format. (options: "text", "json"; default: "text" if the log file is a tty, otherwise "json")
Method	selectDefaultLogObserver	Set `fileLogObserverFactory` to the default appropriate for the chosen `logFile`.
Method	parseOptions	The guts of the command-line parser.
Method	plugins	Undocumented
Method	subCommands	Undocumented
Method	postOptions	I am called after the options are parsed.

Inherited from Options:

Method	opt_help	Display this help and exit.
Method	parseArgs	I am called with any leftover arguments which were not options.
Method	__str__	Undocumented
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): (source)

Undocumented

def getSynopsis(self): (source)

Returns a string containing a description of these options and how to pass them to the executed file.

def opt_version(self): (source)

Print version and exit.

def opt_reactor(self, name): (source)

The name of the reactor to use. (options: {options})

def installReactor(self, name): (source)

Install the reactor.

def opt_log_level(self, levelName): (source)

Set default log level. (options: {options}; default: "{default}")

def opt_log_file(self, fileName): (source)

Log to file. ("-" for stdout, "+" for stderr; default: "-")

def opt_log_format(self, format): (source)

Log file format. (options: "text", "json"; default: "text" if the log file is a tty, otherwise "json")

def selectDefaultLogObserver(self): (source)

Set fileLogObserverFactory to the default appropriate for the chosen logFile.

def parseOptions(self, options=None): (source)

The guts of the command-line parser.

@property
def plugins(self): (source)

Undocumented

@property
def subCommands(self): (source)

Undocumented

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.

twisted.application.twist._options.TwistOptions(Options) class documentation