From c228567e40ca8ab525555b63fba66ad7deb59d47 Mon Sep 17 00:00:00 2001 From: Matt Wozniski Date: Fri, 6 May 2022 05:37:08 -0400 Subject: [PATCH] Document the lifetime of `PyUnicode_AsUTF8String` (GH-92325) The current wording implied this, but didn't state it explicitly. (cherry picked from commit 740da8d37a84638f4a8893bee3648f36fc6beb0f) Co-authored-by: Matt Wozniski --- Doc/c-api/unicode.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index a08cebcc000d0d..cf7d2232125c89 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -1093,7 +1093,8 @@ These are the UTF-8 codec APIs: This caches the UTF-8 representation of the string in the Unicode object, and subsequent calls will return a pointer to the same buffer. The caller is not - responsible for deallocating the buffer. + responsible for deallocating the buffer. The buffer is deallocated and + pointers to it become invalid when the Unicode object is garbage collected. .. versionadded:: 3.3