gh-136914: Fix support of cached functions and properties in DocTest'… · python/cpython@fece15d · GitHub
Skip to content

Commit fece15d

Browse files
dlaxdlax
authored
gh-136914: Fix support of cached functions and properties in DocTest's lineno computation (GH-136930)
Previously, DocTest's lineno of functions and methods decorated with functools.cache(), functools.lru_cache() and functools.cached_property() was not properly returned (None was returned) because the computation relied on inspect.isfunction() which does not consider the decorated result as a function. We now use the more generic inspect.isroutine(), as elsewhere in doctest's logic. Also, added a special case for functools.cached_property().
1 parent d5e75c0 commit fece15d

4 files changed

Lines changed: 39 additions & 1 deletion

File tree

‎Lib/doctest.py‎

Lines changed: 4 additions & 1 deletion

‎Lib/test/test_doctest/doctest_lineno.py‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,32 @@ def property_with_doctest(self):
7676
@decorator
7777
def func_with_docstring_wrapped():
7878
"""Some unrelated info."""
79+
80+
81+
# https://github.com/python/cpython/issues/136914
82+
import functools
83+
84+
85+
@functools.cache
86+
def cached_func_with_doctest(value):
87+
"""
88+
>>> cached_func_with_doctest(1)
89+
-1
90+
"""
91+
return -value
92+
93+
94+
@functools.cache
95+
def cached_func_without_docstring(value):
96+
return value + 1
97+
98+
99+
class ClassWithACachedProperty:
100+
101+
@functools.cached_property
102+
def cached(self):
103+
"""
104+
>>> X().cached
105+
-1
106+
"""
107+
return 0

‎Lib/test/test_doctest/test_doctest.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -678,6 +678,8 @@ def basics(): r"""
678678
>>> for t in tests:
679679
... print('%5s %s' % (t.lineno, t.name))
680680
None test.test_doctest.doctest_lineno
681+
None test.test_doctest.doctest_lineno.ClassWithACachedProperty
682+
102 test.test_doctest.doctest_lineno.ClassWithACachedProperty.cached
681683
22 test.test_doctest.doctest_lineno.ClassWithDocstring
682684
30 test.test_doctest.doctest_lineno.ClassWithDoctest
683685
None test.test_doctest.doctest_lineno.ClassWithoutDocstring
@@ -687,6 +689,8 @@ def basics(): r"""
687689
45 test.test_doctest.doctest_lineno.MethodWrapper.method_with_doctest
688690
None test.test_doctest.doctest_lineno.MethodWrapper.method_without_docstring
689691
61 test.test_doctest.doctest_lineno.MethodWrapper.property_with_doctest
692+
86 test.test_doctest.doctest_lineno.cached_func_with_doctest
693+
None test.test_doctest.doctest_lineno.cached_func_without_docstring
690694
4 test.test_doctest.doctest_lineno.func_with_docstring
691695
77 test.test_doctest.doctest_lineno.func_with_docstring_wrapped
692696
12 test.test_doctest.doctest_lineno.func_with_doctest

‎Misc/NEWS.d/next/Library/2025-07-21-15-40-00.gh-issue-136914.-GNG-d.rst‎

Lines changed: 2 additions & 0 deletions

0 commit comments

Comments
 (0)