/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

  • Committer: Martin Pool
  • Date: 2006-10-29 06:53:11 UTC
  • mto: This revision was merged to the branch mainline in revision 2114.
  • Revision ID: mbp@sourcefrog.net-20061029065311-c0db791096b06831
Better progress bars during tests

This now shows by default something like::

  [41/3989, 10 skipped in 0s] test_bundle.V08BundleTester.test_binary_bundle

The whole test name is generally visible, as are the number skipped or 
failed so far; if there are skips, failures or errors they are printed
out above the progress bar. 

Code for displaying test results in different ways was separated out
into cleaner subclasses, and the selftest builtin was cleaned up.

This introduces a new and (simpler) setup for progress bars through the UI
object.  They don't nest, under the assumption that we can really only convey
one level at a time.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/text.py
 
1
# Copyright (C) 2005 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
 
 
24
from bzrlib.lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
import getpass
 
27
 
 
28
from bzrlib import (
 
29
    osutils,
 
30
    progress,
 
31
    )
 
32
""")
 
33
 
 
34
from bzrlib.symbol_versioning import (
 
35
    deprecated_method,
 
36
    zero_eight,
 
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
                 stdout=None,
 
47
                 stderr=None):
 
48
        """Create a TextUIFactory.
 
49
 
 
50
        :param bar_type: The type of progress bar to create. It defaults to 
 
51
                         letting the bzrlib.progress.ProgressBar factory auto
 
52
                         select.
 
53
        """
 
54
        super(TextUIFactory, self).__init__()
 
55
        self._bar_type = bar_type
 
56
        if stdout is None:
 
57
            self.stdout = sys.stdout
 
58
        else:
 
59
            self.stdout = stdout
 
60
        if stderr is None:
 
61
            self.stderr = sys.stderr
 
62
        else:
 
63
            self.stderr = stderr
 
64
        self._simple_progress_active = False
 
65
 
 
66
    def prompt(self, prompt):
 
67
        """Emit prompt on the CLI."""
 
68
        self.stdout.write(prompt + "? [y/n]:")
 
69
        
 
70
    @deprecated_method(zero_eight)
 
71
    def progress_bar(self):
 
72
        """See UIFactory.nested_progress_bar()."""
 
73
        # this in turn is abstract, and creates either a tty or dots
 
74
        # bar depending on what we think of the terminal
 
75
        return progress.ProgressBar()
 
76
 
 
77
    def get_password(self, prompt='', **kwargs):
 
78
        """Prompt the user for a password.
 
79
 
 
80
        :param prompt: The prompt to present the user
 
81
        :param kwargs: Arguments which will be expanded into the prompt.
 
82
                       This lets front ends display different things if
 
83
                       they so choose.
 
84
        :return: The password string, return None if the user 
 
85
                 canceled the request.
 
86
        """
 
87
        prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
 
88
        prompt += ': '
 
89
        # There's currently no way to say 'i decline to enter a password'
 
90
        # as opposed to 'my password is empty' -- does it matter?
 
91
        return getpass.getpass(prompt)
 
92
 
 
93
    def nested_progress_bar(self):
 
94
        """Return a nested progress bar.
 
95
        
 
96
        The actual bar type returned depends on the progress module which
 
97
        may return a tty or dots bar depending on the terminal.
 
98
        """
 
99
        if self._progress_bar_stack is None:
 
100
            self._progress_bar_stack = progress.ProgressBarStack(
 
101
                klass=self._bar_type)
 
102
        return self._progress_bar_stack.get_nested()
 
103
 
 
104
    def clear_term(self):
 
105
        """Prepare the terminal for output.
 
106
 
 
107
        This will, clear any progress bars, and leave the cursor at the
 
108
        leftmost position."""
 
109
        if self._simple_progress_active:
 
110
            self._clear_progress_line()
 
111
            return
 
112
        if self._progress_bar_stack is None:
 
113
            return
 
114
        overall_pb = self._progress_bar_stack.bottom()
 
115
        if overall_pb is not None:
 
116
            overall_pb.clear()
 
117
 
 
118
    def _clear_progress_line(self):
 
119
        if False:
 
120
            # erase it
 
121
            width = osutils.terminal_width() - 1
 
122
            self.stderr.write('\r')
 
123
            self.stderr.write(' ' * width)
 
124
            self.stderr.write('\r')
 
125
        else:
 
126
            # just leave it, and move to new line - more reliable and leaves
 
127
            # it there for context
 
128
            self.stderr.write('\n')
 
129
        self._simple_progress_active = False
 
130
 
 
131
    def show_progress_line(self, msg):
 
132
        width = osutils.terminal_width() - 1
 
133
        msg = msg[:width]
 
134
        msg = msg.ljust(width)
 
135
        self.stderr.write('\r' + msg)
 
136
        self.stderr.flush()
 
137
        self._simple_progress_active = True
 
138
    
 
139
    def message(self, msg):
 
140
        self.clear_term()
 
141
        self.stderr.write(msg + '\n')