feat: improve error messages for annotation issues in command parameters #1411
+23
−3
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
Reduce the length of the traceback and provide a helpful error message when a user forgets to import a type used in a command parameter annotation outside of a TYPE_CHECKING block.
shiftinv
reviewed
Oct 12, 2025
| except NameError as e: | ||
| raise NameError( | ||
| "Stringified params annotations must have their reference imported outside of a TYPE_CHECKING block: " | ||
| + e.args[0] |
There was a problem hiding this comment.
Suggested change
| + e.args[0] | |
| + str(e) |
Comment on lines
+313
to
+314
| "Could not expand parameters. Please check all annotations are imported outside of TYPE_CHECKING blocks. " | ||
| + e.args[0] |
There was a problem hiding this comment.
Suggested change
| "Could not expand parameters. Please check all annotations are imported outside of TYPE_CHECKING blocks. " | |
| + e.args[0] | |
| "Could not expand parameters. Please check all annotations are imported outside of TYPE_CHECKING blocks. Error: " | |
| + str(e) |
Comment on lines
+486
to
+487
| "Could not expand parameter options. Please check all annotations are imported outside of TYPE_CHECKING blocks. " | ||
| + e.args[0] |
There was a problem hiding this comment.
Suggested change
| "Could not expand parameter options. Please check all annotations are imported outside of TYPE_CHECKING blocks. " | |
| + e.args[0] | |
| "Could not expand parameter options. Please check all annotations are imported outside of TYPE_CHECKING blocks. Error: " | |
| + str(e) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Reduce the length of the traceback and provide a helpful error message
when a user forgets to import a type used in a command parameter annotation
outside of a TYPE_CHECKING block.