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