1
2
3
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
|
# Copyright 2023 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
from typing import Callable, Optional
def print_error(str='', end='\n'):
"""
Print `str` to stderr, terminated with `end`.
Used for warnings and out-of-band messages to avoid mangling precious
stdout output.
"""
import sys
sys.stderr.write(str)
sys.stderr.write(end)
sys.stderr.flush()
def ask_input(question, default='', numeric_only=False, valid_responses=[],
no_echo=False):
from getpass import getpass
question_out = question
if default:
question_out += f' (Default: {default})'
response = ''
while True:
if not no_echo:
response = input(question_out + ' ').strip()
else:
response = getpass(question_out + ' ').strip()
if not response and default:
return default
if numeric_only:
if not response.isnumeric():
print("Invalid value, try again.")
continue
response = int(response)
if valid_responses and response not in valid_responses:
print("Invalid value, try again.")
continue
break
return response
def ask_yes_no(question, default=False) -> bool:
"""Ask a yes/no question via input() and return their answer."""
from sys import stdout
default_msg = "[Y/n]" if default else "[y/N]"
while True:
try:
stdout.write("%s %s " % (question, default_msg))
c = input().lower()
if c == '':
return default
elif c in ("y", "ye", "yes"):
return True
elif c in ("n", "no"):
return False
else:
stdout.write("Please respond with yes/y or no/n\n")
except EOFError:
stdout.write("\nPlease respond with yes/y or no/n\n")
def is_interactive():
"""Try to determine if the routine was called from an interactive shell."""
import os, sys
return os.getenv('TERM', default=False) and sys.stderr.isatty() and sys.stdout.isatty()
def is_dumb_terminal():
"""Check if the current TTY is dumb, so that we can disable advanced terminal features."""
import os
return os.getenv('TERM') in ['vt100', 'dumb']
def select_entry(l: list, list_msg: str = '', prompt_msg: str = '',
list_format: Optional[Callable] = None,
default_entry: Optional[int] = None) -> str:
"""Select an entry from a list
Args:
l (list): a list of entries
list_msg (str): a message to print before listing the entries
prompt_msg (str): a message to print as prompt for selection
Returns:
str: a selected entry
"""
en = list(enumerate(l, 1))
print(list_msg)
for i, e in en:
if list_format:
print(f'\t{i}: {list_format(e)}')
else:
print(f'\t{i}: {e}')
valid_entry = range(1, len(l)+1)
if default_entry and default_entry not in valid_entry:
default_entry = None
select = ask_input(prompt_msg, default=default_entry, numeric_only=True,
valid_responses=valid_entry)
return next(filter(lambda x: x[0] == select, en))[1]
|
