questionary

Warnings

• breaking Between versions 1.6.0 and 1.8.0, the `value` parameter in `Choice` objects began to be implicitly type-cast to `str` upon selection. Applications expecting non-string types (e.g., `int`) to be returned from `select` or `checkbox` prompts may encounter `TypeError` or incorrect logic.
  Fix: Explicitly cast the returned value to the expected type, or ensure string values are handled correctly in your application logic. Always pass string values to `Choice(..., value='...')` if you require string output, or handle the type conversion after `ask()`.
• breaking Support for Python 3.6 and 3.7 was officially deprecated with the release of version 2.0.0. Projects using these older Python versions should upgrade to Python 3.8 or newer.
  Fix: Upgrade your Python environment to 3.8 or a later compatible version.
• gotcha The `checkbox()` prompt does not support the `validate` argument. Attempts to pass a `Validator` or validation function to `checkbox()` will result in an error or unexpected behavior.
  Fix: Perform validation on the list of selected items *after* the `checkbox().ask()` call has returned. You can iterate through the list and apply custom validation logic.
• gotcha Pressing `Ctrl+C` (KeyboardInterrupt) during a prompt will cause `questionary.ask()` methods to return `None` instead of raising an exception. This needs to be explicitly handled in your code if you want to differentiate between user cancellation and a valid answer.
  Fix: Always check for `None` as a possible return value after calling `.ask()` on any prompt type to gracefully handle user cancellation (e.g., `if answer is None: print('Cancelled'); exit()`).
• gotcha There are two main ways to ask multiple questions: `questionary.form()` which takes keyword arguments where values are `Question` instances, and `questionary.prompt()` which takes a list of question dictionaries. Mixing these patterns or using the wrong input format for the respective function can lead to errors.
  Fix: When using `questionary.form()`, pass `questionary.<type>(...).ask()` instances directly to keyword arguments. When using `questionary.prompt()`, provide a list of dictionaries, each defining 'type', 'name', and 'message' keys at a minimum. Refer to the documentation for correct usage of each.

Install

• pip install questionary Standard Installation

Imports

• questionary

  import questionary

• Choice

  from questionary import Choice

  While 'questionary' itself is the main import, specific classes like 'Choice' are typically imported directly from the top-level package.
• Validator, ValidationError

  from questionary import Validator, ValidationError

• prompt

  from questionary import prompt

  Use `prompt` for a list of questions defined as dictionaries, or direct `questionary.<type>().ask()` for single questions.

Quickstart

This quickstart demonstrates how to use `questionary.text` for free-form input and `questionary.select` for choosing from a list. It also includes basic handling for `Ctrl+C` which causes `ask()` to return `None`.

import questionary

def main():
    name = questionary.text("What's your name?").ask()
    if name is None: # User pressed Ctrl+C
        print("Operation cancelled.")
        return

    choice = questionary.select(
        "What do you want to do?",
        choices=['Order a pizza', 'Make a reservation', 'Ask for opening hours']
    ).ask()
    if choice is None:
        print("Operation cancelled.")
        return

    print(f"Hello, {name}!")
    print(f"You chose: {choice}")

if __name__ == "__main__":
    main()