Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-146636: Add Free-threaded Stable ABI migration guide #148453

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
clin1234 wants to merge 10 commits into
base: main
Choose a base branch
from
+377 −0
Open

gh-146636: Add Free-threaded Stable ABI migration guide #148453

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2fbc5eb
Add reference to freethreading-stable-abi-howto
clin1234 Apr 12, 2026
367ef68
Add documentation for Free Threading Stable ABI usage
clin1234 Apr 12, 2026
0e89d37
Update documentation on PyObject opaqueness and module init
clin1234 Apr 12, 2026
e8bdfc6
Fix formatting for PyObject opaqueness section
clin1234 Apr 12, 2026
130d126
Fix formatting of code snippet in documentation
clin1234 Apr 12, 2026
62e4d04
Update documentation on PyObject opaqueness
clin1234 Apr 12, 2026
bedbf04
Py_Type
clin1234 Apr 12, 2026
a91024a
Clarify free-threaded limited API build documentation
clin1234 Apr 12, 2026
cfcef79
Revise freethreading-stable-abi.rst for clarity
clin1234 Apr 12, 2026
b8b5277
Add freethreading-stable-abi.rst to documentation index
clin1234 Apr 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix formatting for PyObject opaqueness section
  • Loading branch information
@clin1234
clin1234 authored Apr 12, 2026
commit e8bdfc6fbab0bcb9a7b6cccc9280ec7b6c35f5ac
8 changes: 4 additions & 4 deletions Doc/howto/freethreading-stable-abi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
can be used to determine whether the current running interpreter had the
macro defined.

`PyObject` opaqueness
``PyObject`` opaqueness
=====================

Check warning on line 33 in Doc/howto/freethreading-stable-abi.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

Title underline too short.

Check warning on line 33 in Doc/howto/freethreading-stable-abi.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

Title underline too short.

Accessing any member of `PyObject` is now prohibited, like the non-GIL
stable ABI. For instance, prefer `Py_Type()` and `Py_SET_TYPE()` over manipulating `ob_type` directly,
`Py_REFCNT`, `Py_INCREF()` and `Py_DecRef().` over `ob_refcnt`, etc.
Accessing any member of ``PyObject`` directly is now prohibited, like the non-GIL
stable ABI. For instance, prefer ``Py_Type()`` and ``Py_SET_TYPE()`` over ``ob_type``,
Comment thread
clin1234 marked this conversation as resolved.
Outdated
``Py_REFCNT``, ``Py_INCREF()`` and ``Py_DecRef()`` over ``ob_refcnt``, etc.
Comment thread
clin1234 marked this conversation as resolved.
Outdated

Module Initialization
=====================
Expand Down Expand Up @@ -129,7 +129,7 @@
.. _PyDict_Next:

``PyDict_Next``
'''''''''''''''

Check warning on line 132 in Doc/howto/freethreading-stable-abi.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

duplicate label pydict_next, other instance in /home/runner/work/cpython/cpython/Doc/howto/free-threading-extensions.rst

A notable exception is :c:func:`PyDict_Next`, which does not lock the
dictionary. You should use :c:macro:`Py_BEGIN_CRITICAL_SECTION` to protect
Expand Down Expand Up @@ -200,7 +200,7 @@
.. _free-threaded-memory-allocation:

Memory Allocation APIs
======================

Check warning on line 203 in Doc/howto/freethreading-stable-abi.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

duplicate label free-threaded-memory-allocation, other instance in /home/runner/work/cpython/cpython/Doc/howto/free-threading-extensions.rst

Python's memory management C API provides functions in three different
:ref:`allocation domains <allocator-domains>`: "raw", "mem", and "object".
Expand Down Expand Up @@ -392,7 +392,7 @@
.. _per-object-locks:

Per-Object Locks (``ob_mutex``)
...............................

Check warning on line 395 in Doc/howto/freethreading-stable-abi.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

duplicate label per-object-locks, other instance in /home/runner/work/cpython/cpython/Doc/howto/free-threading-extensions.rst

In the free-threaded build, each Python object contains a :c:member:`~PyObject.ob_mutex`
Comment thread
clin1234 marked this conversation as resolved.
Outdated
field of type :c:type:`PyMutex`. This mutex is **reserved for use by the
Expand Down
Loading