1
# Copyright (C) 2005 Canonical Ltd
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.
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.
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
21
This tells the library how to display things to the user. Through this
22
layer different applications can choose the style of UI.
24
At the moment this layer is almost trivial: the application can just
25
choose the style of progress bar.
27
Set the ui_factory member to define the behaviour. The default
33
import bzrlib.progress
34
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
37
class UIFactory(object):
40
This tells the library how to display things to the user. Through this
41
layer different applications can choose the style of UI.
45
super(UIFactory, self).__init__()
46
self._progress_bar_stack = None
48
@deprecated_method(zero_eight)
49
def progress_bar(self):
50
"""See UIFactory.nested_progress_bar()."""
51
raise NotImplementedError(self.progress_bar)
53
def get_password(self, prompt='', **kwargs):
54
"""Prompt the user for a password.
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
60
:return: The password string, return None if the user
63
raise NotImplementedError(self.get_password)
65
def nested_progress_bar(self):
66
"""Return a nested progress bar.
68
When the bar has been finished with, it should be released bu calling
71
raise NotImplementedError(self.nested_progress_bar)
74
"""Prepare the terminal for output.
76
This will, for example, clear text progress bars, and leave the
77
cursor at the leftmost position."""
78
raise NotImplementedError(self.clear_term)
80
def get_boolean(self, prompt):
81
"""Get a boolean question answered from the user.
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.
87
raise NotImplementedError(self.get_boolean)
90
class CLIUIFactory(UIFactory):
91
"""Common behaviour for command line UI factories."""
94
super(CLIUIFactory, self).__init__()
95
self.stdin = sys.stdin
97
def get_boolean(self, prompt):
99
# FIXME: make a regexp and handle case variations as well.
102
line = self.stdin.readline()
103
if line in ('y\n', 'yes\n'):
105
if line in ('n\n', 'no\n'):
108
def prompt(self, prompt):
109
"""Emit prompt on the CLI."""
112
class SilentUIFactory(CLIUIFactory):
113
"""A UI Factory which never prints anything.
115
This is the default UI, if another one is never registered.
118
@deprecated_method(zero_eight)
119
def progress_bar(self):
120
"""See UIFactory.nested_progress_bar()."""
121
return bzrlib.progress.DummyProgress()
123
def get_password(self, prompt='', **kwargs):
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()
132
def clear_term(self):
136
def clear_decorator(func, *args, **kwargs):
137
"""Decorator that clears the term"""
138
ui_factory.clear_term()
139
func(*args, **kwargs)
142
ui_factory = SilentUIFactory()
143
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
