twisted.trial.itrial.IReporter(zi.Interface)
interface documentationtwisted.trial.itrial
View Source
(View In Hierarchy)
Known implementations: twisted.plugins.twisted_trial._Reporter, twisted.trial._dist.distreporter.DistReporter, twisted.trial.reporter._ExitWrapper, twisted.trial.reporter.Reporter, twisted.trial.reporter.SubunitReporter, twisted.trial.reporter.TestResult, twisted.trial.reporter.TestResultDecorator, twisted.trial.reporter.UncleanWarningsReporterWrapper
I report results from a run of a test suite.
Attribute | stream | Deprecated in Twisted 8.0. The io-stream that this reporter will write to |
Attribute | tbformat | Either 'default', 'brief', or 'verbose' |
Attribute | args | Additional string argument passed from the command line |
Attribute | shouldStop | A boolean indicating that this reporter would like the test run to stop. |
Attribute | separator | Deprecated in Twisted 8.0. A value which will occasionally be passed to
the write
method. |
Attribute | testsRun | The number of tests that seem to have been run according to this reporter. |
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 | Deprecated in Twisted 8.0. |
Method | endSuite | Deprecated in Twisted 8.0. |
Method | cleanupErrors | Deprecated in Twisted 8.0. |
Method | upDownError | Deprecated in Twisted 8.0. |
Method | addSuccess | Record that test passed. |
Method | addError | Record that a test has raised an unexpected exception. |
Method | addFailure | Record that a test has failed with the given failure. |
Method | addExpectedFailure | Record that the given test failed, and was expected to do so. |
Method | addUnexpectedSuccess | Record that the given test failed, and was expected to do so. |
Method | addSkip | Record that a test has been skipped for the given reason. |
Method | printSummary | Deprecated in Twisted 8.0, use done
instead. |
Method | printErrors | Deprecated in Twisted 8.0, use done
instead. |
Method | write | Deprecated in Twisted 8.0, use done
instead. |
Method | writeln | Deprecated in Twisted 8.0, use done
instead. |
Method | wasSuccessful | Return a boolean indicating whether all test results that were reported to this reporter were successful or not. |
Method | done | Called when the test run is complete. |
Deprecated in Twisted 8.0. A value which will occasionally be passed to
the write
method.
Report the beginning of a run of a single test method.
Parameters | method | an object that is adaptable to ITestMethod |
Report the status of a single test method
Parameters | method | an object that is adaptable to ITestMethod |
Deprecated in Twisted 8.0.
Suites which wish to appear in reporter output should call this before running their tests.
Deprecated in Twisted 8.0.
Called at the end of a suite, if and only if that suite has called
startSuite
.
Deprecated in Twisted 8.0.
Called when the reactor has been left in a 'dirty' state
Parameters | errs | a list of twisted.python.failure.Failure s |
Deprecated in Twisted 8.0.
Called when an error occurs in a setUp* or tearDown* method
Parameters | warn | indicates whether or not the reporter should emit a warning about the error (type: Boolean) |
printStatus | indicates whether or not the reporter should print the name of the method and the status message appropriate for the type of error (type: Boolean) |
Record that a test has raised an unexpected exception.
Parameters | test | The test that has raised an error. |
error | The error that the test raised. It will either be a three-tuple in the
style of sys.exc_info() or a Failure object. |
Record that a test has failed with the given failure.
Parameters | test | The test that has failed. |
failure | The failure that the test failed with. It will either be a three-tuple in
the style of sys.exc_info() or a Failure object. |
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 | The test which this is about. (type: unittest.TestCase ) |
error | The error which this test failed with. (type: failure.Failure ) | |
todo | The reason for the test's TODO status. If None ,
a generic reason is used. (type: unittest.Todo ) |
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 | The test which this is about. (type: unittest.TestCase ) |
todo | The reason for the test's TODO status. If None ,
a generic reason is used. (type: unittest.Todo ) |
Record that a test has been skipped for the given reason.
Parameters | test | The test that has been skipped. |
reason | An object that the test case has specified as the reason for skipping the test. |
Deprecated in Twisted 8.0, use done
instead.
Present the errors that have occurred during the test run. This method will be called after all tests have been run.
Deprecated in Twisted 8.0, use done
instead.
Display a string to the user, without appending a new line.
Return a boolean indicating whether all test results that were reported to this reporter were successful or not.