bpo-33361: Fix bug with seeking in StreamRecoders (pythonGH-8278)

ammaraskar · berkerpeksag · commit a6ec1ce1ac05 · 2019-05-31T22:44:00.000+03:00
diff --git a/Lib/codecs.py b/Lib/codecs.py
@@ -847,6 +847,12 @@ def reset(self):
         self.reader.reset()
         self.writer.reset()
 
+    def seek(self, offset, whence=0):
+        # Seeks must be propagated to both the readers and writers
+        # as they might need to reset their internal buffers.
+        self.reader.seek(offset, whence)
+        self.writer.seek(offset, whence)
+
     def __getattr__(self, name,
                     getattr=getattr):
 
diff --git a/Lib/test/test_codecs.py b/Lib/test/test_codecs.py
@@ -3166,6 +3166,31 @@ def test_write(self):
         sr.write(text.encode('latin1'))
         self.assertEqual(bio.getvalue(), text.encode('utf-8'))
 
+    def test_seeking_read(self):
+        bio = io.BytesIO('line1\nline2\nline3\n'.encode('utf-16-le'))
+        sr = codecs.EncodedFile(bio, 'utf-8', 'utf-16-le')
+
+        self.assertEqual(sr.readline(), b'line1\n')
+        sr.seek(0)
+        self.assertEqual(sr.readline(), b'line1\n')
+        self.assertEqual(sr.readline(), b'line2\n')
+        self.assertEqual(sr.readline(), b'line3\n')
+        self.assertEqual(sr.readline(), b'')
+
+    def test_seeking_write(self):
+        bio = io.BytesIO('123456789\n'.encode('utf-16-le'))
+        sr = codecs.EncodedFile(bio, 'utf-8', 'utf-16-le')
+
+        # Test that seek() only resets its internal buffer when offset
+        # and whence are zero.
+        sr.seek(2)
+        sr.write(b'\nabc\n')
+        self.assertEqual(sr.readline(), b'789\n')
+        sr.seek(0)
+        self.assertEqual(sr.readline(), b'1\n')
+        self.assertEqual(sr.readline(), b'abc\n')
+        self.assertEqual(sr.readline(), b'789\n')
+
 
 @unittest.skipIf(_testcapi is None, 'need _testcapi module')
 class LocaleCodecTest(unittest.TestCase):
diff --git a/Misc/NEWS.d/next/Library/2018-07-13-20-17-17.bpo-33361.dx2NVn.rst b/Misc/NEWS.d/next/Library/2018-07-13-20-17-17.bpo-33361.dx2NVn.rst
@@ -0,0 +1,2 @@
+Fix a bug in :class:`codecs.StreamRecoder` where seeking might leave old data in a
+buffer and break subsequent read calls. Patch by Ammar Askar.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Fix a bug in :class:`codecs.StreamRecoder` where seeking might leave old data in a
	`2`	`+buffer and break subsequent read calls. Patch by Ammar Askar.`