[Python-checkins] bpo-43651: Fix EncodingWarning in fileinput and its test (GH-25648)
methane
webhook-mailer at python.org
Tue Apr 27 02:47:24 EDT 2021
https://github.com/python/cpython/commit/878bc8b6c2051cf344c594636fa957ce6c9d2188
commit: 878bc8b6c2051cf344c594636fa957ce6c9d2188
branch: master
author: Inada Naoki <songofacandy at gmail.com>
committer: methane <songofacandy at gmail.com>
date: 2021-04-27T15:47:16+09:00
summary:
bpo-43651: Fix EncodingWarning in fileinput and its test (GH-25648)
files:
M Lib/fileinput.py
M Lib/test/test_fileinput.py
diff --git a/Lib/fileinput.py b/Lib/fileinput.py
index 6218c4f4e2fdf..35347185da048 100644
--- a/Lib/fileinput.py
+++ b/Lib/fileinput.py
@@ -210,7 +210,8 @@ def __init__(self, files=None, inplace=False, backup="", *,
# We can not use io.text_encoding() here because old openhook doesn't
# take encoding parameter.
- if "b" not in mode and encoding is None and sys.flags.warn_default_encoding:
+ if (sys.flags.warn_default_encoding and
+ "b" not in mode and encoding is None and openhook is None):
import warnings
warnings.warn("'encoding' argument not specified.",
EncodingWarning, 2)
@@ -330,6 +331,13 @@ def _readline(self):
self._file = None
self._isstdin = False
self._backupfilename = 0
+
+ # EncodingWarning is emitted in __init__() already
+ if "b" not in self._mode:
+ encoding = self._encoding or "locale"
+ else:
+ encoding = None
+
if self._filename == '-':
self._filename = '<stdin>'
if 'b' in self._mode:
@@ -347,18 +355,18 @@ def _readline(self):
pass
# The next few lines may raise OSError
os.rename(self._filename, self._backupfilename)
- self._file = open(self._backupfilename, self._mode)
+ self._file = open(self._backupfilename, self._mode, encoding=encoding)
try:
perm = os.fstat(self._file.fileno()).st_mode
except OSError:
- self._output = open(self._filename, self._write_mode)
+ self._output = open(self._filename, self._write_mode, encoding=encoding)
else:
mode = os.O_CREAT | os.O_WRONLY | os.O_TRUNC
if hasattr(os, 'O_BINARY'):
mode |= os.O_BINARY
fd = os.open(self._filename, mode, perm)
- self._output = os.fdopen(fd, self._write_mode)
+ self._output = os.fdopen(fd, self._write_mode, encoding=encoding)
try:
os.chmod(self._filename, perm)
except OSError:
@@ -376,11 +384,6 @@ def _readline(self):
self._file = self._openhook(
self._filename, self._mode, encoding=self._encoding, errors=self._errors)
else:
- # EncodingWarning is emitted in __init__() already
- if "b" not in self._mode:
- encoding = self._encoding or "locale"
- else:
- encoding = None
self._file = open(self._filename, self._mode, encoding=encoding, errors=self._errors)
self._readline = self._file.readline # hide FileInput._readline
return self._readline()
diff --git a/Lib/test/test_fileinput.py b/Lib/test/test_fileinput.py
index d01d39627219e..cae0eb1b5f657 100644
--- a/Lib/test/test_fileinput.py
+++ b/Lib/test/test_fileinput.py
@@ -44,7 +44,8 @@ class BaseTests:
def writeTmp(self, content, *, mode='w'): # opening in text mode is the default
fd, name = tempfile.mkstemp()
self.addCleanup(os_helper.unlink, name)
- with open(fd, mode) as f:
+ encoding = None if "b" in mode else "utf-8"
+ with open(fd, mode, encoding=encoding) as f:
f.write(content)
return name
@@ -96,7 +97,7 @@ def test_buffer_sizes(self):
if verbose:
print('1. Simple iteration')
- fi = FileInput(files=(t1, t2, t3, t4))
+ fi = FileInput(files=(t1, t2, t3, t4), encoding="utf-8")
lines = list(fi)
fi.close()
self.assertEqual(len(lines), 31)
@@ -107,7 +108,7 @@ def test_buffer_sizes(self):
if verbose:
print('2. Status variables')
- fi = FileInput(files=(t1, t2, t3, t4))
+ fi = FileInput(files=(t1, t2, t3, t4), encoding="utf-8")
s = "x"
while s and s != 'Line 6 of file 2\n':
s = fi.readline()
@@ -126,7 +127,7 @@ def test_buffer_sizes(self):
if verbose:
print('4. Stdin')
- fi = FileInput(files=(t1, t2, t3, t4, '-'))
+ fi = FileInput(files=(t1, t2, t3, t4, '-'), encoding="utf-8")
savestdin = sys.stdin
try:
sys.stdin = StringIO("Line 1 of stdin\nLine 2 of stdin\n")
@@ -140,7 +141,7 @@ def test_buffer_sizes(self):
if verbose:
print('5. Boundary conditions')
- fi = FileInput(files=(t1, t2, t3, t4))
+ fi = FileInput(files=(t1, t2, t3, t4), encoding="utf-8")
self.assertEqual(fi.lineno(), 0)
self.assertEqual(fi.filename(), None)
fi.nextfile()
@@ -151,7 +152,7 @@ def test_buffer_sizes(self):
print('6. Inplace')
savestdout = sys.stdout
try:
- fi = FileInput(files=(t1, t2, t3, t4), inplace=1)
+ fi = FileInput(files=(t1, t2, t3, t4), inplace=1, encoding="utf-8")
for line in fi:
line = line[:-1].upper()
print(line)
@@ -159,7 +160,7 @@ def test_buffer_sizes(self):
finally:
sys.stdout = savestdout
- fi = FileInput(files=(t1, t2, t3, t4))
+ fi = FileInput(files=(t1, t2, t3, t4), encoding="utf-8")
for line in fi:
self.assertEqual(line[-1], '\n')
m = pat.match(line[:-1])
@@ -182,7 +183,7 @@ def test_zero_byte_files(self):
t2 = self.writeTmp("")
t3 = self.writeTmp("The only line there is.\n")
t4 = self.writeTmp("")
- fi = FileInput(files=(t1, t2, t3, t4))
+ fi = FileInput(files=(t1, t2, t3, t4), encoding="utf-8")
line = fi.readline()
self.assertEqual(line, 'The only line there is.\n')
@@ -200,7 +201,7 @@ def test_zero_byte_files(self):
def test_files_that_dont_end_with_newline(self):
t1 = self.writeTmp("A\nB\nC")
t2 = self.writeTmp("D\nE\nF")
- fi = FileInput(files=(t1, t2))
+ fi = FileInput(files=(t1, t2), encoding="utf-8")
lines = list(fi)
self.assertEqual(lines, ["A\n", "B\n", "C", "D\n", "E\n", "F"])
self.assertEqual(fi.filelineno(), 3)
@@ -213,14 +214,14 @@ def test_files_that_dont_end_with_newline(self):
## encoding = sys.getfilesystemencoding()
## if encoding is None:
## encoding = 'ascii'
-## fi = FileInput(files=str(t1, encoding))
+## fi = FileInput(files=str(t1, encoding), encoding="utf-8")
## lines = list(fi)
## self.assertEqual(lines, ["A\n", "B"])
def test_fileno(self):
t1 = self.writeTmp("A\nB")
t2 = self.writeTmp("C\nD")
- fi = FileInput(files=(t1, t2))
+ fi = FileInput(files=(t1, t2), encoding="utf-8")
self.assertEqual(fi.fileno(), -1)
line = next(fi)
self.assertNotEqual(fi.fileno(), -1)
@@ -232,7 +233,7 @@ def test_fileno(self):
def test_opening_mode(self):
try:
# invalid mode, should raise ValueError
- fi = FileInput(mode="w")
+ fi = FileInput(mode="w", encoding="utf-8")
self.fail("FileInput should reject invalid mode argument")
except ValueError:
pass
@@ -281,7 +282,7 @@ def __init__(self):
self.invoked = False
def __call__(self, *args, **kargs):
self.invoked = True
- return open(*args)
+ return open(*args, encoding="utf-8")
t = self.writeTmp("\n")
custom_open_hook = CustomOpenHook()
@@ -346,7 +347,7 @@ def old_hook(filename, mode):
def test_context_manager(self):
t1 = self.writeTmp("A\nB\nC")
t2 = self.writeTmp("D\nE\nF")
- with FileInput(files=(t1, t2)) as fi:
+ with FileInput(files=(t1, t2), encoding="utf-8") as fi:
lines = list(fi)
self.assertEqual(lines, ["A\n", "B\n", "C", "D\n", "E\n", "F"])
self.assertEqual(fi.filelineno(), 3)
@@ -356,13 +357,13 @@ def test_context_manager(self):
def test_close_on_exception(self):
t1 = self.writeTmp("")
try:
- with FileInput(files=t1) as fi:
+ with FileInput(files=t1, encoding="utf-8") as fi:
raise OSError
except OSError:
self.assertEqual(fi._files, ())
def test_empty_files_list_specified_to_constructor(self):
- with FileInput(files=[]) as fi:
+ with FileInput(files=[], encoding="utf-8") as fi:
self.assertEqual(fi._files, ('-',))
@warnings_helper.ignore_warnings(category=DeprecationWarning)
@@ -370,7 +371,7 @@ def test__getitem__(self):
"""Tests invoking FileInput.__getitem__() with the current
line number"""
t = self.writeTmp("line1\nline2\n")
- with FileInput(files=[t]) as fi:
+ with FileInput(files=[t], encoding="utf-8") as fi:
retval1 = fi[0]
self.assertEqual(retval1, "line1\n")
retval2 = fi[1]
@@ -388,7 +389,7 @@ def test__getitem__invalid_key(self):
"""Tests invoking FileInput.__getitem__() with an index unequal to
the line number"""
t = self.writeTmp("line1\nline2\n")
- with FileInput(files=[t]) as fi:
+ with FileInput(files=[t], encoding="utf-8") as fi:
with self.assertRaises(RuntimeError) as cm:
fi[1]
self.assertEqual(cm.exception.args, ("accessing lines out of order",))
@@ -398,7 +399,7 @@ def test__getitem__eof(self):
"""Tests invoking FileInput.__getitem__() with the line number but at
end-of-input"""
t = self.writeTmp('')
- with FileInput(files=[t]) as fi:
+ with FileInput(files=[t], encoding="utf-8") as fi:
with self.assertRaises(IndexError) as cm:
fi[0]
self.assertEqual(cm.exception.args, ("end of input reached",))
@@ -413,7 +414,7 @@ def test_nextfile_oserror_deleting_backup(self):
try:
t = self.writeTmp("\n")
self.addCleanup(safe_unlink, t + '.bak')
- with FileInput(files=[t], inplace=True) as fi:
+ with FileInput(files=[t], inplace=True, encoding="utf-8") as fi:
next(fi) # make sure the file is opened
os.unlink = os_unlink_replacement
fi.nextfile()
@@ -432,7 +433,7 @@ def test_readline_os_fstat_raises_OSError(self):
os_fstat_replacement = UnconditionallyRaise(OSError)
try:
t = self.writeTmp("\n")
- with FileInput(files=[t], inplace=True) as fi:
+ with FileInput(files=[t], inplace=True, encoding="utf-8") as fi:
os.fstat = os_fstat_replacement
fi.readline()
finally:
@@ -450,7 +451,7 @@ def test_readline_os_chmod_raises_OSError(self):
os_chmod_replacement = UnconditionallyRaise(OSError)
try:
t = self.writeTmp("\n")
- with FileInput(files=[t], inplace=True) as fi:
+ with FileInput(files=[t], inplace=True, encoding="utf-8") as fi:
os.chmod = os_chmod_replacement
fi.readline()
finally:
@@ -469,7 +470,7 @@ def fileno(self):
unconditionally_raise_ValueError = FilenoRaisesValueError()
t = self.writeTmp("\n")
- with FileInput(files=[t]) as fi:
+ with FileInput(files=[t], encoding="utf-8") as fi:
file_backup = fi._file
try:
fi._file = unconditionally_raise_ValueError
@@ -517,7 +518,7 @@ def test_iteration_buffering(self):
def test_pathlib_file(self):
t1 = Path(self.writeTmp("Pathlib file."))
- with FileInput(t1) as fi:
+ with FileInput(t1, encoding="utf-8") as fi:
line = fi.readline()
self.assertEqual(line, 'Pathlib file.')
self.assertEqual(fi.lineno(), 1)
@@ -526,11 +527,11 @@ def test_pathlib_file(self):
def test_pathlib_file_inplace(self):
t1 = Path(self.writeTmp('Pathlib file.'))
- with FileInput(t1, inplace=True) as fi:
+ with FileInput(t1, inplace=True, encoding="utf-8") as fi:
line = fi.readline()
self.assertEqual(line, 'Pathlib file.')
print('Modified %s' % line)
- with open(t1) as f:
+ with open(t1, encoding="utf-8") as f:
self.assertEqual(f.read(), 'Modified Pathlib file.\n')
More information about the Python-checkins
mailing list