8000 bpo-35753: Fix crash in doctest with unwrap-able functions by splbio · Pull Request #22981 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

bpo-35753: Fix crash in doctest with unwrap-able functions #22981

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 5, 2021
Merged

bpo-35753: Fix crash in doctest with unwrap-able functions #22981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1e5031
bpo-35753: fix expected output for basics() 1/3
splbio Nov 22, 2020
5b83576
bpo-35753: fix doctest on unwrappables funcs 2/3
splbio Nov 22, 2020
81e0d99
bpo-35753: fix doctest on unwrappables funcs 3/3
splbio Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions Lib/doctest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,6 +976,17 @@ def _from_module(self, module, object):
else:
raise ValueError("object must be a class or function")

def _is_routine(self, obj):
"""
Safely unwrap objects and determine if they are functions.
"""
maybe_routine = obj
try:
maybe_routine = inspect.unwrap(maybe_routine)
except ValueError:
pass
return inspect.isroutine(maybe_routine)

def _find(self, tests, obj, name, module, source_lines, globs, seen):
"""
Find tests for the given object and any contained objects, and
Expand All @@ -998,9 +1009,9 @@ def _find(self, tests, obj, name, module, source_lines, globs, seen):
if inspect.ismodule(obj) and self._recurse:
for valname, val in obj.__dict__.items():
valname = '%s.%s' % (name, valname)

# Recurse to functions & classes.
if ((inspect.isroutine(inspect.unwrap(val))
or inspect.isclass(val)) and
if ((self._is_routine(val) or inspect.isclass(val)) and
self._from_module(module, val)):
self._find(tests, val, valname, module, source_lines,
globs, seen)
Expand Down
15 changes: 14 additions & 1 deletion Lib/test/test_doctest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import unittest
import tempfile
import shutil
import types
import contextlib

# NOTE: There are some additional tests relating to interaction with
Expand Down Expand Up @@ -443,7 +444,7 @@ def basics(): r"""
>>> tests = finder.find(sample_func)

>>> print(tests) # doctest: +ELLIPSIS
[<DocTest sample_func from ...:27 (1 example)>]
[<DocTest sample_func from test_doctest.py:28 (1 example)>]

The exact name depends on how test_doctest was invoked, so allow for
leading path components.
Expand Down Expand Up @@ -698,6 +699,18 @@ def non_Python_modules(): r"""

class TestDocTestFinder(unittest.TestCase):

def test_issue35753(self):
# This import of `call` should trigger issue35753 when
# `support.run_doctest` is called due to unwrap failing,
# however with a patched doctest this should succeed.
from unittest.mock import call
dummy_module = types.ModuleType("dummy")
dummy_module.__dict__['inject_call'] = call
try:
support.run_doctest(dummy_module, verbosity=True)
except ValueError as e:
raise support.TestFailed("Doctest unwrap failed") from e

def test_empty_namespace_package(self):
pkg_name = 'doctest_empty_pkg'
with tempfile.TemporaryDirectory() as parent_dir:
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Tests/2020-10-25-19-20-26.bpo-35753.2LT-hO.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix crash in doctest when doctest parses modules that include unwrappable
functions by skipping those functions.
0