twisted.plugins.twisted_trial._Reporter

class documentation

class _Reporter: (source)

Implements interfaces: twisted.plugin.IPlugin, twisted.trial.itrial.IReporter

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method add​Error Record that a test has raised an unexpected exception.
Method add​Expected​Failure Record that the given test failed, and was expected to do so.
Method add​Failure Record that a test has failed with the given failure.
Method add​Skip Record that a test has been skipped for the given reason.
Method add​Success Record that test passed.
Method add​Unexpected​Success Record that the given test failed, and was expected to do so.
Method cleanup​Errors Undocumented
Method done Called when the test run is complete.
Method end​Suite Undocumented
Method print​Errors Undocumented
Method print​Summary Undocumented
Method start​Suite Undocumented
Method start​Test Report the beginning of a run of a single test method.
Method stop​Test Report the status of a single test method
Method up​Down​Error Undocumented
Method was​Successful Return a boolean indicating whether all test results that were reported to this reporter were successful or not.
Method write Undocumented
Method writeln Undocumented
Instance Variable description Undocumented
Instance Variable klass Undocumented
Instance Variable long​Opt Undocumented
Instance Variable module Undocumented
Instance Variable name Undocumented
Instance Variable short​Opt Undocumented
Property args Undocumented
Property separator Undocumented
Property should​Stop A boolean indicating that this reporter would like the test run to stop.
Property stream Undocumented
Property tbformat Undocumented
Property tests​Run The number of tests that seem to have been run according to this reporter.
def __init__(self, name, module, description, longOpt, shortOpt, klass): (source)

Undocumented

def addError(self, test, error): (source)
from twisted.trial.itrial.IReporter
Record that a test has raised an unexpected exception.
Parameters
testThe test that has raised an error.
errorThe error that the test raised. It will either be a three-tuple in the style of sys.exc_info() or a Failure object.
def addExpectedFailure(self, test, failure, todo=None): (source)
from twisted.trial.itrial.IReporter

Record that the given test failed, and was expected to do so.

In Twisted 15.5 and prior, todo was a mandatory parameter.

Parameters
test:unittest.TestCaseThe test which this is about.
failure:failure.FailureThe error which this test failed with.
todo:unittest.TodoThe reason for the test's TODO status. If None, a generic reason is used.
def addFailure(self, test, failure): (source)
from twisted.trial.itrial.IReporter
Record that a test has failed with the given failure.
Parameters
testThe test that has failed.
failureThe failure that the test failed with. It will either be a three-tuple in the style of sys.exc_info() or a Failure object.
def addSkip(self, test, reason): (source)
from twisted.trial.itrial.IReporter
Record that a test has been skipped for the given reason.
Parameters
testThe test that has been skipped.
reasonAn object that the test case has specified as the reason for skipping the test.
def addSuccess(self, test): (source)
from twisted.trial.itrial.IReporter
Record that test passed.
def addUnexpectedSuccess(self, test, todo=None): (source)
from twisted.trial.itrial.IReporter

Record that the given test failed, and was expected to do so.

In Twisted 15.5 and prior, todo was a mandatory parameter.

Parameters
test:unittest.TestCaseThe test which this is about.
todo:unittest.TodoThe reason for the test's TODO status. If None, a generic reason is used.
def cleanupErrors(self, errs): (source)

Undocumented

def done(self): (source)
from twisted.trial.itrial.IReporter

Called when the test run is complete.

This gives the result object an opportunity to display a summary of information to the user. Once you have called done on an IReporter object, you should assume that the IReporter object is no longer usable.

def endSuite(self, name): (source)

Undocumented

def printErrors(self): (source)

Undocumented

def printSummary(self): (source)

Undocumented

def startSuite(self, name): (source)

Undocumented

def startTest(self, method): (source)
from twisted.trial.itrial.IReporter
Report the beginning of a run of a single test method.
Parameters
methodan object that is adaptable to ITestMethod
def stopTest(self, method): (source)
from twisted.trial.itrial.IReporter
Report the status of a single test method
Parameters
methodan object that is adaptable to ITestMethod
def upDownError(self, userMeth, warn=True, printStatus=True): (source)

Undocumented

def wasSuccessful(self): (source)
from twisted.trial.itrial.IReporter
Return a boolean indicating whether all test results that were reported to this reporter were successful or not.
def write(self, string): (source)

Undocumented

def writeln(self, string): (source)

Undocumented

description = (source)

Undocumented

klass = (source)

Undocumented

longOpt = (source)

Undocumented

module = (source)

Undocumented

name = (source)

Undocumented

shortOpt = (source)

Undocumented

@property
args = (source)

Undocumented

@property
separator = (source)

Undocumented

@property
shouldStop = (source)
from twisted.trial.itrial.IReporter
A boolean indicating that this reporter would like the test run to stop.
@property
stream = (source)

Undocumented

@property
tbformat = (source)

Undocumented

@property
testsRun = (source)
from twisted.trial.itrial.IReporter
The number of tests that seem to have been run according to this reporter.