Skip to content

gh-155406: Fix struct.unpack_from documentation signature #155408

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

Closed
shoutoutuoadi325 wants to merge 1 commit into from
+1 −1
Closed

gh-155406: Fix struct.unpack_from documentation signature #155408

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Doc/library/struct.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The module defines the following exception and functions:
size required by the format, as reflected by :func:`calcsize`.


.. function:: unpack_from(format, /, buffer, offset=0)
.. function:: unpack_from(format, buffer, offset=0)

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore the positional-only marker for format

When callers follow this signature and pass format by keyword, struct.unpack_from(format='I', buffer=data) raises TypeError. The Argument Clinic declaration in Modules/_struct.c still places format before /, and the generated text signature remains unpack_from($module, format, /, buffer, offset=0), so removing this marker makes the documentation contradict the actual API.

Useful? React with 👍 / 👎.


Unpack from *buffer* starting at position *offset*, according to the format
string *format*. The result is a tuple even if it contains exactly one
Expand Down
Loading