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.
🗒️ Description
This PR adds a set of simple, HTML-like input functions to the
cli.input
package, which internally use thequestionary
library to handle various types of interactive CLI inputs. The goal is to provide a simplified API for capturing user input, WITHOUT exposing the details ofquestionary
.This makes it easy to swap out
questionary
for another library in the future, without changing the interface. Use away!Changes
input_text(question: str)
: Ask a text input question.input_password(question: str)
: Ask a password input question (hidden text).input_select(question: str, choices: list)
: Ask a single-choice selection question.input_checkbox(question: str, choices: list)
: Ask a multi-choice question.input_confirm(question: str)
: Ask a yes/no confirmation question.Usage Example
🔗 Related Issues
closes #945
✅ Checklist
mkdocs serve
locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.