Static typing improvements in click.shell_completion#3460
Open
jorenham wants to merge 1 commit into
Open
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
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.
As promised in #3455, this improves several (static) types in
click.shell_completion:shell_completenarrowed return typeCompletionItemnow has an optional (defaulting toAnyfor backcompat) generic type parameter for its.value. I did not update the other modules to use this type parameter to avoid merge conflicts, but because of thedefault=Anythere's no downside to this.ShellComplete.source_varsnow returns a typed dictadd_completion_classis now parametrized on theclsinstance type instead of the type type, so that it's easier to see by looking at the annotations thatclsis supposed to be a type rather than an instance. If I remember correctly, now all type checkers support using it as class decorator otherwise, but don't quote me on this.get_completion_classnow has overloads for the builtin shell completion strings, so thatget_completion_class("zsh")will now be inferred astype[ZshComplete]instead oftype[ShellComplete] | None(the| Nonecan be pretty annoying to deal with)