← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/__init__.py

Introduce new bzr progress bar api. ui_factory.nested_progress_bar.

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
 
31
32
import bzrlib.progress
 
33
from bzrlib.symbol_versioning import *
32
34
 
33
35
 
34
36
class UIFactory(object):
37
39
    This tells the library how to display things to the user.  Through this
38
40
    layer different applications can choose the style of UI.
39
41
    """
 
42
 
 
43
    deprecated_method(zero_eight)
40
44
    def progress_bar(self):
41
 
        """Return a progress bar object"""
42
 
        raise NotImplementedError
 
45
        """See UIFactory.nested_progress_bar()."""
 
46
        raise NotImplementedError(self.progress_bar)
43
47
 
44
48
    def get_password(self, prompt='', **kwargs):
45
49
        """Prompt the user for a password.
51
55
        :return: The password string, return None if the user 
52
56
                 canceled the request.
53
57
        """
54
 
        raise NotImplementedError
 
58
        raise NotImplementedError(self.get_password)
55
59
        
 
60
    def nested_progress_bar(self):
 
61
        """Return a nested progress bar.
 
62
 
 
63
        When the bar has been finished with, it should be released bu calling
 
64
        bar.finished().
 
65
        """
 
66
        raise NotImplementedError(self.nested_progress_bar)
 
67
 
56
68
 
57
69
class SilentUIFactory(UIFactory):
58
70
    """A UI Factory which never prints anything.
59
71
 
60
72
    This is the default UI, if another one is never registered.
61
73
    """
 
74
 
 
75
    deprecated_method(zero_eight)
62
76
    def progress_bar(self):
 
77
        """See UIFactory.nested_progress_bar()."""
63
78
        return bzrlib.progress.DummyProgress()
64
79
 
65
80
    def get_password(self, prompt='', **kwargs):
66
81
        return None
67
82
 
 
83
    def nested_progress_bar(self):
 
84
        return bzrlib.progress.DummyProgress()
 
85
 
68
86
 
69
87
ui_factory = SilentUIFactory()
70
88
"""IMPORTANT: never import this symbol directly. ONLY ever access it as