index of compat.doctest [rev. unknown]

compat.doctest

Module doctest -- a framework for running examples in docstrings. In simplest use, end each module M to be tested with: def _test(): import doctest doctest.testmod() if __name__ == "__main__": _test() Then running the module as a script will cause the examples in the docstrings to get executed and verified: python M.py This won't display anything unless an example fails, in which case the failing example(s) and the cause(s) of the failure(s) are printed to stdout (why not stderr? because stderr is a lame hack <0.2 wink>), and the final line of output is "Test failed.". Run it with the -v switch instead: python M.py -v and a detailed report of all examples tried is printed to stdout, along with assorted summaries at the end. You can force verbose mode by passing "verbose=True" to testmod, or prohibit it by passing "verbose=False". In either of those cases, sys.argv is not examined by testmod. There are a variety of other ways to run doctests, including integration with the unittest framework, and support for running non-Python text files containing doctests. There are also many ways to override parts of doctest's default behaviors. See the Library Reference Manual for details.
DebugRunner
DocFileCase
DocFileSuite
DocFileTest
DocTest
DocTestCase
DocTestFailure
DocTestFinder
DocTestParser
DocTestRunner
DocTestSuite
Example
OutputChecker
Tester
UnexpectedException
debug
debug_script
debug_src
is_private
register_optionflag
run_docstring_examples
script_from_examples
set_unittest_reportflags
testfile
testmod
testsource