[Python-checkins] Document the lifetime of `PyUnicode_AsUTF8String` (#92325)
pablogsal
webhook-mailer at python.org
Fri May 6 05:37:22 EDT 2022
https://github.com/python/cpython/commit/740da8d37a84638f4a8893bee3648f36fc6beb0f
commit: 740da8d37a84638f4a8893bee3648f36fc6beb0f
branch: main
author: Matt Wozniski <godlygeek at gmail.com>
committer: pablogsal <Pablogsal at gmail.com>
date: 2022-05-06T10:37:08+01:00
summary:
Document the lifetime of `PyUnicode_AsUTF8String` (#92325)
The current wording implied this, but didn't state it explicitly.
files:
M Doc/c-api/unicode.rst
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 00faac5b69abd..d139112578ca9 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -1075,7 +1075,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
More information about the Python-checkins
mailing list