[Fix] #1091. Prevent confusion between guardrails.cli.hub.install and guardrails.hub install. #1093
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
…eep the invocation as guardrails hub install) so people don't import it by mistake. Add warning for string passage.
zsimjee
approved these changes
Sep 25, 2024
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.
Backstory in #1091
We don't want people to try to import and run the command that defines the COMMAND LINE INTERFACE FOR INSTALL
guardrails hub installinstead of the actual install command. If someone searches the code and doesn't pay attention they might (rather, they have) dofrom guardrails.cli.hub.install import installinstead offrom guardrails.hub import install. The former will report that a guard is not found when invoked with a string because it breaks it into characters and attempts to install all of them individually.We resolve this in two ways:
First, make the install CLI function named install_cli so people don't import it by mistake. (Keep the invocation as
guardrails hub install)Second, check if the parameter passed is a string instead of a list and add a warning for string passage.