diff options
| -rw-r--r-- | Lib/doctest.py | 14 | ||||
| -rw-r--r-- | Lib/test/test_doctest.py | 27 |
2 files changed, 27 insertions, 14 deletions
diff --git a/Lib/doctest.py b/Lib/doctest.py index 156ef57..c1a87b3 100644 --- a/Lib/doctest.py +++ b/Lib/doctest.py @@ -848,8 +848,7 @@ class DocTestFinder: """ def __init__(self, verbose=False, parser=DocTestParser(), - recurse=True, _namefilter=None, - exclude_empty=False): + recurse=True, _namefilter=None, exclude_empty=True): """ Create a new doctest finder. @@ -862,8 +861,8 @@ class DocTestFinder: If the optional argument `recurse` is false, then `find` will only examine the given object, and not any contained objects. - If the optional argument `exclude_empty` is true, then `find` - will exclude tests for objects with empty docstrings. + If the optional argument `exclude_empty` is false, then `find` + will include tests for objects with empty docstrings. """ self._parser = parser self._verbose = verbose @@ -1836,9 +1835,10 @@ master = None def testmod(m=None, name=None, globs=None, verbose=None, isprivate=None, report=True, optionflags=0, extraglobs=None, - raise_on_error=False): + raise_on_error=False, exclude_empty=False): """m=None, name=None, globs=None, verbose=None, isprivate=None, - report=True, optionflags=0, extraglobs=None + report=True, optionflags=0, extraglobs=None, raise_on_error=False, + exclude_empty=False Test examples in docstrings in functions and classes reachable from module m (or the current module if m is not supplied), starting @@ -1930,7 +1930,7 @@ def testmod(m=None, name=None, globs=None, verbose=None, isprivate=None, name = m.__name__ # Find, parse, and run all tests in the given module. - finder = DocTestFinder(_namefilter=isprivate) + finder = DocTestFinder(_namefilter=isprivate, exclude_empty=exclude_empty) if raise_on_error: runner = DebugRunner(verbose=verbose, optionflags=optionflags) diff --git a/Lib/test/test_doctest.py b/Lib/test/test_doctest.py index a304f5c..77b9ef5 100644 --- a/Lib/test/test_doctest.py +++ b/Lib/test/test_doctest.py @@ -377,8 +377,8 @@ By default, tests are created for objects with no docstring: >>> def no_docstring(v): ... pass - >>> finder.find(no_docstring) # doctest: +ELLIPSIS - [<DocTest no_docstring from ... (no examples)>] + >>> finder.find(no_docstring) + [] However, the optional argument `exclude_empty` to the DocTestFinder constructor can be used to exclude tests for objects with empty @@ -414,8 +414,6 @@ methods, classmethods, staticmethods, properties, and nested classes. 1 SampleClass 3 SampleClass.NestedClass 1 SampleClass.NestedClass.__init__ - 0 SampleClass.NestedClass.get - 0 SampleClass.NestedClass.square 1 SampleClass.__init__ 2 SampleClass.a_classmethod 1 SampleClass.a_property @@ -473,8 +471,6 @@ functions, classes, and the `__test__` dictionary, if it exists: 1 some_module.SampleClass 3 some_module.SampleClass.NestedClass 1 some_module.SampleClass.NestedClass.__init__ - 0 some_module.SampleClass.NestedClass.get - 0 some_module.SampleClass.NestedClass.square 1 some_module.SampleClass.__init__ 2 some_module.SampleClass.a_classmethod 1 some_module.SampleClass.a_property @@ -520,6 +516,23 @@ deprecated isprivate gimmick. 1 SampleClass 3 SampleClass.NestedClass 1 SampleClass.NestedClass.__init__ + 1 SampleClass.__init__ + 1 SampleClass.double + 1 SampleClass.get + +By default, that excluded objects with no doctests. exclude_empty=False +tells it to include (empty) tests for objects with no doctests. This feature +is really to support backward compatibility in what doctest.master.summarize() +displays. + + >>> tests = doctest.DocTestFinder(_namefilter=namefilter, + ... exclude_empty=False).find(SampleClass) + >>> tests.sort() + >>> for t in tests: + ... print '%2s %s' % (len(t.examples), t.name) + 1 SampleClass + 3 SampleClass.NestedClass + 1 SampleClass.NestedClass.__init__ 0 SampleClass.NestedClass.get 0 SampleClass.NestedClass.square 1 SampleClass.__init__ @@ -550,7 +563,7 @@ object explicitly passed to DocTestFinder: ... return base == 'SampleClass' >>> tests = doctest.DocTestFinder(_namefilter=namefilter).find(SampleClass) >>> len(tests) - 11 + 9 Turning off Recursion ~~~~~~~~~~~~~~~~~~~~~ |