confirmed

pyhelpers.ops.confirmed(prompt=None, confirmation_required=True, resp=False)

Type to confirm whether to proceed or not.

See also [OPS-C-1].

Parameters

  • prompt (str or None) – a message that prompts a response (Yes/No), defaults to None

  • confirmation_required (bool) – whether to require users to confirm and proceed, defaults to True

  • resp (bool) – default response, defaults to False

Returns

a response

Return type

bool

Examples:

>>> from pyhelpers.ops import confirmed

>>> if confirmed(prompt="Testing if the function works?", resp=True):
...     print("Passed.")
Testing if the function works? [Yes]|No: yes
Passed.