gh-143672: convert the struct module to AC #143673
Conversation
| See help(struct) for more on format strings. | ||
| Return a new Struct object which writes and reads binary data according | ||
| to the format string. See help(struct) for more on format strings. |
There was a problem hiding this comment.
what is the reason for newline -> double space change? I was not aware that this is required.
There was a problem hiding this comment.
In some docstrings "See help(struct) for more on format strings." was separated to a new paragraph. In some - no. Looks as a waste of space, especially in help(struct) output.
Modules/_struct.c
Outdated
| / | ||
| *args: array | ||
| Pack args to the writtable buffer according to the format self. |
There was a problem hiding this comment.
| Pack args to the writtable buffer according to the format self. | |
| Pack args to the writtable buffer according to the struct's format string. |
There was a problem hiding this comment.
Too long. Beware @permit_long_summary.
Modules/_struct.c
Outdated
| strings."); | ||
| *args: array | ||
| Return a bytes object with args, packed according the format self. |
There was a problem hiding this comment.
| Return a bytes object with args, packed according the format self. | |
| Return a bytes object with args, packed according the struct's format string. |
|
BTW, I'm not attached to docstrings. IMO, they aren't good and I tried to improve that. But I can just revert that stuff and keep old doctsrings almost literally (summary line is required, though). |
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka
left a comment
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Sorry, I have not noticed this PR and created an alternative PR #143857.
There are some differences between two PRs, and I had reasons for all changes. We can now gradually convert your PR into my PR by applying one change at a time or just take my PR.
See the difference between the PRs: https://github.com/skirpichev/cpython/pull/14/changes .
| Struct.pack_into as s_pack_into | ||
| buffer: Py_buffer | ||
| offset: Py_ssize_t |
There was a problem hiding this comment.
There is a subtle behavior difference here (IndexError vs OverflowError). I leave this for other issue.
Modules/_struct.c
Outdated
| buffer: Py_buffer | ||
| offset: Py_ssize_t | ||
| / | ||
| *args: array |
There was a problem hiding this comment.
I prever to use more specific name values.
Modules/_struct.c
Outdated
| /*[clinic input] | ||
| Struct.pack_into as s_pack_into | ||
| buffer: Py_buffer |
There was a problem hiding this comment.
The buffer must be writeable.
| offset. Note that the offset is a required argument. See\n\ | ||
| help(struct) for more on format strings."); | ||
| /*[clinic input] | ||
| Struct.pack_into as s_pack_into |
3 participants
Uh oh!
There was an error while loading. Please reload this page.