cli: set click_types.Path for -r and -e options
#5352
Merged
Conversation
This file contains 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
this enables click to generate shell auto completions for files/paths see #3478
|
Can you please add a news file? |
done |
oz123
approved these changes
Sep 21, 2022
matteius
approved these changes
Sep 21, 2022
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.
The issue
pipenv can generate its own shell completions using the click framework. Prior to this PR, there are no file/path completions for the
-rand-eoptions. See #3478 for a discussion.The fix
This PR changes the option type to
click_types.Pathfor-rand-e. This is enough for click to know that file/path completions are desired here.And this isn't only beneficial for fish shell, it automatically applies to bash and zsh also.
This fixes partially issue #3478 but not the part concerning
pipenv runcompletions.The checklist
news/directory to describe this fix with the extension.bugfix.rst,.feature.rst,.behavior.rst,.doc.rst..vendor.rst. or.trivial.rst(this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.I'm not sure whether the news fragment is mandatory and which type would be appropriate. If you tell me, I could add one.