twisted.application.runner._runner.RunnerOptions(Names) class documentation

Part of twisted.application.runner._runner View Source (View In Hierarchy)

Names for options recognized by Runner. These are meant to be used as keys in the options given to Runner, with corresponding values as noted below.

Class Variable reactor The reactor to start. Corresponding value: IReactorCore. (type: NamedConstant)
Class Variable pidFilePath The path to the PID file. Corresponding value: IFilePath. (type: NamedConstant)
Class Variable kill Whether this runner should kill an existing running instance. Corresponding value: bool. (type: NamedConstant)
Class Variable defaultLogLevel The default log level to start the logging system with. Corresponding value: NamedConstant from LogLevel. (type: NamedConstant)
Class Variable logFile A file stream to write logging output to. Corresponding value: writable file like object. (type: NamedConstant)
Class Variable fileLogObserverFactory What file log observer to use when starting the logging system. Corresponding value: callable that returns a twisted.logger.FileLogObserver (type: NamedConstant)
Class Variable whenRunning Hook to call when the reactor is running. This can be considered the Twisted equivalent to main(). Corresponding value: callable that takes the options mapping given to the runner as an argument. (type: NamedConstant)
Class Variable reactorExited Hook to call when the reactor has exited. Corresponding value: callable that takes an empty arguments list (type: NamedConstant)

Inherited from _ConstantsContainer (via Names):

Method __new__ Classes representing constants containers are not intended to be instantiated.
Class Method lookupByName Retrieve a constant by its name or raise a ValueError if there is no constant associated with that name.
Class Method iterconstants Iteration over a Names subclass results in all of the constants it contains.
Class Variable _constantType Specified by a _ConstantsContainer subclass to specify the type of constants allowed by that subclass.
Class Variable _enumerants A dict mapping the names of constants (eg NamedConstant instances) found in the class definition to those instances.
Class Method _constantFactory Construct the value for a new constant to add to this container.
reactor =
The reactor to start. Corresponding value: IReactorCore. (type: NamedConstant)
pidFilePath =
The path to the PID file. Corresponding value: IFilePath. (type: NamedConstant)
kill =
Whether this runner should kill an existing running instance. Corresponding value: bool. (type: NamedConstant)
defaultLogLevel =
The default log level to start the logging system with. Corresponding value: NamedConstant from LogLevel. (type: NamedConstant)
logFile =
A file stream to write logging output to. Corresponding value: writable file like object. (type: NamedConstant)
fileLogObserverFactory =
What file log observer to use when starting the logging system. Corresponding value: callable that returns a twisted.logger.FileLogObserver (type: NamedConstant)
whenRunning =
Hook to call when the reactor is running. This can be considered the Twisted equivalent to main(). Corresponding value: callable that takes the options mapping given to the runner as an argument. (type: NamedConstant)
reactorExited =
Hook to call when the reactor has exited. Corresponding value: callable that takes an empty arguments list (type: NamedConstant)
API Documentation for Twisted, generated by pydoctor at 2016-09-15 00:53:01.