summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2018-09-23 00:53:58 -0700
committerGitHub <noreply@github.com>2018-09-23 00:53:58 -0700
commit0b67995bfa45393585e2e0017c82c706c4a04b04 (patch)
tree0b8605459f029bd7146c97ac8160af7c606749db
parent94812f717dde8b11a9ad9c0fd5be66ff9bd53f58 (diff)
downloadcpython-git-0b67995bfa45393585e2e0017c82c706c4a04b04.tar.gz
bpo-34421: Improve distutils logging for non-ASCII strings. (GH-9126) (GH-9506)
Use "backslashreplace" instead of "unicode-escape". It is not implementation depended and escapes only non-encodable characters. Also simplify the code. (cherry picked from commit 4b860fd) (cherry picked from commit c73df53569f86d0c7742bafa55958c53d57a02e4) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
-rw-r--r--Lib/distutils/log.py7
-rw-r--r--Lib/distutils/tests/test_log.py50
2 files changed, 32 insertions, 25 deletions
diff --git a/Lib/distutils/log.py b/Lib/distutils/log.py
index 3a6602bc8b..8ef6b28ea2 100644
--- a/Lib/distutils/log.py
+++ b/Lib/distutils/log.py
@@ -27,14 +27,13 @@ class Log:
stream = sys.stderr
else:
stream = sys.stdout
- if stream.errors == 'strict':
+ try:
+ stream.write('%s\n' % msg)
+ except UnicodeEncodeError:
# emulate backslashreplace error handler
encoding = stream.encoding
msg = msg.encode(encoding, "backslashreplace").decode(encoding)
- try:
stream.write('%s\n' % msg)
- except UnicodeEncodeError:
- stream.write('%s\n' % msg.encode('unicode-escape').decode('ascii'))
stream.flush()
def log(self, level, msg, *args):
diff --git a/Lib/distutils/tests/test_log.py b/Lib/distutils/tests/test_log.py
index 0c2ad7a426..75cf900617 100644
--- a/Lib/distutils/tests/test_log.py
+++ b/Lib/distutils/tests/test_log.py
@@ -1,35 +1,43 @@
"""Tests for distutils.log"""
+import io
import sys
import unittest
-from tempfile import NamedTemporaryFile
-from test.support import run_unittest
+from test.support import swap_attr, run_unittest
from distutils import log
class TestLog(unittest.TestCase):
def test_non_ascii(self):
- # Issue #8663: test that non-ASCII text is escaped with
- # backslashreplace error handler (stream use ASCII encoding and strict
- # error handler)
- old_stdout = sys.stdout
- old_stderr = sys.stderr
- old_threshold = log.set_threshold(log.DEBUG)
- try:
- with NamedTemporaryFile(mode="w+", encoding='ascii') as stdout, \
- NamedTemporaryFile(mode="w+", encoding='ascii') as stderr:
- sys.stdout = stdout
- sys.stderr = stderr
- log.debug("debug:\xe9")
- log.fatal("fatal:\xe9")
+ # Issues #8663, #34421: test that non-encodable text is escaped with
+ # backslashreplace error handler and encodable non-ASCII text is
+ # output as is.
+ for errors in ('strict', 'backslashreplace', 'surrogateescape',
+ 'replace', 'ignore'):
+ with self.subTest(errors=errors):
+ stdout = io.TextIOWrapper(io.BytesIO(),
+ encoding='cp437', errors=errors)
+ stderr = io.TextIOWrapper(io.BytesIO(),
+ encoding='cp437', errors=errors)
+ old_threshold = log.set_threshold(log.DEBUG)
+ try:
+ with swap_attr(sys, 'stdout', stdout), \
+ swap_attr(sys, 'stderr', stderr):
+ log.debug('Dεbug\tMėssãge')
+ log.fatal('Fαtal\tÈrrōr')
+ finally:
+ log.set_threshold(old_threshold)
+
stdout.seek(0)
- self.assertEqual(stdout.read().rstrip(), "debug:\\xe9")
+ self.assertEqual(stdout.read().rstrip(),
+ 'Dεbug\tM?ss?ge' if errors == 'replace' else
+ 'Dεbug\tMssge' if errors == 'ignore' else
+ 'Dεbug\tM\\u0117ss\\xe3ge')
stderr.seek(0)
- self.assertEqual(stderr.read().rstrip(), "fatal:\\xe9")
- finally:
- log.set_threshold(old_threshold)
- sys.stdout = old_stdout
- sys.stderr = old_stderr
+ self.assertEqual(stderr.read().rstrip(),
+ 'Fαtal\t?rr?r' if errors == 'replace' else
+ 'Fαtal\trrr' if errors == 'ignore' else
+ 'Fαtal\t\\xc8rr\\u014dr')
def test_suite():
return unittest.makeSuite(TestLog)