From 94cb60a6bde75a385c6ad9afbae2c8e738fdc0a0 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 25 Dec 2009 21:55:36 +0100 Subject: moved pydoc pages to doc/pydoc --- doc/test.tc_displayable.html | 551 ------------------------------------------- 1 file changed, 551 deletions(-) delete mode 100644 doc/test.tc_displayable.html (limited to 'doc/test.tc_displayable.html') diff --git a/doc/test.tc_displayable.html b/doc/test.tc_displayable.html deleted file mode 100644 index a1ebcf89..00000000 --- a/doc/test.tc_displayable.html +++ /dev/null @@ -1,551 +0,0 @@ - -Python: module test.tc_displayable - - - - - -
 
- 
test.tc_displayable
index
/home/hut/work/ranger/test/tc_displayable.py
-

-

- - - - - -
 
-Modules
       
curses
-
unittest
-

- - - - - -
 
-Classes
       
-
unittest.TestCase(builtins.object) -
-
-
TestDisplayable -
TestDisplayableContainer -
-
-
-

- - - - - -
 
-class TestDisplayable(unittest.TestCase)
    
Method resolution order:
-
TestDisplayable
-
unittest.TestCase
-
builtins.object
-
-
-Methods defined here:
-
setUp(self)
- -
tearDown(self)
- -
test_boundaries(self)
- -
test_colorscheme(self)
- -
-Methods inherited from unittest.TestCase:
-
__call__(self, *args, **kwds)
- -
__eq__(self, other)
- -
__hash__(self)
- -
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
-method when executed. Raises a ValueError if the instance does
-not have a method with the specified name.
- -
__ne__(self, other)
- -
__repr__(self)
- -
__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
-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
-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 '=='
-operator.
- -
assertEquals = assertEqual(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.
- -
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
-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
-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 '=='
-operator.
- -
assertNotEquals = assertNotEqual(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
-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.
- -
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.
- -
assert_ = assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
- -
countTestCases(self)
- -
debug(self)
Run the test without collecting errors in a TestResult
- -
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)
- -
failIfAlmostEqual = deprecated_func(*args, **kwargs)
- -
failIfEqual = deprecated_func(*args, **kwargs)
- -
failUnless = deprecated_func(*args, **kwargs)
- -
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
- -
failUnlessEqual = deprecated_func(*args, **kwargs)
- -
failUnlessRaises = deprecated_func(*args, **kwargs)
- -
id(self)
- -
run(self, result=None)
- -
shortDescription(self)
Returns both the test method name and first line of its docstring.

-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.
- -
-Data descriptors inherited from unittest.TestCase:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes inherited from unittest.TestCase:
-
failureException = <class 'AssertionError'>
Assertion failed.
- -
longMessage = False
- -

- - - - - -
 
-class TestDisplayableContainer(unittest.TestCase)
    
Method resolution order:
-
TestDisplayableContainer
-
unittest.TestCase
-
builtins.object
-
-
-Methods defined here:
-
setUp(self)
- -
tearDown(self)
- -
test_click(self)
- -
test_container(self)
- -
test_focused_object(self)
- -
-Methods inherited from unittest.TestCase:
-
__call__(self, *args, **kwds)
- -
__eq__(self, other)
- -
__hash__(self)
- -
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
-method when executed. Raises a ValueError if the instance does
-not have a method with the specified name.
- -
__ne__(self, other)
- -
__repr__(self)
- -
__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
-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
-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 '=='
-operator.
- -
assertEquals = assertEqual(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.
- -
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
-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
-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 '=='
-operator.
- -
assertNotEquals = assertNotEqual(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
-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.
- -
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.
- -
assert_ = assertTrue(self, expr, msg=None)
Fail the test unless the expression is true.
- -
countTestCases(self)
- -
debug(self)
Run the test without collecting errors in a TestResult
- -
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)
- -
failIfAlmostEqual = deprecated_func(*args, **kwargs)
- -
failIfEqual = deprecated_func(*args, **kwargs)
- -
failUnless = deprecated_func(*args, **kwargs)
- -
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
- -
failUnlessEqual = deprecated_func(*args, **kwargs)
- -
failUnlessRaises = deprecated_func(*args, **kwargs)
- -
id(self)
- -
run(self, result=None)
- -
shortDescription(self)
Returns both the test method name and first line of its docstring.

-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.
- -
-Data descriptors inherited from unittest.TestCase:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes inherited from unittest.TestCase:
-
failureException = <class 'AssertionError'>
Assertion failed.
- -
longMessage = False
- -

- \ No newline at end of file -- cgit 1.4.1-2-gfad0