Issue #12062: Fix a flushing bug when doing a certain type of I/O sequence

pitrou · pitrou · commit 00dd182b8ec1 · 2011-05-13T00:16:28.000+02:00
on a file opened in read+write mode (namely: reading, seeking a bit forward,
writing, then seeking before the previous write but still within buffered
data, and writing again).
diff --git a/Lib/test/test_io.py b/Lib/test/test_io.py
@@ -1490,6 +1490,32 @@ def test_write_after_readahead(self):
             self.assertEqual(s,
                 b"A" + b"B" * overwrite_size + b"A" * (9 - overwrite_size))
 
+    def test_write_rewind_write(self):
+        # Various combinations of reading / writing / seeking backwards / writing again
+        def mutate(bufio, pos1, pos2):
+            assert pos2 >= pos1
+            # Fill the buffer
+            bufio.seek(pos1)
+            bufio.read(pos2 - pos1)
+            bufio.write(b'\x02')
+            # This writes earlier than the previous write, but still inside
+            # the buffer.
+            bufio.seek(pos1)
+            bufio.write(b'\x01')
+
+        b = b"\x80\x81\x82\x83\x84"
+        for i in range(0, len(b)):
+            for j in range(i, len(b)):
+                raw = self.BytesIO(b)
+                bufio = self.tp(raw, 100)
+                mutate(bufio, i, j)
+                bufio.flush()
+                expected = bytearray(b)
+                expected[j] = 2
+                expected[i] = 1
+                self.assertEqual(raw.getvalue(), expected,
+                                 "failed result for i=%d, j=%d" % (i, j))
+
     def test_truncate_after_read_or_write(self):
         raw = self.BytesIO(b"A" * 10)
         bufio = self.tp(raw, 100)
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -89,6 +89,12 @@ Core and Builtins
 
 Library
 -------
+
+- Issue #12062: Fix a flushing bug when doing a certain type of I/O sequence
+  on a file opened in read+write mode (namely: reading, seeking a bit forward,
+  writing, then seeking before the previous write but still within buffered
+  data, and writing again).
+
 - Issue #1028: Tk returns invalid Unicode null in %A: UnicodeDecodeError.
   With Tk < 8.5 _tkinter.c:PythonCmd() raised UnicodeDecodeError, caused
   IDLE to exit.  Converted to valid Unicode null in PythonCmd().
diff --git a/Modules/_io/bufferedio.c b/Modules/_io/bufferedio.c
@@ -1838,7 +1838,7 @@ bufferedwriter_write(buffered *self, PyObject *args)
     avail = Py_SAFE_DOWNCAST(self->buffer_size - self->pos, Py_off_t, Py_ssize_t);
     if (buf.len <= avail) {
         memcpy(self->buffer + self->pos, buf.buf, buf.len);
-        if (!VALID_WRITE_BUFFER(self)) {
+        if (!VALID_WRITE_BUFFER(self) || self->write_pos > self->pos) {
             self->write_pos = self->pos;
         }
         ADJUST_POSITION(self, self->pos + buf.len);

Original file line number	Diff line number	Diff line change
`@@ -1838,7 +1838,7 @@ bufferedwriter_write(buffered self, PyObject args)`
`1838`	`1838`	`avail = Py_SAFE_DOWNCAST(self->buffer_size - self->pos, Py_off_t, Py_ssize_t);`
`1839`	`1839`	`if (buf.len <= avail) {`
`1840`	`1840`	`memcpy(self->buffer + self->pos, buf.buf, buf.len);`
`1841`		`- if (!VALID_WRITE_BUFFER(self)) {`
	`1841`	`+ if (!VALID_WRITE_BUFFER(self) \|\| self->write_pos > self->pos) {`
`1842`	`1842`	`self->write_pos = self->pos;`
`1843`	`1843`	`}`
`1844`	`1844`	`ADJUST_POSITION(self, self->pos + buf.len);`