48
49
"""Create a TextUIFactory.
50
:param bar_type: The type of progress bar to create. It defaults to
51
:param bar_type: The type of progress bar to create. It defaults to
51
52
letting the bzrlib.progress.ProgressBar factory auto
54
super(TextUIFactory, self).__init__()
55
self._bar_type = bar_type
57
self.stdout = sys.stdout
61
self.stderr = sys.stderr
65
def prompt(self, prompt):
66
"""Emit prompt on the CLI."""
67
self.stdout.write(prompt)
69
@deprecated_method(zero_eight)
70
def progress_bar(self):
71
"""See UIFactory.nested_progress_bar()."""
72
# this in turn is abstract, and creates either a tty or dots
73
# bar depending on what we think of the terminal
74
return progress.ProgressBar()
76
def nested_progress_bar(self):
77
"""Return a nested progress bar.
79
The actual bar type returned depends on the progress module which
80
may return a tty or dots bar depending on the terminal.
82
if self._progress_bar_stack is None:
83
self._progress_bar_stack = progress.ProgressBarStack(
85
return self._progress_bar_stack.get_nested()
55
super(TextUIFactory, self).__init__(stdin=stdin,
56
stdout=stdout, stderr=stderr)
58
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 11, 0))
59
% "bar_type parameter")
60
# paints progress, network activity, etc
61
self._progress_view = TextProgressView(self.stderr)
87
63
def clear_term(self):
88
64
"""Prepare the terminal for output.
90
66
This will, clear any progress bars, and leave the cursor at the
91
67
leftmost position."""
92
if self._progress_bar_stack is None:
68
# XXX: If this is preparing to write to stdout, but that's for example
69
# directed into a file rather than to the terminal, and the progress
70
# bar _is_ going to the terminal, we shouldn't need
71
# to clear it. We might need to separately check for the case of
72
self._progress_view.clear()
75
"""Write an already-formatted message, clearing the progress bar if necessary."""
77
self.stdout.write(msg + '\n')
79
def report_transport_activity(self, transport, byte_count, direction):
80
"""Called by transports as they do IO.
82
This may update a progress bar, spinner, or similar display.
83
By default it does nothing.
85
self._progress_view._show_transport_activity(transport,
86
direction, byte_count)
88
def _progress_updated(self, task):
89
"""A task has been updated and wants to be displayed.
91
if not self._task_stack:
92
warnings.warn("%r updated but no tasks are active" %
94
elif task != self._task_stack[-1]:
95
warnings.warn("%r is not the top progress task %r" %
96
(task, self._task_stack[-1]))
97
self._progress_view.show_progress(task)
99
def _progress_all_finished(self):
100
self._progress_view.clear()
103
class TextProgressView(object):
104
"""Display of progress bar and other information on a tty.
106
This shows one line of text, including possibly a network indicator, spinner,
107
progress bar, message, etc.
109
One instance of this is created and held by the UI, and fed updates when a
110
task wants to be painted.
112
Transports feed data to this through the ui_factory object.
114
The Progress views can comprise a tree with _parent_task pointers, but
115
this only prints the stack from the nominated current task up to the root.
118
def __init__(self, term_file):
119
self._term_file = term_file
120
# true when there's output on the screen we may need to clear
121
self._have_output = False
122
# XXX: We could listen for SIGWINCH and update the terminal width...
123
self._width = osutils.terminal_width()
124
self._last_transport_msg = ''
126
# time we last repainted the screen
127
self._last_repaint = 0
128
# time we last got information about transport activity
129
self._transport_update_time = 0
130
self._last_task = None
131
self._total_byte_count = 0
132
self._bytes_since_update = 0
134
def _show_line(self, s):
136
self._term_file.write('\r%-*.*s\r' % (n, n, s))
139
if self._have_output:
141
self._have_output = False
143
def _render_bar(self):
144
# return a string for the progress bar itself
145
if (self._last_task is None) or self._last_task.show_bar:
146
# If there's no task object, we show space for the bar anyhow.
147
# That's because most invocations of bzr will end showing progress
148
# at some point, though perhaps only after doing some initial IO.
149
# It looks better to draw the progress bar initially rather than
150
# to have what looks like an incomplete progress bar.
151
spin_str = r'/-\|'[self._spin_pos % 4]
154
if self._last_task is None:
155
completion_fraction = 0
157
completion_fraction = \
158
self._last_task._overall_completion_fraction() or 0
159
markers = int(round(float(cols) * completion_fraction)) - 1
160
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
162
elif self._last_task.show_spinner:
163
# The last task wanted just a spinner, no bar
164
spin_str = r'/-\|'[self._spin_pos % 4]
166
return spin_str + ' '
170
def _format_task(self, task):
171
if not task.show_count:
173
elif task.current_cnt is not None and task.total_cnt is not None:
174
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
175
elif task.current_cnt is not None:
176
s = ' %d' % (task.current_cnt)
179
# compose all the parent messages
182
while t._parent_task:
188
def _render_line(self):
189
bar_string = self._render_bar()
191
task_msg = self._format_task(self._last_task)
194
trans = self._last_transport_msg
197
return (bar_string + trans + task_msg)
200
s = self._render_line()
202
self._have_output = True
204
def show_progress(self, task):
205
"""Called by the task object when it has changed.
207
:param task: The top task object; its parents are also included
210
must_update = task is not self._last_task
211
self._last_task = task
213
if (not must_update) and (now < self._last_repaint + 0.1):
94
overall_pb = self._progress_bar_stack.bottom()
95
if overall_pb is not None:
215
if now > self._transport_update_time + 10:
216
# no recent activity; expire it
217
self._last_transport_msg = ''
218
self._last_repaint = now
221
def _show_transport_activity(self, transport, direction, byte_count):
222
"""Called by transports via the ui_factory, as they do IO.
224
This may update a progress bar, spinner, or similar display.
225
By default it does nothing.
227
# XXX: Probably there should be a transport activity model, and that
228
# too should be seen by the progress view, rather than being poked in
230
self._total_byte_count += byte_count
231
self._bytes_since_update += byte_count
233
if self._transport_update_time is None:
234
self._transport_update_time = now
235
elif now >= (self._transport_update_time + 0.5):
236
# guard against clock stepping backwards, and don't update too
238
rate = self._bytes_since_update / (now - self._transport_update_time)
239
scheme = getattr(transport, '_scheme', None) or repr(transport)
240
if direction == 'read':
242
elif direction == 'write':
246
msg = ("%.7s %s %6dKB %5dKB/s" %
247
(scheme, dir_char, self._total_byte_count>>10, int(rate)>>10,))
248
self._transport_update_time = now
249
self._last_repaint = now
250
self._bytes_since_update = 0
251
self._last_transport_msg = msg
added
removed
bzrlib/ui/text.py
