← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/text.py
1
 
# Copyright (C) 2005, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
"""Text UI, write output to the console.
19
19
"""
20
20
 
 
21
import codecs
21
22
import getpass
22
23
import os
23
24
import sys
31
32
    progress,
32
33
    osutils,
33
34
    symbol_versioning,
 
35
    trace,
34
36
    )
35
37
 
36
38
""")
37
39
 
 
40
from bzrlib.osutils import watch_sigwinch
 
41
 
38
42
from bzrlib.ui import (
39
43
    UIFactory,
40
44
    NullProgressView,
58
62
        self.stderr = stderr
59
63
        # paints progress, network activity, etc
60
64
        self._progress_view = self.make_progress_view()
61
 
        
 
65
        # hook up the signals to watch for terminal size changes
 
66
        watch_sigwinch()
 
67
 
 
68
    def be_quiet(self, state):
 
69
        if state and not self._quiet:
 
70
            self.clear_term()
 
71
        UIFactory.be_quiet(self, state)
 
72
        self._progress_view = self.make_progress_view()
 
73
 
62
74
    def clear_term(self):
63
75
        """Prepare the terminal for output.
64
76
 
82
94
                # end-of-file; possibly should raise an error here instead
83
95
                return None
84
96
 
 
97
    def get_integer(self, prompt):
 
98
        while True:
 
99
            self.prompt(prompt)
 
100
            line = self.stdin.readline()
 
101
            try:
 
102
                return int(line)
 
103
            except ValueError:
 
104
                pass
 
105
 
85
106
    def get_non_echoed_password(self):
86
107
        isatty = getattr(self.stdin, 'isatty', None)
87
108
        if isatty is not None and isatty():
135
156
    def make_progress_view(self):
136
157
        """Construct and return a new ProgressView subclass for this UI.
137
158
        """
138
 
        # if the user specifically requests either text or no progress bars,
139
 
        # always do that.  otherwise, guess based on $TERM and tty presence.
140
 
        if os.environ.get('BZR_PROGRESS_BAR') == 'text':
 
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.
 
163
        if self.is_quiet():
 
164
            return NullProgressView()
 
165
        elif os.environ.get('BZR_PROGRESS_BAR') == 'text':
141
166
            return TextProgressView(self.stderr)
142
167
        elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
143
168
            return NullProgressView()
146
171
        else:
147
172
            return NullProgressView()
148
173
 
 
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)
 
181
                if fileno:
 
182
                    import msvcrt
 
183
                    msvcrt.setmode(fileno(), os.O_BINARY)
 
184
            return TextUIOutputStream(self, self.stdout)
 
185
        else:
 
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)
 
193
 
149
194
    def note(self, msg):
150
195
        """Write an already-formatted message, clearing the progress bar if necessary."""
151
196
        self.clear_term()
173
218
        self._progress_view.show_transport_activity(transport,
174
219
            direction, byte_count)
175
220
 
 
221
    def log_transport_activity(self, display=False):
 
222
        """See UIFactory.log_transport_activity()"""
 
223
        log = getattr(self._progress_view, 'log_transport_activity', None)
 
224
        if log is not None:
 
225
            log(display=display)
 
226
 
176
227
    def show_error(self, msg):
177
228
        self.clear_term()
178
229
        self.stderr.write("bzr: error: %s\n" % msg)
191
242
            warnings.warn("%r updated but no tasks are active" %
192
243
                (task,))
193
244
        elif task != self._task_stack[-1]:
194
 
            warnings.warn("%r is not the top progress task %r" %
195
 
                (task, self._task_stack[-1]))
 
245
            # We used to check it was the top task, but it's hard to always
 
246
            # get this right and it's not necessarily useful: any actual
 
247
            # problems will be evident in use
 
248
            #warnings.warn("%r is not the top progress task %r" %
 
249
            #     (task, self._task_stack[-1]))
 
250
            pass
196
251
        self._progress_view.show_progress(task)
197
252
 
198
253
    def _progress_all_finished(self):
199
254
        self._progress_view.clear()
200
255
 
 
256
    def show_user_warning(self, warning_id, **message_args):
 
257
        """Show a text message to the user.
 
258
 
 
259
        Explicitly not for warnings about bzr apis, deprecations or internals.
 
260
        """
 
261
        # eventually trace.warning should migrate here, to avoid logging and
 
262
        # be easier to test; that has a lot of test fallout so for now just
 
263
        # new code can call this
 
264
        if warning_id not in self.suppressed_warnings:
 
265
            self.stderr.write(self.format_user_warning(warning_id, message_args) +
 
266
                '\n')
 
267
 
201
268
 
202
269
class TextProgressView(object):
203
270
    """Display of progress bar and other information on a tty.
218
285
        self._term_file = term_file
219
286
        # true when there's output on the screen we may need to clear
220
287
        self._have_output = False
221
 
        # XXX: We could listen for SIGWINCH and update the terminal width...
222
 
        # https://launchpad.net/bugs/316357
223
 
        self._width = osutils.terminal_width()
224
288
        self._last_transport_msg = ''
225
289
        self._spin_pos = 0
226
290
        # time we last repainted the screen
230
294
        self._last_task = None
231
295
        self._total_byte_count = 0
232
296
        self._bytes_since_update = 0
 
297
        self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
 
298
        self._first_byte_time = None
233
299
        self._fraction = 0
 
300
        # force the progress bar to be off, as at the moment it doesn't 
 
301
        # correspond reliably to overall command progress
 
302
        self.enable_bar = False
234
303
 
235
304
    def _show_line(self, s):
236
305
        # sys.stderr.write("progress %r\n" % s)
237
 
        n = self._width - 1
238
 
        self._term_file.write('\r%-*.*s\r' % (n, n, s))
 
306
        width = osutils.terminal_width()
 
307
        if width is not None:
 
308
            # we need one extra space for terminals that wrap on last char
 
309
            width = width - 1
 
310
            s = '%-*.*s' % (width, width, s)
 
311
        self._term_file.write('\r' + s + '\r')
239
312
 
240
313
    def clear(self):
241
314
        if self._have_output:
244
317
 
245
318
    def _render_bar(self):
246
319
        # return a string for the progress bar itself
247
 
        if (self._last_task is None) or self._last_task.show_bar:
 
320
        if self.enable_bar and (
 
321
            (self._last_task is None) or self._last_task.show_bar):
248
322
            # If there's no task object, we show space for the bar anyhow.
249
323
            # That's because most invocations of bzr will end showing progress
250
324
            # at some point, though perhaps only after doing some initial IO.
266
340
            markers = int(round(float(cols) * completion_fraction)) - 1
267
341
            bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
268
342
            return bar_str
269
 
        elif self._last_task.show_spinner:
 
343
        elif (self._last_task is None) or self._last_task.show_spinner:
270
344
            # The last task wanted just a spinner, no bar
271
345
            spin_str =  r'/-\|'[self._spin_pos % 4]
272
346
            self._spin_pos += 1
334
408
        This may update a progress bar, spinner, or similar display.
335
409
        By default it does nothing.
336
410
        """
337
 
        # XXX: Probably there should be a transport activity model, and that
338
 
        # too should be seen by the progress view, rather than being poked in
339
 
        # here.
340
 
        if not self._have_output:
341
 
            # As a workaround for <https://launchpad.net/bugs/321935> we only
342
 
            # show transport activity when there's already a progress bar
343
 
            # shown, which time the application code is expected to know to
344
 
            # clear off the progress bar when it's going to send some other
345
 
            # output.  Eventually it would be nice to have that automatically
346
 
            # synchronized.
347
 
            return
 
411
        # XXX: there should be a transport activity model, and that too should
 
412
        #      be seen by the progress view, rather than being poked in here.
348
413
        self._total_byte_count += byte_count
349
414
        self._bytes_since_update += byte_count
 
415
        if self._first_byte_time is None:
 
416
            # Note that this isn't great, as technically it should be the time
 
417
            # when the bytes started transferring, not when they completed.
 
418
            # However, we usually start with a small request anyway.
 
419
            self._first_byte_time = time.time()
 
420
        if direction in self._bytes_by_direction:
 
421
            self._bytes_by_direction[direction] += byte_count
 
422
        else:
 
423
            self._bytes_by_direction['unknown'] += byte_count
 
424
        if 'no_activity' in debug.debug_flags:
 
425
            # Can be used as a workaround if
 
426
            # <https://launchpad.net/bugs/321935> reappears and transport
 
427
            # activity is cluttering other output.  However, thanks to
 
428
            # TextUIOutputStream this shouldn't be a problem any more.
 
429
            return
350
430
        now = time.time()
351
431
        if self._total_byte_count < 2000:
352
432
            # a little resistance at first, so it doesn't stay stuck at 0
357
437
        elif now >= (self._transport_update_time + 0.5):
358
438
            # guard against clock stepping backwards, and don't update too
359
439
            # often
360
 
            rate = self._bytes_since_update / (now - self._transport_update_time)
361
 
            msg = ("%6dKB %5dKB/s" %
362
 
                    (self._total_byte_count>>10, int(rate)>>10,))
 
440
            rate = (self._bytes_since_update
 
441
                    / (now - self._transport_update_time))
 
442
            # using base-10 units (see HACKING.txt).
 
443
            msg = ("%6dkB %5dkB/s" %
 
444
                    (self._total_byte_count / 1000, int(rate) / 1000,))
363
445
            self._transport_update_time = now
364
446
            self._last_repaint = now
365
447
            self._bytes_since_update = 0
366
448
            self._last_transport_msg = msg
367
449
            self._repaint()
 
450
 
 
451
    def _format_bytes_by_direction(self):
 
452
        if self._first_byte_time is None:
 
453
            bps = 0.0
 
454
        else:
 
455
            transfer_time = time.time() - self._first_byte_time
 
456
            if transfer_time < 0.001:
 
457
                transfer_time = 0.001
 
458
            bps = self._total_byte_count / transfer_time
 
459
 
 
460
        # using base-10 units (see HACKING.txt).
 
461
        msg = ('Transferred: %.0fkB'
 
462
               ' (%.1fkB/s r:%.0fkB w:%.0fkB'
 
463
               % (self._total_byte_count / 1000.,
 
464
                  bps / 1000.,
 
465
                  self._bytes_by_direction['read'] / 1000.,
 
466
                  self._bytes_by_direction['write'] / 1000.,
 
467
                 ))
 
468
        if self._bytes_by_direction['unknown'] > 0:
 
469
            msg += ' u:%.0fkB)' % (
 
470
                self._bytes_by_direction['unknown'] / 1000.
 
471
                )
 
472
        else:
 
473
            msg += ')'
 
474
        return msg
 
475
 
 
476
    def log_transport_activity(self, display=False):
 
477
        msg = self._format_bytes_by_direction()
 
478
        trace.mutter(msg)
 
479
        if display and self._total_byte_count > 0:
 
480
            self.clear()
 
481
            self._term_file.write(msg + '\n')
 
482
 
 
483
 
 
484
class TextUIOutputStream(object):
 
485
    """Decorates an output stream so that the terminal is cleared before writing.
 
486
 
 
487
    This is supposed to ensure that the progress bar does not conflict with bulk
 
488
    text output.
 
489
    """
 
490
    # XXX: this does not handle the case of writing part of a line, then doing
 
491
    # progress bar output: the progress bar will probably write over it.
 
492
    # one option is just to buffer that text until we have a full line;
 
493
    # another is to save and restore it
 
494
 
 
495
    # XXX: might need to wrap more methods
 
496
 
 
497
    def __init__(self, ui_factory, wrapped_stream):
 
498
        self.ui_factory = ui_factory
 
499
        self.wrapped_stream = wrapped_stream
 
500
        # this does no transcoding, but it must expose the underlying encoding
 
501
        # because some callers need to know what can be written - see for
 
502
        # example unescape_for_display.
 
503
        self.encoding = getattr(wrapped_stream, 'encoding', None)
 
504
 
 
505
    def flush(self):
 
506
        self.ui_factory.clear_term()
 
507
        self.wrapped_stream.flush()
 
508
 
 
509
    def write(self, to_write):
 
510
        self.ui_factory.clear_term()
 
511
        self.wrapped_stream.write(to_write)
 
512
 
 
513
    def writelines(self, lines):
 
514
        self.ui_factory.clear_term()
 
515
        self.wrapped_stream.writelines(lines)