twisted.trial.reporter.Reporter : API documentation

class documentation

class twisted.trial.reporter.Reporter(TestResult): (source)

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

Implements interfaces: twisted.trial.itrial.IReporter

View In Hierarchy

A basic TestResult with support for writing to a stream.

Method	__init__	Undocumented
Instance Variable	tbformat	Undocumented
Instance Variable	realtime	Undocumented
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	upDownError	Undocumented
Method	cleanupErrors	Undocumented
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.
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.
Instance Variable	_publisher	The log publisher which will be observed for warning events.
Class Variable	_separator	Undocumented
Class Variable	_doubleSeparator	Undocumented
Instance Variable	_stream	Undocumented
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	Trim frames to remove internal paths.
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.
Instance Variable	skips	Undocumented
Instance Variable	expectedFailures	Undocumented
Instance Variable	unexpectedSuccesses	Undocumented
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	wasSuccessful	Report whether or not this test suite was successful or not.
Class Variable	_DEFAULT_TODO	Undocumented
Instance Variable	_timings	Undocumented
Method	_getTime	Undocumented
Method	_getFailure	Convert a `sys.exc_info()`-style tuple to a `Failure`, if necessary.
Instance Variable	_testStarted	Undocumented
Instance Variable	_lastTime	Undocumented

_startTime = (source)

The time when the first test was started. It defaults to None, which means that no test was actually launched.

(type: float or None)

_warningCache = (source)

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 = (source)

The log publisher which will be observed for warning events.

(type: twisted.python.log.LogPublisher)

_separator = (source)

Undocumented

_doubleSeparator = (source)

Undocumented

def __init__(self, stream=sys.stdout, tbformat='default', realtime=False, publisher=None): (source)

overrides twisted.trial.reporter.TestResult.__init__

overridden in twisted.trial.reporter.TreeReporter

Undocumented

_stream = (source)

Undocumented

tbformat = (source)

Undocumented

realtime = (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.

Parameters event A 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 startTest(self, test): (source)

from twisted.trial.itrial.IReporter

overrides twisted.trial.reporter.TestResult.startTest

overridden in twisted.trial.reporter.TreeReporter, twisted.trial.reporter.VerboseTextReporter

Called when a test begins to run. Records the time when it was first called and resets the warning cache.

Parameters test ITestCase

def addFailure(self, test, fail): (source)

from twisted.trial.itrial.IReporter

overrides twisted.trial.reporter.TestResult.addFailure

overridden in twisted.trial.reporter.TextReporter, twisted.trial.reporter.TreeReporter, twisted.trial.reporter.VerboseTextReporter

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

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

def addError(self, test, error): (source)

from twisted.trial.itrial.IReporter

overrides twisted.trial.reporter.TestResult.addError

overridden in twisted.trial.reporter.TextReporter, twisted.trial.reporter.TreeReporter, twisted.trial.reporter.VerboseTextReporter

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

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

def _write(self, format, *args): (source)

overridden in twisted.trial.reporter.TreeReporter

Safely write to the reporter's stream.

Parameters	format	A format string to write.
	args	The arguments for the format string.

def _writeln(self, format, *args): (source)

Safely write a line to the reporter's stream. Newline is appended to the format string.

Parameters	format	A format string to write.
	args	The arguments for the format string.

def upDownError(self, method, error, warn=True, printStatus=True): (source)

overridden in twisted.trial.reporter.TreeReporter

Undocumented

def cleanupErrors(self, errs): (source)

overridden in twisted.trial.reporter.TreeReporter

Undocumented

def _trimFrames(self, frames): (source)

Trim frames to remove internal paths.

When a SynchronousTestCase method fails synchronously, the stack looks like this:

[0]: SynchronousTestCase._run
[1]: util.runWithWarningsSuppressed
[2:-2]: code in the test method which failed
[-1]: _synctest.fail

When a TestCase method fails synchronously, the stack looks like this:

[0]: defer.maybeDeferred
[1]: utils.runWithWarningsSuppressed
[2]: utils.runWithWarningsSuppressed
[3:-2]: code in the test method which failed
[-1]: _synctest.fail

When a method fails inside a Deferred (i.e., when the test method returns a Deferred, and that Deferred's errback fires), the stack captured inside the resulting Failure looks like this:

[0]: defer.Deferred._runCallbacks
[1:-2]: code in the testmethod which failed
[-1]: _synctest.fail

As a result, we want to trim either [maybeDeferred, runWWS, runWWS] or [Deferred._runCallbacks] or [SynchronousTestCase._run, runWWS] from the front, and trim the [unittest.fail] from the end.

There is also another case, when the test method is badly defined and contains extra arguments.

If it doesn't recognize one of these cases, it just returns the original frames.

Parameters	frames	The `list` of frames from the test failure.
Returns	The `list` of frames to display.

def _formatFailureTraceback(self, fail): (source)

Undocumented

def _groupResults(self, results, formatter): (source)

Group tests together based on their results.

Parameters	results	An 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.
	formatter	A 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`.
Returns	A `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.

Parameters	flavor	A string indicating the kind of error (e.g. 'TODO').
	errors	A list of errors, often `failure.Failure`s, but sometimes 'todo' errors.
	formatter	A 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)

overridden in twisted.trial.reporter.MinimalReporter

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)

overridden in twisted.trial.reporter.MinimalReporter, twisted.trial.reporter.TreeReporter

Print a line summarising the test results to the stream.

def done(self): (source)

from twisted.trial.itrial.IReporter

overrides twisted.trial.reporter.TestResult.done

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 20.12.1 at 2021-02-28 19:53:36.