Trees | Index | Help |
|
---|
Package zope :: Package testing :: Module doctest :: Class DocTestRunner |
|
DebugRunner
A class used to run DocTest test cases, and accumulate statistics.
The run
method is used to process a single DocTest case. It
returns a tuple (f, t)
, where t
is the number of test cases
tried, and f
is the number of test cases that failed.
>>> tests = DocTestFinder().find(_TestClass) >>> runner = DocTestRunner(verbose=False) >>> for test in tests: ... print runner.run(test) (0, 2) (0, 1) (0, 2) (0, 2)
The summarize
method prints a summary of all the test cases that
have been run by the runner, and returns an aggregated (f, t)
tuple:
>>> runner.summarize(verbose=1) 4 items passed all tests: 2 tests in _TestClass 2 tests in _TestClass.__init__ 2 tests in _TestClass.get 1 tests in _TestClass.square 7 tests in 4 items. 7 passed and 0 failed. Test passed. (0, 7)
The aggregated number of tried examples and failed examples is
also available via the tries
and failures
attributes:
>>> runner.tries 7 >>> runner.failures 0
The comparison between expected outputs and actual outputs is done
by an OutputChecker
. This comparison may be customized with a
number of option flags; see the documentation for testmod
for
more information. If the option flags are insufficient, then the
comparison may also be customized by passing a subclass of
OutputChecker
to the constructor.
The test runner's display output can be controlled in two ways.
First, an output function (out) can be passed to
`TestRunner.run
; this function will be called with strings that
should be displayed. It defaults to sys.stdout.write
. If
capturing the output is not sufficient, then the display output
can be also customized by subclassing DocTestRunner, and
overriding the methods report_start
, report_success
,
report_unexpected_exception
, and report_failure
.
Method Summary | |
---|---|
Create a new test runner. | |
merge(self,
other)
| |
Report that the given example failed. | |
Report that the test runner is about to process the given example. | |
Report that the given example ran successfully. | |
Report that the given example raised an unexpected exception. | |
Run the examples in test , and display the results using the
writer function out . | |
Print a summary of all the test cases that have been run by this DocTestRunner, and return a tuple (f, t) , where f is
the total number of failed examples, and t is the total
number of tried examples. | |
__patched_linecache_getlines(self,
filename)
| |
Record the fact that the given DocTest ( test ) generated f
failures out of t tried examples. | |
Run the examples in test . | |
_failure_header(self,
test,
example)
|
Class Variable Summary | |
---|---|
str |
DIVIDER = '*********************************************...
|
SRE_Pattern |
_DocTestRunner__LINECACHE_FILENAME_RE = <doctest ([\w\.]...
|
Method Details |
---|
__init__(self,
checker=None,
verbose=None,
optionflags=0)
|
report_failure(self, out, test, example, got)Report that the given example failed. |
report_start(self, out, test, example)Report that the test runner is about to process the given example. (Only displays a message if verbose=True) |
report_success(self, out, test, example, got)Report that the given example ran successfully. (Only displays a message if verbose=True) |
report_unexpected_exception(self, out, test, example, exc_info)Report that the given example raised an unexpected exception. |
run(self, test, compileflags=None, out=None, clear_globs=True)Run the examples in The examples are run in the namespace
The output of each example is checked using
|
summarize(self, verbose=None)Print a summary of all the test cases that have been run by
this DocTestRunner, and return a tuple The optional |
__record_outcome(self, test, f, t)Record the fact that the given DocTest ( |
__run(self, test, compileflags, out)Run the examples in |
Class Variable Details |
---|
DIVIDER
|
_DocTestRunner__LINECACHE_FILENAME_RE
|
Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Fri Jun 24 12:01:20 2005 | http://epydoc.sf.net |