Skip to content

Commit 1b4bd8d

Browse files
Enforce correctness of self-dependencies (#9705)
## Summary As far as I can tell, this was added in #319, but it seems _incorrect_ to ignore these. Closes #9693.
1 parent c4f3d1c commit 1b4bd8d

4 files changed

Lines changed: 781 additions & 39 deletions

File tree

crates/uv-resolver/src/pubgrub/dependencies.rs

Lines changed: 15 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ use std::iter;
22

33
use either::Either;
44
use pubgrub::Ranges;
5-
use tracing::warn;
65

76
use uv_normalize::{ExtraName, GroupName, PackageName};
87
use uv_pep440::{Version, VersionSpecifiers};
@@ -91,42 +90,23 @@ impl PubGrubDependency {
9190

9291
// Add the package, plus any extra variants.
9392
iter.map(|(extra, group)| PubGrubRequirement::from_requirement(requirement, extra, group))
94-
.filter_map(move |requirement| {
93+
.map(move |requirement| {
9594
let PubGrubRequirement {
9695
package,
9796
version,
9897
url,
9998
} = requirement;
10099
match &*package {
101-
PubGrubPackageInner::Package { name, .. } => {
102-
// Detect self-dependencies.
103-
if dev.is_none() {
104-
if source_name.is_some_and(|source_name| source_name == name) {
105-
warn!("{name} has a dependency on itself");
106-
return None;
107-
}
108-
}
109-
110-
Some(PubGrubDependency {
111-
package: package.clone(),
112-
version: version.clone(),
113-
url,
114-
})
115-
}
116-
PubGrubPackageInner::Marker { name, .. } => {
117-
// Detect self-dependencies.
118-
if dev.is_none() {
119-
if source_name.is_some_and(|source_name| source_name == name) {
120-
return None;
121-
}
122-
}
123-
124-
Some(PubGrubDependency {
125-
package: package.clone(),
126-
version: version.clone(),
127-
url,
128-
})
129-
}
100+
PubGrubPackageInner::Package { .. } => PubGrubDependency {
101+
package: package.clone(),
102+
version: version.clone(),
103+
url,
104+
},
105+
PubGrubPackageInner::Marker { .. } => PubGrubDependency {
106+
package: package.clone(),
107+
version: version.clone(),
108+
url,
109+
},
130110
PubGrubPackageInner::Extra { name, .. } => {
131111
// Detect self-dependencies.
132112
if dev.is_none() {
@@ -135,11 +115,11 @@ impl PubGrubDependency {
135115
"extras not flattened for {name}"
136116
);
137117
}
138-
Some(PubGrubDependency {
118+
PubGrubDependency {
139119
package: package.clone(),
140120
version: version.clone(),
141121
url,
142-
})
122+
}
143123
}
144124
PubGrubPackageInner::Dev { name, .. } => {
145125
// Detect self-dependencies.
@@ -149,11 +129,11 @@ impl PubGrubDependency {
149129
"group not flattened for {name}"
150130
);
151131
}
152-
Some(PubGrubDependency {
132+
PubGrubDependency {
153133
package: package.clone(),
154134
version: version.clone(),
155135
url,
156-
})
136+
}
157137
}
158138
PubGrubPackageInner::Root(_) => unreachable!("root package in dependencies"),
159139
PubGrubPackageInner::Python(_) => {

crates/uv-resolver/src/pubgrub/report.rs

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,16 @@ impl ReportFormatter<PubGrubPackage, Range<Version>, UnavailableReason>
133133
External::FromDependencyOf(package, package_set, dependency, dependency_set) => {
134134
let package_set = self.simplify_set(package_set, package);
135135
let dependency_set = self.simplify_set(dependency_set, dependency);
136+
137+
if package == dependency {
138+
if let Some(member) = self.format_workspace_member(package) {
139+
return format!(
140+
"{member} depends on itself at an incompatible version ({})",
141+
PackageRange::dependency(package, &dependency_set, None)
142+
);
143+
}
144+
}
145+
136146
if let Some(root) = self.format_root_requires(package) {
137147
return format!(
138148
"{root} {}",
@@ -407,6 +417,24 @@ impl PubGrubReportFormatter<'_> {
407417
}
408418
}
409419

420+
/// Return whether the given package is the root package.
421+
fn is_root(package: &PubGrubPackage) -> bool {
422+
matches!(&**package, PubGrubPackageInner::Root(_))
423+
}
424+
425+
/// Return whether the given package is a workspace member.
426+
fn is_single_project_workspace_member(&self, package: &PubGrubPackage) -> bool {
427+
match &**package {
428+
// TODO(zanieb): Improve handling of dev and extra for single-project workspaces
429+
PubGrubPackageInner::Package {
430+
name, extra, dev, ..
431+
} if self.workspace_members.contains(name) => {
432+
self.is_single_project_workspace() && extra.is_none() && dev.is_none()
433+
}
434+
_ => false,
435+
}
436+
}
437+
410438
/// Create a [`PackageRange::compatibility`] display with this formatter attached.
411439
fn compatible_range<'a>(
412440
&'a self,
@@ -467,6 +495,18 @@ impl PubGrubReportFormatter<'_> {
467495
.and(dependency2.package, &dependency_set2),
468496
)
469497
}
498+
(.., External::FromDependencyOf(package, _, dependency, _))
499+
if Self::is_root(package)
500+
&& self.is_single_project_workspace_member(dependency) =>
501+
{
502+
self.format_external(external1)
503+
}
504+
(External::FromDependencyOf(package, _, dependency, _), ..)
505+
if Self::is_root(package)
506+
&& self.is_single_project_workspace_member(dependency) =>
507+
{
508+
self.format_external(external2)
509+
}
470510
_ => {
471511
let external1 = self.format_external(external1);
472512
let external2 = self.format_external(external2);
@@ -570,6 +610,16 @@ impl PubGrubReportFormatter<'_> {
570610
workspace: self.is_workspace() && !self.is_single_project_workspace(),
571611
});
572612
}
613+
614+
if package_name == dependency_name
615+
&& (dependency.extra().is_none() || package.extra() == dependency.extra())
616+
&& (dependency.dev().is_none() || dependency.dev() == package.dev())
617+
&& workspace_members.contains(package_name)
618+
{
619+
output_hints.insert(PubGrubHint::DependsOnItself {
620+
package: package.clone(),
621+
});
622+
}
573623
}
574624
// Check for no versions due to `Requires-Python`.
575625
if matches!(
@@ -899,6 +949,8 @@ pub(crate) enum PubGrubHint {
899949
dependency: PubGrubPackage,
900950
workspace: bool,
901951
},
952+
/// A package depends on itself at an incompatible version.
953+
DependsOnItself { package: PubGrubPackage },
902954
/// A package was available on an index, but not at the correct version, and at least one
903955
/// subsequent index was not queried. As such, a compatible version may be available on an
904956
/// one of the remaining indexes.
@@ -963,6 +1015,9 @@ enum PubGrubHintCore {
9631015
dependency: PubGrubPackage,
9641016
workspace: bool,
9651017
},
1018+
DependsOnItself {
1019+
package: PubGrubPackage,
1020+
},
9661021
UncheckedIndex {
9671022
package: PubGrubPackage,
9681023
},
@@ -1027,6 +1082,7 @@ impl From<PubGrubHint> for PubGrubHintCore {
10271082
dependency,
10281083
workspace,
10291084
},
1085+
PubGrubHint::DependsOnItself { package } => Self::DependsOnItself { package },
10301086
PubGrubHint::UncheckedIndex { package, .. } => Self::UncheckedIndex { package },
10311087
PubGrubHint::UnauthorizedIndex { index } => Self::UnauthorizedIndex { index },
10321088
PubGrubHint::ForbiddenIndex { index } => Self::ForbiddenIndex { index },
@@ -1269,6 +1325,15 @@ impl std::fmt::Display for PubGrubHint {
12691325
dependency.cyan(),
12701326
)
12711327
}
1328+
Self::DependsOnItself { package } => {
1329+
write!(
1330+
f,
1331+
"{}{} The package `{}` depends on itself. This is likely a mistake. Consider removing the dependency.",
1332+
"hint".bold().cyan(),
1333+
":".bold(),
1334+
package.cyan(),
1335+
)
1336+
}
12721337
Self::UncheckedIndex {
12731338
package,
12741339
range,

crates/uv-resolver/src/resolver/mod.rs

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2453,8 +2453,24 @@ impl ForkState {
24532453
extra: ref dependency_extra,
24542454
dev: ref dependency_dev,
24552455
marker: ref dependency_marker,
2456-
..
24572456
} => {
2457+
debug_assert!(
2458+
dependency_extra.is_none(),
2459+
"Packages should depend on an extra proxy"
2460+
);
2461+
debug_assert!(
2462+
dependency_dev.is_none(),
2463+
"Packages should depend on a group proxy"
2464+
);
2465+
2466+
// Ignore self-dependencies (e.g., `tensorflow-macos` depends on `tensorflow-macos`),
2467+
// but allow groups to depend on other groups, or on the package itself.
2468+
if self_dev.is_none() {
2469+
if self_name == Some(dependency_name) {
2470+
continue;
2471+
}
2472+
}
2473+
24582474
let to_url = self.fork_urls.get(dependency_name);
24592475
let to_index = self.fork_indexes.get(dependency_name);
24602476
let edge = ResolutionDependencyEdge {
@@ -2478,8 +2494,15 @@ impl ForkState {
24782494
PubGrubPackageInner::Marker {
24792495
name: ref dependency_name,
24802496
marker: ref dependency_marker,
2481-
..
24822497
} => {
2498+
// Ignore self-dependencies (e.g., `tensorflow-macos` depends on `tensorflow-macos`),
2499+
// but allow groups to depend on other groups, or on the package itself.
2500+
if self_dev.is_none() {
2501+
if self_name == Some(dependency_name) {
2502+
continue;
2503+
}
2504+
}
2505+
24832506
let to_url = self.fork_urls.get(dependency_name);
24842507
let to_index = self.fork_indexes.get(dependency_name);
24852508
let edge = ResolutionDependencyEdge {
@@ -2504,8 +2527,14 @@ impl ForkState {
25042527
name: ref dependency_name,
25052528
extra: ref dependency_extra,
25062529
marker: ref dependency_marker,
2507-
..
25082530
} => {
2531+
if self_dev.is_none() {
2532+
debug_assert!(
2533+
self_name != Some(dependency_name),
2534+
"Extras should be flattened"
2535+
);
2536+
}
2537+
25092538
// Insert an edge from the dependent package to the extra package.
25102539
let to_url = self.fork_urls.get(dependency_name);
25112540
let to_index = self.fork_indexes.get(dependency_name);
@@ -2551,8 +2580,12 @@ impl ForkState {
25512580
name: ref dependency_name,
25522581
dev: ref dependency_dev,
25532582
marker: ref dependency_marker,
2554-
..
25552583
} => {
2584+
debug_assert!(
2585+
self_name != Some(dependency_name),
2586+
"Groups should be flattened"
2587+
);
2588+
25562589
// Add an edge from the dependent package to the dev package, but _not_ the
25572590
// base package.
25582591
let to_url = self.fork_urls.get(dependency_name);

0 commit comments

Comments
 (0)