← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

  • Committer: Vincent Ladeuil
  • Date: 2012-01-16 14:45:48 UTC
  • mto: (6437.35.1 2.5.0-dev)
  • mto: This revision was merged to the branch mainline in revision 6439.
  • Revision ID: v.ladeuil+lp@free.fr-20120116144548-48mob8d7dee824uc
Tags: bzr-2.5b5
Release 2.5b5

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-2011 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
from __future__ import absolute_import
 
22
 
23
23
import os
24
24
import sys
25
25
import time
26
 
import warnings
27
26
 
28
27
from bzrlib.lazy_import import lazy_import
29
28
lazy_import(globals(), """
 
29
import codecs
 
30
import getpass
 
31
import warnings
 
32
 
30
33
from bzrlib import (
31
34
    debug,
32
35
    progress,
33
36
    osutils,
34
 
    symbol_versioning,
35
37
    trace,
36
38
    )
37
39
 
38
40
""")
39
41
 
40
 
from bzrlib.osutils import watch_sigwinch
41
 
 
42
42
from bzrlib.ui import (
43
43
    UIFactory,
44
44
    NullProgressView,
45
45
    )
46
46
 
47
47
 
 
48
class _ChooseUI(object):
 
49
 
 
50
    """ Helper class for choose implementation.
 
51
    """
 
52
 
 
53
    def __init__(self, ui, msg, choices, default):
 
54
        self.ui = ui
 
55
        self._setup_mode()
 
56
        self._build_alternatives(msg, choices, default)
 
57
 
 
58
    def _setup_mode(self):
 
59
        """Setup input mode (line-based, char-based) and echo-back.
 
60
 
 
61
        Line-based input is used if the BZR_TEXTUI_INPUT environment
 
62
        variable is set to 'line-based', or if there is no controlling
 
63
        terminal.
 
64
        """
 
65
        if os.environ.get('BZR_TEXTUI_INPUT') != 'line-based' and \
 
66
           self.ui.stdin == sys.stdin and self.ui.stdin.isatty():
 
67
            self.line_based = False
 
68
            self.echo_back = True
 
69
        else:
 
70
            self.line_based = True
 
71
            self.echo_back = not self.ui.stdin.isatty()
 
72
 
 
73
    def _build_alternatives(self, msg, choices, default):
 
74
        """Parse choices string.
 
75
 
 
76
        Setup final prompt and the lists of choices and associated
 
77
        shortcuts.
 
78
        """
 
79
        index = 0
 
80
        help_list = []
 
81
        self.alternatives = {}
 
82
        choices = choices.split('\n')
 
83
        if default is not None and default not in range(0, len(choices)):
 
84
            raise ValueError("invalid default index")
 
85
        for c in choices:
 
86
            name = c.replace('&', '').lower()
 
87
            choice = (name, index)
 
88
            if name in self.alternatives:
 
89
                raise ValueError("duplicated choice: %s" % name)
 
90
            self.alternatives[name] = choice
 
91
            shortcut = c.find('&')
 
92
            if -1 != shortcut and (shortcut + 1) < len(c):
 
93
                help = c[:shortcut]
 
94
                help += '[' + c[shortcut + 1] + ']'
 
95
                help += c[(shortcut + 2):]
 
96
                shortcut = c[shortcut + 1]
 
97
            else:
 
98
                c = c.replace('&', '')
 
99
                shortcut = c[0]
 
100
                help = '[%s]%s' % (shortcut, c[1:])
 
101
            shortcut = shortcut.lower()
 
102
            if shortcut in self.alternatives:
 
103
                raise ValueError("duplicated shortcut: %s" % shortcut)
 
104
            self.alternatives[shortcut] = choice
 
105
            # Add redirections for default.
 
106
            if index == default:
 
107
                self.alternatives[''] = choice
 
108
                self.alternatives['\r'] = choice
 
109
            help_list.append(help)
 
110
            index += 1
 
111
 
 
112
        self.prompt = u'%s (%s): ' % (msg, ', '.join(help_list))
 
113
 
 
114
    def _getline(self):
 
115
        line = self.ui.stdin.readline()
 
116
        if '' == line:
 
117
            raise EOFError
 
118
        return line.strip()
 
119
 
 
120
    def _getchar(self):
 
121
        char = osutils.getchar()
 
122
        if char == chr(3): # INTR
 
123
            raise KeyboardInterrupt
 
124
        if char == chr(4): # EOF (^d, C-d)
 
125
            raise EOFError
 
126
        return char
 
127
 
 
128
    def interact(self):
 
129
        """Keep asking the user until a valid choice is made.
 
130
        """
 
131
        if self.line_based:
 
132
            getchoice = self._getline
 
133
        else:
 
134
            getchoice = self._getchar
 
135
        iter = 0
 
136
        while True:
 
137
            iter += 1
 
138
            if 1 == iter or self.line_based:
 
139
                self.ui.prompt(self.prompt)
 
140
            try:
 
141
                choice = getchoice()
 
142
            except EOFError:
 
143
                self.ui.stderr.write('\n')
 
144
                return None
 
145
            except KeyboardInterrupt:
 
146
                self.ui.stderr.write('\n')
 
147
                raise KeyboardInterrupt
 
148
            choice = choice.lower()
 
149
            if choice not in self.alternatives:
 
150
                # Not a valid choice, keep on asking.
 
151
                continue
 
152
            name, index = self.alternatives[choice]
 
153
            if self.echo_back:
 
154
                self.ui.stderr.write(name + '\n')
 
155
            return index
 
156
 
 
157
 
48
158
class TextUIFactory(UIFactory):
49
159
    """A UI factory for Text user interefaces."""
50
160
 
62
172
        self.stderr = stderr
63
173
        # paints progress, network activity, etc
64
174
        self._progress_view = self.make_progress_view()
65
 
        # hook up the signals to watch for terminal size changes
66
 
        watch_sigwinch()
 
175
 
 
176
    def choose(self, msg, choices, default=None):
 
177
        """Prompt the user for a list of alternatives.
 
178
 
 
179
        Support both line-based and char-based editing.
 
180
 
 
181
        In line-based mode, both the shortcut and full choice name are valid
 
182
        answers, e.g. for choose('prompt', '&yes\n&no'): 'y', ' Y ', ' yes',
 
183
        'YES ' are all valid input lines for choosing 'yes'.
 
184
 
 
185
        An empty line, when in line-based mode, or pressing enter in char-based
 
186
        mode will select the default choice (if any).
 
187
 
 
188
        Choice is echoed back if:
 
189
        - input is char-based; which means a controlling terminal is available,
 
190
          and osutils.getchar is used
 
191
        - input is line-based, and no controlling terminal is available
 
192
        """
 
193
 
 
194
        choose_ui = _ChooseUI(self, msg, choices, default)
 
195
        return choose_ui.interact()
67
196
 
68
197
    def be_quiet(self, state):
69
198
        if state and not self._quiet:
82
211
        # to clear it.  We might need to separately check for the case of
83
212
        self._progress_view.clear()
84
213
 
85
 
    def get_boolean(self, prompt):
86
 
        while True:
87
 
            self.prompt(prompt + "? [y/n]: ")
88
 
            line = self.stdin.readline().lower()
89
 
            if line in ('y\n', 'yes\n'):
90
 
                return True
91
 
            elif line in ('n\n', 'no\n'):
92
 
                return False
93
 
            elif line in ('', None):
94
 
                # end-of-file; possibly should raise an error here instead
95
 
                return None
96
 
 
97
214
    def get_integer(self, prompt):
98
215
        while True:
99
216
            self.prompt(prompt)
118
235
                password = password[:-1]
119
236
        return password
120
237
 
121
 
    def get_password(self, prompt='', **kwargs):
 
238
    def get_password(self, prompt=u'', **kwargs):
122
239
        """Prompt the user for a password.
123
240
 
124
241
        :param prompt: The prompt to present the user
157
274
        """Construct and return a new ProgressView subclass for this UI.
158
275
        """
159
276
        # with --quiet, never any progress view
160
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/320035>.  Otherwise if the
 
277
        # <https://bugs.launchpad.net/bzr/+bug/320035>.  Otherwise if the
161
278
        # user specifically requests either text or no progress bars, always
162
279
        # do that.  otherwise, guess based on $TERM and tty presence.
163
280
        if self.is_quiet():
202
319
        :param kwargs: Dictionary of arguments to insert into the prompt,
203
320
            to allow UIs to reformat the prompt.
204
321
        """
 
322
        if type(prompt) != unicode:
 
323
            raise ValueError("prompt %r not a unicode string" % prompt)
205
324
        if kwargs:
206
325
            # See <https://launchpad.net/bugs/365891>
207
326
            prompt = prompt % kwargs
208
327
        prompt = prompt.encode(osutils.get_terminal_encoding(), 'replace')
209
328
        self.clear_term()
 
329
        self.stdout.flush()
210
330
        self.stderr.write(prompt)
211
331
 
212
332
    def report_transport_activity(self, transport, byte_count, direction):
233
353
 
234
354
    def show_warning(self, msg):
235
355
        self.clear_term()
 
356
        if isinstance(msg, unicode):
 
357
            te = osutils.get_terminal_encoding()
 
358
            msg = msg.encode(te, 'replace')
236
359
        self.stderr.write("bzr: warning: %s\n" % msg)
237
360
 
238
361
    def _progress_updated(self, task):
301
424
        # correspond reliably to overall command progress
302
425
        self.enable_bar = False
303
426
 
 
427
    def _avail_width(self):
 
428
        # we need one extra space for terminals that wrap on last char
 
429
        w = osutils.terminal_width() 
 
430
        if w is None:
 
431
            return None
 
432
        else:
 
433
            return w - 1
 
434
 
304
435
    def _show_line(self, s):
305
436
        # sys.stderr.write("progress %r\n" % s)
306
 
        width = osutils.terminal_width()
 
437
        width = self._avail_width()
307
438
        if width is not None:
308
 
            # we need one extra space for terminals that wrap on last char
309
 
            width = width - 1
310
439
            s = '%-*.*s' % (width, width, s)
311
440
        self._term_file.write('\r' + s + '\r')
312
441
 
349
478
            return ''
350
479
 
351
480
    def _format_task(self, task):
 
481
        """Format task-specific parts of progress bar.
 
482
 
 
483
        :returns: (text_part, counter_part) both unicode strings.
 
484
        """
352
485
        if not task.show_count:
353
486
            s = ''
354
487
        elif task.current_cnt is not None and task.total_cnt is not None:
364
497
            t = t._parent_task
365
498
            if t.msg:
366
499
                m = t.msg + ':' + m
367
 
        return m + s
 
500
        return m, s
368
501
 
369
502
    def _render_line(self):
370
503
        bar_string = self._render_bar()
371
504
        if self._last_task:
372
 
            task_msg = self._format_task(self._last_task)
 
505
            task_part, counter_part = self._format_task(self._last_task)
373
506
        else:
374
 
            task_msg = ''
 
507
            task_part = counter_part = ''
375
508
        if self._last_task and not self._last_task.show_transport_activity:
376
509
            trans = ''
377
510
        else:
378
511
            trans = self._last_transport_msg
379
 
            if trans:
380
 
                trans += ' | '
381
 
        return (bar_string + trans + task_msg)
 
512
        # the bar separates the transport activity from the message, so even
 
513
        # if there's no bar or spinner, we must show something if both those
 
514
        # fields are present
 
515
        if (task_part or trans) and not bar_string:
 
516
            bar_string = '| '
 
517
        # preferentially truncate the task message if we don't have enough
 
518
        # space
 
519
        avail_width = self._avail_width()
 
520
        if avail_width is not None:
 
521
            # if terminal avail_width is unknown, don't truncate
 
522
            current_len = len(bar_string) + len(trans) + len(task_part) + len(counter_part)
 
523
            gap = current_len - avail_width
 
524
            if gap > 0:
 
525
                task_part = task_part[:-gap-2] + '..'
 
526
        s = trans + bar_string + task_part + counter_part
 
527
        if avail_width is not None:
 
528
            if len(s) < avail_width:
 
529
                s = s.ljust(avail_width)
 
530
            elif len(s) > avail_width:
 
531
                s = s[:avail_width]
 
532
        return s
382
533
 
383
534
    def _repaint(self):
384
535
        s = self._render_line()
440
591
            rate = (self._bytes_since_update
441
592
                    / (now - self._transport_update_time))
442
593
            # using base-10 units (see HACKING.txt).
443
 
            msg = ("%6dkB %5dkB/s" %
 
594
            msg = ("%6dkB %5dkB/s " %
444
595
                    (self._total_byte_count / 1000, int(rate) / 1000,))
445
596
            self._transport_update_time = now
446
597
            self._last_repaint = now