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

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

Known subclasses: twisted.trial.reporter.TimingTextReporter

A verbose reporter that prints the name of each test as it is running.

Each line is printed with the name of the test, followed by the result of that test.

Method startTest Called when a test begins to run. Records the time when it was first called and resets the warning cache.
Method addSuccess Report that the given test succeeded.
Method addError Called when a test raises an error. If realtime is set, then it prints the error to the stream.
Method addFailure Called when a test fails. If realtime is set, then it prints the error to the stream.
Method addSkip Report that the given test was skipped.
Method addExpectedFailure Report that the given test failed, and was expected to do so.
Method addUnexpectedSuccess Report that the given test succeeded against expectations.
Method stopTest This must be called after the given test is completed.

Inherited from Reporter:

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 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 (via Reporter):

Instance Variable successes count the number of successes achieved by the test run. (type: int)
Method __repr__ Undocumented
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.
def startTest(self, tm): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.Reporter.startTest
Called when a test begins to run. Records the time when it was first called and resets the warning cache.
ParameterstestITestCase
def addSuccess(self, test): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.TestResult.addSuccess
Report that the given test succeeded.
def addError(self, *args): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.Reporter.addError
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 addFailure(self, *args): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.Reporter.addFailure
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 addSkip(self, *args): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.TestResult.addSkip
Report that the given test was skipped.

In Trial, tests can be 'skipped'. Tests are skipped mostly because there is some platform or configuration issue that prevents them from being run correctly.

def addExpectedFailure(self, *args): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.TestResult.addExpectedFailure
Report that the given test failed, and was expected to do so.

In Trial, tests can be marked 'todo'. That is, they are expected to fail.

def addUnexpectedSuccess(self, *args): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.TestResult.addUnexpectedSuccess
Report that the given test succeeded against expectations.

In Trial, tests can be marked 'todo'. That is, they are expected to fail. When a test that is expected to fail instead succeeds, it should call this method to report the unexpected success.

def stopTest(self, test): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.TestResult.stopTest
overridden in twisted.trial.reporter.TimingTextReporter
This must be called after the given test is completed.
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.