build: add poetry.lock to sdist #2405
Merged
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
Fokko
reviewed
Sep 1, 2025
Contributor
Fokko
left a comment
Fokko
left a comment
There was a problem hiding this comment.
Thanks for raising this @kevinjqliu
Alternatively, we can restrict the upperbound of the dependencies, but that since these are optional dependencies, we want to give users the freedom to choose.
I think this is generally a good strategy if a library does proper symver, but some libraries have a major release every time like Arrow and Datafusion. So, in practice this isn't ideal.
| { path = "dev", format = "sdist" }, | ||
| { path = "pyiceberg/**/*.so", format = "wheel" }, | ||
| { path = "pyiceberg/**/*.pyd", format = "wheel" }, | ||
| { path = "poetry.lock", format = "sdist" }, |
Contributor
There was a problem hiding this comment.
We either have to add a ASv2 licence header to the file, or add it to the RAT ignore list.
Contributor
Author
There was a problem hiding this comment.
looks like its already added! :)
iceberg-python/dev/.rat-excludes
Line 6 in 19ba343
Fokko
approved these changes
Sep 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Rationale for this change
This PR explicitly add
poetry.lockto the source distribution artifact so that we can build and test RCs with pinned dependencies.We want to pin dependencies because we verify a release candidate (RC) by re-building the project from source distribution. We unzip the artifact, install the dependencies with
make install, and then run tests.Since
poetry.lockis not automatically added to the source distribution,make installwill install packages only based onpyproject.toml. The resolver will pull in the latest version by default, which can lead to compatibility issues.For example, in 0.10 RC2, we see that this pulled in the latest datafusion which caused an compatibility issue with pyiceberg-core. This is due to the breaking change in the FFI boundary, see apache/datafusion-python#1217
Alternatively, we can restrict the upperbound of the dependencies, but that since these are optional dependencies, we want to give users the freedom to choose.
Are these changes tested?
Are there any user-facing changes?