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`.`reporter``

module documentation
(source)

Defines classes that handle the results of tests.

Class | `MinimalReporter` | A minimalist reporter that prints only a summary of the test result, in the form of (timeTaken, #tests, #tests, #errors, #failures, #skips).
Class | `Reporter` | A basic `TestResult` with support for writing to a stream.
Class | `SafeStream` | Wraps a stream object so that all `write` calls are wrapped in `untilConcludes`.
Class | `SubunitReporter` | Reports test output via Subunit.
Class | `TestResult` | Accumulates the results of several `twisted.trial.unittest.TestCase`s.
Class | `TestResultDecorator` | Base class for TestResult decorators.
Class | `TextReporter` | Simple reporter that prints a single character for each test as it runs, along with the standard Trial summary text.
Class | `TimingTextReporter` | Prints out each test as it is running, followed by the time taken for each test to run.
Class | `TreeReporter` | Print out the tests in the form a tree.
Class | `UncleanWarningsReporterWrapper` | A wrapper for a reporter that converts `util.DirtyReactorAggregateError`s to warnings.
Class | `VerboseTextReporter` | A verbose reporter that prints the name of each test as it is running.
Exception | `BrokenTestCaseWarning` | Emitted as a warning when an exception occurs in one of setUp or tearDown.
Class | `_AdaptedReporter` | TestResult decorator that makes sure that addError only gets tests that have been adapted with a particular test adapter.
Class | `_AnsiColorizer` | A colorizer is an object that loosely wraps around a stream, allowing callers to write text to the stream in a particular color.
Class | `_ExitWrapper` | A wrapper for a reporter that causes the reporter to stop after unsuccessful tests.
Class | `_NullColorizer` | See _AnsiColorizer docstring.
Class | `_Win32Colorizer` | See _AnsiColorizer docstring.
Function | `_makeTodo` | Return a `Todo` object built from `value`.

def _makeTodo(value): (source)

Return a `Todo` object built from `value`.

This is a synonym for `twisted.trial.unittest.makeTodo`, but imported locally to avoid circular imports.

Parameters
value | A string or a tuple of `(errors, reason)`, where `errors` is either a single exception class or an iterable of exception classes.
Returns
A `Todo` object.