Skip to content

Commit 7aeddea

Browse files
[3.14] gh-119132: Update 'Using Python on macOS' documentation. (GH-135591) (#135594)
Remove `experimental` qualification for free-threading in the document text. Note that images included in the document will be updated later in the release cycle. (cherry picked from commit 7c68589) Co-authored-by: Ned Deily <[email protected]>
1 parent d62b73a commit 7aeddea

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Doc/using/mac.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ display. For most uses, the standard set of installation operations is appropria
7676
By pressing the **Customize** button, you can choose to omit or select certain package
7777
components of the installer. Click on each package name to see a description of
7878
what it installs.
79-
To also install support for the optional experimental free-threaded feature,
79+
To also install support for the optional free-threaded feature,
8080
see :ref:`install-freethreaded-macos`.
8181

8282
.. image:: mac_installer_05_custom_install.png
@@ -252,20 +252,20 @@ Advanced Topics
252252
Installing Free-threaded Binaries
253253
---------------------------------
254254

255-
.. versionadded:: 3.13 (Experimental)
256-
257-
.. note::
258-
259-
Everything described in this section is considered experimental,
260-
and should be expected to change in future releases.
255+
.. versionadded:: 3.13
261256

262257
The ``python.org`` :ref:`Python for macOS <getting-and-installing-macpython>`
263258
installer package can optionally install an additional build of
264-
Python |version| that supports :pep:`703`, the experimental free-threading feature
259+
Python |version| that supports :pep:`703`, the free-threading feature
265260
(running with the :term:`global interpreter lock` disabled).
266261
Check the release page on ``python.org`` for possible updated information.
267262

268-
Because this feature is still considered experimental, the support for it
263+
The free-threaded mode is working and continues to be improved, but
264+
there is some additional overhead in single-threaded workloads compared
265+
to the regular build. Additionally, third-party packages, in particular ones
266+
with an :term:`extension module`, may not be ready for use in a
267+
free-threaded build, and will re-enable the :term:`GIL`.
268+
Therefore, the support for free-threading
269269
is not installed by default. It is packaged as a separate install option,
270270
available by clicking the **Customize** button on the **Installation Type**
271271
step of the installer as described above.
@@ -277,8 +277,8 @@ a separate :file:`PythonT.framework` will also be installed
277277
alongside the normal :file:`Python.framework` in :file:`/Library/Frameworks`.
278278
This configuration allows a free-threaded Python |version| build to co-exist
279279
on your system with a traditional (GIL only) Python |version| build with
280-
minimal risk while installing or testing. This installation layout is itself
281-
experimental and is subject to change in future releases.
280+
minimal risk while installing or testing. This installation layout may
281+
change in future releases.
282282

283283
Known cautions and limitations:
284284

@@ -409,13 +409,13 @@ You can then test that both installer builds are now available with something li
409409
410410
$ # test that the free-threaded interpreter was installed if the Unix Command Tools package was enabled
411411
$ /usr/local/bin/python\ |version|\ t -VV
412-
Python \ |version|\ .0b2 experimental free-threading build (v\ |version|\ .0b2:3a83b172af, Jun 5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
412+
Python \ |version|\ .0b2 free-threading build (v\ |version|\ .0b2:3a83b172af, Jun 5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
413413
$ # and the traditional interpreter
414414
$ /usr/local/bin/python\ |version|\ -VV
415415
Python \ |version|\ .0b2 (v\ |version|\ .0b2:3a83b172af, Jun 5 2024, 12:50:24) [Clang 15.0.0 (clang-1500.3.9.4)]
416416
$ # test that they are also available without the prefix if /usr/local/bin is on $PATH
417417
$ python\ |version|\ t -VV
418-
Python \ |version|\ .0b2 experimental free-threading build (v\ |version|\ .0b2:3a83b172af, Jun 5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
418+
Python \ |version|\ .0b2 free-threading build (v\ |version|\ .0b2:3a83b172af, Jun 5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
419419
$ python\ |version|\ -VV
420420
Python \ |version|\ .0b2 (v\ |version|\ .0b2:3a83b172af, Jun 5 2024, 12:50:24) [Clang 15.0.0 (clang-1500.3.9.4)]
421421

0 commit comments

Comments
 (0)