Fixes pipenv lock nondeterminism with environment markers #5299
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
|
I don't know how to write a test for this one. Testing by running a loop seems heuristic. ./stress-lock.sh
attempt 1: greenlet markers="platform_python_implementation == 'CPython'"
attempt 2: greenlet markers="platform_python_implementation == 'CPython'"
attempt 3: greenlet markers="platform_python_implementation == 'CPython'"
attempt 4: greenlet markers="platform_python_implementation == 'CPython'"
attempt 5: greenlet markers="platform_python_implementation == 'CPython'"
attempt 6: greenlet markers="platform_python_implementation == 'CPython'"
attempt 7: greenlet markers="platform_python_implementation == 'CPython'"
attempt 8: greenlet markers="platform_python_implementation == 'CPython'"
^C |
matteius
reviewed
Aug 26, 2022
news/5239.bugfix.rst
Outdated
| @@ -0,0 +1 @@ | |||
| Sorting ``constraints`` before resolving, which fixes ``pipenv lock`` generates nondeterminism environment markers. | |||
There was a problem hiding this comment.
Please rename this file to 5299.bugfix.rst to avoid the merge conflict.
There was a problem hiding this comment.
Sorry, I didn't check that. Fixed.
matteius
approved these changes
Aug 26, 2022
2 tasks
matteius
added a commit
that referenced
this pull request
Sep 1, 2022
)" This reverts commit d33f4ec.
yeisonvargasf
pushed a commit
to yeisonvargasf/pipenv
that referenced
this pull request
Nov 19, 2022
* Fixes pipenv lock nondeterminism with environment markers
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.
Thank you for contributing to Pipenv!
The issue
Fixes #5239
The fix
Packages are added into resolver in this order:
PIPENV_PACKAGESResolverwith the nameconstraints.parsed_requirementsInstallRequirementbyinstall_req_from_parsed_requirementAfter that, we would have all package's markers from resolver.
Thanks @bakhtiary for providing a nice way to overcome this issue by sorting packages.
I think if we want to sort packages, we better sort them after step 5, which is the last step we could intervene.
But even if those packages are sorted, this might not be the best solution. Because markers are generated by pip's resolver, which is something we couldn't control (for example those packages might be reordered inside resolver).
The checklist
news/directory to describe this fix with the extension.bugfix.rst,.feature.rst,.behavior.rst,.doc.rst..vendor.rst. or.trivial.rst(this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.