1
# Copyright (C) 2005, 2006, 2007 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
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
44
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
47
class UIFactory(object):
50
This tells the library how to display things to the user. Through this
51
layer different applications can choose the style of UI.
55
super(UIFactory, self).__init__()
56
self._progress_bar_stack = None
58
@deprecated_method(zero_eight)
59
def progress_bar(self):
60
"""See UIFactory.nested_progress_bar()."""
61
raise NotImplementedError(self.progress_bar)
63
def get_password(self, prompt='', **kwargs):
64
"""Prompt the user for a password.
66
:param prompt: The prompt to present the user
67
:param kwargs: Arguments which will be expanded into the prompt.
68
This lets front ends display different things if
71
:return: The password string, return None if the user canceled the
72
request. Note that we do not touch the encoding, users may
73
have whatever they see fit and the password should be
76
raise NotImplementedError(self.get_password)
78
def nested_progress_bar(self):
79
"""Return a nested progress bar.
81
When the bar has been finished with, it should be released by calling
84
raise NotImplementedError(self.nested_progress_bar)
87
"""Prepare the terminal for output.
89
This will, for example, clear text progress bars, and leave the
90
cursor at the leftmost position."""
91
raise NotImplementedError(self.clear_term)
93
def get_boolean(self, prompt):
94
"""Get a boolean question answered from the user.
96
:param prompt: a message to prompt the user with. Should be a single
97
line without terminating \n.
98
:return: True or False for y/yes or n/no.
100
raise NotImplementedError(self.get_boolean)
102
def recommend_upgrade(self,
105
# this should perhaps be in the TextUIFactory and the default can do
107
trace.warning("%s is deprecated "
108
"and a better format is available.\n"
109
"It is recommended that you upgrade by "
110
"running the command\n"
116
class CLIUIFactory(UIFactory):
117
"""Common behaviour for command line UI factories."""
120
super(CLIUIFactory, self).__init__()
121
self.stdin = sys.stdin
123
def get_boolean(self, prompt):
125
# FIXME: make a regexp and handle case variations as well.
127
self.prompt(prompt + "? [y/n]: ")
128
line = self.stdin.readline()
129
if line in ('y\n', 'yes\n'):
131
if line in ('n\n', 'no\n'):
134
def get_non_echoed_password(self, prompt):
135
encoding = osutils.get_terminal_encoding()
136
return getpass.getpass(prompt.encode(encoding, 'replace'))
138
def get_password(self, prompt='', **kwargs):
139
"""Prompt the user for a password.
141
:param prompt: The prompt to present the user
142
:param kwargs: Arguments which will be expanded into the prompt.
143
This lets front ends display different things if
145
:return: The password string, return None if the user
146
canceled the request.
149
prompt = (prompt % kwargs)
150
# There's currently no way to say 'i decline to enter a password'
151
# as opposed to 'my password is empty' -- does it matter?
152
return self.get_non_echoed_password(prompt)
154
def prompt(self, prompt):
155
"""Emit prompt on the CLI."""
158
class SilentUIFactory(CLIUIFactory):
159
"""A UI Factory which never prints anything.
161
This is the default UI, if another one is never registered.
164
@deprecated_method(zero_eight)
165
def progress_bar(self):
166
"""See UIFactory.nested_progress_bar()."""
167
return progress.DummyProgress()
169
def get_password(self, prompt='', **kwargs):
172
def nested_progress_bar(self):
173
if self._progress_bar_stack is None:
174
self._progress_bar_stack = progress.ProgressBarStack(
175
klass=progress.DummyProgress)
176
return self._progress_bar_stack.get_nested()
178
def clear_term(self):
181
def recommend_upgrade(self, *args):
185
def clear_decorator(func, *args, **kwargs):
186
"""Decorator that clears the term"""
187
ui_factory.clear_term()
188
func(*args, **kwargs)
191
ui_factory = SilentUIFactory()
192
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
