twisted.trial.reporter.Reporter(TestResult)
class documentationtwisted.trial.reporter
View Source
(View In Hierarchy)
Known subclasses: twisted.trial.reporter.MinimalReporter, twisted.trial.reporter.TextReporter, twisted.trial.reporter.TreeReporter, twisted.trial.reporter.VerboseTextReporter
Implements interfaces: twisted.trial.itrial.IReporter
A basic TestResult
with support for writing to a stream.
Method | __init__ | 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 | Deprecated in Twisted 8.0. |
Method | cleanupErrors | Deprecated in Twisted 8.0. |
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 None ) |
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: twisted.python.log.LogPublisher ) |
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. (type: int ) |
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. |
Method | _getTime | Undocumented |
Method | _getFailure | Convert a sys.exc_info() -style tuple to a Failure , if
necessary. |
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
)
twisted.python.log.LogPublisher
)
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 . |
Called when a test begins to run. Records the time when it was first called and resets the warning cache.
Parameters | test | ITestCase |
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. |
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. |
Safely write to the reporter's stream.
Parameters | format | A format string to write. |
*args | The arguments for the format string. |
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. |
Deprecated in Twisted 8.0.
Called when an error occurs in a setUp* or tearDown* method
Parameters | warn | indicates whether or not the reporter should emit a warning about the error (type: Boolean) |
printStatus | indicates whether or not the reporter should print the name of the method and the status message appropriate for the type of error (type: Boolean) |
Deprecated in Twisted 8.0.
Called when the reactor has been left in a 'dirty' state
Parameters | errs | a list of twisted.python.failure.Failure s |
Trim frames to remove internal paths.
When a SynchronousTestCase
method fails synchronously, the
stack looks like this:
SynchronousTestCase._run
util.runWithWarningsSuppressed
_synctest.fail
When a TestCase
method fails synchronously, the stack looks
like this:
defer.maybeDeferred
utils.runWithWarningsSuppressed
utils.runWithWarningsSuppressed
_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:
defer.Deferred._runCallbacks
_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. |
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. |
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. |
Print all of the non-success results to the stream in full.
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.