Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Say "depend on" instead of "depends on" when proper in error messages (#968) 

I would like to spend some additional time working on the package range
display abstractions, but maybe that is best done _after_ I've done a
good bit of fiddling with the error messages.

Addresses
https://github.com/astral-sh/puffin/pull/868#discussion_r1447593081
This commit is contained in:
Zanie Blue 2024-01-19 10:08:17 -06:00 committed by GitHub
parent 5fe3444e5a
commit 7bb4fda8af
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 58 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
crates/puffin-resolver/src/pubgrub/report.rs
View File

@ -81,9 +81,9 @@ impl ReportFormatter<PubGrubPackage, Range<Version>> for PubGrubReportFormatter<
)
} else {
format!(
"{}depends on {}",
Padded::new("", &PackageRange::compatibility(package, &package_set), " "),
PackageRange::dependency(dependency, &dependency_set)
"{}",
PackageRange::compatibility(package, &package_set)
.depends_on(dependency, &dependency_set),
)
}
}
@ -452,6 +452,21 @@ struct PackageRange<'a> {
kind: PackageRangeKind,
}
impl PackageRange<'_> {
/// Returns a boolean indicating if the predicate following this package range should
/// be singular or plural e.g. if false use "<range> depends on <...>" and
/// if true use "<range> depend on <...>"
fn plural(&self) -> bool {
if self.range.is_empty() {
false
} else {
let segments: Vec<_> = self.range.iter().collect();
// "all versions of" is the only plural case
matches!(segments.as_slice(), [(Bound::Unbounded, Bound::Unbounded)])
}
}
}
impl std::fmt::Display for PackageRange<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
if self.range.is_empty() {
@ -517,6 +532,37 @@ impl PackageRange<'_> {
kind: PackageRangeKind::Dependency,
}
}
fn depends_on<'a>(
&'a self,
package: &'a PubGrubPackage,
range: &'a Range<Version>,
) -> DependsOn<'a> {
DependsOn {
first: self,
second: PackageRange::dependency(package, range),
}
}
}
/// A representation of A depends on B.
#[derive(Debug)]
struct DependsOn<'a> {
first: &'a PackageRange<'a>,
second: PackageRange<'a>,
}
impl std::fmt::Display for DependsOn<'_> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", Padded::new("", self.first, " "))?;
if self.first.plural() {
write!(f, "depend on ")?;
} else {
write!(f, "depends on ")?;
};
write!(f, "{}", self.second)?;
Ok(())
}
}
/// Inserts the given padding on the left and right sides of the content if

18
crates/puffin/tests/pip_install_scenarios.rs
View File

@ -565,12 +565,12 @@ fn dependency_excludes_range_of_compatible_versions() -> Result<()> {
crow>1.0.0,<2.0.0
crow>2.0.0
and crow==1.0.0 depends on albatross<2.0.0, we can conclude that crow<2.0.0 depends on albatross<2.0.0.
And because crow==2.0.0 depends on albatross>=3.0.0 we can conclude that all versions of crow depends on one of:
And because crow==2.0.0 depends on albatross>=3.0.0 we can conclude that all versions of crow depend on one of:
albatross<2.0.0
albatross>=3.0.0
And because we know from (1) that albatross<2.0.0 depends on bluebird==1.0.0, we can conclude that albatross!=3.0.0, bluebird!=1.0.0, all versions of crow are incompatible.
And because albatross==3.0.0 depends on bluebird==3.0.0 we can conclude that all versions of crow depends on one of:
And because albatross==3.0.0 depends on bluebird==3.0.0 we can conclude that all versions of crow depend on one of:
bluebird<=1.0.0
bluebird>=3.0.0
@ -701,7 +701,7 @@ fn dependency_excludes_non_contiguous_range_of_compatible_versions() -> Result<(
And because crow==2.0.0 depends on albatross>=3.0.0 we can conclude that all versions of crow, bluebird!=1.0.0, !( albatross>=3.0.0 ) are incompatible. (2)
Because albatross==3.0.0 depends on bluebird==3.0.0 and there are no versions of albatross that satisfy albatross>3.0.0, we can conclude that albatross>=3.0.0 depends on bluebird==3.0.0.
And because we know from (2) that all versions of crow, bluebird!=1.0.0, !( albatross>=3.0.0 ) are incompatible, we can conclude that all versions of crow depends on one of:
And because we know from (2) that all versions of crow, bluebird!=1.0.0, !( albatross>=3.0.0 ) are incompatible, we can conclude that all versions of crow depend on one of:
bluebird<=1.0.0
bluebird>=3.0.0
@ -977,7 +977,7 @@ fn extra_incompatible_with_extra() -> Result<()> {
╰─▶ Because there are no versions of albatross[extra-c] that satisfy any of:
albatross[extra-c]<1.0.0
albatross[extra-c]>1.0.0
and albatross[extra-c]==1.0.0 depends on bluebird==2.0.0, we can conclude that all versions of albatross[extra-c] depends on bluebird==2.0.0.
and albatross[extra-c]==1.0.0 depends on bluebird==2.0.0, we can conclude that all versions of albatross[extra-c] depend on bluebird==2.0.0.
And because albatross[extra-b]==1.0.0 depends on bluebird==1.0.0 and there are no versions of albatross[extra-b] that satisfy any of:
albatross[extra-b]<1.0.0
albatross[extra-b]>1.0.0
@ -1125,7 +1125,7 @@ fn extra_incompatible_with_root() -> Result<()> {
╰─▶ Because albatross[extra]==1.0.0 depends on bluebird==1.0.0 and there are no versions of albatross[extra] that satisfy any of:
albatross[extra]<1.0.0
albatross[extra]>1.0.0
we can conclude that all versions of albatross[extra] depends on bluebird==1.0.0.
we can conclude that all versions of albatross[extra] depend on bluebird==1.0.0.
And because root depends on albatross[extra] and root depends on bluebird==2.0.0, we can conclude that the requirements are unsatisfiable.
"###);
});
@ -1325,7 +1325,7 @@ fn transitive_incompatible_with_root_version() -> Result<()> {
╰─▶ Because albatross==1.0.0 depends on bluebird==2.0.0 and there are no versions of albatross that satisfy any of:
albatross<1.0.0
albatross>1.0.0
we can conclude that all versions of albatross depends on bluebird==2.0.0.
we can conclude that all versions of albatross depend on bluebird==2.0.0.
And because root depends on bluebird==1.0.0 and root depends on albatross, we can conclude that the requirements are unsatisfiable.
"###);
});
@ -1399,7 +1399,7 @@ fn transitive_incompatible_with_transitive() -> Result<()> {
╰─▶ Because there are no versions of bluebird that satisfy any of:
bluebird<1.0.0
bluebird>1.0.0
and bluebird==1.0.0 depends on crow==2.0.0, we can conclude that all versions of bluebird depends on crow==2.0.0.
and bluebird==1.0.0 depends on crow==2.0.0, we can conclude that all versions of bluebird depend on crow==2.0.0.
And because albatross==1.0.0 depends on crow==1.0.0 and there are no versions of albatross that satisfy any of:
albatross<1.0.0
albatross>1.0.0
@ -2418,8 +2418,8 @@ fn transitive_prerelease_and_stable_dependency_many_versions() -> Result<()> {
╰─▶ Because there are no versions of bluebird that satisfy any of:
bluebird<1.0.0
bluebird>1.0.0
and bluebird==1.0.0 depends on crow, we can conclude that all versions of bluebird depends on crow.
And because there are no versions of crow that satisfy crow>=2.0.0b1 we can conclude that all versions of bluebird depends on crow<2.0.0b1.
and bluebird==1.0.0 depends on crow, we can conclude that all versions of bluebird depend on crow.
And because there are no versions of crow that satisfy crow>=2.0.0b1 we can conclude that all versions of bluebird depend on crow<2.0.0b1.
And because albatross==1.0.0 depends on crow>=2.0.0b1 and there are no versions of albatross that satisfy any of:
albatross<1.0.0
albatross>1.0.0