Skip to content

gh-156939: Document that PyBytesObject ends with a NUL byte #157236

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 8 commits into from
Sep 15, 2026
+13 −0
Merged

gh-156939: Document that PyBytesObject ends with a NUL byte #157236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9ae141e
gh-156939: Document that PyBytesObject ends with a NUL byte
vstinner Sep 9, 2026
7a2b992
Don't add the note as an implementation detail
vstinner Sep 9, 2026
65550b7
Replace NUL with null
vstinner Sep 9, 2026
1d3f14c
Add the note as a CPython implementation detail
vstinner Sep 14, 2026
6b25e03
Update Doc/c-api/bytes.rst
vstinner Sep 15, 2026
6756375
Add similar note to bytearray
vstinner Sep 15, 2026
34ecdfd
Update Doc/c-api/bytearray.rst
vstinner Sep 15, 2026
1544e00
Merge branch 'main' into bytes_nul
vstinner Sep 15, 2026
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
6 changes: 6 additions & 0 deletions Doc/c-api/bytearray.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ Byte Array Objects

This subtype of :c:type:`PyObject` represents a Python bytearray object.

.. impl-detail::

The internal buffer of :c:type:`PyByteArrayObject` always includes an
extra trailing null byte for compatibility with null terminated C
strings. This extra byte is not counted in :c:func:`PyByteArray_Size`
nor in the *len* arguments of the functions below.

.. c:var:: PyTypeObject PyByteArray_Type

Expand Down
7 changes: 7 additions & 0 deletions Doc/c-api/bytes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ Bytes Objects
These functions raise :exc:`TypeError` when expecting a bytes parameter and
called with a non-bytes parameter.

.. impl-detail::

The internal buffer of :c:type:`PyBytesObject` always includes an extra
trailing null byte for compatibility with null terminated C strings.
This extra byte is not counted in :c:func:`PyBytes_Size` nor in the
various *length* and *size* arguments of the functions below.

.. index:: pair: object; bytes


Expand Down
Loading