yr.confirm

confirm(
    label: str | None = None,
    true_option: str = 'Yes',
    false_option: str = 'No',
) → bool

Present the user with a binary choice and return True/False.

Parameters

label
type: str | None = None

optional prompt shown above the buttons.

true_option
type: str = 'Yes'

the button option representing true.

false_option
type: str = 'No'

the button option representing false.

Returns

type: bool

boolean value representing whether the user chose the true or false option.