Implement custom resolution failure reporter to hide root package versions #300
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
commented
Nov 2, 2023
| ╰─▶ my-project 0a0.dev0 depends on django ∅ | ||
| ╰─▶ my-project depends on django ∅ |
zanieb
commented
Nov 2, 2023
| lines: Vec<String>, | ||
| } | ||
|
|
||
| impl ResolutionFailureReporter { |
There was a problem hiding this comment.
This is all copied without change
zanieb
commented
Nov 2, 2023
Comment on lines
+312
to
+314
| DerivationTree::External(external) => { | ||
| PuffinExternal::from_pubgrub(external.clone()).to_string() | ||
| } |
There was a problem hiding this comment.
Here, we change from external.to_string() to use our internal type
zanieb
commented
Nov 2, 2023
Comment on lines
+324
to
+357
| /// Puffin derivative of [`pubgrub::report::External`] for customized display | ||
| /// for Puffin internal [`PubGrubPackage`]. | ||
| #[allow(clippy::large_enum_variant)] | ||
| #[derive(Debug, Clone)] | ||
| enum PuffinExternal { | ||
| /// Initial incompatibility aiming at picking the root package for the first decision. | ||
| NotRoot(PubGrubPackage, PubGrubVersion), | ||
| /// There are no versions in the given set for this package. | ||
| NoVersions(PubGrubPackage, Range<PubGrubVersion>), | ||
| /// Dependencies of the package are unavailable for versions in that set. | ||
| UnavailableDependencies(PubGrubPackage, Range<PubGrubVersion>), | ||
| /// Incompatibility coming from the dependencies of a given package. | ||
| FromDependencyOf( | ||
| PubGrubPackage, | ||
| Range<PubGrubVersion>, | ||
| PubGrubPackage, | ||
| Range<PubGrubVersion>, | ||
| ), | ||
| } | ||
|
|
||
| impl PuffinExternal { | ||
| fn from_pubgrub(external: External<PubGrubPackage, Range<PubGrubVersion>>) -> Self { | ||
| match external { | ||
| External::NotRoot(p, v) => PuffinExternal::NotRoot(p, v), | ||
| External::NoVersions(p, vs) => PuffinExternal::NoVersions(p, vs), | ||
| External::UnavailableDependencies(p, vs) => { | ||
| PuffinExternal::UnavailableDependencies(p, vs) | ||
| } | ||
| External::FromDependencyOf(p, vs, p_dep, vs_dep) => { | ||
| PuffinExternal::FromDependencyOf(p, vs, p_dep, vs_dep) | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Here, we replicate the entire External type so we can impl fmt::Display
zanieb
force-pushed
the
zanie/root-version
branch
from
0012594
to
8309a05
Compare
zanieb
added a commit
that referenced
this pull request
Nov 6, 2023
) Partially addresses #310 Addresses case at #309 (comment) Follow-up to #300 ensuring `PuffinExternal` is used consistently when formatting messages Example at https://github.com/astral-sh/puffin/pull/342/files#diff-5c74a74ef34ef1d6e7453de8d2d19134813156e8b6a657e6b5ed71fda5a3a870
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.
Extends #295
Closes #214
Copies some of the implementations from
pubgrub::reportso we can implement PuffinPubGrubPackagespecific display when explaining failed resolutions.Here, we just drop the dummy version number if it's a
PubGrubPackage::Rootpackage. In the future, we can further customize reporting.