13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19
"""Text UI, write output to the console.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
40
from bzrlib.ui import (
46
class TextUIFactory(UIFactory):
25
import bzrlib.progress
26
from bzrlib.symbol_versioning import (deprecated_method,
28
from bzrlib.ui import CLIUIFactory
31
class TextUIFactory(CLIUIFactory):
47
32
"""A UI factory for Text user interefaces."""
53
38
"""Create a TextUIFactory.
40
:param bar_type: The type of progress bar to create. It defaults to
41
letting the bzrlib.progress.ProgressBar factory auto
55
44
super(TextUIFactory, self).__init__()
56
# TODO: there's no good reason not to pass all three streams, maybe we
57
# should deprecate the default values...
61
# paints progress, network activity, etc
62
self._progress_view = self.make_progress_view()
64
def be_quiet(self, state):
65
if state and not self._quiet:
67
UIFactory.be_quiet(self, state)
68
self._progress_view = self.make_progress_view()
45
self._bar_type = bar_type
47
self.stdout = sys.stdout
51
self.stderr = sys.stderr
55
def prompt(self, prompt):
56
"""Emit prompt on the CLI."""
57
self.stdout.write(prompt + "? [y/n]:")
59
@deprecated_method(zero_eight)
60
def progress_bar(self):
61
"""See UIFactory.nested_progress_bar()."""
62
# this in turn is abstract, and creates either a tty or dots
63
# bar depending on what we think of the terminal
64
return bzrlib.progress.ProgressBar()
66
def get_password(self, prompt='', **kwargs):
67
"""Prompt the user for a password.
69
:param prompt: The prompt to present the user
70
:param kwargs: Arguments which will be expanded into the prompt.
71
This lets front ends display different things if
73
:return: The password string, return None if the user
76
prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
78
# There's currently no way to say 'i decline to enter a password'
79
# as opposed to 'my password is empty' -- does it matter?
80
return getpass.getpass(prompt)
82
def nested_progress_bar(self):
83
"""Return a nested progress bar.
85
The actual bar type returned depends on the progress module which
86
may return a tty or dots bar depending on the terminal.
88
if self._progress_bar_stack is None:
89
self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
91
return self._progress_bar_stack.get_nested()
70
93
def clear_term(self):
71
94
"""Prepare the terminal for output.
73
96
This will, clear any progress bars, and leave the cursor at the
74
97
leftmost position."""
75
# XXX: If this is preparing to write to stdout, but that's for example
76
# directed into a file rather than to the terminal, and the progress
77
# bar _is_ going to the terminal, we shouldn't need
78
# to clear it. We might need to separately check for the case of
79
self._progress_view.clear()
81
def get_boolean(self, prompt):
83
self.prompt(prompt + "? [y/n]: ")
84
line = self.stdin.readline().lower()
85
if line in ('y\n', 'yes\n'):
87
elif line in ('n\n', 'no\n'):
89
elif line in ('', None):
90
# end-of-file; possibly should raise an error here instead
93
def get_integer(self, prompt):
96
line = self.stdin.readline()
102
def get_non_echoed_password(self):
103
isatty = getattr(self.stdin, 'isatty', None)
104
if isatty is not None and isatty():
105
# getpass() ensure the password is not echoed and other
106
# cross-platform niceties
107
password = getpass.getpass('')
109
# echo doesn't make sense without a terminal
110
password = self.stdin.readline()
113
elif password[-1] == '\n':
114
password = password[:-1]
117
def get_password(self, prompt='', **kwargs):
118
"""Prompt the user for a password.
120
:param prompt: The prompt to present the user
121
:param kwargs: Arguments which will be expanded into the prompt.
122
This lets front ends display different things if
124
:return: The password string, return None if the user
125
canceled the request.
128
self.prompt(prompt, **kwargs)
129
# There's currently no way to say 'i decline to enter a password'
130
# as opposed to 'my password is empty' -- does it matter?
131
return self.get_non_echoed_password()
133
def get_username(self, prompt, **kwargs):
134
"""Prompt the user for a username.
136
:param prompt: The prompt to present the user
137
:param kwargs: Arguments which will be expanded into the prompt.
138
This lets front ends display different things if
140
:return: The username string, return None if the user
141
canceled the request.
144
self.prompt(prompt, **kwargs)
145
username = self.stdin.readline()
148
elif username[-1] == '\n':
149
username = username[:-1]
152
def make_progress_view(self):
153
"""Construct and return a new ProgressView subclass for this UI.
155
# with --quiet, never any progress view
156
# <https://bugs.launchpad.net/bzr/+bug/320035>. Otherwise if the
157
# user specifically requests either text or no progress bars, always
158
# do that. otherwise, guess based on $TERM and tty presence.
160
return NullProgressView()
161
elif os.environ.get('BZR_PROGRESS_BAR') == 'text':
162
return TextProgressView(self.stderr)
163
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
164
return NullProgressView()
165
elif progress._supports_progress(self.stderr):
166
return TextProgressView(self.stderr)
168
return NullProgressView()
170
def _make_output_stream_explicit(self, encoding, encoding_type):
171
if encoding_type == 'exact':
172
# force sys.stdout to be binary stream on win32;
173
# NB: this leaves the file set in that mode; may cause problems if
174
# one process tries to do binary and then text output
175
if sys.platform == 'win32':
176
fileno = getattr(self.stdout, 'fileno', None)
179
msvcrt.setmode(fileno(), os.O_BINARY)
180
return TextUIOutputStream(self, self.stdout)
182
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
183
errors=encoding_type)
184
# For whatever reason codecs.getwriter() does not advertise its encoding
185
# it just returns the encoding of the wrapped file, which is completely
186
# bogus. So set the attribute, so we can find the correct encoding later.
187
encoded_stdout.encoding = encoding
188
return TextUIOutputStream(self, encoded_stdout)
191
"""Write an already-formatted message, clearing the progress bar if necessary."""
193
self.stdout.write(msg + '\n')
195
def prompt(self, prompt, **kwargs):
196
"""Emit prompt on the CLI.
198
:param kwargs: Dictionary of arguments to insert into the prompt,
199
to allow UIs to reformat the prompt.
202
# See <https://launchpad.net/bugs/365891>
203
prompt = prompt % kwargs
204
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
206
self.stderr.write(prompt)
208
def report_transport_activity(self, transport, byte_count, direction):
209
"""Called by transports as they do IO.
211
This may update a progress bar, spinner, or similar display.
212
By default it does nothing.
214
self._progress_view.show_transport_activity(transport,
215
direction, byte_count)
217
def log_transport_activity(self, display=False):
218
"""See UIFactory.log_transport_activity()"""
219
log = getattr(self._progress_view, 'log_transport_activity', None)
223
def show_error(self, msg):
225
self.stderr.write("bzr: error: %s\n" % msg)
227
def show_message(self, msg):
230
def show_warning(self, msg):
232
if isinstance(msg, unicode):
233
te = osutils.get_terminal_encoding()
234
msg = msg.encode(te, 'replace')
235
self.stderr.write("bzr: warning: %s\n" % msg)
237
def _progress_updated(self, task):
238
"""A task has been updated and wants to be displayed.
240
if not self._task_stack:
241
warnings.warn("%r updated but no tasks are active" %
243
elif task != self._task_stack[-1]:
244
# We used to check it was the top task, but it's hard to always
245
# get this right and it's not necessarily useful: any actual
246
# problems will be evident in use
247
#warnings.warn("%r is not the top progress task %r" %
248
# (task, self._task_stack[-1]))
250
self._progress_view.show_progress(task)
252
def _progress_all_finished(self):
253
self._progress_view.clear()
255
def show_user_warning(self, warning_id, **message_args):
256
"""Show a text message to the user.
258
Explicitly not for warnings about bzr apis, deprecations or internals.
260
# eventually trace.warning should migrate here, to avoid logging and
261
# be easier to test; that has a lot of test fallout so for now just
262
# new code can call this
263
if warning_id not in self.suppressed_warnings:
264
self.stderr.write(self.format_user_warning(warning_id, message_args) +
268
class TextProgressView(object):
269
"""Display of progress bar and other information on a tty.
271
This shows one line of text, including possibly a network indicator, spinner,
272
progress bar, message, etc.
274
One instance of this is created and held by the UI, and fed updates when a
275
task wants to be painted.
277
Transports feed data to this through the ui_factory object.
279
The Progress views can comprise a tree with _parent_task pointers, but
280
this only prints the stack from the nominated current task up to the root.
283
def __init__(self, term_file):
284
self._term_file = term_file
285
# true when there's output on the screen we may need to clear
286
self._have_output = False
287
self._last_transport_msg = ''
289
# time we last repainted the screen
290
self._last_repaint = 0
291
# time we last got information about transport activity
292
self._transport_update_time = 0
293
self._last_task = None
294
self._total_byte_count = 0
295
self._bytes_since_update = 0
296
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
297
self._first_byte_time = None
299
# force the progress bar to be off, as at the moment it doesn't
300
# correspond reliably to overall command progress
301
self.enable_bar = False
303
def _avail_width(self):
304
# we need one extra space for terminals that wrap on last char
305
w = osutils.terminal_width()
311
def _show_line(self, s):
312
# sys.stderr.write("progress %r\n" % s)
313
width = self._avail_width()
314
if width is not None:
315
s = '%-*.*s' % (width, width, s)
316
self._term_file.write('\r' + s + '\r')
319
if self._have_output:
321
self._have_output = False
323
def _render_bar(self):
324
# return a string for the progress bar itself
325
if self.enable_bar and (
326
(self._last_task is None) or self._last_task.show_bar):
327
# If there's no task object, we show space for the bar anyhow.
328
# That's because most invocations of bzr will end showing progress
329
# at some point, though perhaps only after doing some initial IO.
330
# It looks better to draw the progress bar initially rather than
331
# to have what looks like an incomplete progress bar.
332
spin_str = r'/-\|'[self._spin_pos % 4]
335
if self._last_task is None:
336
completion_fraction = 0
339
completion_fraction = \
340
self._last_task._overall_completion_fraction() or 0
341
if (completion_fraction < self._fraction and 'progress' in
343
import pdb;pdb.set_trace()
344
self._fraction = completion_fraction
345
markers = int(round(float(cols) * completion_fraction)) - 1
346
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
348
elif (self._last_task is None) or self._last_task.show_spinner:
349
# The last task wanted just a spinner, no bar
350
spin_str = r'/-\|'[self._spin_pos % 4]
352
return spin_str + ' '
356
def _format_task(self, task):
357
"""Format task-specific parts of progress bar.
359
:returns: (text_part, counter_part) both unicode strings.
361
if not task.show_count:
363
elif task.current_cnt is not None and task.total_cnt is not None:
364
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
365
elif task.current_cnt is not None:
366
s = ' %d' % (task.current_cnt)
369
# compose all the parent messages
372
while t._parent_task:
378
def _render_line(self):
379
bar_string = self._render_bar()
381
task_part, counter_part = self._format_task(self._last_task)
383
task_part = counter_part = ''
384
if self._last_task and not self._last_task.show_transport_activity:
387
trans = self._last_transport_msg
388
# the bar separates the transport activity from the message, so even
389
# if there's no bar or spinner, we must show something if both those
391
if (task_part or trans) and not bar_string:
393
# preferentially truncate the task message if we don't have enough
395
avail_width = self._avail_width()
396
if avail_width is not None:
397
# if terminal avail_width is unknown, don't truncate
398
current_len = len(bar_string) + len(trans) + len(task_part) + len(counter_part)
399
gap = current_len - avail_width
401
task_part = task_part[:-gap-2] + '..'
402
s = trans + bar_string + task_part + counter_part
403
if avail_width is not None:
404
if len(s) < avail_width:
405
s = s.ljust(avail_width)
406
elif len(s) > avail_width:
411
s = self._render_line()
413
self._have_output = True
415
def show_progress(self, task):
416
"""Called by the task object when it has changed.
418
:param task: The top task object; its parents are also included
421
must_update = task is not self._last_task
422
self._last_task = task
424
if (not must_update) and (now < self._last_repaint + task.update_latency):
426
if now > self._transport_update_time + 10:
427
# no recent activity; expire it
428
self._last_transport_msg = ''
429
self._last_repaint = now
432
def show_transport_activity(self, transport, direction, byte_count):
433
"""Called by transports via the ui_factory, as they do IO.
435
This may update a progress bar, spinner, or similar display.
436
By default it does nothing.
438
# XXX: there should be a transport activity model, and that too should
439
# be seen by the progress view, rather than being poked in here.
440
self._total_byte_count += byte_count
441
self._bytes_since_update += byte_count
442
if self._first_byte_time is None:
443
# Note that this isn't great, as technically it should be the time
444
# when the bytes started transferring, not when they completed.
445
# However, we usually start with a small request anyway.
446
self._first_byte_time = time.time()
447
if direction in self._bytes_by_direction:
448
self._bytes_by_direction[direction] += byte_count
450
self._bytes_by_direction['unknown'] += byte_count
451
if 'no_activity' in debug.debug_flags:
452
# Can be used as a workaround if
453
# <https://launchpad.net/bugs/321935> reappears and transport
454
# activity is cluttering other output. However, thanks to
455
# TextUIOutputStream this shouldn't be a problem any more.
458
if self._total_byte_count < 2000:
459
# a little resistance at first, so it doesn't stay stuck at 0
460
# while connecting...
462
if self._transport_update_time is None:
463
self._transport_update_time = now
464
elif now >= (self._transport_update_time + 0.5):
465
# guard against clock stepping backwards, and don't update too
467
rate = (self._bytes_since_update
468
/ (now - self._transport_update_time))
469
# using base-10 units (see HACKING.txt).
470
msg = ("%6dkB %5dkB/s " %
471
(self._total_byte_count / 1000, int(rate) / 1000,))
472
self._transport_update_time = now
473
self._last_repaint = now
474
self._bytes_since_update = 0
475
self._last_transport_msg = msg
478
def _format_bytes_by_direction(self):
479
if self._first_byte_time is None:
482
transfer_time = time.time() - self._first_byte_time
483
if transfer_time < 0.001:
484
transfer_time = 0.001
485
bps = self._total_byte_count / transfer_time
487
# using base-10 units (see HACKING.txt).
488
msg = ('Transferred: %.0fkB'
489
' (%.1fkB/s r:%.0fkB w:%.0fkB'
490
% (self._total_byte_count / 1000.,
492
self._bytes_by_direction['read'] / 1000.,
493
self._bytes_by_direction['write'] / 1000.,
495
if self._bytes_by_direction['unknown'] > 0:
496
msg += ' u:%.0fkB)' % (
497
self._bytes_by_direction['unknown'] / 1000.
503
def log_transport_activity(self, display=False):
504
msg = self._format_bytes_by_direction()
506
if display and self._total_byte_count > 0:
508
self._term_file.write(msg + '\n')
511
class TextUIOutputStream(object):
512
"""Decorates an output stream so that the terminal is cleared before writing.
514
This is supposed to ensure that the progress bar does not conflict with bulk
517
# XXX: this does not handle the case of writing part of a line, then doing
518
# progress bar output: the progress bar will probably write over it.
519
# one option is just to buffer that text until we have a full line;
520
# another is to save and restore it
522
# XXX: might need to wrap more methods
524
def __init__(self, ui_factory, wrapped_stream):
525
self.ui_factory = ui_factory
526
self.wrapped_stream = wrapped_stream
527
# this does no transcoding, but it must expose the underlying encoding
528
# because some callers need to know what can be written - see for
529
# example unescape_for_display.
530
self.encoding = getattr(wrapped_stream, 'encoding', None)
533
self.ui_factory.clear_term()
534
self.wrapped_stream.flush()
536
def write(self, to_write):
537
self.ui_factory.clear_term()
538
self.wrapped_stream.write(to_write)
540
def writelines(self, lines):
541
self.ui_factory.clear_term()
542
self.wrapped_stream.writelines(lines)
98
if self._progress_bar_stack is None:
100
overall_pb = self._progress_bar_stack.bottom()
101
if overall_pb is not None:
added
removed
bzrlib/ui/text.py
