1
# Copyright (C) 2005, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
19
"""Text UI, write output to the console.
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
38
from bzrlib.ui import CLIUIFactory
41
class TextUIFactory(CLIUIFactory):
42
"""A UI factory for Text user interefaces."""
49
"""Create a TextUIFactory.
51
:param bar_type: The type of progress bar to create. It defaults to
52
letting the bzrlib.progress.ProgressBar factory auto
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)
63
def prompt(self, prompt):
64
"""Emit prompt on the CLI."""
65
self.stdout.write(prompt)
68
"""Prepare the terminal for output.
70
This will, clear any progress bars, and leave the cursor at the
72
# XXX: If this is preparing to write to stdout, but that's for example
73
# directed into a file rather than to the terminal, and the progress
74
# bar _is_ going to the terminal, we shouldn't need
75
# to clear it. We might need to separately check for the case of
76
self._progress_view.clear()
79
"""Write an already-formatted message, clearing the progress bar if necessary."""
81
self.stdout.write(msg + '\n')
83
def report_transport_activity(self, transport, byte_count, direction):
84
"""Called by transports as they do IO.
86
This may update a progress bar, spinner, or similar display.
87
By default it does nothing.
89
self._progress_view.show_transport_activity(byte_count)
91
def _progress_updated(self, task):
92
"""A task has been updated and wants to be displayed.
94
if not self._task_stack:
95
warnings.warn("%r updated but no tasks are active" %
97
elif task != self._task_stack[-1]:
98
warnings.warn("%r is not the top progress task %r" %
99
(task, self._task_stack[-1]))
100
self._progress_view.show_progress(task)
102
def _progress_all_finished(self):
103
self._progress_view.clear()
106
class TextProgressView(object):
107
"""Display of progress bar and other information on a tty.
109
This shows one line of text, including possibly a network indicator, spinner,
110
progress bar, message, etc.
112
One instance of this is created and held by the UI, and fed updates when a
113
task wants to be painted.
115
Transports feed data to this through the ui_factory object.
117
The Progress views can comprise a tree with _parent_task pointers, but
118
this only prints the stack from the nominated current task up to the root.
121
def __init__(self, term_file):
122
self._term_file = term_file
123
# true when there's output on the screen we may need to clear
124
self._have_output = False
125
# XXX: We could listen for SIGWINCH and update the terminal width...
126
self._width = osutils.terminal_width()
127
self._last_transport_msg = ''
129
# time we last repainted the screen
130
self._last_repaint = 0
131
# time we last got information about transport activity
132
self._transport_update_time = 0
133
self._task_fraction = None
134
self._last_task = None
135
self._total_byte_count = 0
136
self._bytes_since_update = 0
138
def _show_line(self, s):
140
self._term_file.write('\r%-*.*s\r' % (n, n, s))
143
if self._have_output:
145
self._have_output = False
147
def _render_bar(self):
148
# return a string for the progress bar itself
149
if (self._last_task is not None) and self._last_task.show_bar:
150
spin_str = r'/-\|'[self._spin_pos % 4]
152
f = self._task_fraction or 0
154
# number of markers highlighted in bar
155
markers = int(round(float(cols) * f)) - 1
156
bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
158
elif (self._last_task is None) or self._last_task.show_spinner:
159
spin_str = r'/-\|'[self._spin_pos % 4]
161
return spin_str + ' '
165
def _format_task(self, task):
166
if not task.show_count:
168
elif task.current_cnt is not None and task.total_cnt is not None:
169
s = ' %d/%d' % (task.current_cnt, task.total_cnt)
170
elif task.current_cnt is not None:
171
s = ' %d' % (task.current_cnt)
174
self._task_fraction = task._overall_completion_fraction()
175
# compose all the parent messages
178
while t._parent_task:
185
bar_string = self._render_bar()
187
task_msg = self._format_task(self._last_task)
190
trans = self._last_transport_msg
191
if trans and task_msg:
198
self._have_output = True
200
def show_progress(self, task):
201
self._last_task = task
203
if now < self._last_repaint + 0.1:
205
if now > self._transport_update_time + 5:
206
# no recent activity; expire it
207
self._last_transport_msg = ''
208
self._last_repaint = now
211
def show_transport_activity(self, byte_count):
212
"""Called by transports as they do IO.
214
This may update a progress bar, spinner, or similar display.
215
By default it does nothing.
217
# XXX: Probably there should be a transport activity model, and that
218
# too should be seen by the progress view, rather than being poked in
220
self._total_byte_count += byte_count
221
self._bytes_since_update += byte_count
223
if self._transport_update_time is None:
224
self._transport_update_time = now
225
elif now >= (self._transport_update_time + 0.5):
226
# guard against clock stepping backwards, and don't update too
228
rate = self._bytes_since_update / (now - self._transport_update_time)
229
msg = ("%6dkB @ %4dkB/s" %
230
(self._total_byte_count>>10, int(rate)>>10,))
231
self._transport_update_time = now
232
self._last_repaint = now
233
self._bytes_since_update = 0
234
self._last_transport_msg = msg
added
removed
bzrlib/ui/text.py
