twisted.application.twist._options.TwistOptions

class documentation

class TwistOptions(Options): (source)

View In Hierarchy

Command line options for twist.
Method __init__ Undocumented
Method get​Synopsis Returns a string containing a description of these options and how to pass them to the executed file.
Method install​Reactor Install the reactor.
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 opt​_log​_level Set default log level. (options: {options}; default: "{default}")
Method opt​_reactor The name of the reactor to use. (options: {options})
Method opt​_version Print version and exit.
Method parse​Options The guts of the command-line parser.
Method post​Options I am called after the options are parsed.
Method select​Default​Log​Observer Set fileLogObserverFactory to the default appropriate for the chosen logFile.
Class Variable default​Reactor​Name Undocumented
Property plugins Undocumented
Property sub​Commands Undocumented

Inherited from Options:

Method __str__ Undocumented
Method get​Usage Undocumented
Method opt​_help Display this help and exit.
Method parse​Args I am called with any leftover arguments which were not options.
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 __init__(self): (source)
overrides twisted.python.usage.Options.__init__

Undocumented

def getSynopsis(self): (source)
overrides twisted.python.usage.Options.getSynopsis
Returns a string containing a description of these options and how to pass them to the executed file.
Returns
strUndocumented
def installReactor(self, name): (source)
Install the reactor.
Parameters
name:strUndocumented
Returns
IReactorCoreUndocumented
def opt_log_file(self, fileName): (source)
Log to file. ("-" for stdout, "+" for stderr; default: "-")
Parameters
file​Name:strUndocumented
def opt_log_format(self, format): (source)
Log file format. (options: "text", "json"; default: "text" if the log file is a tty, otherwise "json")
Parameters
format:strUndocumented
def opt_log_level(self, levelName): (source)
Set default log level. (options: {options}; default: "{default}")
Parameters
level​Name:strUndocumented
def opt_reactor(self, name): (source)
The name of the reactor to use. (options: {options})
Parameters
name:strUndocumented
def opt_version(self): (source)
overrides twisted.python.usage.Options.opt_version
Print version and exit.
Returns
typing.NoReturnUndocumented
def parseOptions(self, options=None): (source)
overrides twisted.python.usage.Options.parseOptions
The guts of the command-line parser.
Parameters
options:Optional[Sequence[str]]Undocumented
def postOptions(self): (source)
overrides twisted.python.usage.Options.postOptions

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.

def selectDefaultLogObserver(self): (source)
Set fileLogObserverFactory to the default appropriate for the chosen logFile.
defaultReactorName: str = (source)

Undocumented

@property
plugins: Mapping[str, IServiceMaker] = (source)

Undocumented

@property
subCommands: Iterable[Tuple[str, None, Callable[[IServiceMaker], Options], str]] = (source)

Undocumented