twisted.application.runner._runner.Runner : API documentation

class documentation

class twisted.application.runner._runner.Runner: (source)

Twisted application runner.

Method	run	Run this command.
Method	killIfRequested	If `self._kill` is true, attempt to kill a running instance of the application.
Method	startLogging	Start the `twisted.logger` logging system.
Method	startReactor	Register `self._whenRunning` with the reactor so that it is called once the reactor is running, then start the reactor.
Method	whenRunning	Call `self._whenRunning` with `self._whenRunningArguments`.
Method	reactorExited	Call `self._reactorExited` with `self._reactorExitedArguments`.
Class Variable	_log	The logger attached to this class.
Instance Variable	_reactor	The reactor to start and run the application in.
Instance Variable	_pidFile	The file to store the running process ID in.
Instance Variable	_kill	Whether this runner should kill an existing running instance of the application.
Instance Variable	_defaultLogLevel	The default log level to start the logging system with.
Instance Variable	_logFile	A file stream to write logging output to.
Instance Variable	_fileLogObserverFactory	A factory for the file log observer to use when starting the logging system.
Instance Variable	_whenRunning	Hook to call after the reactor is running; this is where the application code that relies on the reactor gets called.
Instance Variable	_whenRunningArguments	Keyword arguments to pass to `whenRunning` when it is called.
Instance Variable	_reactorExited	Hook to call after the reactor exits.
Instance Variable	_reactorExitedArguments	Keyword arguments to pass to `reactorExited` when it is called.

_log = (source)

The logger attached to this class.

_reactor = (source)

The reactor to start and run the application in.

(type: IReactorCore)

_pidFile = (source)

The file to store the running process ID in.

(type: IPIDFile)

_kill = (source)

Whether this runner should kill an existing running instance of the application.

(type: bool)

_defaultLogLevel = (source)

The default log level to start the logging system with.

(type: NamedConstant)

_logFile = (source)

A file stream to write logging output to.

(type: TextIO)

_fileLogObserverFactory = (source)

A factory for the file log observer to use when starting the logging system.

(type: Callable[[TextIO], FileLogObserver])

_whenRunning = (source)

Hook to call after the reactor is running; this is where the application code that relies on the reactor gets called.

(type: Callable[..., None])

_whenRunningArguments = (source)

Keyword arguments to pass to whenRunning when it is called.

(type: Mapping[str, Any])

_reactorExited = (source)

Hook to call after the reactor exits.

(type: Callable[..., None])

_reactorExitedArguments = (source)

Keyword arguments to pass to reactorExited when it is called.

(type: Mapping[str, Any])

def run(self): (source)

Run this command.

def killIfRequested(self): (source)

If self._kill is true, attempt to kill a running instance of the application.

def startLogging(self): (source)

Start the twisted.logger logging system.

def startReactor(self): (source)

def whenRunning(self): (source)

Call self._whenRunning with self._whenRunningArguments.

Note This method is called after the reactor starts running.

def reactorExited(self): (source)

Call self._reactorExited with self._reactorExitedArguments.

Note This method is called after the reactor exits.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.