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`.`_dist`.`workerreporter`.`WorkerReporter``

class documentation

`class WorkerReporter(TestResult): (source)`

View In Hierarchy

Reporter for trial's distributed workers. We send things not through a stream, but through an `AMP` protocol's `callRemote` method.

Method | `__init__` | No summary
Method | `addError` | Send an error over.
Method | `addExpectedFailure` | Send an expected failure over.
Method | `addFailure` | Send a Failure over.
Method | `addSkip` | Send a skip over.
Method | `addSuccess` | Send a success over.
Method | `addUnexpectedSuccess` | Send an unexpected success over.
Method | `printSummary` | Don't print a summary
Instance Variable | `ampProtocol` | Undocumented
Method | `_getFailure` | Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.
Method | `_getFrames` | Extract frames from a `Failure` instance.
Method | `_getTodoReason` | Get the reason for a `Todo`.
Constant | `_DEFAULT_TODO` | Default message for expected failures and unexpected successes, used only if a `Todo` is not provided.

Inherited from `TestResult`:

Method | `__repr__` | Undocumented
Method | `done` | The test suite has finished running.
Method | `startTest` | This must be called before the given test is commenced.
Method | `stopTest` | This must be called after the given test is completed.
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 | `_getTime` | Undocumented
Instance Variable | `_lastTime` | Undocumented
Instance Variable | `_testStarted` | Undocumented
Instance Variable | `_timings` | Undocumented

def __init__(self, ampProtocol): (source)
overrides `twisted.trial.reporter.TestResult.__init__`

Parameters
ampProtocol:`AMP` | The communication channel with the trial distributed manager which collects all test results.

def addError(self, test, error): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.TestResult.addError`

Send an error over.

def addExpectedFailure(self, test, error, todo=None): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.TestResult.addExpectedFailure`

Send an expected failure over.

def addFailure(self, test, fail): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.TestResult.addFailure`

Send a Failure over.

def addSkip(self, test, reason): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.TestResult.addSkip`

Send a skip over.

def addSuccess(self, test): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.TestResult.addSuccess`

Send a success over.

def addUnexpectedSuccess(self, test, todo=None): (source)
from `twisted.trial.itrial.IReporter`
overrides `twisted.trial.reporter.TestResult.addUnexpectedSuccess`

Send an unexpected success over.

def printSummary(self): (source)

Don't print a summary

ampProtocol = (source)

Undocumented

def _getFailure(self, error): (source)
overrides `twisted.trial.reporter.TestResult._getFailure`

Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.

def _getFrames(self, failure): (source)

Extract frames from a `Failure` instance.

def _getTodoReason(self, todo): (source)

Get the reason for a `Todo`.

If `todo` is `None`, return a sensible default.

_DEFAULT_TODO: `str` = (source)
overrides `twisted.trial.reporter.TestResult._DEFAULT_TODO`

Default message for expected failures and unexpected successes, used only if a `Todo` is not provided.

Value

    'Test expected to fail'