← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-02-18 13:27:08 UTC
  • mfrom: (4011.4.3 ssh-hints)
  • Revision ID: pqm@pqm.ubuntu.com-20090218132708-okubrahz9exvae9r
(Jelmer) Point out bzr+ssh:// to the user when they use ssh://.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/__init__.py
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
 
18
 
 
19
17
"""UI abstraction.
20
18
 
21
19
This tells the library how to display things to the user.  Through this
28
26
displays no output.
29
27
"""
30
28
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
import bzrlib.progress
36
 
 
37
 
 
38
 
class TextUIFactory(object):
39
 
    def progress_bar(self):
40
 
 
41
 
        # this in turn is abstract, and creates either a tty or dots
42
 
        # bar depending on what we think of the terminal
43
 
        return bzrlib.progress.ProgressBar()
44
 
 
45
 
 
46
 
class SilentUIFactory(object):
47
 
    def progress_bar(self):
48
 
        return bzrlib.progress.DummyProgress()
 
29
import os
 
30
import sys
 
31
import warnings
 
32
 
 
33
from bzrlib.lazy_import import lazy_import
 
34
lazy_import(globals(), """
 
35
import getpass
 
36
 
 
37
from bzrlib import (
 
38
    errors,
 
39
    osutils,
 
40
    progress,
 
41
    trace,
 
42
    )
 
43
""")
 
44
 
 
45
 
 
46
class UIFactory(object):
 
47
    """UI abstraction.
 
48
 
 
49
    This tells the library how to display things to the user.  Through this
 
50
    layer different applications can choose the style of UI.
 
51
    """
 
52
 
 
53
    def __init__(self):
 
54
        self._task_stack = []
 
55
 
 
56
    def get_password(self, prompt='', **kwargs):
 
57
        """Prompt the user for a password.
 
58
 
 
59
        :param prompt: The prompt to present the user
 
60
        :param kwargs: Arguments which will be expanded into the prompt.
 
61
                       This lets front ends display different things if
 
62
                       they so choose.
 
63
 
 
64
        :return: The password string, return None if the user canceled the
 
65
                 request. Note that we do not touch the encoding, users may
 
66
                 have whatever they see fit and the password should be
 
67
                 transported as is.
 
68
        """
 
69
        raise NotImplementedError(self.get_password)
 
70
 
 
71
    def nested_progress_bar(self):
 
72
        """Return a nested progress bar.
 
73
 
 
74
        When the bar has been finished with, it should be released by calling
 
75
        bar.finished().
 
76
        """
 
77
        if self._task_stack:
 
78
            t = progress.ProgressTask(self._task_stack[-1], self)
 
79
        else:
 
80
            t = progress.ProgressTask(None, self)
 
81
        self._task_stack.append(t)
 
82
        return t
 
83
 
 
84
    def _progress_finished(self, task):
 
85
        """Called by the ProgressTask when it finishes"""
 
86
        if not self._task_stack:
 
87
            warnings.warn("%r finished but nothing is active"
 
88
                % (task,))
 
89
        elif task != self._task_stack[-1]:
 
90
            warnings.warn("%r is not the active task %r" 
 
91
                % (task, self._task_stack[-1]))
 
92
        else:
 
93
            del self._task_stack[-1]
 
94
        if not self._task_stack:
 
95
            self._progress_all_finished()
 
96
 
 
97
    def _progress_all_finished(self):
 
98
        """Called when the top-level progress task finished"""
 
99
        pass
 
100
 
 
101
    def _progress_updated(self, task):
 
102
        """Called by the ProgressTask when it changes.
 
103
        
 
104
        Should be specialized to draw the progress.
 
105
        """
 
106
        pass
 
107
 
 
108
    def clear_term(self):
 
109
        """Prepare the terminal for output.
 
110
 
 
111
        This will, for example, clear text progress bars, and leave the
 
112
        cursor at the leftmost position.
 
113
        """
 
114
        pass
 
115
 
 
116
    def get_boolean(self, prompt):
 
117
        """Get a boolean question answered from the user. 
 
118
 
 
119
        :param prompt: a message to prompt the user with. Should be a single
 
120
        line without terminating \n.
 
121
        :return: True or False for y/yes or n/no.
 
122
        """
 
123
        raise NotImplementedError(self.get_boolean)
 
124
 
 
125
    def recommend_upgrade(self,
 
126
        current_format_name,
 
127
        basedir):
 
128
        # this should perhaps be in the TextUIFactory and the default can do
 
129
        # nothing
 
130
        trace.warning("%s is deprecated "
 
131
            "and a better format is available.\n"
 
132
            "It is recommended that you upgrade by "
 
133
            "running the command\n"
 
134
            "  bzr upgrade %s",
 
135
            current_format_name,
 
136
            basedir)
 
137
 
 
138
    def report_transport_activity(self, transport, byte_count, direction):
 
139
        """Called by transports as they do IO.
 
140
        
 
141
        This may update a progress bar, spinner, or similar display.
 
142
        By default it does nothing.
 
143
        """
 
144
        pass
 
145
 
 
146
 
 
147
 
 
148
class CLIUIFactory(UIFactory):
 
149
    """Common behaviour for command line UI factories.
 
150
    
 
151
    This is suitable for dumb terminals that can't repaint existing text."""
 
152
 
 
153
    def __init__(self, stdin=None, stdout=None, stderr=None):
 
154
        UIFactory.__init__(self)
 
155
        self.stdin = stdin or sys.stdin
 
156
        self.stdout = stdout or sys.stdout
 
157
        self.stderr = stderr or sys.stderr
 
158
 
 
159
    def get_boolean(self, prompt):
 
160
        self.clear_term()
 
161
        # FIXME: make a regexp and handle case variations as well.
 
162
        while True:
 
163
            self.prompt(prompt + "? [y/n]: ")
 
164
            line = self.stdin.readline()
 
165
            if line in ('y\n', 'yes\n'):
 
166
                return True
 
167
            if line in ('n\n', 'no\n'):
 
168
                return False
 
169
 
 
170
    def get_non_echoed_password(self, prompt):
 
171
        if not sys.stdin.isatty():
 
172
            raise errors.NotATerminal()
 
173
        encoding = osutils.get_terminal_encoding()
 
174
        return getpass.getpass(prompt.encode(encoding, 'replace'))
 
175
 
 
176
    def get_password(self, prompt='', **kwargs):
 
177
        """Prompt the user for a password.
 
178
 
 
179
        :param prompt: The prompt to present the user
 
180
        :param kwargs: Arguments which will be expanded into the prompt.
 
181
                       This lets front ends display different things if
 
182
                       they so choose.
 
183
        :return: The password string, return None if the user 
 
184
                 canceled the request.
 
185
        """
 
186
        prompt += ': '
 
187
        prompt = (prompt % kwargs)
 
188
        # There's currently no way to say 'i decline to enter a password'
 
189
        # as opposed to 'my password is empty' -- does it matter?
 
190
        return self.get_non_echoed_password(prompt)
 
191
 
 
192
    def prompt(self, prompt):
 
193
        """Emit prompt on the CLI."""
 
194
        self.stdout.write(prompt)
 
195
 
 
196
    def note(self, msg):
 
197
        """Write an already-formatted message."""
 
198
        self.stdout.write(msg + '\n')
 
199
 
 
200
 
 
201
class SilentUIFactory(CLIUIFactory):
 
202
    """A UI Factory which never prints anything.
 
203
 
 
204
    This is the default UI, if another one is never registered.
 
205
    """
 
206
 
 
207
    def __init__(self):
 
208
        CLIUIFactory.__init__(self)
 
209
 
 
210
    def get_password(self, prompt='', **kwargs):
 
211
        return None
 
212
 
 
213
    def prompt(self, prompt):
 
214
        pass
 
215
 
 
216
    def note(self, msg):
 
217
        pass
 
218
 
 
219
 
 
220
def clear_decorator(func, *args, **kwargs):
 
221
    """Decorator that clears the term"""
 
222
    ui_factory.clear_term()
 
223
    func(*args, **kwargs)
49
224
 
50
225
 
51
226
ui_factory = SilentUIFactory()
 
227
"""IMPORTANT: never import this symbol directly. ONLY ever access it as 
 
228
ui.ui_factory."""
 
229
 
 
230
 
 
231
def make_ui_for_terminal(stdin, stdout, stderr):
 
232
    """Construct and return a suitable UIFactory for a text mode program.
 
233
 
 
234
    If stdout is a smart terminal, this gets a smart UIFactory with 
 
235
    progress indicators, etc.  If it's a dumb terminal, just plain text output.
 
236
    """
 
237
    cls = None
 
238
    isatty = getattr(stdin, 'isatty', None)
 
239
    if isatty is None:
 
240
        cls = CLIUIFactory
 
241
    elif not isatty():
 
242
        cls = CLIUIFactory
 
243
    elif os.environ.get('TERM') in (None, 'dumb', ''):
 
244
        # e.g. emacs compile window
 
245
        cls = CLIUIFactory
 
246
    # User may know better, otherwise default to TextUIFactory
 
247
    if (   os.environ.get('BZR_USE_TEXT_UI', None) is not None
 
248
        or cls is None):
 
249
        from bzrlib.ui.text import TextUIFactory
 
250
        cls = TextUIFactory
 
251
    return cls(stdin=stdin, stdout=stdout, stderr=stderr)