← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui.py

  • Committer: Robert Collins
  • Date: 2005-10-18 05:26:22 UTC
  • mto: This revision was merged to the branch mainline in revision 1463.
  • Revision ID: robertc@robertcollins.net-20051018052622-653d638c9e26fde4
fix broken tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui.py
29
29
"""
30
30
 
31
31
 
 
32
 
 
33
 
 
34
 
32
35
import bzrlib.progress
33
 
from bzrlib.symbol_versioning import *
34
 
 
35
 
 
36
 
class UIFactory(object):
37
 
    """UI abstraction.
38
 
 
39
 
    This tells the library how to display things to the user.  Through this
40
 
    layer different applications can choose the style of UI.
41
 
    """
42
 
 
43
 
    def __init__(self):
44
 
        super(UIFactory, self).__init__()
45
 
        self._progress_bar_stack = None
46
 
 
47
 
    @deprecated_method(zero_eight)
48
 
    def progress_bar(self):
49
 
        """See UIFactory.nested_progress_bar()."""
50
 
        raise NotImplementedError(self.progress_bar)
51
 
 
52
 
    def get_password(self, prompt='', **kwargs):
53
 
        """Prompt the user for a password.
54
 
 
55
 
        :param prompt: The prompt to present the user
56
 
        :param kwargs: Arguments which will be expanded into the prompt.
57
 
                       This lets front ends display different things if
58
 
                       they so choose.
59
 
        :return: The password string, return None if the user 
60
 
                 canceled the request.
61
 
        """
62
 
        raise NotImplementedError(self.get_password)
63
 
        
64
 
    def nested_progress_bar(self):
65
 
        """Return a nested progress bar.
66
 
 
67
 
        When the bar has been finished with, it should be released bu calling
68
 
        bar.finished().
69
 
        """
70
 
        raise NotImplementedError(self.nested_progress_bar)
71
 
 
72
 
    def clear_term(self):
73
 
        """Prepare the terminal for output.
74
 
 
75
 
        This will, for example, clear text progress bars, and leave the
76
 
        cursor at the leftmost position."""
77
 
        raise NotImplementedError(self.clear_term)
78
 
 
79
 
 
80
 
class SilentUIFactory(UIFactory):
81
 
    """A UI Factory which never prints anything.
82
 
 
83
 
    This is the default UI, if another one is never registered.
84
 
    """
85
 
 
86
 
    @deprecated_method(zero_eight)
87
 
    def progress_bar(self):
88
 
        """See UIFactory.nested_progress_bar()."""
 
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):
89
48
        return bzrlib.progress.DummyProgress()
90
49
 
91
 
    def get_password(self, prompt='', **kwargs):
92
 
        return None
93
 
 
94
 
    def nested_progress_bar(self):
95
 
        if self._progress_bar_stack is None:
96
 
            self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
97
 
                klass=bzrlib.progress.DummyProgress)
98
 
        return self._progress_bar_stack.get_nested()
99
 
 
100
 
    def clear_term(self):
101
 
        pass
102
 
 
103
 
 
104
 
def clear_decorator(func, *args, **kwargs):
105
 
    """Decorator that clears the term"""
106
 
    ui_factory.clear_term()
107
 
    func(*args, **kwargs)
108
 
 
109
50
 
110
51
ui_factory = SilentUIFactory()
111
 
"""IMPORTANT: never import this symbol directly. ONLY ever access it as 
112
 
ui.ui_factory."""