Added customization to the illegal_choice_message. #3247
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.
Type of changes
Checklist
Description
I made the illegal_choice_message an optional parameter of the both the class prompt and the method ask in prompt.py. The illegal choice parameter automatically defaults to the original Text Type("[prompt.invalid.choice]Please select one of the available options."). This will allow those using the library to customize the message that is outputted to the user. I also updated the documentation to reflect this change.
Why
I added this feature because to my knowledge—please correct me if I am wrong in this assumption—there is no way to change the error message outputted when a user does not pick one of the choices. I am somewhat new to programming so I could have missed something. I also feel this change will produce overall more robust code.
Examples
Code:
Output: