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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
18
"""Text UI, write output to the console.
25
import bzrlib.progress
26
from bzrlib.symbol_versioning import (deprecated_method,
28
from bzrlib.ui import CLIUIFactory
31
class TextUIFactory(CLIUIFactory):
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
40
from bzrlib.osutils import watch_sigwinch
42
from bzrlib.ui import (
48
class TextUIFactory(UIFactory):
32
49
"""A UI factory for Text user interefaces."""
38
55
"""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
44
57
super(TextUIFactory, self).__init__()
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()
58
# TODO: there's no good reason not to pass all three streams, maybe we
59
# should deprecate the default values...
63
# paints progress, network activity, etc
64
self._progress_view = self.make_progress_view()
65
# hook up the signals to watch for terminal size changes
68
def be_quiet(self, state):
69
if state and not self._quiet:
71
UIFactory.be_quiet(self, state)
72
self._progress_view = self.make_progress_view()
75
"""Prepare the terminal for output.
77
This will, clear any progress bars, and leave the cursor at the
79
# XXX: If this is preparing to write to stdout, but that's for example
80
# directed into a file rather than to the terminal, and the progress
81
# bar _is_ going to the terminal, we shouldn't need
82
# to clear it. We might need to separately check for the case of
83
self._progress_view.clear()
85
def get_boolean(self, prompt):
87
self.prompt(prompt + "? [y/n]: ")
88
line = self.stdin.readline().lower()
89
if line in ('y\n', 'yes\n'):
91
elif line in ('n\n', 'no\n'):
93
elif line in ('', None):
94
# end-of-file; possibly should raise an error here instead
97
def get_integer(self, prompt):
100
line = self.stdin.readline()
106
def get_non_echoed_password(self):
107
isatty = getattr(self.stdin, 'isatty', None)
108
if isatty is not None and isatty():
109
# getpass() ensure the password is not echoed and other
110
# cross-platform niceties
111
password = getpass.getpass('')
113
# echo doesn't make sense without a terminal
114
password = self.stdin.readline()
117
elif password[-1] == '\n':
118
password = password[:-1]
66
121
def get_password(self, prompt='', **kwargs):
67
122
"""Prompt the user for a password.
70
125
:param kwargs: Arguments which will be expanded into the prompt.
71
126
This lets front ends display different things if
73
:return: The password string, return None if the user
128
:return: The password string, return None if the user
74
129
canceled the request.
76
prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
132
self.prompt(prompt, **kwargs)
78
133
# There's currently no way to say 'i decline to enter a password'
79
134
# 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()
94
"""Prepare the terminal for output.
96
This will, clear any progress bars, and leave the cursor at the
98
if self._progress_bar_stack is None:
100
overall_pb = self._progress_bar_stack.bottom()
101
if overall_pb is not None:
135
return self.get_non_echoed_password()
137
def get_username(self, prompt, **kwargs):
138
"""Prompt the user for a username.
140
:param prompt: The prompt to present the user
141
:param kwargs: Arguments which will be expanded into the prompt.
142
This lets front ends display different things if
144
:return: The username string, return None if the user
145
canceled the request.
148
self.prompt(prompt, **kwargs)
149
username = self.stdin.readline()
152
elif username[-1] == '\n':
153
username = username[:-1]
156
def make_progress_view(self):
157
"""Construct and return a new ProgressView subclass for this UI.
159
# with --quiet, never any progress view
160
# <https://bugs.edge.launchpad.net/bzr/+bug/320035>. Otherwise if the
161
# user specifically requests either text or no progress bars, always
162
# do that. otherwise, guess based on $TERM and tty presence.
164
return NullProgressView()
165
elif os.environ.get('BZR_PROGRESS_BAR') == 'text':
166
return TextProgressView(self.stderr)
167
elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
168
return NullProgressView()
169
elif progress._supports_progress(self.stderr):
170
return TextProgressView(self.stderr)
172
return NullProgressView()
174
def _make_output_stream_explicit(self, encoding, encoding_type):
175
if encoding_type == 'exact':
176
# force sys.stdout to be binary stream on win32;
177
# NB: this leaves the file set in that mode; may cause problems if
178
# one process tries to do binary and then text output
179
if sys.platform == 'win32':
180
fileno = getattr(self.stdout, 'fileno', None)
183
msvcrt.setmode(fileno(), os.O_BINARY)
184
return TextUIOutputStream(self, self.stdout)
186
encoded_stdout = codecs.getwriter(encoding)(self.stdout,
187
errors=encoding_type)
188
# For whatever reason codecs.getwriter() does not advertise its encoding
189
# it just returns the encoding of the wrapped file, which is completely
190
# bogus. So set the attribute, so we can find the correct encoding later.
191
encoded_stdout.encoding = encoding
192
return TextUIOutputStream(self, encoded_stdout)
195
"""Write an already-formatted message, clearing the progress bar if necessary."""
197
self.stdout.write(msg + '\n')
199
def prompt(self, prompt, **kwargs):
200
"""Emit prompt on the CLI.
202
:param kwargs: Dictionary of arguments to insert into the prompt,
203
to allow UIs to reformat the prompt.
206
# See <https://launchpad.net/bugs/365891>
207
prompt = prompt % kwargs
208
prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
210
self.stderr.write(prompt)
212
def report_transport_activity(self, transport, byte_count, direction):
213
"""Called by transports as they do IO.
215
This may update a progress bar, spinner, or similar display.
216
By default it does nothing.
218
self._progress_view.show_transport_activity(transport,
219
direction, byte_count)
221
def log_transport_activity(self, display=False):
222
"""See UIFactory.log_transport_activity()"""
223
log = getattr(self._progress_view, 'log_transport_activity', None)
227
def show_error(self, msg):
229
self.stderr.write("bzr: error: %s\n" % msg)
231
def show_message(self, msg):
234
def show_warning(self, msg):
236
if isinstance(msg, unicode):
237
te = osutils.get_terminal_encoding()
238
msg = msg.encode(te, 'replace')
239
self.stderr.write("bzr: warning: %s\n" % msg)
241
def _progress_updated(self, task):
242
"""A task has been updated and wants to be displayed.
244
if not self._task_stack:
245
warnings.warn("%r updated but no tasks are active" %
247
elif task != self._task_stack[-1]:
248
# We used to check it was the top task, but it's hard to always
249
# get this right and it's not necessarily useful: any actual
250
# problems will be evident in use
251
#warnings.warn("%r is not the top progress task %r" %
252
# (task, self._task_stack[-1]))
254
self._progress_view.show_progress(task)
256
def _progress_all_finished(self):
257
self._progress_view.clear()
259
def show_user_warning(self, warning_id, **message_args):
260
"""Show a text message to the user.
262
Explicitly not for warnings about bzr apis, deprecations or internals.
264
# eventually trace.warning should migrate here, to avoid logging and
265
# be easier to test; that has a lot of test fallout so for now just
266
# new code can call this
267
if warning_id not in self.suppressed_warnings:
268
self.stderr.write(self.format_user_warning(warning_id, message_args) +
272
class TextProgressView(object):
273
"""Display of progress bar and other information on a tty.
275
This shows one line of text, including possibly a network indicator, spinner,
276
progress bar, message, etc.
278
One instance of this is created and held by the UI, and fed updates when a
279
task wants to be painted.
281
Transports feed data to this through the ui_factory object.
283
The Progress views can comprise a tree with _parent_task pointers, but
284
this only prints the stack from the nominated current task up to the root.
287
def __init__(self, term_file):
288
self._term_file = term_file
289
# true when there's output on the screen we may need to clear
290
self._have_output = False
291
self._last_transport_msg = ''
293
# time we last repainted the screen
294
self._last_repaint = 0
295
# time we last got information about transport activity
296
self._transport_update_time = 0
297
self._last_task = None
298
self._total_byte_count = 0
299
self._bytes_since_update = 0
300
self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
301
self._first_byte_time = None
303
# force the progress bar to be off, as at the moment it doesn't
304
# correspond reliably to overall command progress
305
self.enable_bar = False
307
def _show_line(self, s):
308
# sys.stderr.write("progress %r\n" % s)
309
width = osutils.terminal_width()
310
if width is not None:
311
# we need one extra space for terminals that wrap on last char
313
s = '%-*.*s' % (width, width, s)
314
self._term_file.write('\r' + s + '\r')
317
if self._have_output:
319
self._have_output = False
321
def _render_bar(self):
322
# return a string for the progress bar itself
323
if self.enable_bar and (
324
(self._last_task is None) or self._last_task.show_bar):
325
# If there's no task object, we show space for the bar anyhow.
326
# That's because most invocations of bzr will end showing progress
327
# at some point, though perhaps only after doing some initial IO.
328
# It looks better to draw the progress bar initially rather than
329
# to have what looks like an incomplete progress bar.
330
spin_str = r'/-\|'[self._spin_pos % 4]
333
if self._last_task is None:
334
completion_fraction = 0
337
completion_fraction = \
338
self._last_task._overall_completion_fraction() or 0
339
if (completion_fraction < self._fraction and 'progress' in
341
import pdb;pdb.set_trace()
342
self._fraction = completion_fraction
343
markers = int(round(float(cols) * completion_fraction)) - 1
344
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
346
elif (self._last_task is None) or self._last_task.show_spinner:
347
# The last task wanted just a spinner, no bar
348
spin_str = r'/-\|'[self._spin_pos % 4]
350
return spin_str + ' '
354
def _format_task(self, task):
355
if not task.show_count:
357
elif task.current_cnt is not None and task.total_cnt is not None:
358
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
359
elif task.current_cnt is not None:
360
s = ' %d' % (task.current_cnt)
363
# compose all the parent messages
366
while t._parent_task:
372
def _render_line(self):
373
bar_string = self._render_bar()
375
task_msg = self._format_task(self._last_task)
378
if self._last_task and not self._last_task.show_transport_activity:
381
trans = self._last_transport_msg
384
return (bar_string + trans + task_msg)
387
s = self._render_line()
389
self._have_output = True
391
def show_progress(self, task):
392
"""Called by the task object when it has changed.
394
:param task: The top task object; its parents are also included
397
must_update = task is not self._last_task
398
self._last_task = task
400
if (not must_update) and (now < self._last_repaint + task.update_latency):
402
if now > self._transport_update_time + 10:
403
# no recent activity; expire it
404
self._last_transport_msg = ''
405
self._last_repaint = now
408
def show_transport_activity(self, transport, direction, byte_count):
409
"""Called by transports via the ui_factory, as they do IO.
411
This may update a progress bar, spinner, or similar display.
412
By default it does nothing.
414
# XXX: there should be a transport activity model, and that too should
415
# be seen by the progress view, rather than being poked in here.
416
self._total_byte_count += byte_count
417
self._bytes_since_update += byte_count
418
if self._first_byte_time is None:
419
# Note that this isn't great, as technically it should be the time
420
# when the bytes started transferring, not when they completed.
421
# However, we usually start with a small request anyway.
422
self._first_byte_time = time.time()
423
if direction in self._bytes_by_direction:
424
self._bytes_by_direction[direction] += byte_count
426
self._bytes_by_direction['unknown'] += byte_count
427
if 'no_activity' in debug.debug_flags:
428
# Can be used as a workaround if
429
# <https://launchpad.net/bugs/321935> reappears and transport
430
# activity is cluttering other output. However, thanks to
431
# TextUIOutputStream this shouldn't be a problem any more.
434
if self._total_byte_count < 2000:
435
# a little resistance at first, so it doesn't stay stuck at 0
436
# while connecting...
438
if self._transport_update_time is None:
439
self._transport_update_time = now
440
elif now >= (self._transport_update_time + 0.5):
441
# guard against clock stepping backwards, and don't update too
443
rate = (self._bytes_since_update
444
/ (now - self._transport_update_time))
445
# using base-10 units (see HACKING.txt).
446
msg = ("%6dkB %5dkB/s" %
447
(self._total_byte_count / 1000, int(rate) / 1000,))
448
self._transport_update_time = now
449
self._last_repaint = now
450
self._bytes_since_update = 0
451
self._last_transport_msg = msg
454
def _format_bytes_by_direction(self):
455
if self._first_byte_time is None:
458
transfer_time = time.time() - self._first_byte_time
459
if transfer_time < 0.001:
460
transfer_time = 0.001
461
bps = self._total_byte_count / transfer_time
463
# using base-10 units (see HACKING.txt).
464
msg = ('Transferred: %.0fkB'
465
' (%.1fkB/s r:%.0fkB w:%.0fkB'
466
% (self._total_byte_count / 1000.,
468
self._bytes_by_direction['read'] / 1000.,
469
self._bytes_by_direction['write'] / 1000.,
471
if self._bytes_by_direction['unknown'] > 0:
472
msg += ' u:%.0fkB)' % (
473
self._bytes_by_direction['unknown'] / 1000.
479
def log_transport_activity(self, display=False):
480
msg = self._format_bytes_by_direction()
482
if display and self._total_byte_count > 0:
484
self._term_file.write(msg + '\n')
487
class TextUIOutputStream(object):
488
"""Decorates an output stream so that the terminal is cleared before writing.
490
This is supposed to ensure that the progress bar does not conflict with bulk
493
# XXX: this does not handle the case of writing part of a line, then doing
494
# progress bar output: the progress bar will probably write over it.
495
# one option is just to buffer that text until we have a full line;
496
# another is to save and restore it
498
# XXX: might need to wrap more methods
500
def __init__(self, ui_factory, wrapped_stream):
501
self.ui_factory = ui_factory
502
self.wrapped_stream = wrapped_stream
503
# this does no transcoding, but it must expose the underlying encoding
504
# because some callers need to know what can be written - see for
505
# example unescape_for_display.
506
self.encoding = getattr(wrapped_stream, 'encoding', None)
509
self.ui_factory.clear_term()
510
self.wrapped_stream.flush()
512
def write(self, to_write):
513
self.ui_factory.clear_term()
514
self.wrapped_stream.write(to_write)
516
def writelines(self, lines):
517
self.ui_factory.clear_term()
518
self.wrapped_stream.writelines(lines)
added
removed
bzrlib/ui/text.py
