1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
106
106
This tells the library how to display things to the user. Through this
107
107
layer different applications can choose the style of UI.
109
:ivar suppressed_warnings: Identifiers for user warnings that should
113
_user_warning_templates = dict(
114
cross_format_fetch=("Doing on-the-fly conversion from "
115
"%(from_format)s to %(to_format)s.\n"
116
"This may take some time. Upgrade the repositories to the "
117
"same format for better performance."
121
110
def __init__(self):
122
111
self._task_stack = []
123
self.suppressed_warnings = set()
126
def be_quiet(self, state):
127
"""Tell the UI to be more quiet, or not.
129
Typically this suppresses progress bars; the application may also look
130
at ui_factory.is_quiet().
134
113
def get_password(self, prompt='', **kwargs):
135
114
"""Prompt the user for a password.
147
126
raise NotImplementedError(self.get_password)
152
def make_output_stream(self, encoding=None, encoding_type=None):
153
"""Get a stream for sending out bulk text data.
155
This is used for commands that produce bulk text, such as log or diff
156
output, as opposed to user interaction. This should work even for
157
non-interactive user interfaces. Typically this goes to a decorated
158
version of stdout, but in a GUI it might be appropriate to send it to a
159
window displaying the text.
161
:param encoding: Unicode encoding for output; default is the
162
terminal encoding, which may be different from the user encoding.
163
(See get_terminal_encoding.)
165
:param encoding_type: How to handle encoding errors:
166
replace/strict/escape/exact. Default is replace.
168
# XXX: is the caller supposed to close the resulting object?
170
encoding = osutils.get_terminal_encoding()
171
if encoding_type is None:
172
encoding_type = 'replace'
173
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
176
def _make_output_stream_explicit(self, encoding, encoding_type):
177
raise NotImplementedError("%s doesn't support make_output_stream"
178
% (self.__class__.__name__))
180
128
def nested_progress_bar(self):
181
129
"""Return a nested progress bar.
195
143
if not self._task_stack:
196
144
warnings.warn("%r finished but nothing is active"
198
if task in self._task_stack:
199
self._task_stack.remove(task)
146
elif task != self._task_stack[-1]:
147
warnings.warn("%r is not the active task %r"
148
% (task, self._task_stack[-1]))
201
warnings.warn("%r is not in active stack %r"
202
% (task, self._task_stack))
150
del self._task_stack[-1]
203
151
if not self._task_stack:
204
152
self._progress_all_finished()
225
def format_user_warning(self, warning_id, message_args):
227
template = self._user_warning_templates[warning_id]
229
fail = "failed to format warning %r, %r" % (warning_id, message_args)
230
warnings.warn(fail) # so tests will fail etc
233
return template % message_args
234
except ValueError, e:
235
fail = "failed to format warning %r, %r: %s" % (
236
warning_id, message_args, e)
237
warnings.warn(fail) # so tests will fail etc
240
173
def get_boolean(self, prompt):
241
174
"""Get a boolean question answered from the user.
247
180
raise NotImplementedError(self.get_boolean)
249
def get_integer(self, prompt):
250
"""Get an integer from the user.
252
:param prompt: a message to prompt the user with. Could be a multi-line
253
prompt but without a terminating \n.
255
:return: A signed integer.
257
raise NotImplementedError(self.get_integer)
259
182
def make_progress_view(self):
260
183
"""Construct a new ProgressView object for this UI.
267
190
def recommend_upgrade(self,
268
191
current_format_name,
270
# XXX: this should perhaps be in the TextUIFactory and the default can do
193
# this should perhaps be in the TextUIFactory and the default can do
273
# XXX: Change to show_user_warning - that will accomplish the previous
274
# xxx. -- mbp 2010-02-25
275
195
trace.warning("%s is deprecated "
276
196
"and a better format is available.\n"
277
197
"It is recommended that you upgrade by "
291
def log_transport_activity(self, display=False):
292
"""Write out whatever transport activity has been measured.
294
Implementations are allowed to do nothing, but it is useful if they can
295
write a line to the log file.
297
:param display: If False, only log to disk, if True also try to display
298
a message to the user.
301
# Default implementation just does nothing
304
def show_user_warning(self, warning_id, **message_args):
305
"""Show a warning to the user.
307
This is specifically for things that are under the user's control (eg
308
outdated formats), not for internal program warnings like deprecated
311
This can be overridden by UIFactory subclasses to show it in some
312
appropriate way; the default UIFactory is noninteractive and does
313
nothing. format_user_warning maps it to a string, though other
314
presentations can be used for particular UIs.
316
:param warning_id: An identifier like 'cross_format_fetch' used to
317
check if the message is suppressed and to look up the string.
318
:param message_args: Arguments to be interpolated into the message.
322
211
def show_error(self, msg):
323
212
"""Show an error message (not an exception) to the user.
325
214
The message should not have an error prefix or trailing newline. That
326
will be added by the factory if appropriate.
215
will be added by the factory if appropriate.
328
217
raise NotImplementedError(self.show_error)
335
224
"""Show a warning to the user."""
336
225
raise NotImplementedError(self.show_warning)
338
def warn_cross_format_fetch(self, from_format, to_format):
339
"""Warn about a potentially slow cross-format transfer.
341
This is deprecated in favor of show_user_warning, but retained for api
342
compatibility in 2.0 and 2.1.
344
self.show_user_warning('cross_format_fetch', from_format=from_format,
347
def warn_experimental_format_fetch(self, inter):
348
"""Warn about fetching into experimental repository formats."""
349
if inter.target._format.experimental:
350
trace.warning("Fetching into experimental format %s.\n"
351
"This format may be unreliable or change in the future "
352
"without an upgrade path.\n" % (inter.target._format,))
356
229
class SilentUIFactory(UIFactory):
372
245
def get_username(self, prompt, **kwargs):
375
def _make_output_stream_explicit(self, encoding, encoding_type):
376
return NullOutputStream(encoding)
378
248
def show_error(self, msg):
397
267
def get_boolean(self, prompt):
398
268
return self.responses.pop(0)
400
def get_integer(self, prompt):
401
return self.responses.pop(0)
403
270
def get_password(self, prompt='', **kwargs):
404
271
return self.responses.pop(0)
406
273
def get_username(self, prompt, **kwargs):
407
274
return self.responses.pop(0)
409
276
def assert_all_input_consumed(self):
410
277
if self.responses:
411
278
raise AssertionError("expected all input in %r to be consumed"
438
305
def show_transport_activity(self, transport, direction, byte_count):
441
def log_transport_activity(self, display=False):
445
class NullOutputStream(object):
446
"""Acts like a file, but discard all output."""
448
def __init__(self, encoding):
449
self.encoding = encoding
451
def write(self, data):
454
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
