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`.`internet`.`testing`.`EventLoggingObserver``

class documentation

`class EventLoggingObserver(Sequence): (source)`

Implements interfaces: `twisted.logger.ILogObserver`

View In Hierarchy

`ILogObserver` That stores its events in a list for later inspection. This class is similar to `LimitedHistoryLogObserver` save that the internal buffer is public and intended for external inspection. The observer implements the sequence protocol to ease iteration of the events.

Class Method | `createWithCleanup` | Create an `EventLoggingObserver` instance that observes the provided publisher and will be cleaned up with addCleanup().
Method | `__call__` | No summary
Method | `__getitem__` | Undocumented
Method | `__init__` | Undocumented
Method | `__iter__` | Undocumented
Method | `__len__` | Undocumented
Instance Variable | `_events` | The events captured by this observer

@classmethod
def createWithCleanup(cls, testInstance, publisher): (source)

Create an `EventLoggingObserver` instance that observes the provided publisher and will be cleaned up with addCleanup().

Parameters
testInstance:`twisted.trial.unittest.TestCase` | Test instance in which this logger is used.
publisher:twisted.logger.LogPublisher | Log publisher to observe.
Returns
`twisted.test.proto_helpers.EventLoggingObserver` | An EventLoggingObserver configured to observe the provided publisher.

def __call__(self, event): (source)
from `twisted.logger.ILogObserver`

See Also
`ILogObserver`

def __getitem__(self, index): (source)

Undocumented

def __init__(self): (source)

Undocumented

def __iter__(self): (source)

Undocumented

def __len__(self): (source)

Undocumented

_events: `list` = (source)

The events captured by this observer