22
22
Several levels are supported, and you can also register new factories such as
26
26
Semi-abstract base class
28
bzrlib.ui.SilentUIFactory
29
29
Produces no output and cannot take any input; useful for programs using
30
30
bzrlib in batch mode or for programs such as loggerhead.
32
bzrlib.ui.CannedInputUIFactory
33
33
For use in testing; the input values to be returned are provided
36
bzrlib.ui.text.TextUIFactory
37
37
Standard text command-line interface, with stdin, stdout, stderr.
38
38
May make more or less advanced use of them, eg in drawing progress bars,
39
39
depending on the detected capabilities of the terminal.
126
126
raise NotImplementedError(self.get_password)
128
def make_output_stream(self, encoding=None, encoding_type=None):
129
"""Get a stream for sending out bulk text data.
131
This is used for commands that produce bulk text, such as log or diff
132
output, as opposed to user interaction. This should work even for
133
non-interactive user interfaces. Typically this goes to a decorated
134
version of stdout, but in a GUI it might be appropriate to send it to a
135
window displaying the text.
137
:param encoding: Unicode encoding for output; default is the
138
terminal encoding, which may be different from the user encoding.
139
(See get_terminal_encoding.)
141
:param encoding_type: How to handle encoding errors:
142
replace/strict/escape/exact. Default is replace.
144
# XXX: is the caller supposed to close the resulting object?
146
encoding = osutils.get_terminal_encoding()
147
if encoding_type is None:
148
encoding_type = 'replace'
149
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
152
def _make_output_stream_explicit(self, encoding, encoding_type):
153
raise NotImplementedError("%s doesn't support make_output_stream"
154
% (self.__class__.__name__))
128
156
def nested_progress_bar(self):
129
157
"""Return a nested progress bar.
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.
249
def log_transport_activity(self, display=False):
250
"""Write out whatever transport activity has been measured.
252
Implementations are allowed to do nothing, but it is useful if they can
253
write a line to the log file.
255
:param display: If False, only log to disk, if True also try to display
256
a message to the user.
259
# Default implementation just does nothing
262
def show_error(self, msg):
263
"""Show an error message (not an exception) to the user.
287
:param kwargs: Dictionary of arguments to insert into the prompt,
288
to allow UIs to reformat the prompt.
265
The message should not have an error prefix or trailing newline. That
266
will be added by the factory if appropriate.
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')
268
raise NotImplementedError(self.show_error)
270
def show_message(self, msg):
271
"""Show a message to the user."""
272
raise NotImplementedError(self.show_message)
274
def show_warning(self, msg):
275
"""Show a warning to the user."""
276
raise NotImplementedError(self.show_warning)
302
280
class SilentUIFactory(UIFactory):
331
318
def get_boolean(self, prompt):
332
319
return self.responses.pop(0)
321
def get_integer(self, prompt):
322
return self.responses.pop(0)
334
324
def get_password(self, prompt='', **kwargs):
335
325
return self.responses.pop(0)
337
327
def get_username(self, prompt, **kwargs):
338
328
return self.responses.pop(0)
340
330
def assert_all_input_consumed(self):
341
331
if self.responses:
342
332
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)
353
336
ui_factory = SilentUIFactory()
354
337
# IMPORTANT: never import this symbol directly. ONLY ever access it as
355
338
# ui.ui_factory, so that you refer to the current value.
added
removed
bzrlib/ui/__init__.py
