[3.8] bpo-35753: Fix crash in doctest with unwrap-able functions#22834
Closed
splbio wants to merge 1 commit into
Closed
[3.8] bpo-35753: Fix crash in doctest with unwrap-able functions#22834splbio wants to merge 1 commit into
splbio wants to merge 1 commit into
Conversation
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.
splbio
force-pushed
the
fix-issue-35753-doctest-unwrap-3-8
branch
from
October 26, 2020 03:12
cbe1707 to
3b6a384
Compare
|
This PR is stale because it has been open for 30 days with no activity. Remove stale label or comment or this will be closed in 5 days |
Contributor
Author
|
will wait for #22981 to be accepted. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doctest needs to Ignore objects that inspect.unwrap throws ValueError due to "infinite" nesting.
This case is relatively commonly reproduced by importing unittest.mock.call into a module's namespace.
The following code produces a module that will crash doctest:
This is due to the call to unwrap throwing an uncaught ValueError.
For this case we can simply ignore the function and not attempt to extract docstring from this function.
This diff is intentionally done as a branch with two commits to provide failing test case and then a fix to show the problem is contained.
Future thoughts:
idsome objects so that future objects that cause problems with doctest can be passed in to ignore?Note: This branch diff will need to be pulled up into 3.9 and master as the bug exists in those branches as well.
https://bugs.python.org/issue35753