Skip to content

gh-60107: avoid io.RawIOBase.read from reading into a temporary bytearray #138616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

gh-60107: avoid io.RawIOBase.read from reading into a temporary bytearray #138616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
974cc01
allocate a bytes object directly instead and manually construct a wri…
taskevich Sep 7, 2025
b44bec9
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 7, 2025
897e813
gh-60107: gh-138616: Minor code changes
taskevich Sep 7, 2025
77e3875
Merge branch 'direct-read-bytes' of https://github.com/taskevich/cpyt…
taskevich Sep 7, 2025
2351f34
gh-60107: Change blurb_it
taskevich Sep 7, 2025
c671122
Update Misc/NEWS.d/next/C_API/2025-09-07-10-52-09.gh-issue-60107.dhcb…
taskevich Sep 7, 2025
5396b1c
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 7, 2025
23cd0ff
Deleted incorrect news from C_API
taskevich Sep 7, 2025
905b3ec
gh-60107: Tests for readinto
taskevich Sep 7, 2025
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
43 changes: 43 additions & 0 deletions Lib/test/test_io/test_general.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,6 +921,49 @@ def test_RawIOBase_read(self):
self.assertEqual(rawio.read(2), None)
self.assertEqual(rawio.read(2), b"")

def test_exact_RawIOBase(self):
rawio = self.MockRawIOWithoutRead((b"ab", b"cd"))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I wasn't precise enough. RawIOBase.read() is implemented in terms of readinto. So, what we want to do is provide a readinto method that does something bad as it's given the internal buffer we constructed in C. I don't know if it's possible to cause a segfault on main with that approach though.

Stated otherwise, we want some class:

class EvilReadInto(MockRawIOWithoutRead):
    def readinto(self, buf):
        # do something bad with 'buf'

And then

r = EvilReadInto(something_here)
r.read()  # on main, this call should crash, but not with this patch

buf = bytearray(2)
n = rawio.readinto(buf)
self.assertEqual(n, 2)
self.assertEqual(buf, b"ab")

n = rawio.readinto(buf)
self.assertEqual(n, 2)
self.assertEqual(buf, b"cd")

n = rawio.readinto(buf)
self.assertEqual(n, 0)
self.assertEqual(buf, b"cd")

def test_partial_readinto_write_RawIOBase(self):
rawio = self.MockRawIOWithoutRead((b"abcdef",))
buf = bytearray(3)
n = rawio.readinto(buf)
self.assertEqual(n, 3)
self.assertEqual(buf, b"abc")

n2 = rawio.readinto(buf)
self.assertEqual(n2, 3)
self.assertEqual(buf, b"def")

def test_readinto_none_RawIOBase(self):
rawio = self.MockRawIOWithoutRead((None, b"x"))
buf = bytearray(2)
n = rawio.readinto(buf)
self.assertIsNone(n)

n2 = rawio.readinto(buf)
self.assertEqual(n2, 1)
self.assertEqual(buf[0], ord('x'))

def test_read_default_via_readinto_RawIOBase(self):
rawio = self.MockRawIOWithoutRead((b"abcdef",))
result = rawio.read(4)
self.assertEqual(result, b"abcd")
result2 = rawio.read(4)
self.assertEqual(result2, b"ef")

def test_types_have_dict(self):
test = (
self.IOBase(),
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2025-09-07-11-30-53.gh-issue-60107.TFrtr-.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Avoid :meth:`io.RawIOBase.read` from reading into a temporary :class:`bytearray`
when calling its own :meth:`io.RawIOBase.readinto` internally.
25 changes: 17 additions & 8 deletions Modules/_io/iobase.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,19 +921,25 @@ static PyObject *
_io__RawIOBase_read_impl(PyObject *self, Py_ssize_t n)
/*[clinic end generated code: output=6cdeb731e3c9f13c input=b6d0dcf6417d1374]*/
{
PyObject *b, *res;
PyObject *b, *res, *mv;

if (n < 0) {
return PyObject_CallMethodNoArgs(self, &_Py_ID(readall));
}

/* TODO: allocate a bytes object directly instead and manually construct
a writable memoryview pointing to it. */
b = PyByteArray_FromStringAndSize(NULL, n);
b = PyBytes_FromStringAndSize(NULL, n);
if (b == NULL)
return NULL;

res = PyObject_CallMethodObjArgs(self, &_Py_ID(readinto), b, NULL);
mv = PyMemoryView_FromMemory(PyBytes_AS_STRING(b), n, PyBUF_WRITE);
if (mv == NULL) {
Py_DECREF(b);
return NULL;
}

res = PyObject_CallMethodObjArgs(self, &_Py_ID(readinto), mv, NULL);
Py_DECREF(mv);

if (res == NULL || res == Py_None) {
Py_DECREF(b);
return res;
Expand All @@ -946,9 +952,12 @@ _io__RawIOBase_read_impl(PyObject *self, Py_ssize_t n)
return NULL;
}

res = PyBytes_FromStringAndSize(PyByteArray_AsString(b), n);
Py_DECREF(b);
return res;
if (_PyBytes_Resize(&b, n) < 0) {
Py_DECREF(b);
return NULL;
}

return b;
}


Expand Down
Loading