[3.11] gh-85267: Improvements to inspect.signature __text_signature__ handling (GH-98796)#100392
Merged
JelleZijlstra merged 1 commit intopython:3.11from Dec 21, 2022
Merged
Conversation
…ture__ handling (pythonGH-98796) This makes a couple related changes to inspect.signature's behaviour when parsing a signature from `__text_signature__`. First, `inspect.signature` is documented as only raising ValueError or TypeError. However, in some cases, we could raise RuntimeError. This PR changes that, thereby fixing pythonGH-83685. (Note that the new ValueErrors in RewriteSymbolics are caught and then reraised with a message) Second, `inspect.signature` could randomly drop parameters that it didn't understand (corresponding to `return None` in the `p` function). This is the core issue in pythonGH-85267. I think this is very surprising behaviour and it seems better to fail outright. Third, adding this new failure broke a couple tests. To fix them (and to e.g. allow `inspect.signature(select.epoll.register)` as in pythonGH-85267), I add constant folding of a couple binary operations to RewriteSymbolics. (There's some discussion of making signature expression evaluation arbitrary powerful in pythonGH-68155. I think that's out of scope. The additional constant folding here is pretty straightforward, useful, and not much of a slippery slope) Fourth, while pythonGH-85267 is incorrect about the cause of the issue, it turns out if you had consecutive newlines in __text_signature__, you'd get `tokenize.TokenError`. Finally, the `if name is invalid:` code path was dead, since `parse_name` never returned `invalid`.. (cherry picked from commit 79311cb) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
This was referenced Dec 21, 2022
JelleZijlstra
approved these changes
Dec 21, 2022
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.
This makes a couple related changes to inspect.signature's behaviour when parsing a signature from
__text_signature__.First,
inspect.signatureis documented as only raising ValueError or TypeError. However, in some cases, we could raise RuntimeError. This PR changes that, thereby fixing GH-83685.(Note that the new ValueErrors in RewriteSymbolics are caught and then reraised with a message)
Second,
inspect.signaturecould randomly drop parameters that it didn't understand (corresponding toreturn Nonein thepfunction). This is the core issue in GH-85267. I think this is very surprising behaviour and it seems better to fail outright.Third, adding this new failure broke a couple tests. To fix them (and to e.g. allow
inspect.signature(select.epoll.register)as in GH-85267), I add constant folding of a couple binary operations to RewriteSymbolics.(There's some discussion of making signature expression evaluation arbitrary powerful in GH-68155. I think that's out of scope. The additional constant folding here is pretty straightforward, useful, and not much of a slippery slope)
Fourth, while GH-85267 is incorrect about the cause of the issue, it turns out if you had consecutive newlines in text_signature, you'd get
tokenize.TokenError.Finally, the
if name is invalid:code path was dead, sinceparse_namenever returnedinvalid..(cherry picked from commit 79311cb)
Co-authored-by: Shantanu 12621235+hauntsaninja@users.noreply.github.com