135
126
raise NotImplementedError(self.get_password)
140
def make_output_stream(self, encoding=None, encoding_type=None):
141
"""Get a stream for sending out bulk text data.
143
This is used for commands that produce bulk text, such as log or diff
144
output, as opposed to user interaction. This should work even for
145
non-interactive user interfaces. Typically this goes to a decorated
146
version of stdout, but in a GUI it might be appropriate to send it to a
147
window displaying the text.
149
:param encoding: Unicode encoding for output; default is the
150
terminal encoding, which may be different from the user encoding.
151
(See get_terminal_encoding.)
153
:param encoding_type: How to handle encoding errors:
154
replace/strict/escape/exact. Default is replace.
156
# XXX: is the caller supposed to close the resulting object?
158
encoding = osutils.get_terminal_encoding()
159
if encoding_type is None:
160
encoding_type = 'replace'
161
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
164
def _make_output_stream_explicit(self, encoding, encoding_type):
165
raise NotImplementedError("%s doesn't support make_output_stream"
166
% (self.__class__.__name__))
168
128
def nested_progress_bar(self):
169
129
"""Return a nested progress bar.
261
def log_transport_activity(self, display=False):
262
"""Write out whatever transport activity has been measured.
264
Implementations are allowed to do nothing, but it is useful if they can
265
write a line to the log file.
267
:param display: If False, only log to disk, if True also try to display
268
a message to the user.
271
# Default implementation just does nothing
274
def show_error(self, msg):
275
"""Show an error message (not an exception) to the user.
213
class CLIUIFactory(UIFactory):
214
"""Deprecated in favor of TextUIFactory."""
216
@deprecated_method(deprecated_in((1, 18, 0)))
217
def __init__(self, stdin=None, stdout=None, stderr=None):
218
UIFactory.__init__(self)
219
self.stdin = stdin or sys.stdin
220
self.stdout = stdout or sys.stdout
221
self.stderr = stderr or sys.stderr
223
_accepted_boolean_strings = dict(y=True, n=False, yes=True, no=False)
225
def get_boolean(self, prompt):
227
self.prompt(prompt + "? [y/n]: ")
228
line = self.stdin.readline()
229
line = line.rstrip('\n')
230
val = bool_from_string(line, self._accepted_boolean_strings)
234
def get_non_echoed_password(self):
235
isatty = getattr(self.stdin, 'isatty', None)
236
if isatty is not None and isatty():
237
# getpass() ensure the password is not echoed and other
238
# cross-platform niceties
239
password = getpass.getpass('')
241
# echo doesn't make sense without a terminal
242
password = self.stdin.readline()
245
elif password[-1] == '\n':
246
password = password[:-1]
249
def get_password(self, prompt='', **kwargs):
250
"""Prompt the user for a password.
252
:param prompt: The prompt to present the user
253
:param kwargs: Arguments which will be expanded into the prompt.
254
This lets front ends display different things if
256
:return: The password string, return None if the user
257
canceled the request.
260
self.prompt(prompt, **kwargs)
261
# There's currently no way to say 'i decline to enter a password'
262
# as opposed to 'my password is empty' -- does it matter?
263
return self.get_non_echoed_password()
265
def get_username(self, prompt, **kwargs):
266
"""Prompt the user for a username.
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 username string, return None if the user
273
canceled the request.
276
self.prompt(prompt, **kwargs)
277
username = self.stdin.readline()
280
elif username[-1] == '\n':
281
username = username[:-1]
284
def prompt(self, prompt, **kwargs):
285
"""Emit prompt on the CLI.
277
The message should not have an error prefix or trailing newline. That
278
will be added by the factory if appropriate.
287
:param kwargs: Dictionary of arguments to insert into the prompt,
288
to allow UIs to reformat the prompt.
280
raise NotImplementedError(self.show_error)
282
def show_message(self, msg):
283
"""Show a message to the user."""
284
raise NotImplementedError(self.show_message)
286
def show_warning(self, msg):
287
"""Show a warning to the user."""
288
raise NotImplementedError(self.show_warning)
290
def warn_cross_format_fetch(self, from_format, to_format):
291
"""Warn about a potentially slow cross-format transfer"""
292
# See <https://launchpad.net/bugs/456077> asking for a warning here
293
trace.warning("Doing on-the-fly conversion from %s to %s.\n"
294
"This may take some time. Upgrade the repositories to the "
295
"same format for better performance.\n" %
296
(from_format, to_format))
298
def warn_experimental_format_fetch(self, inter):
299
"""Warn about fetching into experimental repository formats."""
300
if inter.target._format.experimental:
301
trace.warning("Fetching into experimental format %s.\n"
302
"This format may be unreliable or change in the future "
303
"without an upgrade path.\n" % (inter.target._format,))
291
# See <https://launchpad.net/bugs/365891>
292
prompt = prompt % kwargs
293
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
295
self.stderr.write(prompt)
298
"""Write an already-formatted message."""
299
self.stdout.write(msg + '\n')
307
302
class SilentUIFactory(UIFactory):
348
331
def get_boolean(self, prompt):
349
332
return self.responses.pop(0)
351
def get_integer(self, prompt):
352
return self.responses.pop(0)
354
334
def get_password(self, prompt='', **kwargs):
355
335
return self.responses.pop(0)
357
337
def get_username(self, prompt, **kwargs):
358
338
return self.responses.pop(0)
360
340
def assert_all_input_consumed(self):
361
341
if self.responses:
362
342
raise AssertionError("expected all input in %r to be consumed"
346
@deprecated_function(deprecated_in((1, 18, 0)))
347
def clear_decorator(func, *args, **kwargs):
348
"""Decorator that clears the term"""
349
ui_factory.clear_term()
350
func(*args, **kwargs)
366
353
ui_factory = SilentUIFactory()
367
354
# IMPORTANT: never import this symbol directly. ONLY ever access it as
368
355
# ui.ui_factory, so that you refer to the current value.
added
removed
bzrlib/ui/__init__.py
