/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: Robert Collins
  • Date: 2007-03-25 08:59:56 UTC
  • mto: (2376.3.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2401.
  • Revision ID: robertc@robertcollins.net-20070325085956-my8jv7cifqzyltyz
New SmartServer hooks facility. There are two initial hooks documented
in bzrlib.transport.smart.SmartServerHooks. The two initial hooks allow
plugins to execute code upon server startup and shutdown.
(Robert Collins).

SmartServer in standalone mode will now close its listening socket
when it stops, rather than waiting for garbage collection. This primarily
fixes test suite hangs when a test tries to connect to a shutdown server.
It may also help improve behaviour when dealing with a server running
on a specific port (rather than dynamically assigned ports).
(Robert Collins)

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.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
        
 
69
    @deprecated_method(zero_eight)
 
70
    def progress_bar(self):
 
71
        """See UIFactory.nested_progress_bar()."""
 
72
        # this in turn is abstract, and creates either a tty or dots
 
73
        # bar depending on what we think of the terminal
 
74
        return progress.ProgressBar()
 
75
 
 
76
    def nested_progress_bar(self):
 
77
        """Return a nested progress bar.
 
78
        
 
79
        The actual bar type returned depends on the progress module which
 
80
        may return a tty or dots bar depending on the terminal.
 
81
        """
 
82
        if self._progress_bar_stack is None:
 
83
            self._progress_bar_stack = progress.ProgressBarStack(
 
84
                klass=self._bar_type)
 
85
        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()