Issue #26335: Make mmap.write() return the number of bytes written like

berkerpeksag · berkerpeksag · commit 6282e656e994 · 2016-03-02T19:30:18.000+02:00
other write methods.

Patch by Jakub Stasiak.
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst
@@ -263,13 +263,18 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
    .. method:: write(bytes)
 
       Write the bytes in *bytes* into memory at the current position of the
-      file pointer; the file position is updated to point after the bytes that
-      were written. If the mmap was created with :const:`ACCESS_READ`, then
+      file pointer and return the number of bytes written (never less than
+      ``len(bytes)``, since if the write fails, a :exc:`ValueError` will be
+      raised).  The file position is updated to point after the bytes that
+      were written.  If the mmap was created with :const:`ACCESS_READ`, then
       writing to it will raise a :exc:`TypeError` exception.
 
       .. versionchanged:: 3.5
          Writable :term:`bytes-like object` is now accepted.
 
+      .. versionchanged:: 3.6
+         The number of bytes written is now returned.
+
 
    .. method:: write_byte(byte)
 
diff --git a/Lib/test/test_mmap.py b/Lib/test/test_mmap.py
@@ -713,6 +713,14 @@ def test_weakref(self):
         gc_collect()
         self.assertIs(wr(), None)
 
+    def test_write_returning_the_number_of_bytes_written(self):
+        mm = mmap.mmap(-1, 16)
+        self.assertEqual(mm.write(b""), 0)
+        self.assertEqual(mm.write(b"x"), 1)
+        self.assertEqual(mm.write(b"yz"), 2)
+        self.assertEqual(mm.write(b"python"), 6)
+
+
 class LargeMmapTests(unittest.TestCase):
 
     def setUp(self):
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -198,6 +198,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #26335: Make mmap.write() return the number of bytes written like
+  other write methods.  Patch by Jakub Stasiak.
+
 - Issue #26457: Fixed the subnets() methods in IP network classes for the case
   when resulting prefix length is equal to maximal prefix length.
   Based on patch by Xiang Zhang.
diff --git a/Modules/mmapmodule.c b/Modules/mmapmodule.c
@@ -389,6 +389,7 @@ mmap_write_method(mmap_object *self,
                   PyObject *args)
 {
     Py_buffer data;
+    PyObject *result;
 
     CHECK_VALID(NULL);
     if (!PyArg_ParseTuple(args, "y*:write", &data))
@@ -406,9 +407,9 @@ mmap_write_method(mmap_object *self,
     }
     memcpy(self->data + self->pos, data.buf, data.len);
     self->pos = self->pos + data.len;
+    result = PyLong_FromSsize_t(data.len);
     PyBuffer_Release(&data);
-    Py_INCREF(Py_None);
-    return Py_None;
+    return result;
 }
 
 static PyObject *

Original file line number	Diff line number	Diff line change
`@@ -389,6 +389,7 @@ mmap_write_method(mmap_object *self,`
`389`	`389`	`PyObject *args)`
`390`	`390`	`{`
`391`	`391`	`Py_buffer data;`
	`392`	`+ PyObject *result;`
`392`	`393`
`393`	`394`	`CHECK_VALID(NULL);`
`394`	`395`	`if (!PyArg_ParseTuple(args, "y*:write", &data))`
`@@ -406,9 +407,9 @@ mmap_write_method(mmap_object *self,`
`406`	`407`	`}`
`407`	`408`	`memcpy(self->data + self->pos, data.buf, data.len);`
`408`	`409`	`self->pos = self->pos + data.len;`
	`410`	`+ result = PyLong_FromSsize_t(data.len);`
`409`	`411`	`PyBuffer_Release(&data);`
`410`		`- Py_INCREF(Py_None);`
`411`		`- return Py_None;`
	`412`	`+ return result;`
`412`	`413`	`}`
`413`	`414`
`414`	`415`	`static PyObject *`