← 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: 2010-02-27 01:34:49 UTC
  • mto: This revision was merged to the branch mainline in revision 5064.
  • Revision ID: mbp@canonical.com-20100227013449-zxostilwfoendxfv
Handle "Directory not empty" from ftp as DirectoryNotEmpty.

FtpTransport._translate_ftp_error can handle all ftp errors; there's no clear
distinction between 'temporary' and 'permament'.

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
 
22
import getpass
21
23
import os
22
24
import sys
23
25
import time
26
28
from bzrlib.lazy_import import lazy_import
27
29
lazy_import(globals(), """
28
30
from bzrlib import (
 
31
    debug,
29
32
    progress,
30
33
    osutils,
31
34
    symbol_versioning,
 
35
    trace,
32
36
    )
33
37
 
34
38
""")
35
39
 
 
40
from bzrlib.osutils import watch_sigwinch
 
41
 
36
42
from bzrlib.ui import (
37
43
    UIFactory,
38
44
    NullProgressView,
47
53
                 stdout=None,
48
54
                 stderr=None):
49
55
        """Create a TextUIFactory.
50
 
 
51
 
        :param bar_type: The type of progress bar to create. It defaults to
52
 
                         letting the bzrlib.progress.ProgressBar factory auto
53
 
                         select.   Deprecated.
54
56
        """
55
57
        super(TextUIFactory, self).__init__()
56
58
        # TODO: there's no good reason not to pass all three streams, maybe we
60
62
        self.stderr = stderr
61
63
        # paints progress, network activity, etc
62
64
        self._progress_view = self.make_progress_view()
63
 
        
 
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
    def clear_term(self):
65
75
        """Prepare the terminal for output.
66
76
 
84
94
                # end-of-file; possibly should raise an error here instead
85
95
                return None
86
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
 
87
106
    def get_non_echoed_password(self):
88
107
        isatty = getattr(self.stdin, 'isatty', None)
89
108
        if isatty is not None and isatty():
137
156
    def make_progress_view(self):
138
157
        """Construct and return a new ProgressView subclass for this UI.
139
158
        """
140
 
        # if the user specifically requests either text or no progress bars,
141
 
        # always do that.  otherwise, guess based on $TERM and tty presence.
142
 
        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':
143
166
            return TextProgressView(self.stderr)
144
167
        elif os.environ.get('BZR_PROGRESS_BAR') == 'none':
145
168
            return NullProgressView()
148
171
        else:
149
172
            return NullProgressView()
150
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
 
151
194
    def note(self, msg):
152
195
        """Write an already-formatted message, clearing the progress bar if necessary."""
153
196
        self.clear_term()
175
218
        self._progress_view.show_transport_activity(transport,
176
219
            direction, byte_count)
177
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
 
 
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
 
178
238
    def _progress_updated(self, task):
179
239
        """A task has been updated and wants to be displayed.
180
240
        """
182
242
            warnings.warn("%r updated but no tasks are active" %
183
243
                (task,))
184
244
        elif task != self._task_stack[-1]:
185
 
            warnings.warn("%r is not the top progress task %r" %
186
 
                (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
187
251
        self._progress_view.show_progress(task)
188
252
 
189
253
    def _progress_all_finished(self):
209
273
        self._term_file = term_file
210
274
        # true when there's output on the screen we may need to clear
211
275
        self._have_output = False
212
 
        # XXX: We could listen for SIGWINCH and update the terminal width...
213
 
        # https://launchpad.net/bugs/316357
214
 
        self._width = osutils.terminal_width()
215
276
        self._last_transport_msg = ''
216
277
        self._spin_pos = 0
217
278
        # time we last repainted the screen
221
282
        self._last_task = None
222
283
        self._total_byte_count = 0
223
284
        self._bytes_since_update = 0
 
285
        self._bytes_by_direction = {'unknown': 0, 'read': 0, 'write': 0}
 
286
        self._first_byte_time = None
 
287
        self._fraction = 0
 
288
        # force the progress bar to be off, as at the moment it doesn't 
 
289
        # correspond reliably to overall command progress
 
290
        self.enable_bar = False
224
291
 
225
292
    def _show_line(self, s):
226
 
        n = self._width - 1
227
 
        self._term_file.write('\r%-*.*s\r' % (n, n, s))
 
293
        # sys.stderr.write("progress %r\n" % s)
 
294
        width = osutils.terminal_width()
 
295
        if width is not None:
 
296
            # we need one extra space for terminals that wrap on last char
 
297
            width = width - 1
 
298
            s = '%-*.*s' % (width, width, s)
 
299
        self._term_file.write('\r' + s + '\r')
228
300
 
229
301
    def clear(self):
230
302
        if self._have_output:
233
305
 
234
306
    def _render_bar(self):
235
307
        # return a string for the progress bar itself
236
 
        if (self._last_task is None) or self._last_task.show_bar:
 
308
        if self.enable_bar and (
 
309
            (self._last_task is None) or self._last_task.show_bar):
237
310
            # If there's no task object, we show space for the bar anyhow.
238
311
            # That's because most invocations of bzr will end showing progress
239
312
            # at some point, though perhaps only after doing some initial IO.
244
317
            cols = 20
245
318
            if self._last_task is None:
246
319
                completion_fraction = 0
 
320
                self._fraction = 0
247
321
            else:
248
322
                completion_fraction = \
249
323
                    self._last_task._overall_completion_fraction() or 0
 
324
            if (completion_fraction < self._fraction and 'progress' in
 
325
                debug.debug_flags):
 
326
                import pdb;pdb.set_trace()
 
327
            self._fraction = completion_fraction
250
328
            markers = int(round(float(cols) * completion_fraction)) - 1
251
329
            bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
252
330
            return bar_str
253
 
        elif self._last_task.show_spinner:
 
331
        elif (self._last_task is None) or self._last_task.show_spinner:
254
332
            # The last task wanted just a spinner, no bar
255
333
            spin_str =  r'/-\|'[self._spin_pos % 4]
256
334
            self._spin_pos += 1
282
360
            task_msg = self._format_task(self._last_task)
283
361
        else:
284
362
            task_msg = ''
285
 
        trans = self._last_transport_msg
286
 
        if trans:
287
 
            trans += ' | '
 
363
        if self._last_task and not self._last_task.show_transport_activity:
 
364
            trans = ''
 
365
        else:
 
366
            trans = self._last_transport_msg
 
367
            if trans:
 
368
                trans += ' | '
288
369
        return (bar_string + trans + task_msg)
289
370
 
290
371
    def _repaint(self):
301
382
        must_update = task is not self._last_task
302
383
        self._last_task = task
303
384
        now = time.time()
304
 
        if (not must_update) and (now < self._last_repaint + 0.1):
 
385
        if (not must_update) and (now < self._last_repaint + task.update_latency):
305
386
            return
306
387
        if now > self._transport_update_time + 10:
307
388
            # no recent activity; expire it
315
396
        This may update a progress bar, spinner, or similar display.
316
397
        By default it does nothing.
317
398
        """
318
 
        # XXX: Probably there should be a transport activity model, and that
319
 
        # too should be seen by the progress view, rather than being poked in
320
 
        # here.
321
 
        if not self._have_output:
322
 
            # As a workaround for <https://launchpad.net/bugs/321935> we only
323
 
            # show transport activity when there's already a progress bar
324
 
            # shown, which time the application code is expected to know to
325
 
            # clear off the progress bar when it's going to send some other
326
 
            # output.  Eventually it would be nice to have that automatically
327
 
            # synchronized.
328
 
            return
 
399
        # XXX: there should be a transport activity model, and that too should
 
400
        #      be seen by the progress view, rather than being poked in here.
329
401
        self._total_byte_count += byte_count
330
402
        self._bytes_since_update += byte_count
 
403
        if self._first_byte_time is None:
 
404
            # Note that this isn't great, as technically it should be the time
 
405
            # when the bytes started transferring, not when they completed.
 
406
            # However, we usually start with a small request anyway.
 
407
            self._first_byte_time = time.time()
 
408
        if direction in self._bytes_by_direction:
 
409
            self._bytes_by_direction[direction] += byte_count
 
410
        else:
 
411
            self._bytes_by_direction['unknown'] += byte_count
 
412
        if 'no_activity' in debug.debug_flags:
 
413
            # Can be used as a workaround if
 
414
            # <https://launchpad.net/bugs/321935> reappears and transport
 
415
            # activity is cluttering other output.  However, thanks to
 
416
            # TextUIOutputStream this shouldn't be a problem any more.
 
417
            return
331
418
        now = time.time()
 
419
        if self._total_byte_count < 2000:
 
420
            # a little resistance at first, so it doesn't stay stuck at 0
 
421
            # while connecting...
 
422
            return
332
423
        if self._transport_update_time is None:
333
424
            self._transport_update_time = now
334
425
        elif now >= (self._transport_update_time + 0.5):
335
426
            # guard against clock stepping backwards, and don't update too
336
427
            # often
337
 
            rate = self._bytes_since_update / (now - self._transport_update_time)
338
 
            msg = ("%6dKB %5dKB/s" %
339
 
                    (self._total_byte_count>>10, int(rate)>>10,))
 
428
            rate = (self._bytes_since_update
 
429
                    / (now - self._transport_update_time))
 
430
            # using base-10 units (see HACKING.txt).
 
431
            msg = ("%6dkB %5dkB/s" %
 
432
                    (self._total_byte_count / 1000, int(rate) / 1000,))
340
433
            self._transport_update_time = now
341
434
            self._last_repaint = now
342
435
            self._bytes_since_update = 0
343
436
            self._last_transport_msg = msg
344
437
            self._repaint()
 
438
 
 
439
    def _format_bytes_by_direction(self):
 
440
        if self._first_byte_time is None:
 
441
            bps = 0.0
 
442
        else:
 
443
            transfer_time = time.time() - self._first_byte_time
 
444
            if transfer_time < 0.001:
 
445
                transfer_time = 0.001
 
446
            bps = self._total_byte_count / transfer_time
 
447
 
 
448
        # using base-10 units (see HACKING.txt).
 
449
        msg = ('Transferred: %.0fkB'
 
450
               ' (%.1fkB/s r:%.0fkB w:%.0fkB'
 
451
               % (self._total_byte_count / 1000.,
 
452
                  bps / 1000.,
 
453
                  self._bytes_by_direction['read'] / 1000.,
 
454
                  self._bytes_by_direction['write'] / 1000.,
 
455
                 ))
 
456
        if self._bytes_by_direction['unknown'] > 0:
 
457
            msg += ' u:%.0fkB)' % (
 
458
                self._bytes_by_direction['unknown'] / 1000.
 
459
                )
 
460
        else:
 
461
            msg += ')'
 
462
        return msg
 
463
 
 
464
    def log_transport_activity(self, display=False):
 
465
        msg = self._format_bytes_by_direction()
 
466
        trace.mutter(msg)
 
467
        if display and self._total_byte_count > 0:
 
468
            self.clear()
 
469
            self._term_file.write(msg + '\n')
 
470
 
 
471
 
 
472
class TextUIOutputStream(object):
 
473
    """Decorates an output stream so that the terminal is cleared before writing.
 
474
 
 
475
    This is supposed to ensure that the progress bar does not conflict with bulk
 
476
    text output.
 
477
    """
 
478
    # XXX: this does not handle the case of writing part of a line, then doing
 
479
    # progress bar output: the progress bar will probably write over it.
 
480
    # one option is just to buffer that text until we have a full line;
 
481
    # another is to save and restore it
 
482
 
 
483
    # XXX: might need to wrap more methods
 
484
 
 
485
    def __init__(self, ui_factory, wrapped_stream):
 
486
        self.ui_factory = ui_factory
 
487
        self.wrapped_stream = wrapped_stream
 
488
        # this does no transcoding, but it must expose the underlying encoding
 
489
        # because some callers need to know what can be written - see for
 
490
        # example unescape_for_display.
 
491
        self.encoding = getattr(wrapped_stream, 'encoding', None)
 
492
 
 
493
    def flush(self):
 
494
        self.ui_factory.clear_term()
 
495
        self.wrapped_stream.flush()
 
496
 
 
497
    def write(self, to_write):
 
498
        self.ui_factory.clear_term()
 
499
        self.wrapped_stream.write(to_write)
 
500
 
 
501
    def writelines(self, lines):
 
502
        self.ui_factory.clear_term()
 
503
        self.wrapped_stream.writelines(lines)