Fix SyntaxError in DispMethodAnnotator signature generation.
#887
Conversation
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
The `DispMethodAnnotator` was generating syntactically invalid method signatures for dispmethods in two specific scenarios, leading to `SyntaxError` when the generated type hint files were used. First, when a method signature required `**kwargs` due to optional arguments being followed by non-optional ones, the generated hint was `def method(..., **kwargs: hints.Any, /)`. This is invalid syntax. Second, when a method had an argument name that is a Python keyword, the annotator would fall back to `*args: hints.Any, **kwargs: hints.Any`, but would still incorrectly append a final `/`. This commit corrects the logic in `DispMethodAnnotator.getvalue` to properly handle the placement of the positional-only marker (`/`): - The marker is now placed before `**kwargs` when present. - The marker is omitted entirely when `*args` is in the signature, as a trailing slash is not valid in that context. The test case in `test_typeannotator.py` has been updated to reflect and verify these corrections.
The logic in `DispMethodAnnotator.getvalue` for placing the positional-only argument marker (`/`) was complex. It involved several conditional checks after the main argument list had been constructed. This commit refactors the method to integrate the marker placement directly into the `inargs` construction loop.
junkmd
added
bug
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #887 +/- ##
=======================================
Coverage 85.00% 85.00%
=======================================
Files 126 126
Lines 11695 11698 +3
=======================================
+ Hits 9941 9944 +3
Misses 1754 1754 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 pull request addresses a regression introduced in #885, where enforcing positional-only arguments for dispmethods led to
SyntaxErrorin some generated type hints. This issue was discovered during Excel testing, which revealed cases where the generated code was syntactically invalid.The
DispMethodAnnotatorwould incorrectly generate signatures likedef method(..., **kwargs, /)ordef method(..., *args, **kwargs, /), both of which are invalid Python.This PR includes two main changes:
DispMethodAnnotatorto correctly place the positional-only marker (/) before**kwargsand to omit it entirely when*argsis present.