This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: doctest.DocTestFinder reports incorrect line numbers with exclude_empty=False
Type: behavior Stage: patch review
Components: Library (Lib) Versions: Python 3.11, Python 3.10, Python 3.9
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: cpitclaudel, kumaraditya, sobolevn, xtreak
Priority: normal Keywords: patch

Created on 2016-09-22 15:32 by cpitclaudel, last changed 2022-04-11 14:58 by admin.

File name Uploaded Description Edit cpitclaudel, 2016-09-22 15:32
Pull Requests
URL Status Linked Edit
PR 30498 open sobolevn, 2022-01-09 11:37
Messages (1)
msg277230 - (view) Author: Clément (cpitclaudel) Date: 2016-09-22 15:32
Line numbers reported by the doctest module are wrong when a function does not include a docstring.  With the attached example file, running

    python -c "import doctest, example; print(doctest.DocTestFinder(exclude_empty=False).find(example))"


    [<DocTest example from (no examples)>,
     <DocTest example.a from (no examples)>,
     <DocTest example.b from (no examples)>,
     <DocTest example.c from (no examples)>]

whereas if one uncomments the docstrings of a and c the output is

    [<DocTest example from (no examples)>,
     <DocTest example.a from (no examples)>,
     <DocTest example.b from (no examples)>,
     <DocTest example.c from (no examples)>]

This bug is due to this line in doctest:

    lineno = self._find_lineno(obj, source_lines)

The documentation of _find_lineno says this:

    def _find_lineno(self, obj, source_lines):
        Return a line number of the given object's docstring.  Note:
        this method assumes that the object has a docstring.

This assumption is violated by the call listed above, because of the exclude_empty=False parameter to DocTestFinder().

I guess lineno should just be None for all methods that do not have a docstring?
Date User Action Args
2022-04-11 14:58:37adminsetgithub: 72436
2022-01-09 11:39:50kumaradityasetnosy: + kumaraditya

type: behavior
versions: + Python 3.9, Python 3.10, Python 3.11, - Python 2.7, Python 3.5
2022-01-09 11:37:06sobolevnsetkeywords: + patch
nosy: + sobolevn

pull_requests: + pull_request28704
stage: patch review
2019-12-10 15:25:39xtreaksetnosy: + xtreak
2016-09-22 15:32:20cpitclaudelcreate