gh-78724: raise RuntimeError's when calling methods on non-ready Struct()'s by skirpichev · Pull Request #143643 · python/cpython · GitHub

Issue: _struct.Struct: calling functions without calling __init__ results in SystemError #78724

… by dunder methods

Now modification of the Struct() while packing trigger a RuntimeError

…y Struct()'s Calling the ``Struct.__new__()`` dunder without required argument now is deprecated. Calling the ``Struct.__init__()`` dunder method on initialized object now also is deprecated.

This issue is relatively independed from the concurrent packing issue, so I suggest fir it separately. We should not add deprecation in maintained versions, so I suggest to only leave checks that Struct was initialized, and add the deprecation in a separate PR.

prepare_s() should be rewritten so it only sets s_codes and other fields when it is successful.

I do not see how can this be useful.

This is to trigger deprecation warning in a following scenario:

>>> import struct
>>> class MyStruct(struct.Struct):
...     def __init__(self):
...         super().__init__('>h')
...         
>>> my_struct = MyStruct()
<python-input-2>:1: DeprecationWarning: Struct().__new__() has one required argument

PS: deprecation part moved to #143659.

prepare_s() should be rewritten so it only sets s_codes and other fields when it is successful.

I think it's already the case. We can move a bit s_size/s_len assignments, but as far as we interested only in s_codes - I'm not sure if it's worth. There should be no failures after codes = PyMem_Malloc(...).

Well, it does not matter. It would reduce the chance of race condition, but nobody should run __init__() and pack() concurrently, there are no reasons to do this, and we should not support this.

S.pack_into(buffer, offset, v1, v2, ...)

BTW, I think that argument processing in the struct's functions/methods should be refactored and transformed to the AC. E.g. S.pack_info could check required arguments before validation of the soself struct.

Though, this belongs to a separate issue.

AC cleanup goes to #143673

Well, it does not matter. It would reduce the chance of race condition, but nobody should run __init__() and pack() concurrently, there are no reasons to do this, and we should not support this.

I guess this belongs to the #143382 pr thread.

LGTM. 👍

Thanks @skirpichev for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

…y Struct()'s (pythonGH-143643) (cherry picked from commit 515ae40) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

Sorry, @skirpichev and @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 515ae4078dffa0b74e5e5431462c2f4fe4563ffa 3.13

GH-143695 is a backport of this pull request to the 3.14 branch.

GH-143714 is a backport of this pull request to the 3.13 branch.

…dy Struct()'s (GH-143643) (GH-143695) (cherry picked from commit 515ae40) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

…dy Struct()'s (GH-143643) (GH-143714) (cherry picked from commit 515ae40)

…y Struct()'s (pythonGH-143643)

skirpichev added 5 commits January 3, 2026 10:36

pythongh-143379 : fix UAF in struct.Struct.pack() when object modified…

a1c2603

… by dunder methods

Merge branch 'master' into fix-uaf-s_pack_internal/143379

716e28c

address review: implement a different solution with a mutex flag

e611953

Now modification of the Struct() while packing trigger a RuntimeError

+ clean the mess

ab62167

pythongh-78724 : raise RuntimeError's when calling methods on non-read…

3b18427

…y Struct()'s Calling the ``Struct.__new__()`` dunder without required argument now is deprecated. Calling the ``Struct.__init__()`` dunder method on initialized object now also is deprecated.

bedevere-app Bot mentioned this pull request Jan 10, 2026

_struct.Struct: calling functions without calling __init__ results in SystemError #78724

Closed

skirpichev mentioned this pull request Jan 10, 2026

gh-143379: fix UAF in struct.Struct.pack() when object modified by dunder methods #143382

Closed

This comment was marked as outdated.

Sign in to view

skirpichev marked this pull request as ready for review January 10, 2026 07:55

bedevere-app Bot added the awaiting review label Jan 10, 2026

skirpichev requested a review from serhiy-storchaka January 10, 2026 07:56

serhiy-storchaka reviewed Jan 10, 2026

View reviewed changes

serhiy-storchaka added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes labels Jan 10, 2026

skirpichev marked this pull request as draft January 10, 2026 10:14

bedevere-app Bot removed the awaiting review label Jan 10, 2026

skirpichev added 3 commits January 10, 2026 13:15

Merge branch 'master' into deprecate-struct-init/78724

54dbea8

revert stuff from python#143382

b6c8bed

revert deprecations (TBD: a separate pr)

f542173

address review: redo patch to use s_codes

69a5eec

skirpichev marked this pull request as ready for review January 10, 2026 11:45

bedevere-app Bot added the awaiting review label Jan 10, 2026

skirpichev requested a review from serhiy-storchaka January 10, 2026 11:46

Merge branch 'main' into deprecate-struct-init/78724

0e6af95

serhiy-storchaka reviewed Jan 10, 2026

View reviewed changes

Comment thread Lib/test/test_struct.py Outdated

Comment thread Modules/_struct.c Outdated

address review: -asserts + redo test

8ba6b33

serhiy-storchaka reviewed Jan 10, 2026

View reviewed changes

address review: adjust tests

ea0f8e2

skirpichev requested a review from serhiy-storchaka January 11, 2026 11:09

serhiy-storchaka reviewed Jan 11, 2026

View reviewed changes

Comment thread Modules/_struct.c

Comment thread Modules/_struct.c Outdated

skirpichev added 2 commits January 11, 2026 18:21

Merge branch 'master' into deprecate-struct-init/78724

c71be45

address review: revert unrelated change

b61bddb

serhiy-storchaka approved these changes Jan 11, 2026

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels Jan 11, 2026

serhiy-storchaka enabled auto-merge (squash) January 11, 2026 15:47

serhiy-storchaka merged commit 515ae40 into python:main Jan 11, 2026
50 checks passed

bedevere-app Bot removed the awaiting merge label Jan 11, 2026

miss-islington-app Bot assigned serhiy-storchaka Jan 11, 2026

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jan 11, 2026

skirpichev deleted the deprecate-struct-init/78724 branch January 11, 2026 18:04

skirpichev self-assigned this Jan 11, 2026

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jan 11, 2026

skirpichev removed their assignment Jan 11, 2026

serhiy-storchaka pushed a commit that referenced this pull request Jan 12, 2026

[3.14] gh-78724 : Raise RuntimeError's when calling methods on non-rea…

8f85adc

…dy Struct()'s (GH-143643) (GH-143695) (cherry picked from commit 515ae40) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>

serhiy-storchaka pushed a commit that referenced this pull request Jan 12, 2026

[3.13] gh-78724 : Raise RuntimeError's when calling methods on non-rea…

8fd4435

…dy Struct()'s (GH-143643) (GH-143714) (cherry picked from commit 515ae40)

reidenong pushed a commit to reidenong/cpython that referenced this pull request Jan 12, 2026

pythongh-78724 : Raise RuntimeError's when calling methods on non-read…

e3ef2fc

…y Struct()'s (pythonGH-143643)

thunder-coding pushed a commit to thunder-coding/cpython that referenced this pull request Feb 15, 2026

pythongh-78724 : Raise RuntimeError's when calling methods on non-read…

3ab851b

…y Struct()'s (pythonGH-143643)

serhiy-storchaka removed their assignment Jul 15, 2026

-                          self.assertRaises(RuntimeError, meth, spam)
+                      self.assertRaises(RuntimeError, S.iter_unpack, 1)
+                      self.assertRaises(RuntimeError, S.pack, 1)
+                      self.assertRaises(RuntimeError, S.pack_into, 1)

               {
                   PyObject *self;
+                  if (PyTuple_GET_SIZE(args) != 1

gh-78724: raise RuntimeError's when calling methods on non-ready Struct()'s by skirpichev · Pull Request #143643 · python/cpython · GitHub

Repository navigation

gh-78724: raise RuntimeError's when calling methods on non-ready Struct()'s - #143643

gh-78724: raise RuntimeError's when calling methods on non-ready Struct()'s#143643serhiy-storchaka merged 14 commits intopython:mainpython/cpython:mainfrom skirpichev:deprecate-struct-init/78724skirpichev/cpython:deprecate-struct-init/78724Copy head branch name to clipboard

Conversation

skirpichev commented Jan 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

serhiy-storchaka Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

skirpichev Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

skirpichev commented Jan 10, 2026

Uh oh!

serhiy-storchaka commented Jan 10, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

skirpichev Jan 10, 2026

Choose a reason for hiding this comment

Uh oh!

skirpichev Jan 11, 2026

Choose a reason for hiding this comment

Uh oh!

skirpichev commented Jan 10, 2026

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app Bot commented Jan 11, 2026

Uh oh!

miss-islington-app Bot commented Jan 11, 2026

Uh oh!

bedevere-app Bot commented Jan 11, 2026

Uh oh!

bedevere-app Bot commented Jan 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gh-78724: raise RuntimeError's when calling methods on non-ready Struct()'s#143643
serhiy-storchaka merged 14 commits into
python:mainfrom
skirpichev:deprecate-struct-init/78724

skirpichev commented Jan 10, 2026 •
edited
Loading