-
-
Notifications
You must be signed in to change notification settings - Fork 32.7k
gh-138171: Migrate testbed location and add cross-platform build script #138176
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.
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
base: main
Are you sure you want to change the base?
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as outdated.
This comment was marked as outdated.
The buildbot initially failed because the buildbot configuration references the older |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
!buildbot iOS |
🤖 New build scheduled with the buildbot fleet by @freakboy3742 for commit 68d671b 🤖 Results will be shown at: https://buildbot.python.org/all/#/grid?branch=refs%2Fpull%2F138176%2Fmerge The command will test the builders whose names match following regular expression: The builders matched are:
|
@freakboy3742 I imagine the CODEOWNERS entries will need updating in this PR? |
.gitignore
Outdated
Apple/testbed/Python.xcframework/*-*/bin | ||
Apple/testbed/Python.xcframework/*-*/include | ||
Apple/testbed/Python.xcframework/*-*/lib | ||
Apple/testbed/Python.xcframework/*-*/Python.framework |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need *-*
or would a simpler *
pattern work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hrm - you may be right. I used the *-*
pattern because there are files in that folder that need to be version controlled (most notably, Info.plist
), but when combined with the suffixes, they should be unique.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is to be a runnable Python package, we should probably have a blank __init__.py
file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The __init__.py
is only necessary if you want the directory to be importable as a module. The __main__
.py-only approach is already used by Tools/wasm/emscripten
,Tools/wasm/wasi
and the existing iOS/testbed
(now Apple/testbed
) folders so that those folders are runnable entry points.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 to moving these under Apple
.
Or should we go a step further and have a build
, platform
or $bikeshed
dir for all of Apple, Android and PC, and whatever comes next (Linux?)
|
||
|
||
def unpack_deps(host, prefix_dir, cache_dir=None): | ||
deps_url = "https://github.com/beeware/cpython-apple-source-deps/releases/download" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there plans to move this under https://github.com/python/
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. @emmatyping started a pre-PEP discussion recently about consolidating the various repos we have into a single "binary dependency management repo", so that we have a single source for all (or as many as possible) of the build systems as possible. iOS and Android binaries (which are both currently BeeWare hosted) are part of those discussions.
If there's a more pressing interest for an interim solution, I'm happy to transfer ownership of both the iOS and Android repos to the Python org, or to give maintainer access to the existing repos any core team member who wants it.
Co-authored-by: Hugo van Kemenade <[email protected]>
I guess we could - but that feels like slight overkill to me. There aren't that many platforms - and other than Linux/Unix, they're already represented in the existing tree structure without being overwhelming. If we were only talking about iOS and macOS, even the Apple rename might not be worth it. However, since there's at least 4 other possible Apple platforms (tvOS, watchOS, visionOS and Catalyst), and they all share a lot in common with iOS (and to a lesser extent, macOS), avoiding another 4 top-level directories seemed worthwhile. |
Thanks for all the work on this. I will have a chance to review it in the next day or so. |
This script simplifies the process of configuring, compiling and packaging an XCframework for an Apple platform. This is an analog of the scripts used to build Android and Emscripten artefacts. It is a precursor to adding GitHub Action builds for iOS, and producing iOS build artefacts.
At present, it only supports iOS, but it has been constructed so that it could be used on any Apple platform (including, potentially, a redistributable macOS XCframework).
The simplest usage of this script is:
which will:
XCframework, merging binaries into a "fat" binary if necessary
This is the complete sequence that would be needed in CI to build and test a candidate release artefact. The output of the command will detect if it's running in a GitHub Actions and use output groups to make the log output easier to digest.
Each individual step can be invoked individually - there are commands to
clean
,configure-build
,make-build
,configure-host
,make-host
,package
, andtest
.There is also a
build
command that can be used to combine the configure and make steps for the build Python, an individual host, all hosts, or all builds.One of the steps is to manage the download of binary artefacts; these artefacts are downloaded to the
cross-build/downloads
folder by default, but an alternate cache location can be provided.There are three potentially controversial parts to this PR:
Moving
iOS
toApple/iOS
As part of recognising that iOS is one of (potentially) many Apple platforms, and to prevent future proliferation of top-level directories for other Apple platforms, it migrates the iOS folder into a top level Apple folder. This change isn't strictly required, but if we don't make this change now, there is potential for a proliferation of directories if/when we add support for tvOS, watchOS, visionOS, macCatalyst. It also provides a convenient home for "cross platform" apple concerns, like the testbed script and the build script itself, as well as place for the existing content in the
Mac
directory to migrate to as part of a cleanup of macOS builds - something that @ned-deily has expressed an interest in doing 1Universal simulator binaries
This PR generates a build that includes x86_64 simulator binaries. The iOS simulator slice of the XCframework is effectively a "universal" build covering both x86_64 and ARM64; although it has to be compiled in 2 passes and binaries merged after the fact. It's possible to both compile and test x86_64 binaries on ARM64 machines (pass
--simulator "iPhone 16e,arch=x86_64"
to theci
ortest
target, or to the testbed script), although running the test suite in emulator mode currently causes some test failure related tobuild-details.json
not being fully cross-platform aware.x86_64 isn't a Tier 3 platform for Python due to the difficulties of commissioning a buildbot; but x86_64 is still a supported platform for Apple. If we're going to produce official binaries, it seems to me like we should still support x86_64.
If we choose not to support x86_64, then there will be some changes required to the build script and testbed, as the name of the simulator slice will change from
ios_arm64_x86_64_simulator
toios_arm64_simulator
. It would also allow removing the most complicated part of this script - the part that does the merging of binaries.Backporting to 3.13 and 3.14
I've proposed this for backport to 3.13 and 3.14. This is primarily so that the buildbots can be migrated to use this script, and CI jobs can be added for iOS. The directory reorganization is a significant change to make in a backport, especially in the year-old 3.13 release; however, when I floated this idea at the CPython core team summit, @Yhg1s suggested 1 that while it is a big change, the set of affected iOS users would be small, so the impact wasn't a huge concern.
NOTE: This PR currently contains a duplicate of the
iOS/Resources/bin
directory; this is needed because the location is hard-coded into the buildbots. Once the location change is confirmed, I can add the new path to the buildbot configuration, and remove the duplicate bin scripts.📚 Documentation preview 📚: https://cpython-previews--138176.org.readthedocs.build/
Footnotes
https://pyfound.blogspot.com/2025/06/python-language-summit-2025-python-on-mobile.html ↩ ↩2