mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-31 05:58:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Added new parameter exclude_empty to DocTestFinder.__init__, which

Browse source 
controls whether tests are included for objects with empty docstrings.
Defaults to True, to match the behavior of Python 2.3.
This commit is contained in:
Edward Loper 2004-09-13 05:47:24 +00:00
parent c56847878e
commit 32ddbf7fab
2 changed files with 34 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

22
Lib/doctest.py
View file

@ -848,7 +848,8 @@ class DocTestFinder:
"""
def __init__(self, verbose=False, parser=DocTestParser(),
recurse=True, _namefilter=None):
recurse=True, _namefilter=None,
exclude_empty=False):
"""
Create a new doctest finder.
@ -860,10 +861,14 @@ 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.
"""
self._parser = parser
self._verbose = verbose
self._recurse = recurse
self._exclude_empty = exclude_empty
# _namefilter is undocumented, and exists only for temporary backward-
# compatibility support of testmod's deprecated isprivate mess.
self._namefilter = _namefilter
@ -1055,18 +1060,19 @@ class DocTestFinder:
else:
try:
if obj.__doc__ is None:
return None
docstring = str(obj.__doc__)
docstring = ''
else:
docstring = str(obj.__doc__)
except (TypeError, AttributeError):
return None
# Don't bother if the docstring is empty.
if not docstring:
return None
docstring = ''
# Find the docstring's location in the file.
lineno = self._find_lineno(obj, source_lines)
# Don't bother if the docstring is empty.
if self._exclude_empty and not docstring:
return None
# Return a DocTest for this object.
if module is None:
filename = None