[verbose][, parser][, recurse][, exclude_empty]) |
The optional argument verbose can be used to display the
objects searched by the finder. It defaults to False
(no
output).
The optional argument parser specifies the DocTestParser object (or a drop-in replacement) that is used to extract doctests from docstrings.
If the optional argument recurse is false, then DocTestFinder.find() will only examine the given object, and not any contained objects.
If the optional argument exclude_empty is false, then DocTestFinder.find() will include tests for objects with empty docstrings.
New in version 2.4.
DocTestFinder defines the following method:
obj[, name][, module][, globs][, extraglobs]) |
The optional argument name specifies the object's name; this
name will be used to construct names for the returned
DocTests. If name is not specified, then
obj.__name__
is used.
The optional parameter module is the module that contains the given object. If the module is not specified or is None, then the test finder will attempt to automatically determine the correct module. The object's module is used:
If module is False
, no attempt to find the module
will be made. This is obscure, of use mostly in testing doctest
itself: if module is False
, or is None
but
cannot be found automatically, then all objects are considered to
belong to the (non-existent) module, so all contained objects will
(recursively) be searched for doctests.
The globals for each DocTest is formed by combining
globs and extraglobs (bindings in extraglobs
override bindings in globs). A new shallow copy of the globals
dictionary is created for each DocTest. If globs is
not specified, then it defaults to the module's __dict__, if
specified, or {}
otherwise. If extraglobs is not
specified, then it defaults to {}
.
See About this document... for information on suggesting changes.