Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`application`.`runner`.`_runner`.`Runner``

class documentation

`class Runner: (source)`

View In Hierarchy

Twisted application runner.

Method | `killIfRequested` | If `self._kill` is true, attempt to kill a running instance of the application.
Method | `reactorExited` | Call `self._reactorExited` with `self._reactorExitedArguments`.
Method | `run` | Run this command.
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`.
Class Variable | `_log` | The logger attached to this class.
Instance Variable | `_defaultLogLevel` | The default log level to start the logging system with.
Instance Variable | `_fileLogObserverFactory` | A factory for the file log observer to use when starting the logging system.
Instance Variable | `_kill` | Whether this runner should kill an existing running instance of the application.
Instance Variable | `_logFile` | A file stream to write logging output to.
Instance Variable | `_pidFile` | The file to store the running process ID in.
Instance Variable | `_reactor` | The reactor to start and run the application in.
Instance Variable | `_reactorExited` | Hook to call after the reactor exits.
Instance Variable | `_reactorExitedArguments` | Keyword arguments to pass to `reactorExited` when it is called.
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.

def killIfRequested(self): (source)

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

def reactorExited(self): (source)

Call `self._reactorExited` with `self._reactorExitedArguments`.

Note
This method is called after the reactor exits.

def run(self): (source)

Run this command.

def startLogging(self): (source)

Start the `twisted.logger` logging system.

def startReactor(self): (source)

Register `self._whenRunning` with the reactor so that it is called once the reactor is running, then start the reactor.

def whenRunning(self): (source)

Call `self._whenRunning` with `self._whenRunningArguments`.

Note
This method is called after the reactor starts running.

_log = (source)

The logger attached to this class.

_defaultLogLevel: `NamedConstant` = (source)

The default log level to start the logging system with.

_fileLogObserverFactory: `Callable[[TextIO], FileLogObserver]` = (source)

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

_kill: `bool` = (source)

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

_logFile: `TextIO` = (source)

A file stream to write logging output to.

_pidFile: `IPIDFile` = (source)

The file to store the running process ID in.

_reactor: `IReactorCore` = (source)

The reactor to start and run the application in.

_reactorExited: `Callable[..., None]` = (source)

Hook to call after the reactor exits.

_reactorExitedArguments: `Mapping[str, Any]` = (source)

Keyword arguments to pass to `reactorExited` when it is called.

_whenRunning: `Callable[..., None]` = (source)

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

_whenRunningArguments: `Mapping[str, Any]` = (source)

Keyword arguments to pass to `whenRunning` when it is called.