twisted.trial.reporter.TextReporter : API documentation

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.

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	startTest	Called when a test begins to run. Records the time when it was first called and resets the warning cache.
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.
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):

Method	__repr__	Undocumented
Method	stopTest	This must be called after the given test is completed.
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 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	test	(type: `pyunit.TestCase` )
	error	(type: `Failure` )
	todo	(type: `unittest.Todo` )

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	test	(type: `pyunit.TestCase` )
	todo	(type: `unittest.Todo` )

Parameters	test	`ITestCase` that raised the error.
	error	`failure.Failure` containing the error.

Parameters	test	`ITestCase` that failed.
	fail	`failure.Failure` containing the error.

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