Detect __pyx_capi__ changes in testing #1067
Open
Conversation
This file contains hidden or 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
|
Auto-sync is disabled for ready for review pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
/ok to test |
|
|
Would this have caught the issues mentioned in #1030? |
Yes, symbols would have been removed from |
|
This theoretically would detect the change as described here. It's basically reverse engineering what Cython does when it does its custom "dynamic linking". I would have liked to have tested it directly, but it's surprisingly hard to build 11.7 today, and there don't seem to be any wheels or conda packages available. |
|
/ok to test |
leofang
added
P1
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.
As a way of detecting changes in "Cython ABI" (which is loosely defined, see #1030), this adds the contents of the
__pyx_capi__dictionary to JSON files in the repository, and then adds a unit test to detect any changes.I think this may be useful as a first defense against ABI changes, however it's not a complete solution. This can not detect changes in structs or enums used across Cython modules.
There is also the risk of annoyance any time new functions are added, which is a completely "ABI safe" operation, but we need to update the baselines in order to detect unsafe operations (deletions) in the future. An alternative approach might be to download a baseline wheel and compare the ABI against it directly -- that could be done in CI but would be harder to run locally.
Closes #1030