1
# Copyright (C) 2005 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
32
import bzrlib.progress
33
from bzrlib.symbol_versioning import *
36
class UIFactory(object):
39
This tells the library how to display things to the user. Through this
40
layer different applications can choose the style of UI.
44
super(UIFactory, self).__init__()
45
self._progress_bar_stack = None
47
@deprecated_method(zero_eight)
48
def progress_bar(self):
49
"""See UIFactory.nested_progress_bar()."""
50
raise NotImplementedError(self.progress_bar)
52
def get_password(self, prompt='', **kwargs):
53
"""Prompt the user for a password.
55
:param prompt: The prompt to present the user
56
:param kwargs: Arguments which will be expanded into the prompt.
57
This lets front ends display different things if
59
:return: The password string, return None if the user
62
raise NotImplementedError(self.get_password)
64
def nested_progress_bar(self):
65
"""Return a nested progress bar.
67
When the bar has been finished with, it should be released bu calling
70
raise NotImplementedError(self.nested_progress_bar)
73
"""Prepare the terminal for output.
75
This will, for example, clear text progress bars, and leave the
76
cursor at the leftmost position."""
77
raise NotImplementedError(self.clear_term)
80
class SilentUIFactory(UIFactory):
81
"""A UI Factory which never prints anything.
83
This is the default UI, if another one is never registered.
86
@deprecated_method(zero_eight)
87
def progress_bar(self):
88
"""See UIFactory.nested_progress_bar()."""
89
return bzrlib.progress.DummyProgress()
91
def get_password(self, prompt='', **kwargs):
94
def nested_progress_bar(self):
95
if self._progress_bar_stack is None:
96
self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
97
klass=bzrlib.progress.DummyProgress)
98
return self._progress_bar_stack.get_nested()
100
def clear_term(self):
104
def clear_decorator(func, *args, **kwargs):
105
"""Decorator that clears the term"""
106
ui_factory.clear_term()
107
func(*args, **kwargs)
110
ui_factory = SilentUIFactory()
111
"""IMPORTANT: never import this symbol directly. ONLY ever access it as
added
removed
bzrlib/ui/__init__.py
