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
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
243
244
245
246
247
248
249
250
251
252
253
254
255
|
# Copyright (C) 2013 Linaro Limited
#
# Author: Antonio Terceiro <antonio.terceiro@linaro.org>
#
# This file is part of lava-tool.
#
# lava-tool is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License version 3
# as published by the Free Software Foundation
#
# lava-tool 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 General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with lava-tool. If not, see <http://www.gnu.org/licenses/>.
"""
Parameter class and its accessory methods/functions.
"""
import sys
from lava_tool.utils import to_list
# Character used to join serialized list parameters.
LIST_SERIALIZE_DELIMITER = ","
class Parameter(object):
"""A parameter with an optional dependency."""
def __init__(self, id, value=None, depends=None):
"""Creates a new parameter.
:param id: The name of this parameter.
:param value: The value of this parameter. Defaults to None.
:param depends: If this Parameter depends on another one. Defaults
to None.
:type Parameter
"""
self.id = id
self.value = value
self.depends = depends
self.asked = False
# Whether to store or not the parameter in the user config file.
self.store = True
def set(self, value):
"""Sets the value of the parameter.
:param value: The value to set.
"""
self.value = value
def prompt(self, old_value=None):
"""Gets the parameter value from the user.
To get user input, the builtin `raw_input` function will be used. Input
will also be stripped of possible whitespace chars. If Enter or any
sort of whitespace chars in typed, the old Parameter value will be
returned.
:param old_value: The old parameter value.
:return The input as typed by the user, or the old value.
"""
if not self.asked:
if old_value is not None:
prompt = "{0} [{1}]: ".format(self.id, old_value)
else:
prompt = "{0}: ".format(self.id)
user_input = self.get_user_input(prompt)
if user_input is not None:
if len(user_input) == 0 and old_value:
# Keep the old value when user press enter or another
# whitespace char.
self.value = old_value
else:
self.value = user_input
self.asked = True
return self.value
@classmethod
def get_user_input(cls, prompt=""):
"""Asks the user for input data.
:param prompt: The prompt that should be given to the user.
:return A string with what the user typed.
"""
data = None
try:
data = raw_input(prompt).strip()
except EOFError:
# Force to return None.
data = None
except KeyboardInterrupt:
sys.exit(-1)
return data
@classmethod
def serialize(cls, value):
"""Serializes the passed value to be friendly written to file.
Lists are serialized as a comma separated string of values.
:param value: The value to serialize.
:return The serialized value as string.
"""
serialized = ""
if isinstance(value, list):
serialized = LIST_SERIALIZE_DELIMITER.join(
str(x) for x in value if x)
else:
serialized = str(value)
return serialized
@classmethod
def deserialize(cls, value):
"""Deserialize a value into a list.
The value must have been serialized with the class instance serialize()
method.
:param value: The string value to be deserialized.
:type str
:return A list of values.
"""
deserialized = []
if isinstance(value, str):
deserialized = filter(None, (x.strip() for x in value.split(
LIST_SERIALIZE_DELIMITER)))
else:
deserialized = list(value)
return deserialized
class SingleChoiceParameter(Parameter):
"""A parameter implemeting a single choice between multiple choices."""
def __init__(self, id, choices):
super(SingleChoiceParameter, self).__init__(id)
self.choices = to_list(choices)
def prompt(self, prompt, old_value=None):
"""Asks the user for their choice."""
# Sliglty different than the other parameters: here we first present
# the user with what the choices are about.
print >> sys.stdout, prompt
index = 1
for choice in self.choices:
print >> sys.stdout, "\t{0:d}. {1}".format(index, choice)
index += 1
choices_len = len(self.choices)
while True:
user_input = self.get_user_input("Choice: ")
if len(user_input) == 0 and old_value:
choice = old_value
break
elif user_input in [str(x) for x in range(1, choices_len + 1)]:
choice = self.choices[int(user_input) - 1]
break
return choice
class ListParameter(Parameter):
"""A specialized Parameter to handle list values."""
# This is used as a deletion character. When we have an old value and the
# user enters this char, it sort of deletes the value.
DELETE_CHAR = "-"
def __init__(self, id, value=None, depends=None):
super(ListParameter, self).__init__(id, depends=depends)
self.value = []
if value:
self.set(value)
def set(self, value):
"""Sets the value of the parameter.
:param value: The value to set.
"""
self.value = to_list(value)
def add(self, value):
"""Adds a new value to the list of values of this parameter.
:param value: The value to add.
"""
if isinstance(value, list):
self.value.extend(value)
else:
self.value.append(value)
def prompt(self, old_value=None):
"""Gets the parameter in a list form.
To exit the input procedure it is necessary to insert an empty line.
:return The list of values.
"""
if not self.asked:
if old_value is not None:
# We might get the old value read from file via ConfigParser,
# and usually it comes in string format.
old_value = self.deserialize(old_value)
print >> sys.stdout, "Values for '{0}': ".format(self.id)
index = 1
while True:
user_input = None
if old_value is not None and (0 < len(old_value) >= index):
prompt = "{0:>3d}.\n\told: {1}\n\tnew: ".format(
index, old_value[index - 1])
user_input = self.get_user_input(prompt)
else:
prompt = "{0:>3d}. ".format(index)
user_input = self.get_user_input(prompt)
if user_input is not None:
# The user has pressed Enter.
if len(user_input) == 0:
if old_value is not None and \
(0 < len(old_value) >= index):
user_input = old_value[index - 1]
else:
break
if len(user_input) == 1 and user_input == \
self.DELETE_CHAR and (0 < len(old_value) >= index):
# We have an old value, user presses the DELETE_CHAR
# and we do not store anything. This is done to delete
# an old entry.
pass
else:
self.value.append(user_input)
index += 1
self.asked = True
return self.value
|
