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`.`trial`.`_synctest``

module documentation
(source)

Things likely to be used by writers of unit tests.

Maintainer: Jonathan Lange

Exception | `UnsupportedTrialFeature` | A feature of twisted.trial was used that pyunit cannot support.
Class | `_Assertions` | Replaces many of the built-in TestCase assertions. In general, these assertions provide better error messages and are easier to use in callbacks.
Class | `_AssertRaisesContext` | A helper for implementing `assertRaises`. This is a context manager and a helper method to support the non-context manager version of `assertRaises`.
Class | `_LogObserver` | Observes the Twisted logs and catches any errors.
Class | `_Warning` | A `_Warning` instance represents one warning emitted through the Python warning system (`warnings`). This is used to insulate callers of `_collectWarnings` from changes to the Python warnings system which might otherwise require changes to the warning objects that function passes to the observer object it accepts.
Function | `_collectWarnings` | Call `f` with `args` positional arguments and `kwargs` keyword arguments and collect all warnings which are emitted as a result in a list.
Function | `_setWarningRegistryToNone` | Disable the per-module cache for every module found in `modules`, typically `sys.modules`.
Variable | `_logObserver` | Undocumented

def _collectWarnings(observeWarning, f, *args, **kwargs): (source)

Call `f` with `args` positional arguments and `kwargs` keyword arguments and collect all warnings which are emitted as a result in a list.

Parameters
observeWarning | A callable which will be invoked with a `_Warning` instance each time a warning is emitted.
f | Undocumented
*args | Undocumented
**kwargs | Undocumented
Returns
The return value of `f(*args, **kwargs)`.

def _setWarningRegistryToNone(modules): (source)

Disable the per-module cache for every module found in `modules`, typically `sys.modules`.

Parameters
modules | Dictionary of modules, typically sys.module dict

_logObserver = (source)

Undocumented