https://github.com/python/cpython/commit/e99b319682fe984074e32f52354dbec23ded4d0a
commit: e99b319682fe984074e32f52354dbec23ded4d0a
branch: main
author: Harjoth Khara <[email protected]>
committer: ZeroIntensity <[email protected]>
date: 2026-06-18T12:55:06-04:00
summary:
gh-146353: Document `PyBytesWriter_GetData` pointer validity (GH-151418)
files:
M Doc/c-api/bytes.rst
diff --git a/Doc/c-api/bytes.rst b/Doc/c-api/bytes.rst
index f56bcd6333a37d..fa77d3d38ff89f 100644
--- a/Doc/c-api/bytes.rst
+++ b/Doc/c-api/bytes.rst
@@ -384,14 +384,18 @@ Getters
Get the writer size.
+ The function does not invalidate pointers returned by
+ :c:func:`PyBytesWriter_GetData`.
+
The function cannot fail.
.. c:function:: void* PyBytesWriter_GetData(PyBytesWriter *writer)
Get the writer data: start of the internal buffer.
- The pointer is valid until :c:func:`PyBytesWriter_Finish` or
- :c:func:`PyBytesWriter_Discard` is called on *writer*.
+ The pointer remains valid until a :c:type:`PyBytesWriter` function other
+ than :c:func:`PyBytesWriter_GetData` or :c:func:`PyBytesWriter_GetSize` is
+ called on *writer*.
The function cannot fail.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
