Interface t.t.i.IReporter(zi.Interface):

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

Known implementations: twisted.plugins.twisted_trial._Reporter, twisted.trial.reporter.Reporter

I report results from a run of a test suite.

In all lists below, 'Results' are either a twisted.python.failure.Failure object, or a string.
Attribute stream
Attribute tbformat
Attribute args
Attribute shouldStop
Method startTest report the beginning of a run of a single test method
Method stopTest report the status of a single test method
Method startSuite suites which wish to appear in reporter output should call this
Method endSuite called at the end of a suite, if and only if that suite has called
Method cleanupErrors called when the reactor has been left in a 'dirty' state
Method upDownError called when an error occurs in a setUp* or tearDown* method
Method addSuccess Record that test passed.
stream =
Instance Variablesstreamthe io-stream that this reporter will write to
tbformat =
Instance Variablestbformateither 'default', 'brief', or 'verbose'
args =
Instance Variablesargsadditional string argument passed from the command line
shouldStop =
Instance VariablesshouldStopa boolean indicating that this reporter would like the test run to stop.
def startTest(method): (source)
report the beginning of a run of a single test method
Parametersmethodan object that is adaptable to ITestMethod
def stopTest(method): (source)
report the status of a single test method
Parametersmethodan object that is adaptable to ITestMethod
def startSuite(name): (source)
suites which wish to appear in reporter output should call this before running their tests
def endSuite(name): (source)
called at the end of a suite, if and only if that suite has called 'startSuite'
def cleanupErrors(errs): (source)
called when the reactor has been left in a 'dirty' state
Parameterserrsa list of twisted.python.failure.Failures
def upDownError(userMeth, warn=True, printStatus=True): (source)
called when an error occurs in a setUp* or tearDown* method
Parameterswarnindicates whether or not the reporter should emit a warning about the error (type: Boolean )
printStatusindicates whether or not the reporter should print the name of the method and the status message appropriate for the type of error (type: Boolean )
def addSuccess(test): (source)
Record that test passed.
API Documentation for twisted, generated by pydoctor.