/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

Fix formatting, remove catch-all for exceptions when opening local repositories.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/text.py
1
 
# Copyright (C) 2005, 2008, 2009 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
 
18
 
 
19
 
"""Text UI, write output to the console.
20
 
"""
21
 
 
22
 
import sys
23
 
import time
24
 
import warnings
25
 
 
26
 
from bzrlib.lazy_import import lazy_import
27
 
lazy_import(globals(), """
28
 
import getpass
29
 
 
30
 
from bzrlib import (
31
 
    progress,
32
 
    osutils,
33
 
    symbol_versioning,
34
 
    )
35
 
 
36
 
""")
37
 
 
38
 
from bzrlib.ui import CLIUIFactory
39
 
 
40
 
 
41
 
class TextUIFactory(CLIUIFactory):
42
 
    """A UI factory for Text user interefaces."""
43
 
 
44
 
    def __init__(self,
45
 
                 bar_type=None,
46
 
                 stdin=None,
47
 
                 stdout=None,
48
 
                 stderr=None):
49
 
        """Create a TextUIFactory.
50
 
 
51
 
        :param bar_type: The type of progress bar to create. It defaults to
52
 
                         letting the bzrlib.progress.ProgressBar factory auto
53
 
                         select.   Deprecated.
54
 
        """
55
 
        super(TextUIFactory, self).__init__(stdin=stdin,
56
 
                stdout=stdout, stderr=stderr)
57
 
        if bar_type:
58
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 11, 0))
59
 
                % "bar_type parameter")
60
 
        # paints progress, network activity, etc
61
 
        self._progress_view = TextProgressView(self.stderr)
62
 
 
63
 
    def prompt(self, prompt):
64
 
        """Emit prompt on the CLI."""
65
 
        self.stdout.write(prompt)
66
 
 
67
 
    def clear_term(self):
68
 
        """Prepare the terminal for output.
69
 
 
70
 
        This will, clear any progress bars, and leave the cursor at the
71
 
        leftmost position."""
72
 
        # XXX: If this is preparing to write to stdout, but that's for example
73
 
        # directed into a file rather than to the terminal, and the progress
74
 
        # bar _is_ going to the terminal, we shouldn't need
75
 
        # to clear it.  We might need to separately check for the case of
76
 
        self._progress_view.clear()
77
 
 
78
 
    def note(self, msg):
79
 
        """Write an already-formatted message, clearing the progress bar if necessary."""
80
 
        self.clear_term()
81
 
        self.stdout.write(msg + '\n')
82
 
 
83
 
    def report_transport_activity(self, transport, byte_count, direction):
84
 
        """Called by transports as they do IO.
85
 
 
86
 
        This may update a progress bar, spinner, or similar display.
87
 
        By default it does nothing.
88
 
        """
89
 
        self._progress_view._show_transport_activity(transport,
90
 
            direction, byte_count)
91
 
 
92
 
    def _progress_updated(self, task):
93
 
        """A task has been updated and wants to be displayed.
94
 
        """
95
 
        if not self._task_stack:
96
 
            warnings.warn("%r updated but no tasks are active" %
97
 
                (task,))
98
 
        elif task != self._task_stack[-1]:
99
 
            warnings.warn("%r is not the top progress task %r" %
100
 
                (task, self._task_stack[-1]))
101
 
        self._progress_view.show_progress(task)
102
 
 
103
 
    def _progress_all_finished(self):
104
 
        self._progress_view.clear()
105
 
 
106
 
 
107
 
class TextProgressView(object):
108
 
    """Display of progress bar and other information on a tty.
109
 
 
110
 
    This shows one line of text, including possibly a network indicator, spinner,
111
 
    progress bar, message, etc.
112
 
 
113
 
    One instance of this is created and held by the UI, and fed updates when a
114
 
    task wants to be painted.
115
 
 
116
 
    Transports feed data to this through the ui_factory object.
117
 
 
118
 
    The Progress views can comprise a tree with _parent_task pointers, but
119
 
    this only prints the stack from the nominated current task up to the root.
120
 
    """
121
 
 
122
 
    def __init__(self, term_file):
123
 
        self._term_file = term_file
124
 
        # true when there's output on the screen we may need to clear
125
 
        self._have_output = False
126
 
        # XXX: We could listen for SIGWINCH and update the terminal width...
127
 
        self._width = osutils.terminal_width()
128
 
        self._last_transport_msg = ''
129
 
        self._spin_pos = 0
130
 
        # time we last repainted the screen
131
 
        self._last_repaint = 0
132
 
        # time we last got information about transport activity
133
 
        self._transport_update_time = 0
134
 
        self._last_task = None
135
 
        self._total_byte_count = 0
136
 
        self._bytes_since_update = 0
137
 
 
138
 
    def _show_line(self, s):
139
 
        n = self._width - 1
140
 
        self._term_file.write('\r%-*.*s\r' % (n, n, s))
141
 
 
142
 
    def clear(self):
143
 
        if self._have_output:
144
 
            self._show_line('')
145
 
        self._have_output = False
146
 
 
147
 
    def _render_bar(self):
148
 
        # return a string for the progress bar itself
149
 
        if (self._last_task is None) or self._last_task.show_bar:
150
 
            # If there's no task object, we show space for the bar anyhow.
151
 
            # That's because most invocations of bzr will end showing progress
152
 
            # at some point, though perhaps only after doing some initial IO.
153
 
            # It looks better to draw the progress bar initially rather than
154
 
            # to have what looks like an incomplete progress bar.
155
 
            spin_str =  r'/-\|'[self._spin_pos % 4]
156
 
            self._spin_pos += 1
157
 
            cols = 20
158
 
            if self._last_task is None:
159
 
                completion_fraction = 0
160
 
            else:
161
 
                completion_fraction = \
162
 
                    self._last_task._overall_completion_fraction() or 0
163
 
            markers = int(round(float(cols) * completion_fraction)) - 1
164
 
            bar_str = '[' + ('#' * markers + spin_str).ljust(cols) + '] '
165
 
            return bar_str
166
 
        elif self._last_task.show_spinner:
167
 
            # The last task wanted just a spinner, no bar
168
 
            spin_str =  r'/-\|'[self._spin_pos % 4]
169
 
            self._spin_pos += 1
170
 
            return spin_str + ' '
171
 
        else:
172
 
            return ''
173
 
 
174
 
    def _format_task(self, task):
175
 
        if not task.show_count:
176
 
            s = ''
177
 
        elif task.current_cnt is not None and task.total_cnt is not None:
178
 
            s = ' %d/%d' % (task.current_cnt, task.total_cnt)
179
 
        elif task.current_cnt is not None:
180
 
            s = ' %d' % (task.current_cnt)
181
 
        else:
182
 
            s = ''
183
 
        # compose all the parent messages
184
 
        t = task
185
 
        m = task.msg
186
 
        while t._parent_task:
187
 
            t = t._parent_task
188
 
            if t.msg:
189
 
                m = t.msg + ':' + m
190
 
        return m + s
191
 
 
192
 
    def _render_line(self):
193
 
        bar_string = self._render_bar()
194
 
        if self._last_task:
195
 
            task_msg = self._format_task(self._last_task)
196
 
        else:
197
 
            task_msg = ''
198
 
        trans = self._last_transport_msg
199
 
        if trans:
200
 
            trans += ' | '
201
 
        return (bar_string + trans + task_msg)
202
 
 
203
 
    def _repaint(self):
204
 
        s = self._render_line()
205
 
        self._show_line(s)
206
 
        self._have_output = True
207
 
 
208
 
    def show_progress(self, task):
209
 
        """Called by the task object when it has changed.
210
 
        
211
 
        :param task: The top task object; its parents are also included 
212
 
            by following links.
213
 
        """
214
 
        must_update = task is not self._last_task
215
 
        self._last_task = task
216
 
        now = time.time()
217
 
        if (not must_update) and (now < self._last_repaint + 0.1):
218
 
            return
219
 
        if now > self._transport_update_time + 10:
220
 
            # no recent activity; expire it
221
 
            self._last_transport_msg = ''
222
 
        self._last_repaint = now
223
 
        self._repaint()
224
 
 
225
 
    def _show_transport_activity(self, transport, direction, byte_count):
226
 
        """Called by transports via the ui_factory, as they do IO.
227
 
 
228
 
        This may update a progress bar, spinner, or similar display.
229
 
        By default it does nothing.
230
 
        """
231
 
        # XXX: Probably there should be a transport activity model, and that
232
 
        # too should be seen by the progress view, rather than being poked in
233
 
        # here.
234
 
        self._total_byte_count += byte_count
235
 
        self._bytes_since_update += byte_count
236
 
        now = time.time()
237
 
        if self._transport_update_time is None:
238
 
            self._transport_update_time = now
239
 
        elif now >= (self._transport_update_time + 0.5):
240
 
            # guard against clock stepping backwards, and don't update too
241
 
            # often
242
 
            rate = self._bytes_since_update / (now - self._transport_update_time)
243
 
            scheme = getattr(transport, '_scheme', None) or repr(transport)
244
 
            if direction == 'read':
245
 
                dir_char = '>'
246
 
            elif direction == 'write':
247
 
                dir_char = '<'
248
 
            else:
249
 
                dir_char = '?'
250
 
            msg = ("%.7s %s %6dkB %5dkB/s" %
251
 
                    (scheme, dir_char, self._total_byte_count>>10, int(rate)>>10,))
252
 
            self._transport_update_time = now
253
 
            self._last_repaint = now
254
 
            self._bytes_since_update = 0
255
 
            self._last_transport_msg = msg
256
 
            self._repaint()
257
 
 
258