← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ui/text.py

  • Committer: Martin Pool
  • Date: 2006-03-20 23:09:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1621.
  • Revision ID: mbp@sourcefrog.net-20060320230942-152767f76202f543
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ui/text.py
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
#
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
19
"""Text UI, write output to the console.
20
20
"""
21
21
 
 
22
import getpass
22
23
import sys
23
24
 
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
import getpass
27
 
 
28
 
from bzrlib import (
29
 
    progress,
30
 
    osutils,
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
 
 
65
 
    def prompt(self, prompt):
66
 
        """Emit prompt on the CLI."""
67
 
        self.stdout.write(prompt)
68
 
        
 
25
import bzrlib.progress
 
26
from bzrlib.symbol_versioning import *
 
27
from bzrlib.ui import UIFactory
 
28
 
 
29
 
 
30
class TextUIFactory(UIFactory):
 
31
 
69
32
    @deprecated_method(zero_eight)
70
33
    def progress_bar(self):
71
34
        """See UIFactory.nested_progress_bar()."""
72
35
        # this in turn is abstract, and creates either a tty or dots
73
36
        # bar depending on what we think of the terminal
74
 
        return progress.ProgressBar()
 
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
75
55
 
76
56
    def nested_progress_bar(self):
77
57
        """Return a nested progress bar.
80
60
        may return a tty or dots bar depending on the terminal.
81
61
        """
82
62
        if self._progress_bar_stack is None:
83
 
            self._progress_bar_stack = progress.ProgressBarStack(
84
 
                klass=self._bar_type)
 
63
            self._progress_bar_stack = bzrlib.progress.ProgressBarStack()
85
64
        return self._progress_bar_stack.get_nested()
86
 
 
87
 
    def clear_term(self):
88
 
        """Prepare the terminal for output.
89
 
 
90
 
        This will, clear any progress bars, and leave the cursor at the
91
 
        leftmost position."""
92
 
        if self._progress_bar_stack is None:
93
 
            return
94
 
        overall_pb = self._progress_bar_stack.bottom()
95
 
        if overall_pb is not None:
96
 
            overall_pb.clear()