bpo-35753: fix doctest on unwrappables funcs 2/2

splbio · splbio · commit cbe1707dfe6d · 2020-10-20T11:40:56.000-07:00
Summary:

Ignore objects that inspect.unwrap throws due to
too many wrappers.  This is a very rare case, however
it can easily be surfaced when a module under doctest
imports unitest.mock.call into its namespace.

This commit adds the fix to the module.

We simply skip any object that throws this exception.

This should handle the majority of cases.

Future thoughts:
1. Should catching this be optional defaulting to true,
but allowing for folks to rethrow the exception to insist
on truly clean code?
2. Should we break out _find() into more sub functions sp
that we can more easily derive our own versions for each
sub function that _find does making it easier to fix
future issues?
3. Should we include a way to denylist by `id` some
objects so that future objects that cause problems
with doctest can be passed in to ignore?

Test Plan:

Reviewers:
diff --git a/Lib/doctest.py b/Lib/doctest.py
@@ -994,9 +994,19 @@ 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)
+
+                # protect against objects that cause unwrap to believe there
+                # is a cycle.
+                # example: https://bugs.python.org/issue35753
+                # how to trigger:
+                #   from unittest.mock import call
+                isroutine = False
+                try:
+                    isroutine = inspect.isroutine(inspect.unwrap(val))
+                except ValueError:
+                    pass
                 # Recurse to functions & classes.
-                if ((inspect.isroutine(inspect.unwrap(val))
-                     or inspect.isclass(val)) and
+                if ((isroutine or inspect.isclass(val)) and
                     self._from_module(module, val)):
                     self._find(tests, val, valname, module, source_lines,
                                globs, seen)
