Skip to content

BLD: add option to build future-compatible abi3 wheels #1600

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
neutrinoceros wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −0
Open

BLD: add option to build future-compatible abi3 wheels #1600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 26 additions & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import shutil
import subprocess
import sys
import sysconfig
from pathlib import Path

from setuptools import Extension, setup
Expand All @@ -15,6 +16,24 @@
PROJ_VERSION_SEARCH = re.compile(r".*Rel\.\s+(?P<version>\d+\.\d+\.\d+).*")
VERSION_SEARCH = re.compile(r".*(?P<version>\d+\.\d+\.\d+).*")

# restrict LIMITED_API usage:
# - require an env var PYPROJ_LIMITED_API=1
# - LIMITED_API is not compatible with free-threading (as of CPython 3.14)

@neutrinoceros neutrinoceros Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

note this comment is going to age like milk because there's a new version of the Limited API coming up in Python 3.15 that's compatible with both GIL-enabled and free-threaded builds. However there are a couple other blockers right now (Cython and setuptools both have work-in-progress patches to support this). Note that I'd be happy to revisit this later this year to add cp315-abi3.abi3t as a target

USE_PY_LIMITED_API = os.environ.get(
"PYPROJ_LIMITED_API"
) == "1" and not sysconfig.get_config_var("Py_GIL_DISABLED")
ABI3_TARGET_VERSION = "".join(str(_) for _ in sys.version_info[:2])
ABI3_TARGET_HEX = hex(sys.hexversion & 0xFFFF00F0)


define_macros = [
("NPY_NO_DEPRECATED_API", "NPY_1_7_API_VERSION"),
# keep in sync with runtime requirements (pyproject.toml)
("NPY_TARGET_VERSION", "NPY_1_23_API_VERSION"),
]
if USE_PY_LIMITED_API:
define_macros.append(("Py_LIMITED_API", ABI3_TARGET_HEX))


def _parse_version(version: str) -> tuple[int, int, int]:
"""Convert a version string to a tuple of integers."""
Expand Down Expand Up @@ -198,6 +217,7 @@ def get_extension_modules():
library_dirs if os.name != "nt" and sys.platform != "cygwin" else None
),
"libraries": get_libraries(library_dirs),
"py_limited_api": USE_PY_LIMITED_API,
}
# setup cythonized modules
return cythonize(
Expand Down Expand Up @@ -244,10 +264,16 @@ def get_package_data() -> dict[str, list[str]]:
return package_data


if USE_PY_LIMITED_API:
options = {"bdist_wheel": {"py_limited_api": f"cp{ABI3_TARGET_VERSION}"}}
else:
options = {}

# static items in pyproject.toml
setup(
ext_modules=get_extension_modules(),
package_data=get_package_data(),
# temptorary hack to add in metadata
url="https://github.com/pyproj4/pyproj",
options=options,
)
Loading