-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-85267: Improvements to inspect.signature __text_signature__ handling #98796
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
16ae02e
gh-85267: Improvements to inspect.signature __text_signature__ handling
hauntsaninja b60fb02
📜🤖 Added by blurb_it.
blurb-it[bot] dd2e08f
Update Lib/test/test_inspect.py
hauntsaninja ea41f40
Update Lib/test/test_inspect.py
hauntsaninja 7f9f257
another runtime error
hauntsaninja 126b8c3
add a comment
hauntsaninja fef9787
Merge branch 'main' into inspect-signature
JelleZijlstra File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2100,7 +2100,7 @@ def _signature_strip_non_python_syntax(signature): | |
self_parameter = None | ||
last_positional_only = None | ||
|
||
lines = [l.encode('ascii') for l in signature.split('\n')] | ||
lines = [l.encode('ascii') for l in signature.split('\n') if l] | ||
generator = iter(lines).__next__ | ||
token_stream = tokenize.tokenize(generator) | ||
|
||
|
@@ -2199,11 +2199,11 @@ def wrap_value(s): | |
try: | ||
value = eval(s, sys_module_dict) | ||
except NameError: | ||
raise RuntimeError() | ||
raise ValueError | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These now get caught on L2254 and acquire an error message there |
||
if isinstance(value, (str, int, float, bytes, bool, type(None))): | ||
return ast.Constant(value) | ||
raise RuntimeError() | ||
raise ValueError | ||
|
||
class RewriteSymbolics(ast.NodeTransformer): | ||
def visit_Attribute(self, node): | ||
|
@@ -2213,7 +2213,7 @@ def visit_Attribute(self, node): | |
a.append(n.attr) | ||
n = n.value | ||
if not isinstance(n, ast.Name): | ||
raise RuntimeError() | ||
raise ValueError | ||
a.append(n.id) | ||
value = ".".join(reversed(a)) | ||
return wrap_value(value) | ||
|
@@ -2223,14 +2223,29 @@ def visit_Name(self, node): | |
raise ValueError() | ||
return wrap_value(node.id) | ||
|
||
def visit_BinOp(self, node): | ||
hauntsaninja marked this conversation as resolved.
Show resolved
Hide resolved
|
||
# Support constant folding of a couple simple binary operations | ||
# commonly used to define default values in text signatures | ||
left = self.visit(node.left) | ||
right = self.visit(node.right) | ||
if not isinstance(left, ast.Constant) or not isinstance(right, ast.Constant): | ||
raise ValueError | ||
if isinstance(node.op, ast.Add): | ||
return ast.Constant(left.value + right.value) | ||
elif isinstance(node.op, ast.Sub): | ||
return ast.Constant(left.value - right.value) | ||
elif isinstance(node.op, ast.BitOr): | ||
return ast.Constant(left.value | right.value) | ||
raise ValueError | ||
|
||
def p(name_node, default_node, default=empty): | ||
name = parse_name(name_node) | ||
if default_node and default_node is not _empty: | ||
try: | ||
default_node = RewriteSymbolics().visit(default_node) | ||
default = ast.literal_eval(default_node) | ||
except ValueError: | ||
return None | ||
raise ValueError("{!r} builtin has invalid signature".format(obj)) from None | ||
parameters.append(Parameter(name, kind, default=default, annotation=empty)) | ||
|
||
# non-keyword-only parameters | ||
|
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
6 changes: 6 additions & 0 deletions
6
Misc/NEWS.d/next/Library/2022-10-28-07-24-34.gh-issue-85267.xUy_Wm.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Several improvements to :func:`inspect.signature`'s handling of ``__text_signature``. | ||
- Fixes a case where :func:`inspect.signature` dropped parameters | ||
- Fixes a case where :func:`inspect.signature` raised :exc:`tokenize.TokenError` | ||
- Allows :func:`inspect.signature` to understand defaults involving binary operations of constants | ||
- :func:`inspect.signature` is documented as only raising :exc:`TypeError` or :exc:`ValueError`, but sometimes raised :exc:`RuntimeError`. These cases now raise :exc:`ValueError` | ||
- Removed a dead code path |
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.
Uh oh!
There was an error while loading. Please reload this page.