14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
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
29
Produces no output and cannot take any input; useful for programs using
30
bzrlib in batch mode or for programs such as loggerhead.
33
For use in testing; the input values to be returned are provided
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.
159
180
raise NotImplementedError(self.get_boolean)
182
def make_progress_view(self):
183
"""Construct a new ProgressView object for this UI.
185
Application code should normally not call this but instead
186
nested_progress_bar().
188
return NullProgressView()
161
190
def recommend_upgrade(self,
162
191
current_format_name,
184
213
class CLIUIFactory(UIFactory):
185
"""Common behaviour for command line UI factories.
187
This is suitable for dumb terminals that can't repaint existing text."""
214
"""Deprecated in favor of TextUIFactory."""
216
@deprecated_method(deprecated_in((1, 18, 0)))
189
217
def __init__(self, stdin=None, stdout=None, stderr=None):
190
218
UIFactory.__init__(self)
191
219
self.stdin = stdin or sys.stdin
271
299
self.stdout.write(msg + '\n')
274
class SilentUIFactory(CLIUIFactory):
302
class SilentUIFactory(UIFactory):
275
303
"""A UI Factory which never prints anything.
277
This is the default UI, if another one is never registered.
305
This is the default UI, if another one is never registered by a program
306
using bzrlib, and it's also active for example inside 'bzr serve'.
308
Methods that try to read from the user raise an error; methods that do
280
312
def __init__(self):
281
CLIUIFactory.__init__(self)
313
UIFactory.__init__(self)
318
def get_username(self, prompt, **kwargs):
322
class CannedInputUIFactory(SilentUIFactory):
323
"""A silent UI that return canned input."""
325
def __init__(self, responses):
326
self.responses = responses
329
return "%s(%r)" % (self.__class__.__name__, self.responses)
331
def get_boolean(self, prompt):
332
return self.responses.pop(0)
283
334
def get_password(self, prompt='', **kwargs):
286
def get_username(self, prompt='', **kwargs):
289
def prompt(self, prompt, **kwargs):
335
return self.responses.pop(0)
337
def get_username(self, prompt, **kwargs):
338
return self.responses.pop(0)
340
def assert_all_input_consumed(self):
342
raise AssertionError("expected all input in %r to be consumed"
346
@deprecated_function(deprecated_in((1, 18, 0)))
296
347
def clear_decorator(func, *args, **kwargs):
297
348
"""Decorator that clears the term"""
298
349
ui_factory.clear_term()
302
353
ui_factory = SilentUIFactory()
303
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
354
# IMPORTANT: never import this symbol directly. ONLY ever access it as
355
# ui.ui_factory, so that you refer to the current value.
307
358
def make_ui_for_terminal(stdin, stdout, stderr):
308
359
"""Construct and return a suitable UIFactory for a text mode program.
310
If stdout is a smart terminal, this gets a smart UIFactory with
311
progress indicators, etc. If it's a dumb terminal, just plain text output.
314
isatty = getattr(stdin, 'isatty', None)
319
elif os.environ.get('TERM') in ('dumb', ''):
320
# e.g. emacs compile window
322
# User may know better, otherwise default to TextUIFactory
323
if ( os.environ.get('BZR_USE_TEXT_UI', None) is not None
325
from bzrlib.ui.text import TextUIFactory
327
return cls(stdin=stdin, stdout=stdout, stderr=stderr)
361
# this is now always TextUIFactory, which in turn decides whether it
362
# should display progress bars etc
363
from bzrlib.ui.text import TextUIFactory
364
return TextUIFactory(stdin, stdout, stderr)
367
class NullProgressView(object):
368
"""Soak up and ignore progress information."""
373
def show_progress(self, task):
376
def show_transport_activity(self, transport, direction, byte_count):
added
removed
bzrlib/ui/__init__.py
