class documentation

Simple reporter that prints a single character for each test as it runs, along with the standard Trial summary text.

Method addError Called when a test raises an error. If realtime is set, then it prints the error to the stream.
Method addExpectedFailure Report that the given test failed, and was expected to do so.
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 addSuccess Report that the given test succeeded.
Method addUnexpectedSuccess Report that the given test succeeded against expectations.

Inherited from Reporter:

Method __init__ Undocumented
Method cleanupErrors Undocumented
Method done Summarize the result of the test run.
Method startTest Called when a test begins to run. Records the time when it was first called and resets the warning cache.
Method upDownError Undocumented
Instance Variable realtime Undocumented
Instance Variable tbformat Undocumented
Method _formatFailureTraceback Undocumented
Method _getSummary Return a formatted count of tests status results.
Method _groupResults Group tests together based on their results.
Method _observeWarnings Observe warning events and write them to self._stream.
Method _printErrors Print all of the non-success results to the stream in full.
Method _printExpectedFailure Undocumented
Method _printResults Print a group of errors to the stream.
Method _printSummary Print a line summarising the test results to the stream.
Method _printUnexpectedSuccess Undocumented
Method _trimFrames Trim frames to remove internal paths.
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.
Class Variable _doubleSeparator Undocumented
Class Variable _separator Undocumented
Instance Variable _publisher The log publisher which will be observed for warning events.
Instance Variable _startTime The time when the first test was started. It defaults to None, which means that no test was actually launched.
Instance Variable _stream Undocumented
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.

Inherited from TestResult (via Reporter):

Method __repr__ Undocumented
Method stopTest This must be called after the given test is completed.
Method wasSuccessful Report whether or not this test suite was successful or not.
Instance Variable expectedFailures Undocumented
Instance Variable skips Undocumented
Instance Variable successes count the number of successes achieved by the test run.
Instance Variable unexpectedSuccesses Undocumented
Method _getFailure Convert a sys.exc_info()-style tuple to a Failure, if necessary.
Method _getTime Undocumented
Constant _DEFAULT_TODO Undocumented
Instance Variable _lastTime The duration of the current test run. It defaults to None, which means that the test was skipped.
Instance Variable _testStarted Undocumented
Instance Variable _timings Undocumented
def addError(self, *args): (source)

Called when a test raises an error. If realtime is set, then it prints the error to the stream.

Parameters
*argsUndocumented
testITestCase that raised the error.
errorfailure.Failure containing the error.
def addExpectedFailure(self, *args): (source)

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.

Parameters
*argsUndocumented
test:pyunit.TestCaseUndocumented
error:FailureUndocumented
todo:unittest.Todo, or None, in which case a default todo message is provided.Undocumented
def addFailure(self, *args): (source)

Called when a test fails. If realtime is set, then it prints the error to the stream.

Parameters
*argsUndocumented
testITestCase that failed.
failfailure.Failure containing the error.
def addSkip(self, *args): (source)

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.

Parameters
*argsUndocumented
test:pyunit.TestCaseUndocumented
reason:strUndocumented
def addSuccess(self, test): (source)

Report that the given test succeeded.

Parameters
test:pyunit.TestCaseUndocumented
def addUnexpectedSuccess(self, *args): (source)

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.

Parameters
*argsUndocumented
test:pyunit.TestCaseUndocumented
todo:unittest.Todo, or None, in which case a default todo message is provided.Undocumented