interface documentation

The interface that a test case must implement in order to be used in Trial.

Method __call__ Run the test. Should always do exactly the same thing as run().
Method countTestCases Return the number of tests in this test case. Usually 1.
Method id Return a unique identifier for the test, usually the fully-qualified Python name.
Method run Run the test, storing the results in result.
Method shortDescription Return a short description of the test.
Attribute failureException The exception class that is raised by failed assertions
Attribute skip The reason why this test case should be skipped, or None to not skip.
def __call__(result): (source)

Run the test. Should always do exactly the same thing as run().

def countTestCases(): (source)

Return the number of tests in this test case. Usually 1.

def id(): (source)

Return a unique identifier for the test, usually the fully-qualified Python name.

def run(result): (source)

Run the test, storing the results in result.

Parameters
resultA TestResult.
def shortDescription(): (source)

Return a short description of the test.

failureException = (source)

The exception class that is raised by failed assertions

skip: str | None = (source)

The reason why this test case should be skipped, or None to not skip.