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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Abstraction for interacting with the user.
Applications can choose different types of UI, and they deal with displaying
messages or progress to the user, and with gathering different types of input.
Several levels are supported, and you can also register new factories such as
for a GUI.
bzrlib.ui.UIFactory
Semi-abstract base class
bzrlib.ui.SilentUIFactory
Produces no output and cannot take any input; useful for programs using
bzrlib in batch mode or for programs such as loggerhead.
bzrlib.ui.CannedInputUIFactory
For use in testing; the input values to be returned are provided
at construction.
bzrlib.ui.text.TextUIFactory
Standard text command-line interface, with stdin, stdout, stderr.
May make more or less advanced use of them, eg in drawing progress bars,
depending on the detected capabilities of the terminal.
GUIs may choose to subclass this so that unimplemented methods fall
back to working through the terminal.
"""
import os
import sys
import warnings
from bzrlib.lazy_import import lazy_import
lazy_import(globals(), """
import getpass
from bzrlib import (
errors,
osutils,
progress,
trace,
)
""")
from bzrlib.symbol_versioning import (
deprecated_function,
deprecated_in,
deprecated_method,
)
_valid_boolean_strings = dict(yes=True, no=False,
y=True, n=False,
on=True, off=False,
true=True, false=False)
_valid_boolean_strings['1'] = True
_valid_boolean_strings['0'] = False
def bool_from_string(s, accepted_values=None):
"""Returns a boolean if the string can be interpreted as such.
Interpret case insensitive strings as booleans. The default values
includes: 'yes', 'no, 'y', 'n', 'true', 'false', '0', '1', 'on',
'off'. Alternative values can be provided with the 'accepted_values'
parameter.
:param s: A string that should be interpreted as a boolean. It should be of
type string or unicode.
:param accepted_values: An optional dict with accepted strings as keys and
True/False as values. The strings will be tested against a lowered
version of 's'.
:return: True or False for accepted strings, None otherwise.
"""
if accepted_values is None:
accepted_values = _valid_boolean_strings
val = None
if type(s) in (str, unicode):
try:
val = accepted_values[s.lower()]
except KeyError:
pass
return val
class UIFactory(object):
"""UI abstraction.
This tells the library how to display things to the user. Through this
layer different applications can choose the style of UI.
"""
def __init__(self):
self._task_stack = []
def get_password(self, prompt='', **kwargs):
"""Prompt the user for a password.
:param prompt: The prompt to present the user
:param kwargs: Arguments which will be expanded into the prompt.
This lets front ends display different things if
they so choose.
:return: The password string, return None if the user canceled the
request. Note that we do not touch the encoding, users may
have whatever they see fit and the password should be
transported as is.
"""
raise NotImplementedError(self.get_password)
def nested_progress_bar(self):
"""Return a nested progress bar.
When the bar has been finished with, it should be released by calling
bar.finished().
"""
if self._task_stack:
t = progress.ProgressTask(self._task_stack[-1], self)
else:
t = progress.ProgressTask(None, self)
self._task_stack.append(t)
return t
def _progress_finished(self, task):
"""Called by the ProgressTask when it finishes"""
if not self._task_stack:
warnings.warn("%r finished but nothing is active"
% (task,))
elif task != self._task_stack[-1]:
warnings.warn("%r is not the active task %r"
% (task, self._task_stack[-1]))
else:
del self._task_stack[-1]
if not self._task_stack:
self._progress_all_finished()
def _progress_all_finished(self):
"""Called when the top-level progress task finished"""
pass
def _progress_updated(self, task):
"""Called by the ProgressTask when it changes.
Should be specialized to draw the progress.
"""
pass
def clear_term(self):
"""Prepare the terminal for output.
This will, for example, clear text progress bars, and leave the
cursor at the leftmost position.
"""
pass
def get_boolean(self, prompt):
"""Get a boolean question answered from the user.
:param prompt: a message to prompt the user with. Should be a single
line without terminating \n.
:return: True or False for y/yes or n/no.
"""
raise NotImplementedError(self.get_boolean)
def make_progress_view(self):
"""Construct a new ProgressView object for this UI.
Application code should normally not call this but instead
nested_progress_bar().
"""
return NullProgressView()
def recommend_upgrade(self,
current_format_name,
basedir):
# this should perhaps be in the TextUIFactory and the default can do
# nothing
trace.warning("%s is deprecated "
"and a better format is available.\n"
"It is recommended that you upgrade by "
"running the command\n"
" bzr upgrade %s",
current_format_name,
basedir)
def report_transport_activity(self, transport, byte_count, direction):
"""Called by transports as they do IO.
This may update a progress bar, spinner, or similar display.
By default it does nothing.
"""
pass
def show_error(self, msg):
"""Show an error message (not an exception) to the user.
The message should not have an error prefix or trailing newline. That
will be added by the factory if appropriate.
"""
raise NotImplementedError(self.show_error)
def show_message(self, msg):
"""Show a message to the user."""
raise NotImplementedError(self.show_message)
def show_warning(self, msg):
"""Show a warning to the user."""
raise NotImplementedError(self.show_warning)
class SilentUIFactory(UIFactory):
"""A UI Factory which never prints anything.
This is the default UI, if another one is never registered by a program
using bzrlib, and it's also active for example inside 'bzr serve'.
Methods that try to read from the user raise an error; methods that do
output do nothing.
"""
def __init__(self):
UIFactory.__init__(self)
def note(self, msg):
pass
def get_username(self, prompt, **kwargs):
return None
def show_error(self, msg):
pass
def show_message(self, msg):
pass
def show_warning(self, msg):
pass
class CannedInputUIFactory(SilentUIFactory):
"""A silent UI that return canned input."""
def __init__(self, responses):
self.responses = responses
def __repr__(self):
return "%s(%r)" % (self.__class__.__name__, self.responses)
def get_boolean(self, prompt):
return self.responses.pop(0)
def get_password(self, prompt='', **kwargs):
return self.responses.pop(0)
def get_username(self, prompt, **kwargs):
return self.responses.pop(0)
def assert_all_input_consumed(self):
if self.responses:
raise AssertionError("expected all input in %r to be consumed"
% (self,))
ui_factory = SilentUIFactory()
# IMPORTANT: never import this symbol directly. ONLY ever access it as
# ui.ui_factory, so that you refer to the current value.
def make_ui_for_terminal(stdin, stdout, stderr):
"""Construct and return a suitable UIFactory for a text mode program.
"""
# this is now always TextUIFactory, which in turn decides whether it
# should display progress bars etc
from bzrlib.ui.text import TextUIFactory
return TextUIFactory(stdin, stdout, stderr)
class NullProgressView(object):
"""Soak up and ignore progress information."""
def clear(self):
pass
def show_progress(self, task):
pass
def show_transport_activity(self, transport, direction, byte_count):
pass
|