← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

  • Committer: Martin Pool
  • Date: 2009-09-11 06:36:50 UTC
  • mto: This revision was merged to the branch mainline in revision 4688.
  • Revision ID: mbp@sourcefrog.net-20090911063650-yvb522sbe6k0i62r
Only mutter extension load errors when they occur, and record for later

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/text.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2008, 2009 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
22
21
import getpass
23
22
import os
24
23
import sys
28
27
from bzrlib.lazy_import import lazy_import
29
28
lazy_import(globals(), """
30
29
from bzrlib import (
31
 
    debug,
32
30
    progress,
33
31
    osutils,
34
32
    symbol_versioning,
35
 
    trace,
36
33
    )
37
34
 
38
35
""")
39
36
 
40
 
from bzrlib.osutils import watch_sigwinch
41
 
 
42
37
from bzrlib.ui import (
43
38
    UIFactory,
44
39
    NullProgressView,
53
48
                 stdout=None,
54
49
                 stderr=None):
55
50
        """Create a TextUIFactory.
 
51
 
 
52
        :param bar_type: The type of progress bar to create. It defaults to
 
53
                         letting the bzrlib.progress.ProgressBar factory auto
 
54
                         select.   Deprecated.
56
55
        """
57
56
        super(TextUIFactory, self).__init__()
58
57
        # TODO: there's no good reason not to pass all three streams, maybe we
62
61
        self.stderr = stderr
63
62
        # paints progress, network activity, etc
64
63
        self._progress_view = self.make_progress_view()
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
 
 
 
64
        
74
65
    def clear_term(self):
75
66
        """Prepare the terminal for output.
76
67
 
94
85
                # end-of-file; possibly should raise an error here instead
95
86
                return None
96
87
 
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
 
 
106
88
    def get_non_echoed_password(self):
107
89
        isatty = getattr(self.stdin, 'isatty', None)
108
90
        if isatty is not None and isatty():
156
138
    def make_progress_view(self):
157
139
        """Construct and return a new ProgressView subclass for this UI.
158
140
        """
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
        # if the user specifically requests either text or no progress bars,
 
142
        # always do that.  otherwise, guess based on $TERM and tty presence.
 
143
        if os.environ.get('BZR_PROGRESS_BAR') == 'text':
166
144
            return TextProgressView(self.stderr)
167
145
        elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
168
146
            return NullProgressView()
171
149
        else:
172
150
            return NullProgressView()
173
151
 
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
 
 
194
152
    def note(self, msg):
195
153
        """Write an already-formatted message, clearing the progress bar if necessary."""
196
154
        self.clear_term()
218
176
        self._progress_view.show_transport_activity(transport,
219
177
            direction, byte_count)
220
178
 
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
 
 
227
 
    def show_error(self, msg):
228
 
        self.clear_term()
229
 
        self.stderr.write("bzr: error: %s\n" % msg)
230
 
 
231
 
    def show_message(self, msg):
232
 
        self.note(msg)
233
 
 
234
 
    def show_warning(self, msg):
235
 
        self.clear_term()
236
 
        self.stderr.write("bzr: warning: %s\n" % msg)
237
 
 
238
179
    def _progress_updated(self, task):
239
180
        """A task has been updated and wants to be displayed.
240
181
        """
242
183
            warnings.warn("%r updated but no tasks are active" %
243
184
                (task,))
244
185
        elif 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
 
186
            warnings.warn("%r is not the top progress task %r" %
 
187
                (task, self._task_stack[-1]))
251
188
        self._progress_view.show_progress(task)
252
189
 
253
190
    def _progress_all_finished(self):
254
191
        self._progress_view.clear()
255
192
 
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
 
 
268
193
 
269
194
class TextProgressView(object):
270
195
    """Display of progress bar and other information on a tty.
285
210
        self._term_file = term_file
286
211
        # true when there's output on the screen we may need to clear
287
212
        self._have_output = False
 
213
        # XXX: We could listen for SIGWINCH and update the terminal width...
 
214
        # https://launchpad.net/bugs/316357
 
215
        self._width = osutils.terminal_width()
288
216
        self._last_transport_msg = ''
289
217
        self._spin_pos = 0
290
218
        # time we last repainted the screen
294
222
        self._last_task = None
295
223
        self._total_byte_count = 0
296
224
        self._bytes_since_update = 0
297
 
        self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
298
 
        self._first_byte_time = None
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
303
225
 
304
226
    def _show_line(self, s):
305
 
        # sys.stderr.write("progress %r\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')
 
227
        n = self._width - 1
 
228
        self._term_file.write('\r%-*.*s\r' % (n, n, s))
312
229
 
313
230
    def clear(self):
314
231
        if self._have_output:
317
234
 
318
235
    def _render_bar(self):
319
236
        # return a string for the progress bar itself
320
 
        if self.enable_bar and (
321
 
            (self._last_task is None) or self._last_task.show_bar):
 
237
        if (self._last_task is None) or self._last_task.show_bar:
322
238
            # If there's no task object, we show space for the bar anyhow.
323
239
            # That's because most invocations of bzr will end showing progress
324
240
            # at some point, though perhaps only after doing some initial IO.
329
245
            cols = 20
330
246
            if self._last_task is None:
331
247
                completion_fraction = 0
332
 
                self._fraction = 0
333
248
            else:
334
249
                completion_fraction = \
335
250
                    self._last_task._overall_completion_fraction() or 0
336
 
            if (completion_fraction < self._fraction and 'progress' in
337
 
                debug.debug_flags):
338
 
                import pdb;pdb.set_trace()
339
 
            self._fraction = completion_fraction
340
251
            markers = int(round(float(cols) * completion_fraction)) - 1
341
252
            bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
342
253
            return bar_str
343
 
        elif (self._last_task is None) or self._last_task.show_spinner:
 
254
        elif self._last_task.show_spinner:
344
255
            # The last task wanted just a spinner, no bar
345
256
            spin_str =  r'/-\|'[self._spin_pos % 4]
346
257
            self._spin_pos += 1
372
283
            task_msg = self._format_task(self._last_task)
373
284
        else:
374
285
            task_msg = ''
375
 
        if self._last_task and not self._last_task.show_transport_activity:
376
 
            trans = ''
377
 
        else:
378
 
            trans = self._last_transport_msg
379
 
            if trans:
380
 
                trans += ' | '
 
286
        trans = self._last_transport_msg
 
287
        if trans:
 
288
            trans += ' | '
381
289
        return (bar_string + trans + task_msg)
382
290
 
383
291
    def _repaint(self):
394
302
        must_update = task is not self._last_task
395
303
        self._last_task = task
396
304
        now = time.time()
397
 
        if (not must_update) and (now < self._last_repaint + task.update_latency):
 
305
        if (not must_update) and (now < self._last_repaint + 0.1):
398
306
            return
399
307
        if now > self._transport_update_time + 10:
400
308
            # no recent activity; expire it
408
316
        This may update a progress bar, spinner, or similar display.
409
317
        By default it does nothing.
410
318
        """
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.
 
319
        # XXX: Probably there should be a transport activity model, and that
 
320
        # too should be seen by the progress view, rather than being poked in
 
321
        # here.
 
322
        if not self._have_output:
 
323
            # As a workaround for <https://launchpad.net/bugs/321935> we only
 
324
            # show transport activity when there's already a progress bar
 
325
            # shown, which time the application code is expected to know to
 
326
            # clear off the progress bar when it's going to send some other
 
327
            # output.  Eventually it would be nice to have that automatically
 
328
            # synchronized.
 
329
            return
413
330
        self._total_byte_count += byte_count
414
331
        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
430
332
        now = time.time()
431
 
        if self._total_byte_count < 2000:
432
 
            # a little resistance at first, so it doesn't stay stuck at 0
433
 
            # while connecting...
434
 
            return
435
333
        if self._transport_update_time is None:
436
334
            self._transport_update_time = now
437
335
        elif now >= (self._transport_update_time + 0.5):
438
336
            # guard against clock stepping backwards, and don't update too
439
337
            # often
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,))
 
338
            rate = self._bytes_since_update / (now - self._transport_update_time)
 
339
            msg = ("%6dKB %5dKB/s" %
 
340
                    (self._total_byte_count>>10, int(rate)>>10,))
445
341
            self._transport_update_time = now
446
342
            self._last_repaint = now
447
343
            self._bytes_since_update = 0
448
344
            self._last_transport_msg = msg
449
345
            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)