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`.`tcp`.`_BuffersLogs``

class documentation

`class _BuffersLogs: (source)`

View In Hierarchy

A context manager that buffers any log events until after its block exits.

Method | `__enter__` | Enter a log buffering context.
Method | `__exit__` | Exit a log buffering context and log all buffered events to the provided observer.
Instance Variable | `_logs` | Undocumented
Instance Variable | `_namespace` | The namespace of the buffered events.
Instance Variable | `_observer` | The observer to which buffered log events will be written

def __enter__(self): (source)

Enter a log buffering context.

Returns
`Logger`. | A logger that buffers log events.

def __exit__(self, excValue, excType, traceback): (source)

Exit a log buffering context and log all buffered events to the provided observer.

Parameters
excValue | See `object.__exit__`
excType | See `object.__exit__`
traceback | See `object.__exit__`

_logs: `List[LogEvent]` = (source)

Undocumented

_namespace: `str`. = (source)

The namespace of the buffered events.

_observer: `twisted.logger.ILogObserver`. = (source)

The observer to which buffered log events will be written