Visitar URL original
gh-78724: raise RuntimeError's when calling methods on non-ready Struct()'s by skirpichev · Pull Request #143643 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
address review: redo patch to use s_codes
  • Loading branch information
skirpichev committed Jan 10, 2026
commit 69a5eecfe47a04b964265a8c2abe5bd5d57f2bc8
2 changes: 1 addition & 1 deletion Lib/test/test_struct.py
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ def test_Struct_reinitialization(self):

def check_sizeof(self, format_str, number_of_codes):
# The size of 'PyStructObject'
totalsize = support.calcobjsize('2n3PB')
totalsize = support.calcobjsize('2n3P')
# The size taken up by the 'formatcode' dynamic array
totalsize += struct.calcsize('P3n0P') * (number_of_codes + 1)
support.check_sizeof(self, struct.Struct(format_str), totalsize)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
Prevent crashes due to using half-initialized :class:`~struct.Struct`
objects. For example, created by ``Struct.__new__(Struct)``. Calling the
``Struct.__new__()`` dunder without required argument now is deprecated.
Calling :meth:`~object.__init__` dunder method of :class:`~struct.Struct`
object on initialized object now also is deprecated. Patch by Sergey B
Kirpichev.
Raise :exc:`RuntimeError`'s when user attempts to call methods on
half-initialized :class:`~struct.Struct` objects, For example, created by
``Struct.__new__(Struct)``. Patch by Sergey B Kirpichev.
40 changes: 15 additions & 25 deletions Modules/_struct.c
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ typedef struct {
formatcode *s_codes;
PyObject *s_format;
PyObject *weakreflist; /* List of weak references */
bool ready;
} PyStructObject;

#define PyStructObject_CAST(op) ((PyStructObject *)(op))
Expand Down Expand Up @@ -1699,8 +1698,6 @@ prepare_s(PyStructObject *self)
return -1;
}

self->s_size = size;
self->s_len = len;
codes = PyMem_Malloc((ncodes + 1) * sizeof(formatcode));
if (codes == NULL) {
PyErr_NoMemory();
Expand All @@ -1710,6 +1707,8 @@ prepare_s(PyStructObject *self)
if (self->s_codes != NULL)
PyMem_Free(self->s_codes);
self->s_codes = codes;
self->s_size = size;
self->s_len = len;

s = fmt;
size = 0;
Expand Down Expand Up @@ -1774,7 +1773,6 @@ s_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
s->s_codes = NULL;
s->s_size = -1;
s->s_len = -1;
s->ready = false;
}
return self;
}
Expand Down Expand Up @@ -1819,7 +1817,6 @@ Struct___init___impl(PyStructObject *self, PyObject *format)
if (prepare_s(self)) {
return -1;
}
self->ready = true;
return 0;
}

Expand Down Expand Up @@ -1900,6 +1897,14 @@ s_unpack_internal(PyStructObject *soself, const char *startfrom,
return NULL;
}

#define ENSURE_STRUCT_IS_READY(self) \
do { \
if (!(self)->s_codes) { \
PyErr_SetString(PyExc_RuntimeError, \
"Struct object is not initialized"); \
return NULL; \
} \
} while (0);

/*[clinic input]
Struct.unpack
Expand All @@ -1920,10 +1925,7 @@ Struct_unpack_impl(PyStructObject *self, Py_buffer *buffer)
/*[clinic end generated code: output=873a24faf02e848a input=3113f8e7038b2f6c]*/
{
_structmodulestate *state = get_struct_state_structinst(self);
if (!self->ready) {
PyErr_SetString(PyExc_RuntimeError, "Call unpack on non-initialized Struct()");
return NULL;
}
ENSURE_STRUCT_IS_READY(self);
assert(self->s_codes != NULL);
Comment thread
skirpichev marked this conversation as resolved.
Outdated
if (buffer->len != self->s_size) {
PyErr_Format(state->StructError,
Expand Down Expand Up @@ -1956,10 +1958,7 @@ Struct_unpack_from_impl(PyStructObject *self, Py_buffer *buffer,
/*[clinic end generated code: output=57fac875e0977316 input=cafd4851d473c894]*/
{
_structmodulestate *state = get_struct_state_structinst(self);
if (!self->ready) {
PyErr_SetString(PyExc_RuntimeError, "Call unpack_from on non-initialized Struct()");
return NULL;
}
ENSURE_STRUCT_IS_READY(self);
assert(self->s_codes != NULL);

if (offset < 0) {
Expand Down Expand Up @@ -2112,10 +2111,7 @@ Struct_iter_unpack_impl(PyStructObject *self, PyObject *buffer)
{
_structmodulestate *state = get_struct_state_structinst(self);
unpackiterobject *iter;
if (!self->ready) {
PyErr_SetString(PyExc_RuntimeError, "Call iter_unpack on non-initialized Struct()");
return NULL;
}
ENSURE_STRUCT_IS_READY(self);

assert(self->s_codes != NULL);

Expand Down Expand Up @@ -2257,10 +2253,7 @@ s_pack(PyObject *self, PyObject *const *args, Py_ssize_t nargs)

/* Validate arguments. */
soself = PyStructObject_CAST(self);
if (!soself->ready) {
PyErr_SetString(PyExc_RuntimeError, "Call pack on non-initialized Struct()");
return NULL;
}
ENSURE_STRUCT_IS_READY(soself);
assert(PyStruct_Check(self, state));
assert(soself->s_codes != NULL);
if (nargs != soself->s_len)
Expand Down Expand Up @@ -2304,10 +2297,7 @@ s_pack_into(PyObject *self, PyObject *const *args, Py_ssize_t nargs)

/* Validate arguments. +1 is for the first arg as buffer. */
soself = PyStructObject_CAST(self);
if (!soself->ready) {
PyErr_SetString(PyExc_RuntimeError, "Call pack_into on non-initialized Struct()");
return NULL;
}
ENSURE_STRUCT_IS_READY(soself);
assert(PyStruct_Check(self, state));
assert(soself->s_codes != NULL);
if (nargs != (soself->s_len + 2))
Expand Down
Loading