twisted.trial.reporter.TreeReporter(Reporter) class documentationtwisted.trial.reporter
(View In Hierarchy)
Print out the tests in the form a tree.
Tests are indented according to which class and module they belong. Results are printed in ANSI color.
| Method | __init__ | Undocumented |
| Method | getDescription | Return the name of the method which 'test' represents. This is what gets displayed in the leaves of the tree. |
| 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. |
| Method | cleanupErrors | Deprecated in Twisted 8.0. |
| Method | upDownError | Deprecated in Twisted 8.0. |
| Method | startTest | Called when test starts. Writes the tests name to the
stream using a tree format. |
| Method | endLine | Print 'message' in the given color. |
| Method | _write | Safely write to the reporter's stream. |
| Method | _getPreludeSegments | Return a list of all non-leaf segments to display in the tree. |
| Method | _testPrelude | Write the name of the test to the stream, indenting it appropriately. |
| Method | _printSummary | Print a line summarising the test results to the stream, and color the status result. |
Inherited from Reporter:
| 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 | _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. |
Inherited from TestResult (via Reporter):
| 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 | 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. |
Return the name of the method which 'test' represents. This is what gets displayed in the leaves of the tree.
e.g. getDescription(TestCase('test_foo')) ==> test_foo
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. |
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. |
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.
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.
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.
Safely write to the reporter's stream.
| Parameters | format | A format string to write. |
| *args | The arguments for the format string. |
Return a list of all non-leaf segments to display in the tree.
Normally this is the module and class name.
Write the name of the test to the stream, indenting it appropriately.
If the test is the first test in a new 'branch' of the tree, also write all of the parents in that branch.
Deprecated in Twisted 8.0.
Called when the reactor has been left in a 'dirty' state
| Parameters | errs | a list of twisted.python.failure.Failures |
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) |
Called when test starts. Writes the tests name to the
stream using a tree format.
Print 'message' in the given color.
| Parameters | message | A string message, usually '[OK]' or something similar. |
| color | A string color, 'red', 'green' and so forth. |