← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui.py

- rules for using destructors

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 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
 
import sys
32
 
 
33
 
from bzrlib.lazy_import import lazy_import
34
 
lazy_import(globals(), """
35
 
from bzrlib import (
36
 
    progress,
37
 
    )
38
 
""")
39
 
 
40
 
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
41
 
 
42
 
 
43
 
class UIFactory(object):
44
 
    """UI abstraction.
45
 
 
46
 
    This tells the library how to display things to the user.  Through this
47
 
    layer different applications can choose the style of UI.
48
 
    """
49
 
 
50
 
    def __init__(self):
51
 
        super(UIFactory, self).__init__()
52
 
        self._progress_bar_stack = None
53
 
 
54
 
    @deprecated_method(zero_eight)
55
 
    def progress_bar(self):
56
 
        """See UIFactory.nested_progress_bar()."""
57
 
        raise NotImplementedError(self.progress_bar)
58
 
 
59
 
    def get_password(self, prompt='', **kwargs):
60
 
        """Prompt the user for a password.
61
 
 
62
 
        :param prompt: The prompt to present the user
63
 
        :param kwargs: Arguments which will be expanded into the prompt.
64
 
                       This lets front ends display different things if
65
 
                       they so choose.
66
 
        :return: The password string, return None if the user 
67
 
                 canceled the request.
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 bu calling
75
 
        bar.finished().
76
 
        """
77
 
        raise NotImplementedError(self.nested_progress_bar)
78
 
 
79
 
    def clear_term(self):
80
 
        """Prepare the terminal for output.
81
 
 
82
 
        This will, for example, clear text progress bars, and leave the
83
 
        cursor at the leftmost position."""
84
 
        raise NotImplementedError(self.clear_term)
85
 
 
86
 
    def get_boolean(self, prompt):
87
 
        """Get a boolean question answered from the user. 
88
 
 
89
 
        :param prompt: a message to prompt the user with. Should be a single
90
 
        line without terminating \n.
91
 
        :return: True or False for y/yes or n/no.
92
 
        """
93
 
        raise NotImplementedError(self.get_boolean)
94
 
 
95
 
    def show_progress_line(self, msg):
96
 
        """Show one line of text that will be cleared."""
97
 
        raise NotImplementedError(self.show_progress_line)
98
 
 
99
 
 
100
 
class CLIUIFactory(UIFactory):
101
 
    """Common behaviour for command line UI factories."""
102
 
 
103
 
    def __init__(self):
104
 
        super(CLIUIFactory, self).__init__()
105
 
        self.stdin = sys.stdin
106
 
 
107
 
    def get_boolean(self, prompt):
108
 
        self.clear_term()
109
 
        # FIXME: make a regexp and handle case variations as well.
110
 
        while True:
111
 
            self.prompt(prompt)
112
 
            line = self.stdin.readline()
113
 
            if line in ('y\n', 'yes\n'):
114
 
                return True
115
 
            if line in ('n\n', 'no\n'):
116
 
                return False
117
 
 
118
 
    def prompt(self, prompt):
119
 
        """Emit prompt on the CLI."""
120
 
 
121
 
 
122
 
class SilentUIFactory(CLIUIFactory):
123
 
    """A UI Factory which never prints anything.
124
 
 
125
 
    This is the default UI, if another one is never registered.
126
 
    """
127
 
 
128
 
    @deprecated_method(zero_eight)
129
 
    def progress_bar(self):
130
 
        """See UIFactory.nested_progress_bar()."""
131
 
        return progress.DummyProgress()
132
 
 
133
 
    def get_password(self, prompt='', **kwargs):
134
 
        return None
135
 
 
136
 
    def nested_progress_bar(self):
137
 
        if self._progress_bar_stack is None:
138
 
            self._progress_bar_stack = progress.ProgressBarStack(
139
 
                klass=progress.DummyProgress)
140
 
        return self._progress_bar_stack.get_nested()
141
 
 
142
 
    def clear_term(self):
143
 
        pass
144
 
 
145
 
    def show_progress_line(self, msg):
146
 
        pass
147
 
 
148
 
    def message(self, msg):
149
 
        pass
150
 
 
151
 
 
152
 
def clear_decorator(func, *args, **kwargs):
153
 
    """Decorator that clears the term"""
154
 
    ui_factory.clear_term()
155
 
    func(*args, **kwargs)
 
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()
156
49
 
157
50
 
158
51
ui_factory = SilentUIFactory()
159
 
"""IMPORTANT: never import this symbol directly. ONLY ever access it as 
160
 
ui.ui_factory."""