setuptools/dist: Fix reproducibility issue by sorting globbing #2692
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
globbing uses os.listdir() which returns order on disk which is unsorted. Ultimately this leads to random ordering of License-File entries in PKG-INFO and means the resulting output isn't deterministic. Adding a sort fixes that. Switch to glob instead ot iglob since sorted() removes the benefit of an iterator. pypa#2691 Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Member
I think I'd still prefer an iterator. Can you create a test to capture this expectation? |
webknjaz reviewed Jun 23, 2021
Member
There was a problem hiding this comment.
Could you add a change note file following this instruction? https://setuptools.readthedocs.io/en/latest/development/developer-guide.html#adding-change-notes-with-your-prs
webknjaz reviewed Jun 23, 2021
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 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.
globbing uses os.listdir() which returns order on disk which is unsorted.
Ultimately this leads to random ordering of License-File entries in PKG-INFO
and means the resulting output isn't deterministic.
Adding a sort fixes that. Switch to glob instead ot iglob since sorted()
removes the benefit of an iterator.
#2691
Signed-off-by: Richard Purdie richard.purdie@linuxfoundation.org
Summary of changes
Closes
Pull Request Checklist
changelog.d/.(See documentation for details)