askr

Simple, validated input prompts for the terminal.

Every function keeps asking until the answer is valid, so you never have to write another while True / try / except ValueError loop around input() again.

Installation

pip install askr

Requires Python 3.10 or newer. No dependencies.

Usage

from datetime import date
from askr import ask_choice, ask_date, ask_float, ask_int, ask_password, ask_path, ask_str, ask_yn

age = ask_int("Your age: ", min_value=0, max_value=120)
price = ask_float("Price: ", min_value=0)
name = ask_str("Your name: ", min_length=1, max_length=40)

if ask_yn("Continue?"):             # Enter = yes
    ...
if ask_yn("Delete everything?", default=False):   # Enter = no
    ...

mode = ask_choice("Difficulty?", ["Easy", "Medium", "Hard"], default="Medium")

password = ask_password(confirm=True, min_length=8, require_upper=True,
                        require_digit=True, require_special=True)
pin = ask_password("PIN: ", pattern=r"\d{4}", pattern_hint="be exactly 4 digits")

file = ask_path("File to open: ", kind="file")
birthday = ask_date("Birthday: ", ("%Y-%m-%d", "%d.%m.%Y"), max_date=date.today())

What the user sees:

Your age: abc
Invalid entry. Please enter a whole number.
Your age: 200
The number must be between 0 and 120.

Difficulty?
  1. Easy
  2. Medium (default)
  3. Hard
Your choice: hard

Password:
The password must:
  - contain an uppercase letter
  - contain a special character

Functions

Invalid arguments from the programmer (for example min_value greater than max_value) raise a ValueError immediately instead of asking the user forever.

Ctrl+C and Ctrl+D are not caught, so your program can handle them the way it wants (KeyboardInterrupt and EOFError).

License

MIT