93
class ConfirmationUserInterfacePolicy(object):
94
"""Wrapper for a UIFactory that allows or denies all confirmed actions."""
96
def __init__(self, wrapped_ui, default_answer, specific_answers):
97
"""Generate a proxy UI that does no confirmations.
99
:param wrapped_ui: Underlying UIFactory.
100
:param default_answer: Bool for whether requests for
101
confirmation from the user should be noninteractively accepted or
103
:param specific_answers: Map from confirmation_id to bool answer.
105
self.wrapped_ui = wrapped_ui
106
self.default_answer = default_answer
107
self.specific_answers = specific_answers
109
def __getattr__(self, name):
110
return getattr(self.wrapped_ui, name)
113
return '%s(%r, %r, %r)' % (
114
self.__class__.__name__,
117
self.specific_answers)
119
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
120
if confirmation_id in self.specific_answers:
121
return self.specific_answers[confirmation_id]
122
elif self.default_answer is not None:
123
return self.default_answer
125
return self.wrapped_ui.confirm_action(
126
prompt, confirmation_id, prompt_kwargs)
129
103
class UIFactory(object):
130
104
"""UI abstraction.
132
106
This tells the library how to display things to the user. Through this
133
107
layer different applications can choose the style of UI.
135
UI Factories are also context managers, for some syntactic sugar some users
138
:ivar suppressed_warnings: Identifiers for user warnings that should
142
_user_warning_templates = dict(
143
cross_format_fetch=("Doing on-the-fly conversion from "
144
"%(from_format)s to %(to_format)s.\n"
145
"This may take some time. Upgrade the repositories to the "
146
"same format for better performance."
149
"The command 'bzr %(deprecated_name)s' "
150
"has been deprecated in bzr %(deprecated_in_version)s. "
151
"Please use 'bzr %(recommended_name)s' instead."),
152
recommend_upgrade=("%(current_format_name)s is deprecated "
153
"and a better format is available.\n"
154
"It is recommended that you upgrade by "
155
"running the command\n"
156
" bzr upgrade %(basedir)s"),
158
u"Stole dead lock %(lock_url)s %(other_holder_info)s."),
161
110
def __init__(self):
162
111
self._task_stack = []
163
self.suppressed_warnings = set()
167
"""Context manager entry support.
169
Override in a concrete factory class if initialisation before use is
172
return self # This is bound to the 'as' clause in a with statement.
174
def __exit__(self, exc_type, exc_val, exc_tb):
175
"""Context manager exit support.
177
Override in a concrete factory class if more cleanup than a simple
178
self.clear_term() is needed when the UIFactory is finished with.
181
return False # propogate exceptions.
183
def be_quiet(self, state):
184
"""Tell the UI to be more quiet, or not.
186
Typically this suppresses progress bars; the application may also look
187
at ui_factory.is_quiet().
191
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
192
"""Seek user confirmation for an action.
194
If the UI is noninteractive, or the user does not want to be asked
195
about this action, True is returned, indicating bzr should just
198
The confirmation id allows the user to configure certain actions to
199
always be confirmed or always denied, and for UIs to specialize the
200
display of particular confirmations.
202
:param prompt: Suggested text to display to the user.
203
:param prompt_kwargs: A dictionary of arguments that can be
204
string-interpolated into the prompt.
205
:param confirmation_id: Unique string identifier for the confirmation.
207
return self.get_boolean(prompt % prompt_kwargs)
209
def get_password(self, prompt=u'', **kwargs):
113
def get_password(self, prompt='', **kwargs):
210
114
"""Prompt the user for a password.
212
:param prompt: The prompt to present the user (must be unicode)
116
:param prompt: The prompt to present the user
213
117
:param kwargs: Arguments which will be expanded into the prompt.
214
118
This lets front ends display different things if
222
126
raise NotImplementedError(self.get_password)
227
def make_output_stream(self, encoding=None, encoding_type=None):
228
"""Get a stream for sending out bulk text data.
230
This is used for commands that produce bulk text, such as log or diff
231
output, as opposed to user interaction. This should work even for
232
non-interactive user interfaces. Typically this goes to a decorated
233
version of stdout, but in a GUI it might be appropriate to send it to a
234
window displaying the text.
236
:param encoding: Unicode encoding for output; if not specified
237
uses the configured 'output_encoding' if any; otherwise the
239
(See get_terminal_encoding.)
241
:param encoding_type: How to handle encoding errors:
242
replace/strict/escape/exact. Default is replace.
244
# XXX: is the caller supposed to close the resulting object?
246
from bzrlib import config
247
encoding = config.GlobalConfig().get_user_option(
250
encoding = osutils.get_terminal_encoding(trace=True)
251
if encoding_type is None:
252
encoding_type = 'replace'
253
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
256
def _make_output_stream_explicit(self, encoding, encoding_type):
257
raise NotImplementedError("%s doesn't support make_output_stream"
258
% (self.__class__.__name__))
260
128
def nested_progress_bar(self):
261
129
"""Return a nested progress bar.
305
def format_user_warning(self, warning_id, message_args):
307
template = self._user_warning_templates[warning_id]
309
fail = "bzr warning: %r, %r" % (warning_id, message_args)
310
warnings.warn("no template for warning: " + fail) # so tests will fail etc
313
return template % message_args
314
except ValueError, e:
315
fail = "bzr unprintable warning: %r, %r, %s" % (
316
warning_id, message_args, e)
317
warnings.warn(fail) # so tests will fail etc
320
173
def get_boolean(self, prompt):
321
174
"""Get a boolean question answered from the user.
323
176
:param prompt: a message to prompt the user with. Should be a single
324
line without terminating \\n.
177
line without terminating \n.
325
178
:return: True or False for y/yes or n/no.
327
180
raise NotImplementedError(self.get_boolean)
329
def get_integer(self, prompt):
330
"""Get an integer from the user.
332
:param prompt: a message to prompt the user with. Could be a multi-line
333
prompt but without a terminating \\n.
335
:return: A signed integer.
337
raise NotImplementedError(self.get_integer)
339
182
def make_progress_view(self):
340
183
"""Construct a new ProgressView object for this UI.
345
188
return NullProgressView()
347
def recommend_upgrade(self, current_format_name, basedir):
348
"""Recommend the user upgrade a control directory.
350
:param current_format_name: Description of the current format
351
:param basedir: Location of the control dir
353
self.show_user_warning('recommend_upgrade',
354
current_format_name=current_format_name, basedir=basedir)
190
def recommend_upgrade(self,
193
# this should perhaps be in the TextUIFactory and the default can do
195
trace.warning("%s is deprecated "
196
"and a better format is available.\n"
197
"It is recommended that you upgrade by "
198
"running the command\n"
356
203
def report_transport_activity(self, transport, byte_count, direction):
357
204
"""Called by transports as they do IO.
364
def log_transport_activity(self, display=False):
365
"""Write out whatever transport activity has been measured.
367
Implementations are allowed to do nothing, but it is useful if they can
368
write a line to the log file.
370
:param display: If False, only log to disk, if True also try to display
371
a message to the user.
374
# Default implementation just does nothing
377
def show_user_warning(self, warning_id, **message_args):
378
"""Show a warning to the user.
380
This is specifically for things that are under the user's control (eg
381
outdated formats), not for internal program warnings like deprecated
384
This can be overridden by UIFactory subclasses to show it in some
385
appropriate way; the default UIFactory is noninteractive and does
386
nothing. format_user_warning maps it to a string, though other
387
presentations can be used for particular UIs.
389
:param warning_id: An identifier like 'cross_format_fetch' used to
390
check if the message is suppressed and to look up the string.
391
:param message_args: Arguments to be interpolated into the message.
395
211
def show_error(self, msg):
396
212
"""Show an error message (not an exception) to the user.
398
214
The message should not have an error prefix or trailing newline. That
399
will be added by the factory if appropriate.
215
will be added by the factory if appropriate.
401
217
raise NotImplementedError(self.show_error)
408
224
"""Show a warning to the user."""
409
225
raise NotImplementedError(self.show_warning)
411
def warn_cross_format_fetch(self, from_format, to_format):
412
"""Warn about a potentially slow cross-format transfer.
229
class CLIUIFactory(UIFactory):
230
"""Deprecated in favor of TextUIFactory."""
232
@deprecated_method(deprecated_in((1, 18, 0)))
233
def __init__(self, stdin=None, stdout=None, stderr=None):
234
UIFactory.__init__(self)
235
self.stdin = stdin or sys.stdin
236
self.stdout = stdout or sys.stdout
237
self.stderr = stderr or sys.stderr
239
_accepted_boolean_strings = dict(y=True, n=False, yes=True, no=False)
241
def get_boolean(self, prompt):
243
self.prompt(prompt + "? [y/n]: ")
244
line = self.stdin.readline()
245
line = line.rstrip('\n')
246
val = bool_from_string(line, self._accepted_boolean_strings)
250
def get_non_echoed_password(self):
251
isatty = getattr(self.stdin, 'isatty', None)
252
if isatty is not None and isatty():
253
# getpass() ensure the password is not echoed and other
254
# cross-platform niceties
255
password = getpass.getpass('')
257
# echo doesn't make sense without a terminal
258
password = self.stdin.readline()
261
elif password[-1] == '\n':
262
password = password[:-1]
265
def get_password(self, prompt='', **kwargs):
266
"""Prompt the user for a password.
268
:param prompt: The prompt to present the user
269
:param kwargs: Arguments which will be expanded into the prompt.
270
This lets front ends display different things if
272
:return: The password string, return None if the user
273
canceled the request.
276
self.prompt(prompt, **kwargs)
277
# There's currently no way to say 'i decline to enter a password'
278
# as opposed to 'my password is empty' -- does it matter?
279
return self.get_non_echoed_password()
281
def get_username(self, prompt, **kwargs):
282
"""Prompt the user for a username.
284
:param prompt: The prompt to present the user
285
:param kwargs: Arguments which will be expanded into the prompt.
286
This lets front ends display different things if
288
:return: The username string, return None if the user
289
canceled the request.
292
self.prompt(prompt, **kwargs)
293
username = self.stdin.readline()
296
elif username[-1] == '\n':
297
username = username[:-1]
300
def prompt(self, prompt, **kwargs):
301
"""Emit prompt on the CLI.
414
This is deprecated in favor of show_user_warning, but retained for api
415
compatibility in 2.0 and 2.1.
303
:param kwargs: Dictionary of arguments to insert into the prompt,
304
to allow UIs to reformat the prompt.
417
self.show_user_warning('cross_format_fetch', from_format=from_format,
420
def warn_experimental_format_fetch(self, inter):
421
"""Warn about fetching into experimental repository formats."""
422
if inter.target._format.experimental:
423
trace.warning("Fetching into experimental format %s.\n"
424
"This format may be unreliable or change in the future "
425
"without an upgrade path.\n" % (inter.target._format,))
428
class NoninteractiveUIFactory(UIFactory):
429
"""Base class for UIs with no user."""
431
def confirm_action(self, prompt, confirmation_id, prompt_kwargs):
435
return '%s()' % (self.__class__.__name__, )
438
class SilentUIFactory(NoninteractiveUIFactory):
307
# See <https://launchpad.net/bugs/365891>
308
prompt = prompt % kwargs
309
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
311
self.stderr.write(prompt)
314
"""Write an already-formatted message."""
315
self.stdout.write(msg + '\n')
318
class SilentUIFactory(UIFactory):
439
319
"""A UI Factory which never prints anything.
441
321
This is the default UI, if another one is never registered by a program
476
353
def __repr__(self):
477
354
return "%s(%r)" % (self.__class__.__name__, self.responses)
479
def confirm_action(self, prompt, confirmation_id, args):
480
return self.get_boolean(prompt % args)
482
356
def get_boolean(self, prompt):
483
357
return self.responses.pop(0)
485
def get_integer(self, prompt):
486
return self.responses.pop(0)
488
def get_password(self, prompt=u'', **kwargs):
359
def get_password(self, prompt='', **kwargs):
489
360
return self.responses.pop(0)
491
362
def get_username(self, prompt, **kwargs):
492
363
return self.responses.pop(0)
494
365
def assert_all_input_consumed(self):
495
366
if self.responses:
496
367
raise AssertionError("expected all input in %r to be consumed"
371
@deprecated_function(deprecated_in((1, 18, 0)))
372
def clear_decorator(func, *args, **kwargs):
373
"""Decorator that clears the term"""
374
ui_factory.clear_term()
375
func(*args, **kwargs)
500
378
ui_factory = SilentUIFactory()
501
379
# IMPORTANT: never import this symbol directly. ONLY ever access it as
502
380
# ui.ui_factory, so that you refer to the current value.
added
removed
bzrlib/ui/__init__.py
