Skip to content

gh-129813: Enhance PyBytesWriter documentation #140152

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

Merged
vstinner merged 4 commits into from
Oct 15, 2025
Merged

gh-129813: Enhance PyBytesWriter documentation #140152

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
751c2d0
gh-129813: Enhance PyBytesWriter documentation
vstinner Oct 15, 2025
1a00528
Update Doc/c-api/bytes.rst
vstinner Oct 15, 2025
e4ee5c8
Update Doc/c-api/bytes.rst
vstinner Oct 15, 2025
3d397d1
Apply Antoine's suggestion
vstinner Oct 15, 2025
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
Next Next commit
gh-129813: Enhance PyBytesWriter documentation 
Mention if functions overallocate or not.
  • Loading branch information
@vstinner
vstinner committed Oct 15, 2025
commit 751c2d0cf977e85317f06326c2ec84e410ba0c52
5 changes: 3 additions & 2 deletions Doc/c-api/bytes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Create, Finish, Discard

If *size* is greater than zero, allocate *size* bytes, and set the
writer size to *size*. The caller is responsible to write *size*
bytes using :c:func:`PyBytesWriter_GetData`.
bytes using :c:func:`PyBytesWriter_GetData`. Do not overallocate.
Comment thread
vstinner marked this conversation as resolved.
Outdated

On error, set an exception and return ``NULL``.

Expand Down Expand Up @@ -348,7 +348,7 @@ Low-level API
.. c:function:: int PyBytesWriter_Resize(PyBytesWriter *writer, Py_ssize_t size)

Resize the writer to *size* bytes. It can be used to enlarge or to
shrink the writer.
shrink the writer. Overallocate the writer.
Comment thread
vstinner marked this conversation as resolved.
Outdated

Newly allocated bytes are left uninitialized.

Expand All @@ -360,6 +360,7 @@ Low-level API
.. c:function:: int PyBytesWriter_Grow(PyBytesWriter *writer, Py_ssize_t grow)

Resize the writer by adding *grow* bytes to the current writer size.
Overallocate the writer.
Comment thread
vstinner marked this conversation as resolved.
Outdated

Newly allocated bytes are left uninitialized.

Expand Down
Loading