From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Thu, 18 Jun 2026 17:39:20 +0000 (+0200) Subject: [3.15] gh-146353: Document `PyBytesWriter_GetData` pointer validity (GH-151418) ... X-Git-Tag: v3.15.0b3~41 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fd3c510827d5bc0f92571754ee7495078fc60086;p=thirdparty%2FPython%2Fcpython.git [3.15] gh-146353: Document `PyBytesWriter_GetData` pointer validity (GH-151418) (GH-151664) gh-146353: Document `PyBytesWriter_GetData` pointer validity (GH-151418) (cherry picked from commit e99b319682fe984074e32f52354dbec23ded4d0a) Co-authored-by: Harjoth Khara --- diff --git a/Doc/c-api/bytes.rst b/Doc/c-api/bytes.rst index f56bcd6333a3..fa77d3d38ff8 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.