Skip to content

inputer

Inputer

Source code in systemd_py/utils/terminal/inputer.py 
  4
  5
  6
  7
  8
  9
 10
 11
 12
 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
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
class Inputer:
    Empty = TypeVar("Empty", str, None)

    @staticmethod
    def input(prompt: str, default: Any = None, choices: List[Any] = None, force: bool = False) -> Any:
        """
        Input a value from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param default: The default value to use if the user does not input anything
        :type default: Any

        :param choices: The choices to display to the user
        :type choices: List[Any]

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: Any
        """

        prompt = prompt.strip()

        if choices is None:
            choices = []
        if default is not None:
            choices.append(default)
        if choices:
            prompt += f" ({', '.join(str(choice) for choice in choices)})"

        if not prompt.endswith(":"):
            prompt += ": "
        if not prompt.endswith(" "):
            prompt += " "

        while True:
            value = input(prompt)

            if value:
                if choices:
                    if force:
                        if value not in choices:
                            print(f"Invalid choice: {value}")
                            continue
                return value
            if default is not None:
                if default == Inputer.Empty:
                    return None
                return default
            print(f'Invalid input: "{value}"')

    @staticmethod
    def input_bool(prompt: str, default: bool = None, force: bool = False) -> bool:
        """
        Input a boolean value from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param default: The default value to use if the user does not input anything
        :type default: bool

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: bool
        """

        choices = ["y", "n"]
        if default is not None:
            choices.append(default)
        value = Inputer.input(prompt, choices=choices, force=force)
        if value == "y":
            return True
        if value == "n":
            return False
        return default

    @staticmethod
    def input_int(prompt: str, default: int = None, force: bool = False) -> Optional[int]:
        """
        Input an integer value from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param default: The default value to use if the user does not input anything
        :type default: int

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: Optional[int]
        """

        while True:
            value = Inputer.input(prompt, default=default, force=force)
            if value is Inputer.Empty:
                return None
            try:
                return int(value)
            except (ValueError, TypeError):
                print("Invalid input")

    @staticmethod
    def input_float(prompt: str, default: float = None, force: bool = False) -> float:
        """
        Input a float value from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param default: The default value to use if the user does not input anything
        :type default: float

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: float
        """

        while True:
            value = Inputer.input(prompt, default=default, force=force)
            try:
                return float(value)
            except ValueError:
                print("Invalid input")

    @staticmethod
    def input_list(prompt: str, default: List[str] = None, force: bool = False) -> List[str]:
        """
        Input a list of values from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param default: The default value to use if the user does not input anything
        :type default: List[str]

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: List[str]
        """

        if default is None:
            default = []
        value = Inputer.input(prompt, default=",".join(default), force=force)
        return value.split(",")

    @staticmethod
    def input_dict(prompt: str, default: Dict[str, str] = None, force: bool = False) -> Dict[str, str]:
        """
        Input a dictionary of values from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param default: The default value to use if the user does not input anything
        :type default: Dict[str, str]

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: Dict[str, str]
        """

        if default is None:
            default = {}
        value = Inputer.input(
            prompt,
            default=",".join(f"{key}={value}" for key, value in default.items()),
            force=force
        )
        return {key: value for key, value in (item.split("=") for item in value.split(","))}

    @staticmethod
    def input_choice(prompt: str, choices: List[Any], default: Any = None, force: bool = False) -> Any:
        """
        Input a choice from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param choices: The choices to display to the user
        :type choices: List[Any]

        :param default: The default value to use if the user does not input anything
        :type default: Any

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: Any
        """

        if default is not None:
            choices.append(default)
        value = Inputer.input(prompt, choices=choices, force=force)
        if value in choices:
            return value
        return default

    @staticmethod
    def input_choice_bool(prompt: str, choices: List[bool], default: bool = None, force: bool = False) -> bool:
        """
        Input a choice from the user

        :param prompt: The prompt to display to the user
        :type prompt: str

        :param choices: The choices to display to the user
        :type choices: List[bool]

        :param default: The default value to use if the user does not input anything
        :type default: bool

        :param force: Force the user to input a value that exist in choices
        :type force: bool

        :return: The value the user input
        :rtype: bool
        """

        if default is not None:
            choices.append(default)
        value = Inputer.input(prompt, choices=choices, force=force)
        if value in choices:
            return value
        return default

input(prompt, default=None, choices=None, force=False) staticmethod

Input a value from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
default Any

The default value to use if the user does not input anything

 None
choices List[Any]

The choices to display to the user

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
Any

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
 7
 8
 9
10
11
12
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
48
49
50
51
52
53
54
55
56
@staticmethod
def input(prompt: str, default: Any = None, choices: List[Any] = None, force: bool = False) -> Any:
    """
    Input a value from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param default: The default value to use if the user does not input anything
    :type default: Any

    :param choices: The choices to display to the user
    :type choices: List[Any]

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: Any
    """

    prompt = prompt.strip()

    if choices is None:
        choices = []
    if default is not None:
        choices.append(default)
    if choices:
        prompt += f" ({', '.join(str(choice) for choice in choices)})"

    if not prompt.endswith(":"):
        prompt += ": "
    if not prompt.endswith(" "):
        prompt += " "

    while True:
        value = input(prompt)

        if value:
            if choices:
                if force:
                    if value not in choices:
                        print(f"Invalid choice: {value}")
                        continue
            return value
        if default is not None:
            if default == Inputer.Empty:
                return None
            return default
        print(f'Invalid input: "{value}"')

input_bool(prompt, default=None, force=False) staticmethod

Input a boolean value from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
default bool

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
bool

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@staticmethod
def input_bool(prompt: str, default: bool = None, force: bool = False) -> bool:
    """
    Input a boolean value from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param default: The default value to use if the user does not input anything
    :type default: bool

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: bool
    """

    choices = ["y", "n"]
    if default is not None:
        choices.append(default)
    value = Inputer.input(prompt, choices=choices, force=force)
    if value == "y":
        return True
    if value == "n":
        return False
    return default

input_choice(prompt, choices, default=None, force=False) staticmethod

Input a choice from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
choices List[Any]

The choices to display to the user

 required
default Any

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
Any

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
@staticmethod
def input_choice(prompt: str, choices: List[Any], default: Any = None, force: bool = False) -> Any:
    """
    Input a choice from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param choices: The choices to display to the user
    :type choices: List[Any]

    :param default: The default value to use if the user does not input anything
    :type default: Any

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: Any
    """

    if default is not None:
        choices.append(default)
    value = Inputer.input(prompt, choices=choices, force=force)
    if value in choices:
        return value
    return default

input_choice_bool(prompt, choices, default=None, force=False) staticmethod

Input a choice from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
choices List[bool]

The choices to display to the user

 required
default bool

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
bool

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
@staticmethod
def input_choice_bool(prompt: str, choices: List[bool], default: bool = None, force: bool = False) -> bool:
    """
    Input a choice from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param choices: The choices to display to the user
    :type choices: List[bool]

    :param default: The default value to use if the user does not input anything
    :type default: bool

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: bool
    """

    if default is not None:
        choices.append(default)
    value = Inputer.input(prompt, choices=choices, force=force)
    if value in choices:
        return value
    return default

input_dict(prompt, default=None, force=False) staticmethod

Input a dictionary of values from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
default Dict[str, str]

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
Dict[str, str]

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
@staticmethod
def input_dict(prompt: str, default: Dict[str, str] = None, force: bool = False) -> Dict[str, str]:
    """
    Input a dictionary of values from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param default: The default value to use if the user does not input anything
    :type default: Dict[str, str]

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: Dict[str, str]
    """

    if default is None:
        default = {}
    value = Inputer.input(
        prompt,
        default=",".join(f"{key}={value}" for key, value in default.items()),
        force=force
    )
    return {key: value for key, value in (item.split("=") for item in value.split(","))}

input_float(prompt, default=None, force=False) staticmethod

Input a float value from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
default float

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
float

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
@staticmethod
def input_float(prompt: str, default: float = None, force: bool = False) -> float:
    """
    Input a float value from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param default: The default value to use if the user does not input anything
    :type default: float

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: float
    """

    while True:
        value = Inputer.input(prompt, default=default, force=force)
        try:
            return float(value)
        except ValueError:
            print("Invalid input")

input_int(prompt, default=None, force=False) staticmethod

Input an integer value from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
default int

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
Optional[int]

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
@staticmethod
def input_int(prompt: str, default: int = None, force: bool = False) -> Optional[int]:
    """
    Input an integer value from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param default: The default value to use if the user does not input anything
    :type default: int

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: Optional[int]
    """

    while True:
        value = Inputer.input(prompt, default=default, force=force)
        if value is Inputer.Empty:
            return None
        try:
            return int(value)
        except (ValueError, TypeError):
            print("Invalid input")

input_list(prompt, default=None, force=False) staticmethod

Input a list of values from the user

Parameters:

Name Type Description Default
prompt str

The prompt to display to the user

 required
default List[str]

The default value to use if the user does not input anything

 None
force bool

Force the user to input a value that exist in choices

 False

Returns:

Type Description
List[str]

The value the user input
Source code in systemd_py/utils/terminal/inputer.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
@staticmethod
def input_list(prompt: str, default: List[str] = None, force: bool = False) -> List[str]:
    """
    Input a list of values from the user

    :param prompt: The prompt to display to the user
    :type prompt: str

    :param default: The default value to use if the user does not input anything
    :type default: List[str]

    :param force: Force the user to input a value that exist in choices
    :type force: bool

    :return: The value the user input
    :rtype: List[str]
    """

    if default is None:
        default = []
    value = Inputer.input(prompt, default=",".join(default), force=force)
    return value.split(",")