Stubtest: add a hint when arguments in the stub need to be keyword-only#16210
Merged
hauntsaninja merged 1 commit intopython:masterfrom Oct 1, 2023
Merged
Stubtest: add a hint when arguments in the stub need to be keyword-only#16210hauntsaninja merged 1 commit intopython:masterfrom
hauntsaninja merged 1 commit intopython:masterfrom
Conversation
JelleZijlstra
approved these changes
Oct 1, 2023
Member
JelleZijlstra
left a comment
There was a problem hiding this comment.
Your example doesn't seem all that contrived, this is a good addition.
Member
Author
|
(The real-life example is python/typeshed#10815. The stubtest errors on the first commit in that PR were these -- 42 errors due to two missing |
hauntsaninja
approved these changes
Oct 1, 2023
Collaborator
|
Nice, thank you! |
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.
Something I've seen come up several times in typeshed is that a runtime library will have a class similar to this (which is contrived, but you hopefully see the point):
Somebody will then come along and try to write stubs for this class like this, which is nearly correct, except that all the arguments need to be keyword-only:
Stubtest then (correctly!) gets very angry and reports three errors for this function. However, none of the error messages tells the author of the stub that the arguments all need to be made keyword-only:
With this PR, stubtest instead emits the following error messages if the runtime has a
**kwargsvariadic keyword argument: