Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions Doc/c-api/stable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@ Contents of the Limited API are :ref:`listed below <limited-api-list>`.
You can also define ``Py_LIMITED_API`` to ``3``. This works the same as
``0x03020000`` (Python 3.2, the version that introduced Limited API).

.. c:macro:: Py_TARGET_ABI3T

Define this macro before including ``Python.h`` to opt in to only use
the Limited API for :term:`free-threaded builds <free-threaded build>`,
and to select the Limited API version.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's not obvious from the doc that the macro value should be a Python version.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes. I plan to send a separate PR for docs; this is a tiny paragraph to appease the linter.

.. seealso:: :pep:`803`

.. versionadded:: next


.. _stable-abi:

Expand Down
4 changes: 0 additions & 4 deletions Include/Python.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,6 @@
#endif

#if defined(Py_GIL_DISABLED)
# if defined(Py_LIMITED_API) && !defined(_Py_OPAQUE_PYOBJECT)
# error "Py_LIMITED_API is not currently supported in the free-threaded build"
# endif

# if defined(_MSC_VER)
# include <intrin.h> // __readgsqword()
# endif
Expand Down
28 changes: 28 additions & 0 deletions Include/patchlevel.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,32 @@
#define PYTHON_ABI_VERSION 3
#define PYTHON_ABI_STRING "3"


/* Stable ABI for free-threaded builds (introduced in PEP 803)
is enabled by one of:
- Py_TARGET_ABI3T, or
- Py_LIMITED_API and Py_GIL_DISABLED.
"Output" macros to be used internally:
- Py_LIMITED_API (defines the subset of API we expose)
- _Py_OPAQUE_PYOBJECT (additionally hides what's ABI-incompatible between
free-threaded & GIL)
(Don't use Py_TARGET_ABI3T directly; we merge into the above two here.
We do set it for users' convenience though.)
*/
#if defined(Py_LIMITED_API) && defined(Py_GIL_DISABLED) \
&& !defined(Py_TARGET_ABI3T)
# define Py_TARGET_ABI3T Py_LIMITED_API
#endif
#if defined(Py_TARGET_ABI3T)
# define _Py_OPAQUE_PYOBJECT
# if !defined(Py_LIMITED_API)
# define Py_LIMITED_API Py_TARGET_ABI3T
# elif Py_LIMITED_API > Py_TARGET_ABI3T
// if both are defined, use the *lower* version,
// i.e. maximum compatibility
# undef Py_LIMITED_API
# define Py_LIMITED_API Py_TARGET_ABI3T
# endif
#endif

#endif //_Py_PATCHLEVEL_H
17 changes: 8 additions & 9 deletions Lib/test/test_cext/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ def test_build(self):
self.check_build('_test_cext')

def check_build(self, extension_name, std=None, limited=False,
opaque_pyobject=False):
abi3t=False):
venv_dir = 'env'
with support.setup_venv_with_pip_setuptools(venv_dir) as python_exe:
self._check_build(extension_name, python_exe,
std=std, limited=limited,
opaque_pyobject=opaque_pyobject)
abi3t=abi3t)

def _check_build(self, extension_name, python_exe, std, limited,
opaque_pyobject):
abi3t):
pkg_dir = 'pkg'
os.mkdir(pkg_dir)
shutil.copy(SETUP, os.path.join(pkg_dir, os.path.basename(SETUP)))
Expand All @@ -60,8 +60,8 @@ def run_cmd(operation, cmd):
env['CPYTHON_TEST_STD'] = std
if limited:
env['CPYTHON_TEST_LIMITED'] = '1'
if opaque_pyobject:
env['CPYTHON_TEST_OPAQUE_PYOBJECT'] = '1'
if abi3t:
env['CPYTHON_TEST_ABI3T'] = '1'
env['CPYTHON_TEST_EXT_NAME'] = extension_name
env['TEST_INTERNAL_C_API'] = str(int(self.TEST_INTERNAL_C_API))
if support.verbose:
Expand Down Expand Up @@ -116,10 +116,9 @@ def test_build_limited_c11(self):
def test_build_c11(self):
self.check_build('_test_c11_cext', std='c11')

def test_build_opaque_pyobject(self):
# Test with _Py_OPAQUE_PYOBJECT
self.check_build('_test_limited_opaque_cext', limited=True,
opaque_pyobject=True)
def test_build_abi3t(self):
# Test with Py_TARGET_ABI3T
self.check_build('_test_abi3t', abi3t=True)

@unittest.skipIf(support.MS_WINDOWS, "MSVC doesn't support /std:c99")
def test_build_c99(self):
Expand Down
12 changes: 5 additions & 7 deletions Lib/test/test_cext/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def main():
std = os.environ.get("CPYTHON_TEST_STD", "")
module_name = os.environ["CPYTHON_TEST_EXT_NAME"]
limited = bool(os.environ.get("CPYTHON_TEST_LIMITED", ""))
opaque_pyobject = bool(os.environ.get("CPYTHON_TEST_OPAQUE_PYOBJECT", ""))
abi3t = bool(os.environ.get("CPYTHON_TEST_ABI3T", ""))
internal = bool(int(os.environ.get("TEST_INTERNAL_C_API", "0")))

sources = [SOURCE]
Expand Down Expand Up @@ -91,14 +91,12 @@ def main():
# CC env var overrides sysconfig CC variable in setuptools
os.environ['CC'] = cmd

# Define Py_LIMITED_API macro
# Define opt-in macros
if limited:
version = sys.hexversion
cflags.append(f'-DPy_LIMITED_API={version:#x}')
cflags.append(f'-DPy_LIMITED_API={sys.hexversion:#x}')

# Define _Py_OPAQUE_PYOBJECT macro
if opaque_pyobject:
cflags.append(f'-D_Py_OPAQUE_PYOBJECT')
if abi3t:
cflags.append(f'-DPy_TARGET_ABI3T={sys.hexversion:#x}')

if internal:
cflags.append('-DTEST_INTERNAL_C_API=1')
Expand Down
16 changes: 15 additions & 1 deletion Lib/test/test_importlib/extension/test_finder.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from test.support import is_apple_mobile
from test.support import is_apple_mobile, Py_GIL_DISABLED
from test.test_importlib import abc, util

machinery = util.import_importlib('importlib.machinery')
Expand Down Expand Up @@ -59,6 +59,20 @@ def test_module(self):
def test_failure(self):
self.assertIsNone(self.find_spec('asdfjkl;'))

def test_abi3_extension_suffixes(self):
suffixes = self.machinery.EXTENSION_SUFFIXES
if 'win32' in sys.platform:
# Either "_d.pyd" or ".pyd" must be in suffixes
self.assertTrue({"_d.pyd", ".pyd"}.intersection(suffixes))
elif 'cygwin' in sys.platform:
pass
else:
if Py_GIL_DISABLED:
self.assertNotIn(".abi3.so", suffixes)
else:
self.assertIn(".abi3.so", suffixes)
self.assertIn(".abi3t.so", suffixes)


(Frozen_FinderTests,
Source_FinderTests
Expand Down
3 changes: 3 additions & 0 deletions Python/dynload_shlib.c
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ const char *_PyImport_DynLoadFiletab[] = {
#ifdef ALT_SOABI
"." ALT_SOABI ".so",
#endif
#ifndef Py_GIL_DISABLED
".abi" PYTHON_ABI_STRING ".so",
#endif /* Py_GIL_DISABLED */
".abi" PYTHON_ABI_STRING "t.so",
".so",
#endif /* __CYGWIN__ */
NULL,
Expand Down
Loading