← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

  • Committer: Aaron Bentley
  • Date: 2007-03-12 19:56:41 UTC
  • mto: (1551.19.24 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2353.
  • Revision ID: abentley@panoramicfeedback.com-20070312195641-ezjnseqwgjtkh0iu
merge3 auto-detects line endings for conflict markers

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 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
28
28
displays no output.
29
29
"""
30
30
 
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()
 
31
import sys
 
32
 
 
33
from bzrlib.lazy_import import lazy_import
 
34
lazy_import(globals(), """
 
35
import getpass
 
36
 
 
37
from bzrlib import (
 
38
    progress,
 
39
    )
 
40
""")
 
41
 
 
42
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
 
43
 
 
44
 
 
45
class UIFactory(object):
 
46
    """UI abstraction.
 
47
 
 
48
    This tells the library how to display things to the user.  Through this
 
49
    layer different applications can choose the style of UI.
 
50
    """
 
51
 
 
52
    def __init__(self):
 
53
        super(UIFactory, self).__init__()
 
54
        self._progress_bar_stack = None
 
55
 
 
56
    @deprecated_method(zero_eight)
 
57
    def progress_bar(self):
 
58
        """See UIFactory.nested_progress_bar()."""
 
59
        raise NotImplementedError(self.progress_bar)
 
60
 
 
61
    def get_password(self, prompt='', **kwargs):
 
62
        """Prompt the user for a password.
 
63
 
 
64
        :param prompt: The prompt to present the user
 
65
        :param kwargs: Arguments which will be expanded into the prompt.
 
66
                       This lets front ends display different things if
 
67
                       they so choose.
 
68
 
 
69
        :return: The password string, return None if the user canceled the
 
70
                 request. Note that we do not touch the encoding, users may
 
71
                 have whatever they see fit and the password should be
 
72
                 transported as is.
 
73
        """
 
74
        raise NotImplementedError(self.get_password)
 
75
 
 
76
    def nested_progress_bar(self):
 
77
        """Return a nested progress bar.
 
78
 
 
79
        When the bar has been finished with, it should be released by calling
 
80
        bar.finished().
 
81
        """
 
82
        raise NotImplementedError(self.nested_progress_bar)
 
83
 
 
84
    def clear_term(self):
 
85
        """Prepare the terminal for output.
 
86
 
 
87
        This will, for example, clear text progress bars, and leave the
 
88
        cursor at the leftmost position."""
 
89
        raise NotImplementedError(self.clear_term)
 
90
 
 
91
    def get_boolean(self, prompt):
 
92
        """Get a boolean question answered from the user. 
 
93
 
 
94
        :param prompt: a message to prompt the user with. Should be a single
 
95
        line without terminating \n.
 
96
        :return: True or False for y/yes or n/no.
 
97
        """
 
98
        raise NotImplementedError(self.get_boolean)
 
99
 
 
100
 
 
101
class CLIUIFactory(UIFactory):
 
102
    """Common behaviour for command line UI factories."""
 
103
 
 
104
    def __init__(self):
 
105
        super(CLIUIFactory, self).__init__()
 
106
        self.stdin = sys.stdin
 
107
 
 
108
    def get_boolean(self, prompt):
 
109
        self.clear_term()
 
110
        # FIXME: make a regexp and handle case variations as well.
 
111
        while True:
 
112
            self.prompt(prompt + "? [y/n]: ")
 
113
            line = self.stdin.readline()
 
114
            if line in ('y\n', 'yes\n'):
 
115
                return True
 
116
            if line in ('n\n', 'no\n'):
 
117
                return False
 
118
 
 
119
    def get_non_echoed_password(self, prompt):
 
120
        return getpass.getpass(prompt)
 
121
 
 
122
    def get_password(self, prompt='', **kwargs):
 
123
        """Prompt the user for a password.
 
124
 
 
125
        :param prompt: The prompt to present the user
 
126
        :param kwargs: Arguments which will be expanded into the prompt.
 
127
                       This lets front ends display different things if
 
128
                       they so choose.
 
129
        :return: The password string, return None if the user 
 
130
                 canceled the request.
 
131
        """
 
132
        prompt += ': '
 
133
        prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
 
134
        # There's currently no way to say 'i decline to enter a password'
 
135
        # as opposed to 'my password is empty' -- does it matter?
 
136
        return self.get_non_echoed_password(prompt)
 
137
 
 
138
    def prompt(self, prompt):
 
139
        """Emit prompt on the CLI."""
 
140
 
 
141
 
 
142
class SilentUIFactory(CLIUIFactory):
 
143
    """A UI Factory which never prints anything.
 
144
 
 
145
    This is the default UI, if another one is never registered.
 
146
    """
 
147
 
 
148
    @deprecated_method(zero_eight)
 
149
    def progress_bar(self):
 
150
        """See UIFactory.nested_progress_bar()."""
 
151
        return progress.DummyProgress()
 
152
 
 
153
    def get_password(self, prompt='', **kwargs):
 
154
        return None
 
155
 
 
156
    def nested_progress_bar(self):
 
157
        if self._progress_bar_stack is None:
 
158
            self._progress_bar_stack = progress.ProgressBarStack(
 
159
                klass=progress.DummyProgress)
 
160
        return self._progress_bar_stack.get_nested()
 
161
 
 
162
    def clear_term(self):
 
163
        pass
 
164
 
 
165
 
 
166
def clear_decorator(func, *args, **kwargs):
 
167
    """Decorator that clears the term"""
 
168
    ui_factory.clear_term()
 
169
    func(*args, **kwargs)
49
170
 
50
171
 
51
172
ui_factory = SilentUIFactory()
 
173
"""IMPORTANT: never import this symbol directly. ONLY ever access it as 
 
174
ui.ui_factory."""