t.t.r.Reporter(TestResult) : class documentation

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

Known subclasses: twisted.trial.reporter.MinimalReporter, twisted.trial.reporter.TextReporter, twisted.trial.reporter.TreeReporter, twisted.trial.reporter.VerboseTextReporter

Implements interfaces: twisted.trial.itrial.IReporter

A basic TestResult with support for writing to a stream.
Method __init__ Undocumented
Method stream Deprecated in Twisted 8.0. The io-stream that this reporter will write to
Method separator Deprecated in Twisted 8.0. A value which will occasionally be passed to the write method.
Method startTest Called when a test begins to run. Records the time when it was first called and resets the warning cache.
Method addFailure Called when a test fails. If realtime is set, then it prints the error to the stream.
Method addError Called when a test raises an error. If realtime is set, then it prints the error to the stream.
Method write Deprecated in Twisted 8.0, use done instead.
Method writeln Deprecated in Twisted 8.0, use done instead.
Method upDownError Deprecated in Twisted 8.0.
Method cleanupErrors Report an error that occurred during the cleanup between tests.
Method printErrors Print all of the non-success results in full to the stream.
Method printSummary Print a line summarising the test results to the stream.
Method done Summarize the result of the test run.
Instance Variable _startTime The time when the first test was started. It defaults to None, which means that no test was actually launched. (type: float or NoneType)
Instance Variable _warningCache A set of tuples of warning message (file, line, text, category) which have already been written to the output stream during the currently executing test. This is used to avoid writing duplicates of the same warning to the output stream. (type: set)
Instance Variable _publisher The log publisher which will be observed for warning events. (type: LogPublisher (or another type sufficiently similar))
Method _observeWarnings Observe warning events and write them to self._stream.
Method _write Safely write to the reporter's stream.
Method _writeln Safely write a line to the reporter's stream. Newline is appended to the format string.
Method _trimFrames Undocumented
Method _formatFailureTraceback Undocumented
Method _groupResults Group tests together based on their results.
Method _printResults Print a group of errors to the stream.
Method _printExpectedFailure Undocumented
Method _printUnexpectedSuccess Undocumented
Method _printErrors Print all of the non-success results to the stream in full.
Method _getSummary Return a formatted count of tests status results.
Method _printSummary Print a line summarising the test results to the stream.

Inherited from TestResult:

Instance Variable successes count the number of successes achieved by the test run. (type: int)
Method __repr__ Undocumented
Method stopTest This must be called after the given test is completed.
Method addSkip Report that the given test was skipped.
Method addUnexpectedSuccess Report that the given test succeeded against expectations.
Method addExpectedFailure Report that the given test failed, and was expected to do so.
Method addSuccess Report that the given test succeeded.
Method startSuite Deprecated in Twisted 8.0.
Method endSuite Deprecated in Twisted 8.0.
Method _getTime Undocumented
Method _getFailure Convert a sys.exc_info()-style tuple to a Failure, if necessary.
_startTime =
The time when the first test was started. It defaults to None, which means that no test was actually launched. (type: float or NoneType)
_warningCache =
A set of tuples of warning message (file, line, text, category) which have already been written to the output stream during the currently executing test. This is used to avoid writing duplicates of the same warning to the output stream. (type: set)
_publisher =
The log publisher which will be observed for warning events. (type: LogPublisher (or another type sufficiently similar))
def __init__(self, stream=sys.stdout, tbformat='default', realtime=False, publisher=None): (source)
Undocumented
def _observeWarnings(self, event): (source)
Observe warning events and write them to self._stream.

This method is a log observer which will be registered with self._publisher.addObserver.

ParameterseventA dict from the logging system. If it has a 'warning' key, a logged warning will be extracted from it and possibly written to self.stream.
def stream(self): (source)
Deprecated in Twisted 8.0. The io-stream that this reporter will write to
def separator(self): (source)
Deprecated in Twisted 8.0. A value which will occasionally be passed to the write method.
def startTest(self, test): (source)
Called when a test begins to run. Records the time when it was first called and resets the warning cache.
ParameterstestITestCase
def addFailure(self, test, fail): (source)
Called when a test fails. If realtime is set, then it prints the error to the stream.
ParameterstestITestCase that failed.
failfailure.Failure containing the error.
def addError(self, test, error): (source)
Called when a test raises an error. If realtime is set, then it prints the error to the stream.
ParameterstestITestCase that raised the error.
errorfailure.Failure containing the error.
def write(self, format, *args): (source)
Deprecated in Twisted 8.0, use done instead.

Display a string to the user, without appending a new line.

def _write(self, format, *args): (source)
Safely write to the reporter's stream.
ParametersformatA format string to write.
*argsThe arguments for the format string.
def writeln(self, format, *args): (source)
Deprecated in Twisted 8.0, use done instead.

Display a string to the user, appending a new line.

def _writeln(self, format, *args): (source)
Safely write a line to the reporter's stream. Newline is appended to the format string.
ParametersformatA format string to write.
*argsThe arguments for the format string.
def upDownError(self, method, error, warn, printStatus): (source)
Deprecated in Twisted 8.0.

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 cleanupErrors(self, errs): (source)
Report an error that occurred during the cleanup between tests.
def _trimFrames(self, frames): (source)
Undocumented
def _formatFailureTraceback(self, fail): (source)
Undocumented
def _groupResults(self, results, formatter): (source)
Group tests together based on their results.
ParametersresultsAn iterable of tuples of two or more elements. The first element of each tuple is a test case. The remaining elements describe the outcome of that test case.
formatterA callable which turns a test case result into a string. The elements after the first of the tuples in results will be passed as positional arguments to formatter.
ReturnsA list of two-tuples. The first element of each tuple is a unique string describing one result from at least one of the test cases in results. The second element is a list of the test cases which had that result.
def _printResults(self, flavor, errors, formatter): (source)
Print a group of errors to the stream.
ParametersflavorA string indicating the kind of error (e.g. 'TODO').
errorsA list of errors, often failure.Failures, but sometimes 'todo' errors.
formatterA callable that knows how to format the errors.
def _printExpectedFailure(self, error, todo): (source)
Undocumented
def _printUnexpectedSuccess(self, todo): (source)
Undocumented
def printErrors(self): (source)
Print all of the non-success results in full to the stream.
def _printErrors(self): (source)
Print all of the non-success results to the stream in full.
def _getSummary(self): (source)
Return a formatted count of tests status results.
def printSummary(self): (source)
Print a line summarising the test results to the stream.
def _printSummary(self): (source)
Print a line summarising the test results to the stream.
def done(self): (source)
Summarize the result of the test run.

The summary includes a report of all of the errors, todos, skips and so forth that occurred during the run. It also includes the number of tests that were run and how long it took to run them (not including load time).

Expects that _printErrors, _writeln, _write, _printSummary and _separator are all implemented.

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