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`.`python`.`log`.`_GlobalStartStopObserver``

class documentation

`class _GlobalStartStopObserver(ABC): (source)`

Known subclasses: `twisted.python.log.DefaultObserver`, `twisted.python.log.FileLogObserver`, `twisted.python.log.PythonLoggingObserver`

View In Hierarchy

Mix-in for global log observers that can start and stop.

Method | `emit` | Emit the given log event.
Method | `start` | Start observing log events.
Method | `stop` | Stop observing log events.

@abstractmethod
def emit(self, eventDict: `EventDict`): (source)
overridden in `twisted.python.log.DefaultObserver`, `twisted.python.log.FileLogObserver`, `twisted.python.log.PythonLoggingObserver`

Emit the given log event.

Parameters
eventDict:`EventDict` | a log event

def start(self): (source)

Start observing log events.

def stop(self): (source)

Stop observing log events.