traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-34421: Improve distutils logging for non-ASCII strings. (GH-9126) 

Use "backslashreplace" instead of "unicode-escape".  It is not
implementation depended and escapes only non-encodable characters.

Also simplify the code.
This commit is contained in:
Serhiy Storchaka 2018-09-23 09:12:59 +03:00 committed by GitHub
parent 8fabae3b00
commit 4b860fd777
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Lib/distutils/log.py
View File

@ -27,14 +27,13 @@ class Log:
stream = sys.stderr stream = sys.stderr
else: else:
stream = sys.stdout stream = sys.stdout
if stream.errors == 'strict':
# emulate backslashreplace error handler
encoding = stream.encoding
msg = msg.encode(encoding, "backslashreplace").decode(encoding)
try: try:
stream.write('%s\n' % msg) stream.write('%s\n' % msg)
except UnicodeEncodeError: except UnicodeEncodeError:
stream.write('%s\n' % msg.encode('unicode-escape').decode('ascii')) # emulate backslashreplace error handler
encoding = stream.encoding
msg = msg.encode(encoding, "backslashreplace").decode(encoding)
stream.write('%s\n' % msg)
stream.flush() stream.flush()
def log(self, level, msg, *args): def log(self, level, msg, *args):

46
Lib/distutils/tests/test_log.py
View File

@ -3,33 +3,39 @@
import sys import sys
import unittest import unittest
from tempfile import NamedTemporaryFile from tempfile import NamedTemporaryFile
from test.support import run_unittest from test.support import swap_attr, run_unittest
from distutils import log from distutils import log
class TestLog(unittest.TestCase): class TestLog(unittest.TestCase):
def test_non_ascii(self): def test_non_ascii(self):
# Issue #8663: test that non-ASCII text is escaped with # Issues #8663, #34421: test that non-encodable text is escaped with
# backslashreplace error handler (stream use ASCII encoding and strict # backslashreplace error handler and encodable non-ASCII text is
# error handler) # output as is.
old_stdout = sys.stdout for errors in ('strict', 'backslashreplace', 'surrogateescape',
old_stderr = sys.stderr 'replace', 'ignore'):
old_threshold = log.set_threshold(log.DEBUG) with self.subTest(errors=errors), \
try: NamedTemporaryFile("w+", encoding='cp437', errors=errors) as stdout, \
with NamedTemporaryFile(mode="w+", encoding='ascii') as stdout, \ NamedTemporaryFile("w+", encoding='cp437', errors=errors) as stderr:
NamedTemporaryFile(mode="w+", encoding='ascii') as stderr: old_threshold = log.set_threshold(log.DEBUG)
sys.stdout = stdout try:
sys.stderr = stderr with swap_attr(sys, 'stdout', stdout), \
log.debug("debug:\xe9") swap_attr(sys, 'stderr', stderr):
log.fatal("fatal:\xe9") log.debug('Dεbug\tMėssãge')
log.fatal('Fαtal\tÈrrōr')
finally:
log.set_threshold(old_threshold)
stdout.seek(0) 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) stderr.seek(0)
self.assertEqual(stderr.read().rstrip(), "fatal:\\xe9") self.assertEqual(stderr.read().rstrip(),
finally: 'Fαtal\t?rr?r' if errors == 'replace' else
log.set_threshold(old_threshold) 'Fαtal\trrr' if errors == 'ignore' else
sys.stdout = old_stdout 'Fαtal\t\\xc8rr\\u014dr')
sys.stderr = old_stderr
def test_suite(): def test_suite():
return unittest.makeSuite(TestLog) return unittest.makeSuite(TestLog)