Fix tab-completion to work with helper mode #851
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
Click tab completion uses the name of the program for various environment variables eg _KART_COMPLETE. Our program name varies depending on how the program is run kart vs kart_cli depending on helper mode etc. Since we can't be sure if the way kart is currently being run is the same as it was run when tab-completion was installed, its safest to stick to one "canoncial" program name for tab-completion at all times. Click lets us do this. The chosen name is "kart" and therefore the variable is _KART_COMPLETE.
craigds
approved these changes
May 31, 2023
| @@ -403,7 +403,9 @@ def load_commands_from_args(args, skip_first_arg=True): | |||
| def entrypoint(): | |||
| freeze_support() | |||
| load_commands_from_args(sys.argv) | |||
| cli() | |||
| # Don't let helper mode mess up the usage-text, or the shell complete environment variables. | |||
| prog_name = "kart" if os.path.basename(sys.argv[0]) == "kart_cli" else None | |||
There was a problem hiding this comment.
what's the None case here for? Would that handle a case where you created a shell alias/symlink to kart called k or something like that?
There was a problem hiding this comment.
Yes, it seems to correctly handle that case - if you rename or alias kart, you get usage info for the renamed kart.
Depending on why kart was renamed or aliased, this may or may not be desirable, but at least it's not like tab-completion where something breaks if we get it wrong.
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.
Click tab completion uses the name of the program for various environment variables eg _KART_COMPLETE.
Our program name varies depending on how the program is run kart vs kart_cli depending on helper mode etc.
Since we can't be sure if the way kart is currently being run is the same as it was run when tab-completion was installed, its safest to stick to one "canoncial" program name for tab-completion at all times. Click lets us do this. The chosen name is "kart" and therefore the variable is _KART_COMPLETE.
Checklist: