class documentation

Tests for SynchronousTestCase's assertion methods. That is, failUnless*, failIf*, assert* (not covered by other more specific test classes).

Note: As of 11.2, assertEqual is preferred over the failUnlessEqual(s) variants. Tests have been modified to reflect this preference.

This is pretty paranoid. Still, a certain paranoia is healthy if you are testing a unit testing framework.

Method test_assertDictEqual twisted.trial.unittest.TestCase supports the assertDictEqual method inherited from the standard library in Python 2.7.
Method test_assertEqual_basic Undocumented
Method test_assertEqual_custom Undocumented
Method test_assertEqual_incomparable Undocumented
Method test_assertEqualMessage When a message is passed to assertEqual it is included in the error message.
Method test_assertEqualNoneMessage If a message is specified as None, it is not included in the error message of assertEqual.
Method test_assertIs assertIs passes if two objects are identical.
Method test_assertIsError assertIs fails if two objects are not identical.
Method test_assertIsInstance Test a true condition of assertIsInstance.
Method test_assertIsInstanceCustomMessage If TestCase.assertIsInstance is passed a custom message as its 3rd argument, the message is included in the failure exception raised when the assertion fails.
Method test_assertIsInstanceError Test an error with assertIsInstance.
Method test_assertIsInstanceErrorMultipleClasses Test an error with assertIsInstance and multiple classes.
Method test_assertIsInstanceMultipleClasses Test a true condition of assertIsInstance with multiple classes.
Method test_assertIsNot assertIsNot passes if two objects are not identical.
Method test_assertIsNotError assertIsNot fails if two objects are identical.
Method test_assertNotIsInstance Test a true condition of assertNotIsInstance.
Method test_assertNotIsInstanceError Test an error with assertNotIsInstance.
Method test_assertNotIsInstanceErrorMultipleClasses Test an error with assertNotIsInstance and multiple classes.
Method test_assertNotIsInstanceMultipleClasses Test a true condition of assertNotIsInstance and multiple classes.
Method test_assertRaisesContextExpected If assertRaises is used to create a context manager and an exception is raised from the body of the with statement then the context manager's exception attribute is set to the exception that was raised.
Method test_assertRaisesContextNoException If assertRaises is used to create a context manager and no exception is raised from the body of the with statement then the with statement raises failureException describing the lack of exception.
Method test_assertRaisesContextUnexpected If assertRaises is used to create a context manager and the wrong exception type is raised from the body of the with statement then the with statement raises failureException describing the mismatch.
Method test_brokenName If the exception type passed to assertRaises does not have a __name__ then the context manager still manages to construct a descriptive string for it.
Method test_failIfAlmostEqual Undocumented
Method test_failIfEqual_basic Undocumented
Method test_failIfEqual_customEq Undocumented
Method test_failIfIdenticalNegative failIfIdentical raises failureException if its first and second arguments are the same object.
Method test_failIfIdenticalPositive failIfIdentical returns its first argument if its first and second arguments are not the same object.
Method test_failIfSubstring Undocumented
Method test_failUnlessAlmostEqual Undocumented
Method test_failUnlessApproximates Undocumented
Method test_failUnlessIdentical Undocumented
Method test_failUnlessRaises_expected Undocumented
Method test_failUnlessRaises_failureException Undocumented
Method test_failUnlessRaises_noException Undocumented
Method test_failUnlessRaises_unexpected Undocumented
Method test_failUnlessSubstring Undocumented
Method _raiseError Undocumented
Method _testEqualPair Undocumented
Method _testUnequalPair Assert that when called with unequal arguments, assertEqual raises a failure exception with the same message as the standard library assertEqual would have raised.

Inherited from SynchronousTestCase:

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
Method __init__ Undocumented
Method addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
Method callDeprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method shortDescription Undocumented
Instance Variable failureException An exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable skip None or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
Instance Variable suppress None or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
Instance Variable todo None, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _passed Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via SynchronousTestCase):

Method assertAlmostEqual Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertApproximates Fail if first - second > tolerance
Method assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
Method assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertNotAlmostEqual Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
Method assertRaises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
Method assertWarns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def test_assertDictEqual(self):

twisted.trial.unittest.TestCase supports the assertDictEqual method inherited from the standard library in Python 2.7.

def test_assertEqual_basic(self):

Undocumented

def test_assertEqual_custom(self):

Undocumented

def test_assertEqual_incomparable(self):

Undocumented

def test_assertEqualMessage(self):

When a message is passed to assertEqual it is included in the error message.

def test_assertEqualNoneMessage(self):

If a message is specified as None, it is not included in the error message of assertEqual.

def test_assertIs(self):

assertIs passes if two objects are identical.

def test_assertIsError(self):

assertIs fails if two objects are not identical.

def test_assertIsInstance(self):

Test a true condition of assertIsInstance.

def test_assertIsInstanceCustomMessage(self):

If TestCase.assertIsInstance is passed a custom message as its 3rd argument, the message is included in the failure exception raised when the assertion fails.

def test_assertIsInstanceError(self):

Test an error with assertIsInstance.

def test_assertIsInstanceErrorMultipleClasses(self):

Test an error with assertIsInstance and multiple classes.

def test_assertIsInstanceMultipleClasses(self):

Test a true condition of assertIsInstance with multiple classes.

def test_assertIsNot(self):

assertIsNot passes if two objects are not identical.

def test_assertIsNotError(self):

assertIsNot fails if two objects are identical.

def test_assertNotIsInstance(self):

Test a true condition of assertNotIsInstance.

def test_assertNotIsInstanceError(self):

Test an error with assertNotIsInstance.

def test_assertNotIsInstanceErrorMultipleClasses(self):

Test an error with assertNotIsInstance and multiple classes.

def test_assertNotIsInstanceMultipleClasses(self):

Test a true condition of assertNotIsInstance and multiple classes.

def test_assertRaisesContextExpected(self):

If assertRaises is used to create a context manager and an exception is raised from the body of the with statement then the context manager's exception attribute is set to the exception that was raised.

def test_assertRaisesContextNoException(self):

If assertRaises is used to create a context manager and no exception is raised from the body of the with statement then the with statement raises failureException describing the lack of exception.

def test_assertRaisesContextUnexpected(self):

If assertRaises is used to create a context manager and the wrong exception type is raised from the body of the with statement then the with statement raises failureException describing the mismatch.

def test_brokenName(self):

If the exception type passed to assertRaises does not have a __name__ then the context manager still manages to construct a descriptive string for it.

def test_failIfAlmostEqual(self):

Undocumented

def test_failIfEqual_basic(self):

Undocumented

def test_failIfEqual_customEq(self):

Undocumented

def test_failIfIdenticalNegative(self):

failIfIdentical raises failureException if its first and second arguments are the same object.

def test_failIfIdenticalPositive(self):

failIfIdentical returns its first argument if its first and second arguments are not the same object.

def test_failIfSubstring(self):

Undocumented

def test_failUnlessAlmostEqual(self):

Undocumented

def test_failUnlessApproximates(self):

Undocumented

def test_failUnlessIdentical(self):

Undocumented

def test_failUnlessRaises_expected(self):

Undocumented

def test_failUnlessRaises_failureException(self):

Undocumented

def test_failUnlessRaises_noException(self):

Undocumented

def test_failUnlessRaises_unexpected(self):

Undocumented

def test_failUnlessSubstring(self):

Undocumented

def _raiseError(self, error):

Undocumented

def _testEqualPair(self, first, second):

Undocumented

def _testUnequalPair(self, first, second):

Assert that when called with unequal arguments, assertEqual raises a failure exception with the same message as the standard library assertEqual would have raised.