← 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: 2008-06-05 03:27:37 UTC
  • mto: This revision was merged to the branch mainline in revision 3491.
  • Revision ID: mbp@sourcefrog.net-20080605032737-0eytu5y1k9k5a72t
Add plugin and integration guides to doc indexes

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
    progress,
 
30
    osutils,
 
31
    )
 
32
""")
 
33
 
 
34
from bzrlib.ui import CLIUIFactory
 
35
 
 
36
 
 
37
class TextUIFactory(CLIUIFactory):
 
38
    """A UI factory for Text user interefaces."""
 
39
 
 
40
    def __init__(self,
 
41
                 bar_type=None,
 
42
                 stdout=None,
 
43
                 stderr=None):
 
44
        """Create a TextUIFactory.
 
45
 
 
46
        :param bar_type: The type of progress bar to create. It defaults to 
 
47
                         letting the bzrlib.progress.ProgressBar factory auto
 
48
                         select.
 
49
        """
 
50
        super(TextUIFactory, self).__init__()
 
51
        self._bar_type = bar_type
 
52
        if stdout is None:
 
53
            self.stdout = sys.stdout
 
54
        else:
 
55
            self.stdout = stdout
 
56
        if stderr is None:
 
57
            self.stderr = sys.stderr
 
58
        else:
 
59
            self.stderr = stderr
 
60
 
 
61
    def prompt(self, prompt):
 
62
        """Emit prompt on the CLI."""
 
63
        self.stdout.write(prompt)
 
64
        
 
65
    def nested_progress_bar(self):
 
66
        """Return a nested progress bar.
 
67
        
 
68
        The actual bar type returned depends on the progress module which
 
69
        may return a tty or dots bar depending on the terminal.
 
70
        """
 
71
        if self._progress_bar_stack is None:
 
72
            self._progress_bar_stack = progress.ProgressBarStack(
 
73
                klass=self._bar_type)
 
74
        return self._progress_bar_stack.get_nested()
 
75
 
 
76
    def clear_term(self):
 
77
        """Prepare the terminal for output.
 
78
 
 
79
        This will, clear any progress bars, and leave the cursor at the
 
80
        leftmost position."""
 
81
        if self._progress_bar_stack is None:
 
82
            return
 
83
        overall_pb = self._progress_bar_stack.bottom()
 
84
        if overall_pb is not None:
 
85
            overall_pb.clear()