← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

  • Committer: Aaron Bentley
  • Date: 2006-04-17 22:59:54 UTC
  • mto: This revision was merged to the branch mainline in revision 1672.
  • Revision ID: aaron.bentley@utoronto.ca-20060417225954-79d47d850ef690b1
Add failing test case

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 getpass
 
23
import sys
 
24
 
 
25
import bzrlib.progress
 
26
from bzrlib.symbol_versioning import *
 
27
from bzrlib.ui import UIFactory
 
28
 
 
29
 
 
30
class TextUIFactory(UIFactory):
 
31
 
 
32
    @deprecated_method(zero_eight)
 
33
    def progress_bar(self):
 
34
        """See UIFactory.nested_progress_bar()."""
 
35
        # this in turn is abstract, and creates either a tty or dots
 
36
        # bar depending on what we think of the terminal
 
37
        return bzrlib.progress.ProgressBar()
 
38
 
 
39
    def get_password(self, prompt='', **kwargs):
 
40
        """Prompt the user for a password.
 
41
 
 
42
        :param prompt: The prompt to present the user
 
43
        :param kwargs: Arguments which will be expanded into the prompt.
 
44
                       This lets front ends display different things if
 
45
                       they so choose.
 
46
        :return: The password string, return None if the user 
 
47
                 canceled the request.
 
48
        """
 
49
        prompt = (prompt % kwargs).encode(sys.stdout.encoding, 'replace')
 
50
        prompt += ': '
 
51
        try:
 
52
            return getpass.getpass(prompt)
 
53
        except KeyboardInterrupt:
 
54
            return None
 
55
 
 
56
    def nested_progress_bar(self):
 
57
        """Return a nested progress bar.
 
58
        
 
59
        The actual bar type returned depends on the progress module which
 
60
        may return a tty or dots bar depending on the terminal.
 
61
        """
 
62
        if self._progress_bar_stack is None:
 
63
            self._progress_bar_stack = bzrlib.progress.ProgressBarStack()
 
64
        return self._progress_bar_stack.get_nested()
 
65
 
 
66
    def clear_term(self):
 
67
        """Prepare the terminal for output.
 
68
 
 
69
        This will, clear any progress bars, and leave the cursor at the
 
70
        leftmost position."""
 
71
        if self._progress_bar_stack is None:
 
72
            return
 
73
        overall_pb = self._progress_bar_stack.bottom()
 
74
        if overall_pb is not None:
 
75
            overall_pb.clear()