← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-06 06:48:25 UTC
  • mfrom: (4070.8.6 debug-config)
  • Revision ID: pqm@pqm.ubuntu.com-20090306064825-kbpwggw21dygeix6
(mbp) debug_flags configuration option

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/text.py
12
12
#
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
16
16
 
17
17
 
18
18
 
60
60
        # paints progress, network activity, etc
61
61
        self._progress_view = TextProgressView(self.stderr)
62
62
 
 
63
    def prompt(self, prompt):
 
64
        """Emit prompt on the CLI."""
 
65
        self.stdout.write(prompt)
 
66
 
63
67
    def clear_term(self):
64
68
        """Prepare the terminal for output.
65
69
 
82
86
        This may update a progress bar, spinner, or similar display.
83
87
        By default it does nothing.
84
88
        """
85
 
        self._progress_view._show_transport_activity(transport,
86
 
            direction, byte_count)
 
89
        self._progress_view.show_transport_activity(byte_count)
87
90
 
88
91
    def _progress_updated(self, task):
89
92
        """A task has been updated and wants to be displayed.
127
130
        self._last_repaint = 0
128
131
        # time we last got information about transport activity
129
132
        self._transport_update_time = 0
 
133
        self._task_fraction = None
130
134
        self._last_task = None
131
135
        self._total_byte_count = 0
132
136
        self._bytes_since_update = 0
142
146
 
143
147
    def _render_bar(self):
144
148
        # 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.
 
149
        if (self._last_task is not None) and self._last_task.show_bar:
151
150
            spin_str =  r'/-\|'[self._spin_pos % 4]
152
151
            self._spin_pos += 1
 
152
            f = self._task_fraction or 0
153
153
            cols = 20
154
 
            if self._last_task is None:
155
 
                completion_fraction = 0
156
 
            else:
157
 
                completion_fraction = \
158
 
                    self._last_task._overall_completion_fraction() or 0
159
 
            markers = int(round(float(cols) * completion_fraction)) - 1
 
154
            # number of markers highlighted in bar
 
155
            markers = int(round(float(cols) * f)) - 1
160
156
            bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
161
157
            return bar_str
162
 
        elif self._last_task.show_spinner:
163
 
            # The last task wanted just a spinner, no bar
 
158
        elif (self._last_task is None) or self._last_task.show_spinner:
164
159
            spin_str =  r'/-\|'[self._spin_pos % 4]
165
160
            self._spin_pos += 1
166
161
            return spin_str + ' '
176
171
            s = ' %d' % (task.current_cnt)
177
172
        else:
178
173
            s = ''
 
174
        self._task_fraction = task._overall_completion_fraction()
179
175
        # compose all the parent messages
180
176
        t = task
181
177
        m = task.msg
185
181
                m = t.msg + ':' + m
186
182
        return m + s
187
183
 
188
 
    def _render_line(self):
 
184
    def _repaint(self):
189
185
        bar_string = self._render_bar()
190
186
        if self._last_task:
191
187
            task_msg = self._format_task(self._last_task)
192
188
        else:
193
189
            task_msg = ''
194
190
        trans = self._last_transport_msg
195
 
        if trans:
 
191
        if trans and task_msg:
196
192
            trans += ' | '
197
 
        return (bar_string + trans + task_msg)
198
 
 
199
 
    def _repaint(self):
200
 
        s = self._render_line()
 
193
        s = (bar_string
 
194
             + trans
 
195
             + task_msg
 
196
             )
201
197
        self._show_line(s)
202
198
        self._have_output = True
203
199
 
204
200
    def show_progress(self, task):
205
 
        """Called by the task object when it has changed.
206
 
        
207
 
        :param task: The top task object; its parents are also included 
208
 
            by following links.
209
 
        """
210
 
        must_update = task is not self._last_task
211
201
        self._last_task = task
212
202
        now = time.time()
213
 
        if (not must_update) and (now < self._last_repaint + 0.1):
 
203
        if now < self._last_repaint + 0.1:
214
204
            return
215
 
        if now > self._transport_update_time + 10:
 
205
        if now > self._transport_update_time + 5:
216
206
            # no recent activity; expire it
217
207
            self._last_transport_msg = ''
218
208
        self._last_repaint = now
219
209
        self._repaint()
220
210
 
221
 
    def _show_transport_activity(self, transport, direction, byte_count):
222
 
        """Called by transports via the ui_factory, as they do IO.
 
211
    def show_transport_activity(self, byte_count):
 
212
        """Called by transports as they do IO.
223
213
 
224
214
        This may update a progress bar, spinner, or similar display.
225
215
        By default it does nothing.
236
226
            # guard against clock stepping backwards, and don't update too
237
227
            # often
238
228
            rate = self._bytes_since_update / (now - self._transport_update_time)
239
 
            scheme = getattr(transport, '_scheme', None) or repr(transport)
240
 
            if direction == 'read':
241
 
                dir_char = '>'
242
 
            elif direction == 'write':
243
 
                dir_char = '<'
244
 
            else:
245
 
                dir_char = '?'
246
 
            msg = ("%.7s %s %6dKB %5dKB/s" %
247
 
                    (scheme, dir_char, self._total_byte_count>>10, int(rate)>>10,))
 
229
            msg = ("%6dkB @ %4dkB/s" %
 
230
                (self._total_byte_count>>10, int(rate)>>10,))
248
231
            self._transport_update_time = now
249
232
            self._last_repaint = now
250
233
            self._bytes_since_update = 0