Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions Doc/library/mmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
Writable :term:`bytes-like object` is now accepted.


.. method:: flush()
flush(offset, size, /)
.. method:: flush([offset[, size]])

Flushes changes made to the in-memory copy of a file back to disk. Without
use of this call there is no guarantee that changes are written back before
Expand All @@ -230,6 +229,12 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
on error under Windows. A zero value was returned on success; an
exception was raised on error under Unix.

.. versionchanged:: next
Allow specifying *offset* without *size*. Previously, both *offset*
and *size* parameters were required together. Now *offset* can be
specified alone, and the flush operation will extend from *offset*
to the end of the mmap.


.. method:: madvise(option[, start[, length]])

Expand Down
12 changes: 12 additions & 0 deletions Lib/test/test_mmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -1145,6 +1145,18 @@ def test_access_violations(self):
self.assertEqual(stdout.strip(), b'')
self.assertEqual(stderr.strip(), b'')

def test_flush_parameters(self):
with open(TESTFN, 'wb+') as f:
f.write(b'x' * PAGESIZE * 3)
f.flush()

m = mmap.mmap(f.fileno(), PAGESIZE * 3)
self.addCleanup(m.close)

m.flush()
m.flush(PAGESIZE)
m.flush(PAGESIZE, PAGESIZE)


class LargeMmapTests(unittest.TestCase):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fixed a bug in :meth:`mmap.mmap.flush` where calling with only an offset
parameter would fail.
8 changes: 6 additions & 2 deletions Modules/mmapmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -933,11 +933,15 @@ static PyObject *
mmap_flush_method(PyObject *op, PyObject *args)
{
Py_ssize_t offset = 0;
Py_ssize_t size = -1;
mmap_object *self = mmap_object_CAST(op);
Py_ssize_t size = self->size;
CHECK_VALID(NULL);
if (!PyArg_ParseTuple(args, "|nn:flush", &offset, &size))
if (!PyArg_ParseTuple(args, "|nn:flush", &offset, &size)) {
return NULL;
}
if (size == -1) {
size = self->size - offset;
}
if (size < 0 || offset < 0 || self->size - offset < size) {
PyErr_SetString(PyExc_ValueError, "flush values out of range");
return NULL;
Expand Down
Loading