Python: module test.tc

From 34a60763e79546e0f84e30fbcc430632f3dbb39e Mon Sep 17 00:00:00 2001 From: hut Date: Tue, 16 Feb 2010 01:56:21 +0100 Subject: incremented version number and updated pydoc html files --- doc/pydoc/test.tc_keyapi.html | 193 ++++++++++-------------------------------- 1 file changed, 46 insertions(+), 147 deletions(-) (limited to 'doc/pydoc/test.tc_keyapi.html') diff --git a/doc/pydoc/test.tc_keyapi.html b/doc/pydoc/test.tc_keyapi.html index bd802343..d4f2418d 100644 --- a/doc/pydoc/test.tc_keyapi.html +++ b/doc/pydoc/test.tc_keyapi.html @@ -1,6 +1,6 @@ + Python: module test.tc_keyapi - @@ -8,7 +8,7 @@

test.tc_keyapi

index
/home/hut/work/ranger/test/tc_keyapi.py

+>index
/home/hut/ranger/test/tc_keyapi.py

@@ -18,7 +18,7 @@

-
unittest.TestCase(builtins.object) +
unittest.TestCase(__builtin__.object)

Test @@ -35,7 +35,7 @@
Method resolution order:

Test

unittest.TestCase
-
builtins.object
+
__builtin__.object

Methods defined here:
@@ -59,167 +59,58 @@ not have a method with the specified name.
__str__(self)
-
addCleanup(self, function, *args, **kwargs)
Add a function, with arguments, to be called when the test is -completed. Functions added are called on a LIFO basis and are -called after tearDown on test failure or success. - -Cleanup items are called even if setUp fails (unlike tearDown).
- -
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type. - -This method is for use by TestCase subclasses that need to register -their own type equality functions to provide nicer error messages. - -Args: -    typeobj: The data type to call this function on when both values -            are of the same type in assertEqual(). -    function: The callable taking two arguments and an optional -            msg= argument that raises self.failureException with a -            useful error message when the two arguments are not equal.
- -
assertAlmostEqual(self, first, second, *, places=7, msg=None)
Fail if the two objects are unequal as determined by their +assertAlmostEqual = failUnlessAlmostEqual(self, first, second, places=7, msg=None) 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. Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit). -assertAlmostEquals = assertAlmostEqual(self, first, second, *, places=7, msg=None) Fail if the two objects are unequal as determined by their +assertAlmostEquals = failUnlessAlmostEqual(self, first, second, places=7, msg=None) 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. Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit). -assertDictContainsSubset(self, expected, actual, msg=None) Checks whether actual is a superset of expected. - -assertDictEqual(self, d1, d2, msg=None) - -assertEqual(self, first, second, msg=None) Fail if the two objects are unequal as determined by the '==' +assertEqual = failUnlessEqual(self, first, second, msg=None) Fail if the two objects are unequal as determined by the '==' operator. -assertEquals = assertEqual(self, first, second, msg=None) Fail if the two objects are unequal as determined by the '==' +assertEquals = failUnlessEqual(self, first, second, msg=None) Fail if the two objects are unequal as determined by the '==' operator. -assertFalse(self, expr, msg=None) Fail the test if the expression is true. - -assertGreater(self, a, b, msg=None) Just like assertTrue(a > b), but with a nicer default message. - -assertGreaterEqual(self, a, b, msg=None) Just like assertTrue(a >= b), but with a nicer default message. - -assertIn(self, member, container, msg=None) Just like assertTrue(a in b), but with a nicer default message. - -assertIs(self, expr1, expr2, msg=None) Just like assertTrue(a is b), but with a nicer default message. - -assertIsNone(self, obj, msg=None) Same as assertTrue(obj is None), with a nicer default message. - -assertIsNot(self, expr1, expr2, msg=None) Just like assertTrue(a is not b), but with a nicer default message. - -assertIsNotNone(self, obj, msg=None) Included for symmetry with assertIsNone. +assertFalse = failIf(self, expr, msg=None) Fail the test if the expression is true. -assertLess(self, a, b, msg=None) Just like assertTrue(a < b), but with a nicer default message. - -assertLessEqual(self, a, b, msg=None) Just like assertTrue(a <= b), but with a nicer default message. - -assertListEqual(self, list1, list2, msg=None) A list-specific equality assertion. - -Args: -    list1: The first list to compare. -    list2: The second list to compare. -    msg: Optional message to use on failure instead of a list of -            differences. - -assertMultiLineEqual(self, first, second, msg=None) Assert that two multi-line strings are equal. - -assertNotAlmostEqual(self, first, second, *, places=7, msg=None) Fail if the two objects are equal as determined by their +assertNotAlmostEqual = failIfAlmostEqual(self, first, second, places=7, msg=None) 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. Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit). -assertNotAlmostEquals = assertNotAlmostEqual(self, first, second, *, places=7, msg=None) Fail if the two objects are equal as determined by their +assertNotAlmostEquals = failIfAlmostEqual(self, first, second, places=7, msg=None) 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. Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit). -assertNotEqual(self, first, second, msg=None) Fail if the two objects are equal as determined by the '==' +assertNotEqual = failIfEqual(self, first, second, msg=None) Fail if the two objects are equal as determined by the '==' operator. -assertNotEquals = assertNotEqual(self, first, second, msg=None) Fail if the two objects are equal as determined by the '==' +assertNotEquals = failIfEqual(self, first, second, msg=None) Fail if the two objects are equal as determined by the '==' operator. -assertNotIn(self, member, container, msg=None) Just like assertTrue(a not in b), but with a nicer default message. - -assertRaises(self, excClass, callableObj=None, *args, **kwargs) Fail unless an exception of class excClass is thrown +assertRaises = failUnlessRaises(self, excClass, callableObj, *args, **kwargs) Fail unless an exception of class excClass is thrown by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is thrown, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an -unexpected exception. - -If called with callableObj omitted or None, will return a -context object used like this:: - -     with assertRaises(some_error_class): -         do_something() - -assertRaisesRegexp(self, expected_exception, expected_regexp, callable_obj=None, *args, **kwargs) Asserts that the message in a raised exception matches a regexp. - -Args: -    expected_exception: Exception class expected to be raised. -    expected_regexp: Regexp (re pattern object or string) expected -            to be found in error message. -    callable_obj: Function to be called. -    args: Extra args. -    kwargs: Extra kwargs. - -assertRegexpMatches(self, text, expected_regex, msg=None) - -assertSameElements(self, expected_seq, actual_seq, msg=None) An unordered sequence specific comparison. - -Raises with an error message listing which elements of expected_seq -are missing from actual_seq and vice versa if any. +unexpected exception. -assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None) An equality assertion for ordered sequences (like lists and tuples). - -For the purposes of this function, a valid orderd sequence type is one -which can be indexed, has a length, and has an equality operator. - -Args: -    seq1: The first sequence to compare. -    seq2: The second sequence to compare. -    seq_type: The expected datatype of the sequences, or None if no -            datatype should be enforced. -    msg: Optional message to use on failure instead of a list of -            differences. - -assertSetEqual(self, set1, set2, msg=None) A set-specific equality assertion. - -Args: -    set1: The first set to compare. -    set2: The second set to compare. -    msg: Optional message to use on failure instead of a list of -            differences. - -For more general containership equality, assertSameElements will work -with things other than sets.    This uses ducktyping to support -different types of sets, and is optimized for sets specifically -(parameters must support a difference method). - -assertTrue(self, expr, msg=None) Fail the test unless the expression is true. - -assertTupleEqual(self, tuple1, tuple2, msg=None) A tuple-specific equality assertion. - -Args: -    tuple1: The first tuple to compare. -    tuple2: The second tuple to compare. -    msg: Optional message to use on failure instead of a list of -            differences. +assertTrue = failUnless(self, expr, msg=None) Fail the test unless the expression is true. -assert_ = assertTrue(self, expr, msg=None) Fail the test unless the expression is true. +assert_ = failUnless(self, expr, msg=None) Fail the test unless the expression is true. countTestCases(self) @@ -227,24 +118,38 @@ Args: defaultTestResult(self) -doCleanups(self) Execute all cleanup functions. Normally called for you after -tearDown. - fail(self, msg=None) Fail immediately, with the given message. -failIf = deprecated_func(*args, **kwargs) +failIf(self, expr, msg=None) Fail the test if the expression is true. -failIfAlmostEqual = deprecated_func(*args, **kwargs) +failIfAlmostEqual(self, first, second, places=7, msg=None) 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. + +Note that decimal places (from zero) are usually not the same +as significant digits (measured from the most signficant digit). -failIfEqual = deprecated_func(*args, **kwargs) +failIfEqual(self, first, second, msg=None) Fail if the two objects are equal as determined by the '==' +operator. -failUnless = deprecated_func(*args, **kwargs) +failUnless(self, expr, msg=None) Fail the test unless the expression is true. -failUnlessAlmostEqual = deprecated_func(*args, **kwargs) +failUnlessAlmostEqual(self, first, second, places=7, msg=None) 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. + +Note that decimal places (from zero) are usually not the same +as significant digits (measured from the most signficant digit). -failUnlessEqual = deprecated_func(*args, **kwargs) +failUnlessEqual(self, first, second, msg=None) Fail if the two objects are unequal as determined by the '==' +operator. -failUnlessRaises = deprecated_func(*args, **kwargs) +failUnlessRaises(self, excClass, callableObj, *args, **kwargs) Fail unless an exception of class excClass is thrown +by callableObj when invoked with arguments args and keyword +arguments kwargs. If a different type of exception is +thrown, it will not be caught, and the test case will be +deemed to have suffered an error, exactly as for an +unexpected exception. id(self) @@ -252,15 +157,11 @@ tearDown. setUp(self) Hook method for setting up the test fixture before exercising it. -shortDescription(self) Returns both the test method name and first line of its docstring. +shortDescription(self) Returns a one-line description of the test, or None if no +description has been provided. -If no docstring is given, only returns the method name. - -This method overrides unittest.TestCase.shortDescription(), which -only returns the first line of the docstring, obscuring the name -of the test upon failure. - -skipTest(self, reason) Skip this test. +The default implementation of this method returns the first line of +the specified test method's docstring. tearDown(self) Hook method for deconstructing the test fixture after testing it. @@ -274,9 +175,7 @@ Data descriptors inherited from unittest.TestCa Data and other attributes inherited from unittest.TestCase: -failureException = <class 'AssertionError'> Assertion failed. - -longMessage = False +failureException = <type 'exceptions.AssertionError'> Assertion failed.
\ No newline at end of file -- cgit 1.4.1-2-gfad0