/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
6621.22.1 by Martin
Refactor bzrlib.ui to be based on unicode streams
1
# Copyright (C) 2005-2016 Canonical Ltd, 2017 Bazaar developers
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
17
from __future__ import absolute_import
18
19
import io
20
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
21
from .. import (
6621.22.1 by Martin
Refactor bzrlib.ui to be based on unicode streams
22
    ui,
23
)
6695.1.1 by Martin
Make ui package pass tests on Python 3
24
from ..ui import text as ui_text
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
25
from ..sixish import (
6621.22.1 by Martin
Refactor bzrlib.ui to be based on unicode streams
26
    text_type,
27
)
28
29
30
class StringIOWithEncoding(io.StringIO):
31
32
    encoding = "ascii"
33
6621.22.2 by Martin
Use BytesIO or StringIO from bzrlib.sixish
34
    def write(self, string):
35
        if isinstance(string, bytes):
36
            string = string.decode(self.encoding)
37
        io.StringIO.write(self, string)
38
6621.22.1 by Martin
Refactor bzrlib.ui to be based on unicode streams
39
40
class BytesIOWithEncoding(io.BytesIO):
41
42
    encoding = "ascii"
43
44
45
class StringIOAsTTY(StringIOWithEncoding):
46
    """A helper class which makes a StringIO look like a terminal"""
47
48
    def isatty(self):
49
        return True
50
51
6695.1.1 by Martin
Make ui package pass tests on Python 3
52
class TextUIFactory(ui_text.TextUIFactory):
6621.22.1 by Martin
Refactor bzrlib.ui to be based on unicode streams
53
54
    def __init__(self, stdin=None, stdout=None, stderr=None):
55
        if isinstance(stdin, bytes):
56
            stdin = stdin.decode()
57
        if isinstance(stdin, text_type):
58
            stdin = StringIOWithEncoding(stdin)
59
        if stdout is None:
60
            stdout = StringIOWithEncoding()
61
        if stderr is None:
62
            stderr = StringIOWithEncoding()
63
        super(TextUIFactory, self).__init__(stdin, stdout, stderr)
64
65
66
class TestUIFactory(TextUIFactory):
67
    """A UI Factory for testing.
68
69
    Hide the progress bar but emit note()s.
70
    Redirect stdin.
71
    Allows get_password to be tested without real tty attached.
72
73
    See also CannedInputUIFactory which lets you provide programmatic input in
74
    a structured way.
75
    """
76
    # TODO: Capture progress events at the model level and allow them to be
77
    # observed by tests that care.
78
    #
79
    # XXX: Should probably unify more with CannedInputUIFactory or a
80
    # particular configuration of TextUIFactory, or otherwise have a clearer
81
    # idea of how they're supposed to be different.
82
    # See https://bugs.launchpad.net/bzr/+bug/408213
83
84
    def get_non_echoed_password(self):
85
        """Get password from stdin without trying to handle the echo mode"""
86
        password = self.stdin.readline()
87
        if not password:
88
            raise EOFError
89
        if password[-1] == '\n':
90
            password = password[:-1]
91
        return password
92
93
    def make_progress_view(self):
94
        return ui.NullProgressView()