InquirerPy

0.3.4 · active · verified Thu Apr 09

InquirerPy is a Python port of the famous Inquirer.js, offering a collection of common interactive command-line user interfaces. It is a re-implementation of the PyInquirer project, focusing on bug fixes, new prompts, backward-compatible APIs, and enhanced customization. Currently at version 0.3.4, the library maintains an active development and release cadence.

Warnings

breaking When migrating from PyInquirer, note that 'EditorPrompt' is not supported in InquirerPy. Also, parameters for 'CheckboxPrompt' (e.g., `pointer_sign` changed to `pointer`) and keys for 'Style' (e.g., `selected` changed to `pointer`) have been renamed or altered.
Fix: Review the InquirerPy migration guide for specific parameter and style key changes, and replace unsupported prompts with alternative InquirerPy options.
deprecated The `raise_keyboard_interrupt` parameter in the `.execute()` function is slated for deprecation. Its behavior has changed, and the recommended approach is to provide `raise_keyboard_interrupt` as an initialisation option to the prompt class.
Fix: Pass `raise_keyboard_interrupt=True/False` directly when initializing the prompt (e.g., `inquirer.text(message='...', raise_keyboard_interrupt=True)`).
gotcha In version 0.3.4, automatic spacing was introduced for checkbox, expand, and rawlist prompts. If you have custom `enabled_symbol` or `disabled_symbol` configurations, you might need to remove any extra spaces you previously added to maintain alignment.
Fix: Inspect custom symbol configurations for checkbox, expand, and rawlist prompts and adjust spacing as needed to accommodate the new automatic spacing.
deprecated For the `expand` prompt, the `help_msg` parameter has been deprecated in favor of `expand_help` for customising help messages and expansion keys.
Fix: Replace `help_msg` with `expand_help` when configuring the `expand` prompt.
gotcha The default value for the `border` parameter in fuzzy prompts was changed from `True` to `False` in version 0.3.4 to ensure consistency with other prompt types.
Fix: If you require a border for fuzzy prompts, explicitly set `border=True` during prompt initialization.

Install

pip install InquirerPy Install InquirerPy

Imports

inquirer
```
from InquirerPy import inquirer
```
Recommended 'Alternate Syntax' for direct interaction with prompt classes.
prompt
```
from InquirerPy import prompt
```
Used for 'Classic Syntax' (PyInquirer compatible), taking a list of questions.
Validator
```
from InquirerPy.validator import Validator
```
Validator classes (e.g., NumberValidator, PathValidator) are within the 'validator' submodule.

Quickstart

This quickstart demonstrates the recommended 'Alternate Syntax' to create and execute common interactive prompts like text input, single-choice selection, and confirmation. The `.execute()` method runs the prompt and returns the user's input.

from InquirerPy import inquirer

name = inquirer.text(message="What's your name:").execute()
fav_lang = inquirer.select(
    message="What's your favourite programming language:",
    choices=["Go", "Python", "Rust", "JavaScript"],
).execute()
confirm = inquirer.confirm(message="Confirm?").execute()

print(f"Hello {name}, your favourite language is {fav_lang}, and you confirmed: {confirm}")

view raw JSON →