t.t.r.SubunitReporter(object) : class documentation

Part of twisted.trial.reporter View Source View In Hierarchy

Implements interfaces: twisted.trial.itrial.IReporter

Reports test output via Subunit.
Present Since10.0
Method __init__ Construct a SubunitReporter.
Method done Record that the entire test suite run is finished.
Method shouldStop Whether or not the test runner should stop running tests.
Method stop Signal that the test runner should stop running tests.
Method wasSuccessful Has the test run been successful so far?
Method startTest Record that test has started.
Method stopTest Record that test has completed.
Method addSuccess Record that test was successful.
Method addSkip Record that test was skipped for reason.
Method addError Record that test failed with an unexpected error err.
Method addFailure Record that test failed an assertion with the error err.
Method addExpectedFailure Record an expected failure from a test.
Method addUnexpectedSuccess Record an unexpected success.
Instance Variable _subunit The subunit protocol client that we are wrapping.
Instance Variable _successful An internal variable, used to track whether we have received only successful results.
_subunit =
The subunit protocol client that we are wrapping.
_successful =
An internal variable, used to track whether we have received only successful results.
def __init__(self, stream=sys.stdout, tbformat='default', realtime=False, publisher=None): (source)
Construct a SubunitReporter.
ParametersstreamA file-like object representing the stream to print output to. Defaults to stdout.
tbformatThe format for tracebacks. Ignored, since subunit always uses Python's standard format.
realtimeWhether or not to print exceptions in the middle of the test results. Ignored, since subunit always does this.
publisherThe log publisher which will be preserved for reporting events. Ignored, as it's not relevant to subunit.
def done(self): (source)
from twisted.trial.itrial.IReporter
Record that the entire test suite run is finished.

We do nothing, since a summary clause is irrelevant to the subunit protocol.

def shouldStop(self): (source)
from twisted.trial.itrial.IReporter
Whether or not the test runner should stop running tests.
def stop(self): (source)
Signal that the test runner should stop running tests.
def wasSuccessful(self): (source)
from twisted.trial.itrial.IReporter
Has the test run been successful so far?
ReturnsTrue if we have received no reports of errors or failures, False otherwise.
def startTest(self, test): (source)
from twisted.trial.itrial.IReporter
Record that test has started.
def stopTest(self, test): (source)
from twisted.trial.itrial.IReporter
Record that test has completed.
def addSuccess(self, test): (source)
from twisted.trial.itrial.IReporter
Record that test was successful.
def addSkip(self, test, reason): (source)
from twisted.trial.itrial.IReporter
Record that test was skipped for reason.

Some versions of subunit don't have support for addSkip. In those cases, the skip is reported as a success.

ParameterstestA unittest-compatible TestCase.
reasonThe reason for it being skipped. The str() of this object will be included in the subunit output stream.
def addError(self, test, err): (source)
from twisted.trial.itrial.IReporter
Record that test failed with an unexpected error err.

Also marks the run as being unsuccessful, causing SubunitReporter.wasSuccessful to return False.

def addFailure(self, test, err): (source)
from twisted.trial.itrial.IReporter
Record that test failed an assertion with the error err.

Also marks the run as being unsuccessful, causing SubunitReporter.wasSuccessful to return False.

def addExpectedFailure(self, test, failure, todo): (source)
from twisted.trial.itrial.IReporter
Record an expected failure from a test.

Some versions of subunit do not implement this. For those versions, we record a success.

def addUnexpectedSuccess(self, test, todo): (source)
from twisted.trial.itrial.IReporter
Record an unexpected success.

Since subunit has no way of expressing this concept, we record a success on the subunit stream.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.