← 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-01-11 03:46:53 UTC
  • mto: (2255.6.1 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: aaron.bentley@utoronto.ca-20070111034653-wa1n3uy49wbvom5m
Remove get_format_*, make FormatRegistry.register_metadir vary working tree

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
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 by 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
 
 
96
class CLIUIFactory(UIFactory):
 
97
    """Common behaviour for command line UI factories."""
 
98
 
 
99
    def __init__(self):
 
100
        super(CLIUIFactory, self).__init__()
 
101
        self.stdin = sys.stdin
 
102
 
 
103
    def get_boolean(self, prompt):
 
104
        self.clear_term()
 
105
        # FIXME: make a regexp and handle case variations as well.
 
106
        while True:
 
107
            self.prompt(prompt)
 
108
            line = self.stdin.readline()
 
109
            if line in ('y\n', 'yes\n'):
 
110
                return True
 
111
            if line in ('n\n', 'no\n'):
 
112
                return False
 
113
 
 
114
    def prompt(self, prompt):
 
115
        """Emit prompt on the CLI."""
 
116
 
 
117
 
 
118
class SilentUIFactory(CLIUIFactory):
 
119
    """A UI Factory which never prints anything.
 
120
 
 
121
    This is the default UI, if another one is never registered.
 
122
    """
 
123
 
 
124
    @deprecated_method(zero_eight)
 
125
    def progress_bar(self):
 
126
        """See UIFactory.nested_progress_bar()."""
 
127
        return progress.DummyProgress()
 
128
 
 
129
    def get_password(self, prompt='', **kwargs):
 
130
        return None
 
131
 
 
132
    def nested_progress_bar(self):
 
133
        if self._progress_bar_stack is None:
 
134
            self._progress_bar_stack = progress.ProgressBarStack(
 
135
                klass=progress.DummyProgress)
 
136
        return self._progress_bar_stack.get_nested()
 
137
 
 
138
    def clear_term(self):
 
139
        pass
 
140
 
 
141
 
 
142
def clear_decorator(func, *args, **kwargs):
 
143
    """Decorator that clears the term"""
 
144
    ui_factory.clear_term()
 
145
    func(*args, **kwargs)
49
146
 
50
147
 
51
148
ui_factory = SilentUIFactory()
 
149
"""IMPORTANT: never import this symbol directly. ONLY ever access it as 
 
150
ui.ui_factory."""