~bzr-pqm/bzr/bzr.dev

1185.1.29 by Robert Collins
merge merge tweaks from aaron, which includes latest .dev
1
# Copyright (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
18
19
"""UI abstraction.
20
21
This tells the library how to display things to the user.  Through this
22
layer different applications can choose the style of UI.
23
24
At the moment this layer is almost trivial: the application can just
25
choose the style of progress bar.
26
27
Set the ui_factory member to define the behaviour.  The default
28
displays no output.
29
"""
30
31
import bzrlib.progress
32
33
1185.49.21 by John Arbash Meinel
Refactored bzrlib/ui.py into a module with the possibility for multiple ui forms.
34
class UIFactory(object):
35
    """UI abstraction.
36
37
    This tells the library how to display things to the user.  Through this
38
    layer different applications can choose the style of UI.
39
    """
1185.1.29 by Robert Collins
merge merge tweaks from aaron, which includes latest .dev
40
    def progress_bar(self):
1185.49.22 by John Arbash Meinel
Added get_password to the UIFactory, using it inside of sftp.py
41
        """Return a progress bar object"""
42
        raise NotImplementedError
43
44
    def get_password(self, prompt='', **kwargs):
45
        """Prompt the user for a password.
46
47
        :param prompt: The prompt to present the user
48
        :param kwargs: Arguments which will be expanded into the prompt.
49
                       This lets front ends display different things if
50
                       they so choose.
51
        :return: The password string, return None if the user 
52
                 canceled the request.
53
        """
54
        raise NotImplementedError
55
        
1185.49.21 by John Arbash Meinel
Refactored bzrlib/ui.py into a module with the possibility for multiple ui forms.
56
57
class SilentUIFactory(UIFactory):
58
    """A UI Factory which never prints anything.
59
60
    This is the default UI, if another one is never registered.
61
    """
1185.1.29 by Robert Collins
merge merge tweaks from aaron, which includes latest .dev
62
    def progress_bar(self):
63
        return bzrlib.progress.DummyProgress()
64
1185.49.22 by John Arbash Meinel
Added get_password to the UIFactory, using it inside of sftp.py
65
    def get_password(self, prompt='', **kwargs):
66
        return None
67
68
1185.1.29 by Robert Collins
merge merge tweaks from aaron, which includes latest .dev
69
ui_factory = SilentUIFactory()