-
-
Notifications
You must be signed in to change notification settings - Fork 35k
gh-148529: Accept any contiguous bytes-like object for the struct 's' and 'p' formats #152029
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
Open
iamsharduld
wants to merge
1
commit into
python:main
Choose a base branch
from
iamsharduld:local-gh-148529-struct-pack-buffer
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+79
−22
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
Misc/NEWS.d/next/Library/2026-06-24-12-00-00.gh-issue-148529.rwH6cW.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| :func:`struct.pack`, :func:`struct.pack_into` and :meth:`struct.Struct.pack` | ||
| now accept any contiguous :term:`bytes-like object` (such as | ||
| :class:`memoryview` or :class:`array.array`) for the ``'s'`` and ``'p'`` | ||
| format codes, instead of only :class:`bytes` and :class:`bytearray`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2347,44 +2347,58 @@ s_pack_internal(PyStructObject *soself, PyObject *const *args, | |
| PyObject *v = args[i++]; | ||
| if (strcmp(e->format, "s") == 0) { | ||
| Py_ssize_t n; | ||
| int isstring; | ||
| const void *p; | ||
| isstring = PyBytes_Check(v); | ||
| if (!isstring && !PyByteArray_Check(v)) { | ||
| PyErr_SetString(state->StructError, | ||
| "argument for 's' must be a bytes object"); | ||
| return -1; | ||
| } | ||
| if (isstring) { | ||
| Py_buffer view; | ||
| int gotview = 0; | ||
| if (PyBytes_Check(v)) { | ||
| n = PyBytes_GET_SIZE(v); | ||
| p = PyBytes_AS_STRING(v); | ||
| } | ||
| else { | ||
| else if (PyByteArray_Check(v)) { | ||
| n = PyByteArray_GET_SIZE(v); | ||
| p = PyByteArray_AS_STRING(v); | ||
| } | ||
| else if (PyObject_GetBuffer(v, &view, PyBUF_SIMPLE) == 0) { | ||
| n = view.len; | ||
| p = view.buf; | ||
| gotview = 1; | ||
| } | ||
| else { | ||
| PyErr_Format(state->StructError, | ||
| "argument for 's' must be a bytes-like object, " | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "must be a contiguous bytes-like object" Otherwise it will be confusing for non-contiguous memoryview. |
||
| "not %.200s", Py_TYPE(v)->tp_name); | ||
| return -1; | ||
| } | ||
| if (n > code->size) | ||
| n = code->size; | ||
| if (n > 0) | ||
| memcpy(res, p, n); | ||
| if (gotview) | ||
| PyBuffer_Release(&view); | ||
| } else if (strcmp(e->format, "p") == 0) { | ||
| Py_ssize_t n; | ||
| int isstring; | ||
| const void *p; | ||
| isstring = PyBytes_Check(v); | ||
| if (!isstring && !PyByteArray_Check(v)) { | ||
| PyErr_SetString(state->StructError, | ||
| "argument for 'p' must be a bytes object"); | ||
| return -1; | ||
| } | ||
| if (isstring) { | ||
| Py_buffer view; | ||
| int gotview = 0; | ||
| if (PyBytes_Check(v)) { | ||
| n = PyBytes_GET_SIZE(v); | ||
| p = PyBytes_AS_STRING(v); | ||
| } | ||
| else { | ||
| else if (PyByteArray_Check(v)) { | ||
| n = PyByteArray_GET_SIZE(v); | ||
| p = PyByteArray_AS_STRING(v); | ||
| } | ||
| else if (PyObject_GetBuffer(v, &view, PyBUF_SIMPLE) == 0) { | ||
| n = view.len; | ||
| p = view.buf; | ||
| gotview = 1; | ||
| } | ||
| else { | ||
| PyErr_Format(state->StructError, | ||
| "argument for 'p' must be a bytes-like object, " | ||
| "not %.200s", Py_TYPE(v)->tp_name); | ||
| return -1; | ||
| } | ||
| if (code->size == 0) { | ||
| n = 0; | ||
| } | ||
|
|
@@ -2396,6 +2410,8 @@ s_pack_internal(PyStructObject *soself, PyObject *const *args, | |
| if (n > 255) | ||
| n = 255; | ||
| *res = Py_SAFE_DOWNCAST(n, Py_ssize_t, unsigned char); | ||
| if (gotview) | ||
| PyBuffer_Release(&view); | ||
| } else { | ||
| if (e->pack(state, res, v, e) < 0) { | ||
| if (PyLong_Check(v) && PyErr_ExceptionMatches(PyExc_OverflowError)) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is better to only raise StructError if there were no error set or it was a TypeError. Otherwise it can shadow errors like MemoryError, OverflowError or KeyboardInterrupt.