4 # Author: Lea Wiemann <LeWiemann@gmail.com>
5 # Copyright: This module has been placed in the public domain.
12 import DocutilsTestSupport
# must be imported before docutils
13 from docutils
import io
14 from docutils
.utils
.error_reporting
import locale_encoding
15 from test_error_reporting
import BBuf
, UBuf
17 class mock_stdout(UBuf
):
24 class HelperTests(unittest
.TestCase
):
26 def test_check_encoding_true(self
):
27 """Return `True` if lookup returns the same codec"""
28 self
.assertEqual(io
.check_encoding(mock_stdout
, 'utf8'), True)
29 self
.assertEqual(io
.check_encoding(mock_stdout
, 'utf-8'), True)
30 self
.assertEqual(io
.check_encoding(mock_stdout
, 'UTF-8'), True)
32 def test_check_encoding_false(self
):
33 """Return `False` if lookup returns different codecs"""
34 self
.assertEqual(io
.check_encoding(mock_stdout
, 'ascii'), False)
35 self
.assertEqual(io
.check_encoding(mock_stdout
, 'latin-1'), False)
37 def test_check_encoding_none(self
):
38 """Cases where the comparison fails."""
39 # stream.encoding is None:
40 self
.assertEqual(io
.check_encoding(io
.FileInput(), 'ascii'), None)
41 # stream.encoding does not exist:
42 self
.assertEqual(io
.check_encoding(BBuf
, 'ascii'), None)
44 self
.assertEqual(io
.check_encoding(mock_stdout
, None), None)
46 self
.assertEqual(io
.check_encoding(mock_stdout
, 'UTF-9'), None)
49 class InputTests(unittest
.TestCase
):
52 input = io
.StringInput(source
=b
'\xef\xbb\xbf foo \xef\xbb\xbf bar',
54 # Assert BOMs are gone.
55 self
.assertEqual(input.read(), u
' foo bar')
57 input = io
.StringInput(source
=u
'\ufeff foo \ufeff bar')
58 # Assert BOMs are still there.
59 self
.assertEqual(input.read(), u
'\ufeff foo \ufeff bar')
61 def test_coding_slug(self
):
62 input = io
.StringInput(source
=b
"""\
63 .. -*- coding: ascii -*-
68 self
.assertEqual(input.successful_encoding
, 'ascii')
69 input = io
.StringInput(source
=b
"""\
71 # -*- coding: ascii -*-
75 self
.assertEqual(input.successful_encoding
, 'ascii')
76 input = io
.StringInput(source
=b
"""\
78 # extraneous comment; prevents coding slug from being read
79 # -*- coding: ascii -*-
83 self
.assertNotEqual(input.successful_encoding
, 'ascii')
85 def test_bom_detection(self
):
86 source
= u
'\ufeffdata\nblah\n'
87 input = io
.StringInput(source
=source
.encode('utf-16-be'))
89 self
.assertEqual(input.successful_encoding
, 'utf-16-be')
90 input = io
.StringInput(source
=source
.encode('utf-16-le'))
92 self
.assertEqual(input.successful_encoding
, 'utf-16-le')
93 input = io
.StringInput(source
=source
.encode('utf-8'))
95 self
.assertEqual(input.successful_encoding
, 'utf-8')
97 def test_readlines(self
):
98 input = io
.FileInput(source_path
='data/include.txt')
99 data
= input.readlines()
100 self
.assertEqual(data
, [u
'Some include text.\n'])
102 def test_heuristics_utf8(self
):
103 # if no encoding is given, try decoding with utf8:
104 input = io
.FileInput(source_path
='functional/input/cyrillic.txt')
106 if sys
.version_info
< (3,0):
107 # in Py3k, the locale encoding is used without --input-encoding
108 # skipping the heuristic
109 self
.assertEqual(input.successful_encoding
, 'utf-8')
111 def test_heuristics_no_utf8(self
):
112 # if no encoding is given and decoding with utf8 fails,
113 # use either the locale encoding (if specified) or latin-1:
114 if sys
.version_info
>= (3,0) and locale_encoding
!= "utf8":
115 # in Py3k, the locale encoding is used without --input-encoding
116 # skipping the heuristic unless decoding fails.
118 probed_encodings
= (locale_encoding
, 'latin-1')
119 input = io
.FileInput(source_path
='data/latin1.txt')
121 if input.successful_encoding
not in probed_encodings
:
122 raise AssertionError(
123 "guessed encoding '%s' differs from probed encodings %r"
124 % (input.successful_encoding
, probed_encodings
))
125 if input.successful_encoding
== 'latin-1':
126 self
.assertEqual(data
, u
'Gr\xfc\xdfe\n')
128 def test_decode_unicode(self
):
129 # With the special value "unicode" or "Unicode":
130 uniinput
= io
.Input(encoding
='unicode')
131 # keep unicode instances as-is
132 self
.assertEqual(uniinput
.decode(u
'ja'), u
'ja')
133 # raise AssertionError if data is not an unicode string
134 self
.assertRaises(AssertionError, uniinput
.decode
, b
'ja')
137 class OutputTests(unittest
.TestCase
):
144 """Buffer accepting binary strings (bytes)"""
146 """Buffer accepting unicode strings"""
147 self
.mock_stdout
= mock_stdout()
148 """Stub of sys.stdout under Python 3"""
150 def test_write_unicode(self
):
151 fo
= io
.FileOutput(destination
=self
.udrain
, encoding
='unicode',
154 self
.assertEqual(self
.udrain
.getvalue(), self
.udata
)
156 def test_write_utf8(self
):
157 if sys
.version_info
>= (3,0):
158 fo
= io
.FileOutput(destination
=self
.udrain
, encoding
='utf8',
161 self
.assertEqual(self
.udrain
.getvalue(), self
.udata
)
163 fo
= io
.FileOutput(destination
=self
.bdrain
, encoding
='utf8',
166 self
.assertEqual(self
.bdrain
.getvalue(), self
.udata
.encode('utf8'))
168 # With destination in binary mode, data must be binary string
169 # and is written as-is:
170 def test_write_bytes(self
):
171 fo
= io
.FileOutput(destination
=self
.bdrain
, encoding
='utf8',
172 mode
='wb', autoclose
=False)
174 self
.assertEqual(self
.bdrain
.getvalue(), self
.bdata
)
176 # Test for Python 3 features:
177 if sys
.version_info
>= (3,0):
178 def test_write_bytes_to_stdout(self
):
179 # try writing data to `destination.buffer`, if data is
180 # instance of `bytes` and writing to `destination` fails:
181 fo
= io
.FileOutput(destination
=self
.mock_stdout
)
183 self
.assertEqual(self
.mock_stdout
.buffer.getvalue(),
186 def test_encoding_clash_resolved(self
):
187 fo
= io
.FileOutput(destination
=self
.mock_stdout
,
188 encoding
='latin1', autoclose
=False)
190 self
.assertEqual(self
.mock_stdout
.buffer.getvalue(),
191 self
.udata
.encode('latin1'))
193 def test_encoding_clash_nonresolvable(self
):
194 del(self
.mock_stdout
.buffer)
195 fo
= io
.FileOutput(destination
=self
.mock_stdout
,
196 encoding
='latin1', autoclose
=False)
197 self
.assertRaises(ValueError, fo
.write
, self
.udata
)
200 if __name__
== '__main__':