Documentation
The document for PyUnicode_InternFromString currently claimed that
CPython implementation detail: Strings interned this way are made immortal.
However, testing with simple code like,
auto v = PyUnicode_InternFromString("abcdefg_aaaaa");
// PyUnicode_InternImmortal(&v);
printf("immortalized? %d\n", _Py_IsImmortal(v));suggests that the returned value is not, which is expected based on the code since it calls _PyUnicode_InternMortal rather than _PyUnicode_InternImmortal. If a call to the internal API PyUnicode_InternImmortal was added (as in the commented out code above), then the string is indeed immortalized.
This document was added in #121364 but that PR did not change the behavior of this function. AFAICT, PyUnicode_InternFromString never immortalize the string ever since it was added in #120520.
The only public API that ever immortalized the input string appears to be PyUnicode_InternInPlace and that was changed in #121364 (the one that added the wrong doc) and there doesn't seem to be any public API that immortalize the string anymore. Although this is technically a document issue, I think it might be better to change the behavior of the function instead to match the document.
Linked PRs
Documentation
The document for
PyUnicode_InternFromStringcurrently claimed thatHowever, testing with simple code like,
suggests that the returned value is not, which is expected based on the code since it calls
_PyUnicode_InternMortalrather than_PyUnicode_InternImmortal. If a call to the internal APIPyUnicode_InternImmortalwas added (as in the commented out code above), then the string is indeed immortalized.This document was added in #121364 but that PR did not change the behavior of this function. AFAICT,
PyUnicode_InternFromStringnever immortalize the string ever since it was added in #120520.The only public API that ever immortalized the input string appears to be
PyUnicode_InternInPlaceand that was changed in #121364 (the one that added the wrong doc) and there doesn't seem to be any public API that immortalize the string anymore. Although this is technically a document issue, I think it might be better to change the behavior of the function instead to match the document.Linked PRs