twisted.trial.reporter.TextReporter

class documentation

class TextReporter(Reporter): (source)

View In Hierarchy

Simple reporter that prints a single character for each test as it runs, along with the standard Trial summary text.
Method add​Error Called when a test raises an error. If realtime is set, then it prints the error to the stream.
Method add​Expected​Failure Report that the given test failed, and was expected to do so.
Method add​Failure Called when a test fails. If realtime is set, then it prints the error to the stream.
Method add​Skip Report that the given test was skipped.
Method add​Success Report that the given test succeeded.
Method add​Unexpected​Success Report that the given test succeeded against expectations.

Inherited from Reporter:

Method __init__ Undocumented
Method cleanup​Errors Undocumented
Method done Summarize the result of the test run.
Method start​Test Called when a test begins to run. Records the time when it was first called and resets the warning cache.
Method up​Down​Error Undocumented
Instance Variable realtime Undocumented
Instance Variable tbformat Undocumented
Method _format​Failure​Traceback Undocumented
Method _get​Summary Return a formatted count of tests status results.
Method _group​Results Group tests together based on their results.
Method _observe​Warnings Observe warning events and write them to self._stream.
Method _print​Errors Print all of the non-success results to the stream in full.
Method _print​Expected​Failure Undocumented
Method _print​Results Print a group of errors to the stream.
Method _print​Summary Print a line summarising the test results to the stream.
Method _print​Unexpected​Success Undocumented
Method _trim​Frames 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 _double​Separator Undocumented
Class Variable _separator Undocumented
Instance Variable _publisher The log publisher which will be observed for warning events.
Instance Variable _start​Time 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 _warning​Cache 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 stop​Test This must be called after the given test is completed.
Method was​Successful Report whether or not this test suite was successful or not.
Instance Variable expected​Failures Undocumented
Instance Variable skips Undocumented
Instance Variable successes count the number of successes achieved by the test run.
Instance Variable unexpected​Successes Undocumented
Method _get​Failure Convert a sys.exc_info()-style tuple to a Failure, if necessary.
Method _get​Time Undocumented
Constant _DEFAULT​_TODO Undocumented
Instance Variable _last​Time Undocumented
Instance Variable _test​Started Undocumented
Instance Variable _timings Undocumented
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.
Parameters
*argsUndocumented
testITestCase that raised the error.
errorfailure.Failure containing the error.
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.

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)
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.
Parameters
*argsUndocumented
testITestCase 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.

Parameters
*argsUndocumented
test:pyunit.TestCaseUndocumented
reason:strUndocumented
def addSuccess(self, test): (source)
from twisted.trial.itrial.IReporter
overrides twisted.trial.reporter.TestResult.addSuccess
Report that the given test succeeded.
Parameters
test:pyunit.TestCaseUndocumented
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.

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