← 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: 2006-07-10 19:23:53 UTC
  • mto: This revision was merged to the branch mainline in revision 1848.
  • Revision ID: abentley@panoramicfeedback.com-20060710192353-469477798c5c4139
Switch to John Meinel's _unescape_xml implementation

Show diffs side-by-side

added added

removed removed

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