1
# Copyright (C) 2005, 2006 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(), """
40
from bzrlib.symbol_versioning import (deprecated_method, zero_eight)
43
class UIFactory(object):
46
This tells the library how to display things to the user. Through this
47
layer different applications can choose the style of UI.
51
super(UIFactory, self).__init__()
52
self._progress_bar_stack = None
54
@deprecated_method(zero_eight)
55
def progress_bar(self):
56
"""See UIFactory.nested_progress_bar()."""
57
raise NotImplementedError(self.progress_bar)
59
def get_password(self, prompt='', **kwargs):
60
"""Prompt the user for a password.
62
:param prompt: The prompt to present the user
63
:param kwargs: Arguments which will be expanded into the prompt.
64
This lets front ends display different things if
66
:return: The password string, return None if the user
69
raise NotImplementedError(self.get_password)
71
def nested_progress_bar(self):
72
"""Return a nested progress bar.
74
When the bar has been finished with, it should be released by calling
77
raise NotImplementedError(self.nested_progress_bar)
80
"""Prepare the terminal for output.
82
This will, for example, clear text progress bars, and leave the
83
cursor at the leftmost position."""
84
raise NotImplementedError(self.clear_term)
86
def get_boolean(self, prompt):
87
"""Get a boolean question answered from the user.
89
:param prompt: a message to prompt the user with. Should be a single
90
line without terminating \n.
91
:return: True or False for y/yes or n/no.
93
raise NotImplementedError(self.get_boolean)
96
class CLIUIFactory(UIFactory):
97
"""Common behaviour for command line UI factories."""
100
super(CLIUIFactory, self).__init__()
101
self.stdin = sys.stdin
103
def get_boolean(self, prompt):
105
# FIXME: make a regexp and handle case variations as well.
108
line = self.stdin.readline()
109
if line in ('y\n', 'yes\n'):
111
if line in ('n\n', 'no\n'):
114
def prompt(self, prompt):
115
"""Emit prompt on the CLI."""
118
class SilentUIFactory(CLIUIFactory):
119
"""A UI Factory which never prints anything.
121
This is the default UI, if another one is never registered.
124
@deprecated_method(zero_eight)
125
def progress_bar(self):
126
"""See UIFactory.nested_progress_bar()."""
127
return progress.DummyProgress()
129
def get_password(self, prompt='', **kwargs):
132
def nested_progress_bar(self):
133
if self._progress_bar_stack is None:
134
self._progress_bar_stack = progress.ProgressBarStack(
135
klass=progress.DummyProgress)
136
return self._progress_bar_stack.get_nested()
138
def clear_term(self):
142
def clear_decorator(func, *args, **kwargs):
143
"""Decorator that clears the term"""
144
ui_factory.clear_term()
145
func(*args, **kwargs)
148
ui_factory = SilentUIFactory()
149
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
