Enhancements to bash completions for better file/directory handling #781
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
Allows parameter types to implement their own completions.
The -o default will cause the shell to complete paths in any case that the program did not provide completions in COMPREPLY, this is undesirable as it will result in completing filenames when the next argument or option in context is not a filename. We use nospace here so we can control whether to append a space or not to the completions, this will allow us to complete paths with python code and allow completing more dynamically (so that after completing a subdirectory there is no space appended and one can continue to complete the next subdir).
…tions Instead of special casing the Choice type. Note that this checks the user provided 'autocompletions' list in advance of consulting the parameter class, this should allow users to override the default completion list of a parameter. Some minor adjustments made to append a space to builtin completion lists of commands and option names so that this works seamlessly with the new "complete -o nospace" approach.
Slightly changed semantic for the autocompletion function which can be specified in a decorator, now point out the semantic difference of appending a space to a returned completion suggestion or not. This should not be an API break since the autocompletion function was added recently and has never been in a stable/official release.
After changing the bash wrapping script to invoke complete with the nospace option, the decision to append a space and decide to start completing the next program argument falls on click. So now all results from get_choices() which are entirely "complete" and cannot be further completed have an appended space. Updated test case to expect this behavior from get_choices().
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 addresses the issues outlined in #780
completions()method for BoolParamType, File and Path parameter types tooThis behaves all around much better: