Skip to content
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.

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

GH-78724: Initialize struct.Struct in __new__ #94532

Merged
merged 8 commits into from
Sep 25, 2022
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
14 changes: 14 additions & 0 deletions Lib/test/test_struct.py
Original file line number Diff line number Diff line change
Expand Up @@ -700,6 +700,20 @@ def test__struct_types_immutable(self):
with self.assertRaises(TypeError):
cls.x = 1

@support.cpython_only
def test__struct_Struct__new__initialized(self):
# See https://github.com/python/cpython/issues/78724

s = struct.Struct.__new__(struct.Struct, "b")
s.unpack_from(b"abcd")

@support.cpython_only
def test__struct_Struct_subclassing(self):
class Bob(struct.Struct):
pass

s = Bob("b")
s.unpack_from(b"abcd")

def test_issue35714(self):
# Embedded null characters should not be allowed in format strings.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix crash in :class:`struct.Struct` when it was not completely initialized by initializing it in :meth:`~object.__new__``. Patch by Kumar Aditya.
59 changes: 26 additions & 33 deletions Modules/_struct.c
Original file line number Diff line number Diff line change
Expand Up @@ -1433,28 +1433,9 @@ prepare_s(PyStructObject *self)
return -1;
}

static PyObject *
s_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
PyObject *self;

assert(type != NULL);
allocfunc alloc_func = PyType_GetSlot(type, Py_tp_alloc);
assert(alloc_func != NULL);

self = alloc_func(type, 0);
if (self != NULL) {
PyStructObject *s = (PyStructObject*)self;
s->s_format = Py_NewRef(Py_None);
s->s_codes = NULL;
s->s_size = -1;
s->s_len = -1;
}
return self;
}

/*[clinic input]
Struct.__init__
@classmethod
Struct.__new__

format: object

Expand All @@ -1466,36 +1447,49 @@ the format string.
See help(struct) for more on format strings.
[clinic start generated code]*/

static int
Struct___init___impl(PyStructObject *self, PyObject *format)
/*[clinic end generated code: output=b8e80862444e92d0 input=192a4575a3dde802]*/
static PyObject *
Struct_impl(PyTypeObject *type, PyObject *format)
/*[clinic end generated code: output=49468b044e334308 input=8b91868eb1df0e28]*/
{
int ret = 0;
allocfunc alloc = PyType_GetSlot(type, Py_tp_alloc);
assert(alloc != NULL);
PyStructObject *self = (PyStructObject *)alloc(type, 0);

if (self == NULL) {
return NULL;
}

if (PyUnicode_Check(format)) {
format = PyUnicode_AsASCIIString(format);
if (format == NULL)
return -1;
if (format == NULL) {
Py_DECREF(self);
return NULL;
}
}
else {
Py_INCREF(format);
}

if (!PyBytes_Check(format)) {
Py_DECREF(format);
Py_DECREF(self);
PyErr_Format(PyExc_TypeError,
"Struct() argument 1 must be a str or bytes object, "
"not %.200s",
_PyType_Name(Py_TYPE(format)));
return -1;
return NULL;
}

Py_SETREF(self->s_format, format);
self->s_format = format;

ret = prepare_s(self);
return ret;
if (prepare_s(self) < 0) {
Py_DECREF(self);
return NULL;
}
return (PyObject *)self;
}


static int
s_clear(PyStructObject *s)
{
Expand Down Expand Up @@ -2100,9 +2094,8 @@ static PyType_Slot PyStructType_slots[] = {
{Py_tp_methods, s_methods},
{Py_tp_members, s_members},
{Py_tp_getset, s_getsetlist},
{Py_tp_init, Struct___init__},
{Py_tp_new, Struct},
{Py_tp_alloc, PyType_GenericAlloc},
{Py_tp_new, s_new},
{Py_tp_free, PyObject_GC_Del},
{0, 0},
};
Expand Down
16 changes: 8 additions & 8 deletions Modules/clinic/_struct.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.