Set _PYTHON_HOST_PLATFORM when building wheels in CI #21942
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tdyas
reviewed
Feb 10, 2025
| # macosx-10.9-universal2. Thus, without this env var, we tag our single-platform wheels | ||
| # as universal2... this is a lie and understandably leads to installing the wrong wheel | ||
| # and thus things do not work (see #21938 for an example). | ||
| ret["_PYTHON_HOST_PLATFORM"] = "macosx-13.0-x86_64" |
There was a problem hiding this comment.
Should we also have logic in the GHA workflow to check that the wheel's filename is as expected? I.e. that no universal2 wheels were generated.
There was a problem hiding this comment.
Ah, yeah, I'll add some extra checks to release.py
|
Woohoo. This looks better. From the CI logs:
Compared to a problematic build (e.g. the 2.26.0.dev0 release):
|
tdyas
approved these changes
Feb 11, 2025
|
I tried to automatically cherry-pick this change back to each relevant milestone, so that it is available in those older releases of Pants. ✔️ 2.25.xSuccessfully opened #21944. Thanks again for your contributions! |
Merged
huonw
added a commit
that referenced
this pull request
Feb 11, 2025
…21942) (#21944) This follows the lead of `cibuildwheel` to explicitly correctly tag our wheels on macOS, via the `_PYTHON_HOST_PLATFORM` environment variable. This change ensures that the `pip` understands which platform each wheel is built for and compatible with, and thus external plugins using `pants_requirements(...)` work again. It appears the file name (including platform) tags of a wheel are derived from `sysconfig.get_platform()`, i.e. based on the build configuration of the current Python interpreter. Pants builds single platform wheels, so the wheels need to be tagged with the right CPU architecture. In #21655, we changed from tagging correctly to tagging incorrectly: - Before that change, our self-hosted runners had 'simple' Python interpreters, built for the current platform via Pyenv. `python -c 'import sysconfig; print(sysconfig.get_platform())' reports `macosx-10.15-x86_64` and `macosx-11.6-arm64`, and indeed the wheels were tagged like that. - After that change, we started using Python interpreters provided by GitHub-hosted runners. The interpreters report `macosx-10.9-universal2` on both the ARM64 and x86-64 runners. That is, they're built as universal binaries that can run on either architecture. This lead to the wheels being tagged as `universal2` as well. The `_PYTHON_HOST_PLATFORM` environment variable overrides the default `sysconfig.get_platform()` value, and appears to be designed for this sort of purpose (and is used by `cibuildwheel` for such): - https://github.com/python/cpython/blob/5505b91a684b0fc7ffcb3a5b325302671d74fb15/Lib/sysconfig.py#L652-L654 - https://github.com/pypa/cibuildwheel/blob/3805787fe7a0476391541d834fa548a721f0ab2e/cibuildwheel/macos.py#L318-L331 Fixes #21938 Co-authored-by: Huon Wilson <huon@exoflare.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This follows the lead of
cibuildwheelto explicitly correctly tag our wheels on macOS, via the_PYTHON_HOST_PLATFORMenvironment variable. This change ensures that thepipunderstands which platform each wheel is built for and compatible with, and thus external plugins usingpants_requirements(...)work again.It appears the file name (including platform) tags of a wheel are derived from
sysconfig.get_platform(), i.e. based on the build configuration of the current Python interpreter. Pants builds single platform wheels, so the wheels need to be tagged with the right CPU architecture.In #21655, we changed from tagging correctly to tagging incorrectly:
python -c 'import sysconfig; print(sysconfig.get_platform())' reportsmacosx-10.15-x86_64andmacosx-11.6-arm64`, and indeed the wheels were tagged like that.macosx-10.9-universal2on both the ARM64 and x86-64 runners. That is, they're built as universal binaries that can run on either architecture. This lead to the wheels being tagged asuniversal2as well.The
_PYTHON_HOST_PLATFORMenvironment variable overrides the defaultsysconfig.get_platform()value, and appears to be designed for this sort of purpose (and is used bycibuildwheelfor such):Fixes #21938