bpo-17446: Get line numbers of properties in doctest

python · mscuthbert · Sep 7, 2017 · Sep 7, 2017 · Sep 7, 2017 · Sep 7, 2017
commit c0c4d6cae8dab59fe1766cad9d2a700dd789aa50
diff --git a/Lib/doctest.py b/Lib/doctest.py
@@ -1096,6 +1096,12 @@ def _find_lineno(self, obj, source_lines):
         if inspect.isframe(obj): obj = obj.f_code
         if inspect.iscode(obj):
             lineno = getattr(obj, 'co_firstlineno', None)-1
+        if lineno is None and isinstance(obj, property) \
+                and obj.fget is not None \
+                and hasattr(obj.fget, "__code__"):
+            obj = obj.fget.__code__
+            # no need to subtract 1 because of decorator line
+            lineno = getattr(obj, 'co_firstlineno', None)
 
         # Find the line number where the docstring starts.  Assume
         # that it's the first line that begins with a quote mark.

diff --git a/Lib/test/test_doctest.py b/Lib/test/test_doctest.py
@@ -646,6 +646,23 @@ def basics(): r"""
     >>> test = doctest.DocTestFinder().find(f)[0]
     >>> [e.lineno for e in test.examples]
     [1, 9, 12]
+
+
+Line numbers of properties
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+DocTestFinder finds the line numbers of each propery example
+
+    >>> @property
+    ... def foo(x):
+    ...     '''
+    ...     >>> 1/1
+    ...     1
+    ...     >>> 41 + 1
+    ...     42
+    ...     '''
+    >>> test = doctest.DocTestFinder().find(foo, "foo")[0]
+    >>> [e.lineno for e in test.examples]
+    [1, 3]
 """
 
     if int.__doc__: # simple check for --without-doc-strings, skip if lacking