change doctest DocTestSuite not to raise ValueError if no docstrings

[cjerdonek]

BPO	15916
Nosy	@ezio-melotti, @bitdancer, @asvetlov, @cjerdonek, @akheron
Files	issue15916.patch issue15916-no-exception.patch issue15916-with-docs.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-04-15.00:29:46.123>
created_at = <Date 2012-09-10.23:54:54.491>
labels = ['easy', 'type-bug', 'library']
title = 'change doctest DocTestSuite not to raise ValueError if no docstrings'
updated_at = <Date 2014-04-15.00:29:46.110>
user = 'https://github.com/cjerdonek'

bugs.python.org fields:

activity = <Date 2014-04-15.00:29:46.110>
actor = 'r.david.murray'
assignee = 'none'
closed = True
closed_date = <Date 2014-04-15.00:29:46.123>
closer = 'r.david.murray'
components = ['Library (Lib)']
creation = <Date 2012-09-10.23:54:54.491>
creator = 'chris.jerdonek'
dependencies = []
files = ['27673', '34829', '34848']
hgrepos = []
issue_num = 15916
keywords = ['patch', 'easy']
message_count = 8.0
messages = ['170250', '173597', '173632', '216145', '216169', '216211', '216255', '216256']
nosy_count = 8.0
nosy_names = ['ezio.melotti', 'r.david.murray', 'asvetlov', 'chris.jerdonek', 'python-dev', 'petri.lehtinen', 'tuukka', 'Glenn.Jones']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue15916'
versions = ['Python 3.4']

[cjerdonek]

Currently, calling doctest.DocTestSuite() raises a ValueError if the module passed to it has no docstrings. This was the subject of bpo-14649.

This issue is to discuss and possibly change DocTestSuite's behavior not to raise an exception in that situation.

In the discussion for bpo-14649 (in particular with R. David Murray), it was acknowledged that the current behavior probably isn't correct or desirable. However, treating the behavior as a bug and fixing it in maintenance branches would have been too big of a change.

Thus, if this change is made, it could be slated for the next feature release.

[tuukka]

I'm attaching a patch that changes DocTestSuite's default behaviour as suggested.

[cjerdonek]

Hmm. This patch still raises the "has no docstrings" ValueError if "not tests" is True. And because the patch changes the default DocTestFinder, it's possible that the patch changes behavior in non-error use cases.

Why not just return an empty TestSuite if not tests is True? IIRC, this was the conclusion of the bpo-14649 discussion.

[GlennJones]

I've attached a patch that uses the original default DocTestFinder and does not raise an exception when there are no tests.

[bitdancer]

This looks good, however we also need a documentation change indicating the new behavior, including a '.. versionchanged:: 3.5' tag, and an entry in whatsnew/3.5 in the 'other changes' section.

[GlennJones]

Added docs to patch

[python-dev]

New changeset 57fb5441a4aa by R David Murray in branch 'default':
bpo-15916: if there are no docstrings, make empty suite, not an error.
http://hg.python.org/cpython/rev/57fb5441a4aa

[bitdancer]

Thanks, Glenn.