NotificationsYou must be signed in to change notification settings
Fork34k
Star71.2k

gh-144161: Clarify additional immortalization in free-threaded build#144176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

HernaniSamuel wants to merge11 commits intopython:mainfromHernaniSamuel:doc-clarify-interned-strings

Closed

gh-144161: Clarify additional immortalization in free-threaded build#144176

HernaniSamuel wants to merge11 commits intopython:mainfromHernaniSamuel:doc-clarify-interned-strings

+11 −3

Conversation

Copy link

HernaniSamuel commentedJan 23, 2026•
edited by github-actionsbot
Loading

Clarify that the objects listed in the free-threading HOWTO are additional immortalizations specific to the free-threaded build.

This addresses the inconsistency reported in#144161, wheresys.intern() documentation states that interned strings are not immortal, while the free-threading HOWTO suggested otherwise. Both are correct for their respective contexts (default vs. free-threaded builds).

Changes follow the suggestion by@Prometheus3375 in the issue discussion.

Issue:Inconsistent documentation: are interned strings immortal or not? #144161

📚 Documentation preview 📚:https://cpython-previews--144176.org.readthedocs.build/

pythongh-144161: Clarify additional immortalization in free-threaded …

c07f6d6

…buildClarify that the objects listed in the free-threading HOWTO areadditional immortalizations specific to the free-threaded build.This addresses the inconsistency with sys.intern() documentation,which describes the default (mortal) behavior.

Copy link

python-cla-botbot commentedJan 23, 2026•
edited
Loading

All commit authors signed the Contributor License Agreement.

bedevere-appbot added docs

Documentation in the Doc dir

skip news labels

Jan 23, 2026

github-project-automationbot added this toDocs PRs

Jan 23, 2026

github-project-automationbot moved this toTodo inDocs PRs

Jan 23, 2026

bedevere-appbot added the awaiting review label

Jan 23, 2026

bedevere-appbot mentioned this pull request

Jan 23, 2026

Inconsistent documentation: are interned strings immortal or not?#144161

Open

sharktide reviewed

Jan 23, 2026

View reviewed changes

Copy link

Contributor

sharktide left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

LGTM

ZeroIntensity reviewed

Jan 23, 2026

View reviewed changes

Copy link

Member

ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think it would make much more sense to just add a note tosys.intern andPyUnicode_InternInPlace saying that the free-threaded build makes all interned strings immortal.

Add notes to sys.intern and PyUnicode_InternInPlace about immortal st…

2381777

…rings

This comment was marked as outdated.

Address review comments: emphasize 'are' and rephrase to avoid duplic…

60877e6

…ate 'Note'

ZeroIntensity reviewed

Jan 24, 2026

View reviewed changes

Doc/howto/free-threading-python.rst OutdatedShow resolvedHide resolved

Doc/c-api/unicode.rst OutdatedShow resolvedHide resolved

Doc/library/sys.rst OutdatedShow resolvedHide resolved

HernaniSamuel added3 commits

January 24, 2026 15:45

Docs: address review feedback on interned string immortality

8615a75

pythongh-144161: fix glossary term 'free-threaded'

bd1935f

Remove :term: reference from 'free-threaded' (not in glossary)

d261c91

ZeroIntensity reviewed

Jan 25, 2026

View reviewed changes

Doc/c-api/unicode.rst Outdated

		You must keep a reference to the result to benefit from interning.

		..note::
		On the free-threaded build, all interned strings are:term:`immortal`.

Copy link

Member

ZeroIntensityJan 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Sorry I messed up the suggestion, the right term is "free threading":

Suggested change

	On the free-threaded build, all interned strings are:term:`immortal`.
	On the:term:`freethreaded <free threading>` build, all interned strings are:term:`immortal`.

Docs: reference free threading glossary term correctly

6f221be

This comment was marked as outdated.

HernaniSamuel added2 commits

January 26, 2026 10:28

pythongh-144161: wrap free threading note to 80 columns

6f18666

pythongh-144161: remove trailing whitespace

9aef49e

This comment was marked as outdated.

Docs: use hyphenated 'free-threaded' in term references

dcc823d

Copy link

Member

ZeroIntensity commentedJan 27, 2026

Phrase "free-threaded" is usually used with hyphen between the words, but in suggestion by ZeroIntensity it was left out.

"free threaded" is the more common spelling in the docs:

ZeroIntensity mentioned this pull request

Jan 27, 2026

Inconsistent use of the "free threading" term#144277

Open

Copy link

Member

vstinner commentedJan 27, 2026

"free threaded" is the more common spelling in the docs

I confirm. No hyphen should be used, see the issuegh-144277.

docs: use 'free threaded' without hyphen for consistency

47632d1

Copy link

Contributor

Prometheus3375 commentedJan 28, 2026

In this PR preposition was changed from "in the free threaded build" to "on the free threaded build". I believe that "in" is more correct because it can be rephrased as "inside the free threaded build" unlike "on" version. Quick check with LLM also told me that, but perhaps I am missing something.