13
13
# You should have received a copy of the GNU General Public License
14
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
19
This tells the library how to display things to the user. Through this
20
layer different applications can choose the style of UI.
22
At the moment this layer is almost trivial: the application can just
23
choose the style of progress bar.
25
Set the ui_factory member to define the behaviour. The default
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Abstraction for interacting with the user.
19
Applications can choose different types of UI, and they deal with displaying
20
messages or progress to the user, and with gathering different types of input.
22
Several levels are supported, and you can also register new factories such as
26
Semi-abstract base class
28
bzrlib.ui.SilentUIFactory
29
Produces no output and cannot take any input; useful for programs using
30
bzrlib in batch mode or for programs such as loggerhead.
32
bzrlib.ui.CannedInputUIFactory
33
For use in testing; the input values to be returned are provided
36
bzrlib.ui.text.TextUIFactory
37
Standard text command-line interface, with stdin, stdout, stderr.
38
May make more or less advanced use of them, eg in drawing progress bars,
39
depending on the detected capabilities of the terminal.
40
GUIs may choose to subclass this so that unimplemented methods fall
41
back to working through the terminal.
31
49
from bzrlib.lazy_import import lazy_import
32
50
lazy_import(globals(), """
68
135
raise NotImplementedError(self.get_password)
140
def make_output_stream(self, encoding=None, encoding_type=None):
141
"""Get a stream for sending out bulk text data.
143
This is used for commands that produce bulk text, such as log or diff
144
output, as opposed to user interaction. This should work even for
145
non-interactive user interfaces. Typically this goes to a decorated
146
version of stdout, but in a GUI it might be appropriate to send it to a
147
window displaying the text.
149
:param encoding: Unicode encoding for output; default is the
150
terminal encoding, which may be different from the user encoding.
151
(See get_terminal_encoding.)
153
:param encoding_type: How to handle encoding errors:
154
replace/strict/escape/exact. Default is replace.
156
# XXX: is the caller supposed to close the resulting object?
158
encoding = osutils.get_terminal_encoding()
159
if encoding_type is None:
160
encoding_type = 'replace'
161
out_stream = self._make_output_stream_explicit(encoding, encoding_type)
164
def _make_output_stream_explicit(self, encoding, encoding_type):
165
raise NotImplementedError("%s doesn't support make_output_stream"
166
% (self.__class__.__name__))
70
168
def nested_progress_bar(self):
71
169
"""Return a nested progress bar.
73
171
When the bar has been finished with, it should be released by calling
76
raise NotImplementedError(self.nested_progress_bar)
175
t = progress.ProgressTask(self._task_stack[-1], self)
177
t = progress.ProgressTask(None, self)
178
self._task_stack.append(t)
181
def _progress_finished(self, task):
182
"""Called by the ProgressTask when it finishes"""
183
if not self._task_stack:
184
warnings.warn("%r finished but nothing is active"
186
if task in self._task_stack:
187
self._task_stack.remove(task)
189
warnings.warn("%r is not in active stack %r"
190
% (task, self._task_stack))
191
if not self._task_stack:
192
self._progress_all_finished()
194
def _progress_all_finished(self):
195
"""Called when the top-level progress task finished"""
198
def _progress_updated(self, task):
199
"""Called by the ProgressTask when it changes.
201
Should be specialized to draw the progress.
78
205
def clear_term(self):
79
206
"""Prepare the terminal for output.
81
208
This will, for example, clear text progress bars, and leave the
82
cursor at the leftmost position."""
83
raise NotImplementedError(self.clear_term)
209
cursor at the leftmost position.
85
213
def get_boolean(self, prompt):
86
"""Get a boolean question answered from the user.
214
"""Get a boolean question answered from the user.
88
216
:param prompt: a message to prompt the user with. Should be a single
89
217
line without terminating \n.
104
250
current_format_name,
108
class CLIUIFactory(UIFactory):
109
"""Common behaviour for command line UI factories."""
112
super(CLIUIFactory, self).__init__()
113
self.stdin = sys.stdin
115
def get_boolean(self, prompt):
117
# FIXME: make a regexp and handle case variations as well.
119
self.prompt(prompt + "? [y/n]: ")
120
line = self.stdin.readline()
121
if line in ('y\n', 'yes\n'):
123
if line in ('n\n', 'no\n'):
126
def get_non_echoed_password(self, prompt):
127
if not sys.stdin.isatty():
128
raise errors.NotATerminal()
129
encoding = osutils.get_terminal_encoding()
130
return getpass.getpass(prompt.encode(encoding, 'replace'))
132
def get_password(self, prompt='', **kwargs):
133
"""Prompt the user for a password.
135
:param prompt: The prompt to present the user
136
:param kwargs: Arguments which will be expanded into the prompt.
137
This lets front ends display different things if
139
:return: The password string, return None if the user
140
canceled the request.
143
prompt = (prompt % kwargs)
144
# There's currently no way to say 'i decline to enter a password'
145
# as opposed to 'my password is empty' -- does it matter?
146
return self.get_non_echoed_password(prompt)
148
def prompt(self, prompt):
149
"""Emit prompt on the CLI."""
152
class SilentUIFactory(CLIUIFactory):
253
def report_transport_activity(self, transport, byte_count, direction):
254
"""Called by transports as they do IO.
256
This may update a progress bar, spinner, or similar display.
257
By default it does nothing.
261
def log_transport_activity(self, display=False):
262
"""Write out whatever transport activity has been measured.
264
Implementations are allowed to do nothing, but it is useful if they can
265
write a line to the log file.
267
:param display: If False, only log to disk, if True also try to display
268
a message to the user.
271
# Default implementation just does nothing
274
def show_error(self, msg):
275
"""Show an error message (not an exception) to the user.
277
The message should not have an error prefix or trailing newline. That
278
will be added by the factory if appropriate.
280
raise NotImplementedError(self.show_error)
282
def show_message(self, msg):
283
"""Show a message to the user."""
284
raise NotImplementedError(self.show_message)
286
def show_warning(self, msg):
287
"""Show a warning to the user."""
288
raise NotImplementedError(self.show_warning)
290
def warn_cross_format_fetch(self, from_format, to_format):
291
"""Warn about a potentially slow cross-format transfer"""
292
# See <https://launchpad.net/bugs/456077> asking for a warning here
293
trace.warning("Doing on-the-fly conversion from %s to %s.\n"
294
"This may take some time. Upgrade the repositories to the "
295
"same format for better performance.\n" %
296
(from_format, to_format))
298
def warn_experimental_format_fetch(self, inter):
299
"""Warn about fetching into experimental repository formats."""
300
if inter.target._format.experimental:
301
trace.warning("Fetching into experimental format %s.\n"
302
"This format may be unreliable or change in the future "
303
"without an upgrade path.\n" % (inter.target._format,))
307
class SilentUIFactory(UIFactory):
153
308
"""A UI Factory which never prints anything.
155
This is the default UI, if another one is never registered.
310
This is the default UI, if another one is never registered by a program
311
using bzrlib, and it's also active for example inside 'bzr serve'.
313
Methods that try to read from the user raise an error; methods that do
158
def get_password(self, prompt='', **kwargs):
318
UIFactory.__init__(self)
323
def get_username(self, prompt, **kwargs):
161
def nested_progress_bar(self):
162
if self._progress_bar_stack is None:
163
self._progress_bar_stack = progress.ProgressBarStack(
164
klass=progress.DummyProgress)
165
return self._progress_bar_stack.get_nested()
167
def clear_term(self):
170
def recommend_upgrade(self, *args):
174
def clear_decorator(func, *args, **kwargs):
175
"""Decorator that clears the term"""
176
ui_factory.clear_term()
177
func(*args, **kwargs)
326
def _make_output_stream_explicit(self, encoding, encoding_type):
327
return NullOutputStream(encoding)
329
def show_error(self, msg):
332
def show_message(self, msg):
335
def show_warning(self, msg):
339
class CannedInputUIFactory(SilentUIFactory):
340
"""A silent UI that return canned input."""
342
def __init__(self, responses):
343
self.responses = responses
346
return "%s(%r)" % (self.__class__.__name__, self.responses)
348
def get_boolean(self, prompt):
349
return self.responses.pop(0)
351
def get_integer(self, prompt):
352
return self.responses.pop(0)
354
def get_password(self, prompt='', **kwargs):
355
return self.responses.pop(0)
357
def get_username(self, prompt, **kwargs):
358
return self.responses.pop(0)
360
def assert_all_input_consumed(self):
362
raise AssertionError("expected all input in %r to be consumed"
180
366
ui_factory = SilentUIFactory()
181
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
367
# IMPORTANT: never import this symbol directly. ONLY ever access it as
368
# ui.ui_factory, so that you refer to the current value.
371
def make_ui_for_terminal(stdin, stdout, stderr):
372
"""Construct and return a suitable UIFactory for a text mode program.
374
# this is now always TextUIFactory, which in turn decides whether it
375
# should display progress bars etc
376
from bzrlib.ui.text import TextUIFactory
377
return TextUIFactory(stdin, stdout, stderr)
380
class NullProgressView(object):
381
"""Soak up and ignore progress information."""
386
def show_progress(self, task):
389
def show_transport_activity(self, transport, direction, byte_count):
392
def log_transport_activity(self, display=False):
396
class NullOutputStream(object):
397
"""Acts like a file, but discard all output."""
399
def __init__(self, encoding):
400
self.encoding = encoding
402
def write(self, data):
405
def writelines(self, data):
added
removed
bzrlib/ui/__init__.py
