Report incompatible distributions to users #1293
Merged
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
zanieb
force-pushed
the
zb/no-wheel-platform
branch
from
e323b62 to
ce013a8
Compare
zanieb
changed the title
zanieb
force-pushed
the
zb/refactor-dist
branch
from
dd9dfe5 to
691e3b0
Compare
zanieb
force-pushed
the
zb/no-wheel-platform
branch
from
ce013a8 to
1933d60
Compare
zanieb
commented
Feb 13, 2024
This was referenced Feb 14, 2024
# Conflicts: # crates/puffin-resolver/src/candidate_selector.rs
zanieb
force-pushed
the
zb/no-wheel-platform
branch
from
90afb5e to
b5da4ff
Compare
zanieb
force-pushed
the
zb/no-wheel-platform
branch
from
77cba18 to
48a5401
Compare
zanieb
commented
Feb 15, 2024
Comment on lines
-7
to
-17
| /// A [`Dist`] and metadata about it required for downstream filtering. | ||
| #[derive(Debug, Clone)] | ||
| pub struct DistMetadata { | ||
| pub dist: Dist, | ||
|
|
||
| /// The version of Python required by the distribution | ||
| pub requires_python: Option<VersionSpecifiers>, | ||
|
|
||
| /// Is the distribution file yanked? | ||
| pub yanked: Yanked, | ||
| } |
There was a problem hiding this comment.
Moved down; will be removed entirely in #1298
BurntSushi
approved these changes
Feb 15, 2024
| } | ||
|
|
||
| /// Set the `exclude_newer` flag | ||
| pub fn set_exclude_newer(&mut self) { |
There was a problem hiding this comment.
I might accept a yes: bool parameter here. Or rename to enable_exclude_newer. (I usually like the former since it's a little more flexible.)
There was a problem hiding this comment.
👍 it's going away in the next pull request and seems fine so I'll leave it for now but keep in mind for the future
| (Self::Incompatible(t_self), Self::Incompatible(t_other)) => t_self.cmp(t_other), | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Nice. I looked at this a bit to see if I could find a way that it breaks the contract for Ord, but nothing came to mind. :)
zanieb
added a commit
that referenced
this pull request
Mar 8, 2024
Extends the "compatibility" types introduced in #1293 to apply to source distributions as well as wheels. - We now track the most-relevant incompatible source distribution - Exclude newer, Python requirements, and yanked versions are all tracked as incompatibilities in the new model (this lets us remove `DistMetadata`!)
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.
Instead of dropping versions without a compatible distribution, we track them as incompatibilities in the solver. This implementation follows patterns established in #1290.
This required some significant refactoring of how we track incompatible distributions. Notably:
Option<TagPriority>is nowWheelCompatibilitywhich allows us to track the reason a wheel is incompatible instead of justNone.Candidatenow has aCandidateDistwithCompatibleandIncompatibilevariants instead of justResolvableDist; candidates are not strictly compatible anymoreResolvableDistwas renamed toCompatibleDistIncompatibleWheelwas given an ordering implementation so we can track the "most compatible" (but still incompatible) wheel. This allows us to collapse the reason a version cannot be used to a single incompatibility.VersionMapis retained, we still only store one incompatible wheel per version. This is sufficient for error reporting.TagCompatibilitytype was added for tracking which part of a wheel tag is incompatibleCandidate::validate_pythonmoved toPythonRequirement::validate_distI am doing more refactoring in #1298 — I think a couple passes will be necessary to clarify the relationships of these types.
Includes improved error message snapshots for multiple incompatible Python tag types from #1285 — we should add more scenarios for coverage of behavior when multiple tags with different levels are present.