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

class documentation

`class TimingTextReporter(VerboseTextReporter): (source)`

Constructor: `TimingTextReporter(stream, tbformat, realtime, publisher)`

View In Hierarchy

Prints out each test as it is running, followed by the time taken for each test to run.

Method | `stopTest` | Mark the test as stopped, and write the time it took to run the test to the stream.

Inherited from `VerboseTextReporter`:

Method | `addError` | Called when a test raises an error. If `realtime` is set, then it prints the error to the stream.
Method | `addExpectedFailure` | Report that the given test failed, and was expected to do so.
Method | `addFailure` | Called when a test fails. If `realtime` is set, then it prints the error to the stream.
Method | `addSkip` | Report that the given test was skipped.
Method | `addSuccess` | Report that the given test succeeded.
Method | `addUnexpectedSuccess` | Report that the given test succeeded against expectations.
Method | `startTest` | Called when a test begins to run. Records the time when it was first called and resets the warning cache.

Inherited from `Reporter` (via `VerboseTextReporter`):

Method | `__init__` | Undocumented
Method | `cleanupErrors` | Undocumented
Method | `done` | Summarize the result of the test run.
Method | `upDownError` | Undocumented
Instance Variable | `realtime` | Undocumented
Instance Variable | `tbformat` | Undocumented
Method | `_formatFailureTraceback` | Undocumented
Method | `_getSummary` | Return a formatted count of tests status results.
Method | `_groupResults` | Group tests together based on their results.
Method | `_observeWarnings` | Observe warning events and write them to `self._stream`.
Method | `_printErrors` | Print all of the non-success results to the stream in full.
Method | `_printExpectedFailure` | Undocumented
Method | `_printResults` | Print a group of errors to the stream.
Method | `_printSummary` | Print a line summarising the test results to the stream.
Method | `_printUnexpectedSuccess` | Undocumented
Method | `_trimFrames` | Trim frames to remove internal paths.
Method | `_write` | Safely write to the reporter's stream.
Method | `_writeln` | Safely write a line to the reporter's stream. Newline is appended to the format string.
Class Variable | `_doubleSeparator` | Undocumented
Class Variable | `_separator` | Undocumented
Instance Variable | `_publisher` | The log publisher which will be observed for warning events.
Instance Variable | `_startTime` | The time when the first test was started. It defaults to `None`, which means that no test was actually launched.
Instance Variable | `_stream` | Undocumented
Instance Variable | `_warningCache` | A `set` of tuples of warning message (file, line, text, category) which have already been written to the output stream during the currently executing test. This is used to avoid writing duplicates of the same warning to the output stream.

Inherited from `TestResult` (via `VerboseTextReporter`, `Reporter`):

Method | `__repr__` | Undocumented
Method | `wasSuccessful` | Report whether or not this test suite was successful or not.
Instance Variable | `expectedFailures` | Undocumented
Instance Variable | `skips` | Undocumented
Instance Variable | `successes` | count the number of successes achieved by the test run.
Instance Variable | `unexpectedSuccesses` | Undocumented
Method | `_getFailure` | Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.
Method | `_getTime` | Undocumented
Constant | `_DEFAULT_TODO` | Undocumented
Instance Variable | `_lastTime` | The duration of the current test run. It defaults to `None`, which means that the test was skipped.
Instance Variable | `_testStarted` | Undocumented
Instance Variable | `_timings` | Undocumented

def stopTest(self, method): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.VerboseTextReporter.stopTest`

Mark the test as stopped, and write the time it took to run the test to the stream.