Skip to content

prompt

Utilities for helping build interactive prompts

confirm(default)

Confirm that the user wishes to continue

Parameters:

Name Type Description Default
default bool

Whether the default selection should be True (yes) or False (no)

 required

Returns:

Type Description
bool

Whether the user has opted to continue
Source code in enderchest/prompt.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def confirm(default: bool) -> bool:
    """Confirm that the user wishes to continue

    Parameters
    ----------
    default : bool
        Whether the default selection should be True (yes) or False (no)

    Returns
    -------
    bool
        Whether the user has opted to continue
    """

    response = prompt("Do you wish to continue?", "Y/n" if default else "y/N").lower()

    if response == "":
        return default

    if response in YES:
        return True

    return False

prompt(message, suggestion=None, is_password=False)

Prompt the user and return the response

Parameters:

Name Type Description Default
message str

The prompt message

 required
suggestion str

A suggested input. If None is provided, no suggestion will be shown.

 None
is_password bool

If this is a prompt for a password, pass in is_password = True to hide the user's input

 False

Returns:

Type Description
str

The user-provided response
Notes
  • The output will be stripped of trailing and leading whitespace, but no other validation or processing will be used.
  • Regardless of whether a suggestion is provided, if the user provides an empty input, this method will return an empty string. To reiterate: the suggestion does not serve as a default / fallback value.
Source code in enderchest/prompt.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def prompt(
    message: str, suggestion: str | None = None, is_password: bool = False
) -> str:
    """Prompt the user and return the response

    Parameters
    ----------
    message : str
        The prompt message
    suggestion : str, optional
        A suggested input. If None is provided, no suggestion will be shown.
    is_password : bool, optional
        If this is a prompt for a password, pass in `is_password = True` to
        hide the user's input

    Returns
    -------
    str
        The user-provided response

    Notes
    -----
    - The output will be stripped of trailing and leading whitespace, but no
      other validation or processing will be used.
    - Regardless of whether a suggestion is provided, if the user provides an
      empty input, this method will return an empty string. To reiterate: the
      suggestion *does not serve* as a default / fallback value.
    """
    lines = message.splitlines() + [""]
    message = "\n".join(f"{CURSOR}\x1b[1m {line}\x1b[0m" for line in lines)
    if suggestion is not None:
        message += f"\x1b[35;1m[{suggestion}]\x1b[0m "
    if is_password:
        return getpass.getpass(prompt=message)
    return input(message)