gh-136914: Use inspect.isroutine() in DocTest's lineno computation #136930
Conversation
Previously, DocTest's lineno of `functools.cache()`-decorated functions was not properly returned (None was returned) because the underlying computation, in `DocTest._find_lineno()`, 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, thus fixing lineno computation for functools.cache()-decorated functions.
dlax
force-pushed
the
doctest-lineno-isroutine
branch
from
b1e3185 to
ddf3ab1
Compare
serhiy-storchaka
added
needs backport to 3.13
| import functools | ||
|
|
||
|
|
||
| @functools.cache |
There was a problem hiding this comment.
I'd suggest using a custom class decorator here instead of functools.cache. We don't want this to depend on the implementation details of functools.cache, which could change in the future.
There was a problem hiding this comment.
I think that this may add unnecessary complexity to the tests. And such test will not guarantee that the code works also for functools.cached, which is a comon case. Other tests just test common cases.
| @@ -0,0 +1 @@ | |||
| Fix retrieval of :attr:`doctest.DocTest.lineno` for :func:`functools.cache`-decorated functions. | |||
There was a problem hiding this comment.
Likewise, I'd suggest wording this more generally -- this affects any class decorator that uses functools.update_wrapper, not just functools.cache
Apparently not; should I make it work in the scope of this PR? |
|
If this is easy, why not? Otherwise this can be a separate PR. |
|
Added a commit to handle |
dlax
force-pushed
the
doctest-lineno-isroutine
branch
from
168503c to
553fb13
Compare
Previously, DocTest's lineno of
functools.cache()-decorated functions was not properly returned (None was returned) because the underlying computation, inDocTest._find_lineno(), relied oninspect.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, thus fixing lineno computation for functools.cache()-decorated functions.