Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.4.x] Fix doctest collection of functools.cached_property objects. #11403

Merged
merged 2 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,7 @@ Tony Narlock
Tor Colvin
Trevor Bekolay
Tyler Goodlet
Tyler Smart
Tzu-ping Chung
Vasily Kuznetsov
Victor Maryama
Expand Down
1 change: 1 addition & 0 deletions changelog/11237.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix doctest collection of `functools.cached_property` objects.
18 changes: 18 additions & 0 deletions src/_pytest/doctest.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
"""Discover and run doctests in modules and test files."""
import bdb
import functools
import inspect
import os
import platform
Expand Down Expand Up @@ -536,6 +537,23 @@ def _find(
tests, obj, name, module, source_lines, globs, seen
)

if sys.version_info < (3, 13):

def _from_module(self, module, object):
"""`cached_property` objects are never considered a part
of the 'current module'. As such they are skipped by doctest.
Here we override `_from_module` to check the underlying
function instead. https://github.com/python/cpython/issues/107995
"""
if isinstance(object, functools.cached_property):
object = object.func

# Type ignored because this is a private function.
return super()._from_module(module, object) # type: ignore[misc]

else: # pragma: no cover
pass

if self.path.name == "conftest.py":
module = self.config.pluginmanager._importconftest(
self.path,
Expand Down
18 changes: 18 additions & 0 deletions testing/test_doctest.py
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,24 @@ def test_doctestmodule(self, pytester: Pytester):
reprec = pytester.inline_run(p, "--doctest-modules")
reprec.assertoutcome(failed=1)

def test_doctest_cached_property(self, pytester: Pytester):
p = pytester.makepyfile(
"""
import functools

class Foo:
@functools.cached_property
def foo(self):
'''
>>> assert False, "Tacos!"
'''
...
"""
)
result = pytester.runpytest(p, "--doctest-modules")
result.assert_outcomes(failed=1)
assert "Tacos!" in result.stdout.str()

def test_doctestmodule_external_and_issue116(self, pytester: Pytester):
p = pytester.mkpydir("hello")
p.joinpath("__init__.py").write_text(
Expand Down