mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

gh-127253: Note that Stable ABI is about ABI stability (GH-127254)

Browse source
This commit is contained in:
Petr Viktorin 2024-12-03 13:30:27 +01:00 • committed by GitHub
parent 8c3fd1f245
commit 35d37d6592
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/c-api/stable.rst
View file

@ -66,7 +66,7 @@ Limited C API
Python 3.2 introduced the *Limited API*, a subset of Python's C API. Python 3.2 introduced the *Limited API*, a subset of Python's C API.
Extensions that only use the Limited API can be Extensions that only use the Limited API can be
compiled once and work with multiple versions of Python. compiled once and be loaded on multiple versions of Python.
Contents of the Limited API are :ref:`listed below <limited-api-list>`. Contents of the Limited API are :ref:`listed below <limited-api-list>`.
.. c:macro:: Py_LIMITED_API .. c:macro:: Py_LIMITED_API
@ -76,7 +76,7 @@ Contents of the Limited API are :ref:`listed below <limited-api-list>`.
Define ``Py_LIMITED_API`` to the value of :c:macro:`PY_VERSION_HEX` Define ``Py_LIMITED_API`` to the value of :c:macro:`PY_VERSION_HEX`
corresponding to the lowest Python version your extension supports. corresponding to the lowest Python version your extension supports.
The extension will work without recompilation with all Python 3 releases The extension will be ABI-compatible with all Python 3 releases
from the specified one onward, and can use Limited API introduced up to that from the specified one onward, and can use Limited API introduced up to that
version. version.
@ -94,7 +94,15 @@ Stable ABI
---------- ----------
To enable this, Python provides a *Stable ABI*: a set of symbols that will To enable this, Python provides a *Stable ABI*: a set of symbols that will
remain compatible across Python 3.x versions. remain ABI-compatible across Python 3.x versions.
.. note::
The Stable ABI prevents ABI issues, like linker errors due to missing
symbols or data corruption due to changes in structure layouts or function
signatures.
However, other changes in Python can change the *behavior* of extensions.
See Python's Backwards Compatibility Policy (:pep:`387`) for details.
The Stable ABI contains symbols exposed in the :ref:`Limited API The Stable ABI contains symbols exposed in the :ref:`Limited API
<limited-c-api>`, but also other ones – for example, functions necessary to <limited-c-api>`, but also other ones – for example, functions necessary to