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., 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.
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
135
69
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__))
168
71
def nested_progress_bar(self):
169
72
"""Return a nested progress bar.
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))
299
class SilentUIFactory(UIFactory):
148
class CLIUIFactory(UIFactory):
149
"""Common behaviour for command line UI factories.
151
This is suitable for dumb terminals that can't repaint existing text."""
153
def __init__(self, stdin=None, stdout=None, stderr=None):
154
UIFactory.__init__(self)
155
self.stdin = stdin or sys.stdin
156
self.stdout = stdout or sys.stdout
157
self.stderr = stderr or sys.stderr
159
def get_boolean(self, prompt):
161
# FIXME: make a regexp and handle case variations as well.
163
self.prompt(prompt + "? [y/n]: ")
164
line = self.stdin.readline()
165
if line in ('y\n', 'yes\n'):
167
if line in ('n\n', 'no\n'):
170
def get_non_echoed_password(self, prompt):
171
if not sys.stdin.isatty():
172
raise errors.NotATerminal()
173
encoding = osutils.get_terminal_encoding()
174
return getpass.getpass(prompt.encode(encoding, 'replace'))
176
def get_password(self, prompt='', **kwargs):
177
"""Prompt the user for a password.
179
:param prompt: The prompt to present the user
180
:param kwargs: Arguments which will be expanded into the prompt.
181
This lets front ends display different things if
183
:return: The password string, return None if the user
184
canceled the request.
187
prompt = (prompt % kwargs)
188
# There's currently no way to say 'i decline to enter a password'
189
# as opposed to 'my password is empty' -- does it matter?
190
return self.get_non_echoed_password(prompt)
192
def prompt(self, prompt):
193
"""Emit prompt on the CLI."""
194
self.stdout.write(prompt)
197
"""Write an already-formatted message."""
198
self.stdout.write(msg + '\n')
201
class SilentUIFactory(CLIUIFactory):
300
202
"""A UI Factory which never prints anything.
302
This is the default UI, if another one is never registered by a program
303
using bzrlib, and it's also active for example inside 'bzr serve'.
305
Methods that try to read from the user raise an error; methods that do
204
This is the default UI, if another one is never registered.
309
207
def __init__(self):
310
UIFactory.__init__(self)
315
def get_username(self, prompt, **kwargs):
208
CLIUIFactory.__init__(self)
210
def get_password(self, prompt='', **kwargs):
318
def _make_output_stream_explicit(self, encoding, encoding_type):
319
return NullOutputStream(encoding)
321
def show_error(self, msg):
324
def show_message(self, msg):
327
def show_warning(self, msg):
331
class CannedInputUIFactory(SilentUIFactory):
332
"""A silent UI that return canned input."""
334
def __init__(self, responses):
335
self.responses = responses
338
return "%s(%r)" % (self.__class__.__name__, self.responses)
340
def get_boolean(self, prompt):
341
return self.responses.pop(0)
343
def get_integer(self, prompt):
344
return self.responses.pop(0)
346
def get_password(self, prompt='', **kwargs):
347
return self.responses.pop(0)
349
def get_username(self, prompt, **kwargs):
350
return self.responses.pop(0)
352
def assert_all_input_consumed(self):
354
raise AssertionError("expected all input in %r to be consumed"
213
def prompt(self, prompt):
220
def clear_decorator(func, *args, **kwargs):
221
"""Decorator that clears the term"""
222
ui_factory.clear_term()
223
func(*args, **kwargs)
358
226
ui_factory = SilentUIFactory()
359
# IMPORTANT: never import this symbol directly. ONLY ever access it as
360
# ui.ui_factory, so that you refer to the current value.
227
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
363
231
def make_ui_for_terminal(stdin, stdout, stderr):
364
232
"""Construct and return a suitable UIFactory for a text mode program.
234
If stdout is a smart terminal, this gets a smart UIFactory with
235
progress indicators, etc. If it's a dumb terminal, just plain text output.
366
# this is now always TextUIFactory, which in turn decides whether it
367
# should display progress bars etc
368
from bzrlib.ui.text import TextUIFactory
369
return TextUIFactory(stdin, stdout, stderr)
372
class NullProgressView(object):
373
"""Soak up and ignore progress information."""
378
def show_progress(self, task):
381
def show_transport_activity(self, transport, direction, byte_count):
384
def log_transport_activity(self, display=False):
388
class NullOutputStream(object):
389
"""Acts like a file, but discard all output."""
391
def __init__(self, encoding):
392
self.encoding = encoding
394
def write(self, data):
397
def writelines(self, data):
238
isatty = getattr(stdin, 'isatty', None)
243
elif os.environ.get('TERM') in (None, 'dumb', ''):
244
# e.g. emacs compile window
246
# User may know better, otherwise default to TextUIFactory
247
if ( os.environ.get('BZR_USE_TEXT_UI', None) is not None
249
from bzrlib.ui.text import TextUIFactory
251
return cls(stdin=stdin, stdout=stdout, stderr=stderr)
added
removed
bzrlib/ui/__init__.py
