class documentation

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

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.

Instance Variable currentLine Undocumented
Class Variable indent Undocumented
Class Variable columns Undocumented
Class Variable FAILURE Undocumented
Class Variable ERROR Undocumented
Class Variable TODO Undocumented
Class Variable SKIP Undocumented
Class Variable TODONE Undocumented
Class Variable SUCCESS Undocumented
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 Undocumented
Method upDownError Undocumented
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.
Instance Variable _lastTest Undocumented
Instance Variable _colorizer Undocumented
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:

Instance Variable tbformat Undocumented
Instance Variable realtime 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 _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.
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 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
currentLine = (source)

Undocumented

indent = (source)

Undocumented

(type: str)
columns = (source)

Undocumented

(type: int)
FAILURE = (source)

Undocumented

(type: str)
ERROR = (source)

Undocumented

(type: str)
TODO = (source)

Undocumented

(type: str)
SKIP = (source)

Undocumented

(type: str)
TODONE = (source)

Undocumented

(type: str)
SUCCESS = (source)

Undocumented

(type: str)
def __init__(self, stream=sys.stdout, *args, **kwargs): (source)
_lastTest = (source)

Undocumented

_colorizer = (source)

Undocumented

def getDescription(self, test): (source)

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

def addSuccess(self, test): (source)

Report that the given test succeeded.

ParameterstestUndocumented (type: pyunit.TestCase)
def addError(self, *args): (source)

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

ParametersargsUndocumented
testITestCase that raised the error.
errorfailure.Failure containing the error.
def addFailure(self, *args): (source)

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

ParametersargsUndocumented
testITestCase that failed.
failfailure.Failure containing the error.
def addSkip(self, *args): (source)

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.

ParametersargsUndocumented
testUndocumented (type: pyunit.TestCase)
reasonUndocumented (type: str)
def addExpectedFailure(self, *args): (source)

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.

ParametersargsUndocumented
testUndocumented (type: pyunit.TestCase)
errorUndocumented (type: Failure)
todoUndocumented (type: unittest.Todo, or None, in which case a default todo message is provided.)
def addUnexpectedSuccess(self, *args): (source)

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.

ParametersargsUndocumented
testUndocumented (type: pyunit.TestCase)
todoUndocumented (type: unittest.Todo, or None, in which case a default todo message is provided.)
def _write(self, format, *args): (source)

Safely write to the reporter's stream.

ParametersformatA format string to write.
argsThe arguments for the format string.
def _getPreludeSegments(self, testID): (source)

Return a list of all non-leaf segments to display in the tree.

Normally this is the module and class name.

def _testPrelude(self, testID): (source)

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.

def cleanupErrors(self, errs): (source)
def upDownError(self, method, error, warn, printStatus): (source)
def startTest(self, test): (source)

Called when test starts. Writes the tests name to the stream using a tree format.

def endLine(self, message, color): (source)

Print 'message' in the given color.

ParametersmessageA string message, usually '[OK]' or something similar.
colorA string color, 'red', 'green' and so forth.
def _printSummary(self): (source)

Print a line summarising the test results to the stream, and color the status result.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.