API docs for “twisted.trial.unittest.

Class t.t.u._Assertions(pyunit.TestCase, object):

Replaces many of the built-in TestCase assertions. In general, these assertions provide better error messages and are easier to use in callbacks. Also provides new assertions such as failUnlessFailure.

Although the tests are defined as 'failIf*' and 'failUnless*', they can also be called as 'assertNot*' and 'assert*'.

Method	fail	absolutely fails the test, do not pass go, do not collect $200
Method	failIf	fails the test if `condition` evaluates to False
Method	failUnless	fails the test if `condition` evaluates to True
Method	failUnlessRaises	fails the test unless calling the function `f` with the given `args`
Method	failUnlessEqual	fail the test if `first` and `second` are not equal
Method	failUnlessIdentical	fail the test if `first` is not `second`. This is an
Method	failIfIdentical	fail the test if `first` is `second`. This is an
Method	failIfEqual	fail the test if `first` == `second`
Method	failUnlessIn	fail the test if `containee` is not found in `container`
Method	failIfIn	fail the test if `containee` is found in `container`
Method	failIfAlmostEqual	Fail if the two objects are equal as determined by their
Method	failUnlessAlmostEqual	Fail if the two objects are unequal as determined by their
Method	failUnlessApproximates	asserts that `first` - `second` > `tolerance`
Method	failUnlessFailure	Assert that `deferred` will errback with one of
Method	failUnlessSubstring	Undocumented
Method	failIfSubstring	Undocumented

def fail(self, msg=None): (source)

absolutely fails the test, do not pass go, do not collect $200

Parameters msg the message that will be displayed as the reason for the failure

def failIf(self, condition, msg=None): (source)

fails the test if condition evaluates to False

Parameters condition any object that defines __nonzero__

def failUnless(self, condition, msg=None): (source)

fails the test if condition evaluates to True

Parameters condition any object that defines __nonzero__

def failUnlessRaises(self, exception, f, *args, **kwargs): (source)

fails the test unless calling the function f with the given args and kwargs does not raise exception. The failure will report the traceback and call stack of the unexpected exception.

Parameters	exception	exception type that is to be expected
	f	the function to call
Returns	The raised exception instance, if it is of the given type.
Raises	self.failureException	Raised if the function call does not raise an exception or if it raises an exception of a different type.

def failUnlessEqual(self, first, second, msg=None): (source)

fail the test if first and second are not equal

Parameters msg if msg is None, then the failure message will be '%r != %r' % (first, second)

def failUnlessIdentical(self, first, second, msg=None): (source)

fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test

Parameters msg if msg is None, then the failure message will be '%r is not %r' % (first, second)

def failIfIdentical(self, first, second, msg=None): (source)

fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test

Parameters msg if msg is None, then the failure message will be '%r is %r' % (first, second)

def failIfEqual(self, first, second, msg=None): (source)

fail the test if first == second

Parameters msg if msg is None, then the failure message will be '%r == %r' % (first, second)

def failUnlessIn(self, containee, container, msg=None): (source)

fail the test if containee is not found in container

Parameters	containee	the value that should be in `container`
	container	a sequence type, or in the case of a mapping type, will follow semantics of 'if key in dict.keys()'
	msg	if msg is None, then the failure message will be '%r not in %r' % (first, second)

def failIfIn(self, containee, container, msg=None): (source)

fail the test if containee is found in container

Parameters	containee	the value that should not be in `container`
	container	a sequence type, or in the case of a mapping type, will follow semantics of 'if key in dict.keys()'
	msg	if msg is None, then the failure message will be '%r in %r' % (first, second)

def failIfAlmostEqual(self, first, second, places=7, msg=None): (source)

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.

Notes	decimal places (from zero) is usually not the same as significant digits (measured from the most signficant digit).
	included for compatiblity with PyUnit test cases

def failUnlessAlmostEqual(self, first, second, places=7, msg=None): (source)

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.

Notes	decimal places (from zero) is usually not the same as significant digits (measured from the most signficant digit).
	included for compatiblity with PyUnit test cases

def failUnlessApproximates(self, first, second, tolerance, msg=None): (source)

asserts that first - second > tolerance

Parameters msg if msg is None, then the failure message will be '%r ~== %r' % (first, second)

def failUnlessFailure(self, deferred, *expectedFailures): (source)

Assert that deferred will errback with one of expectedFailures. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.

def failUnlessSubstring(self, substring, astring, msg=None): (source)

Undocumented

def failIfSubstring(self, substring, astring, msg=None): (source)

Undocumented