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

Rename `Dependency.id` to `Dependency.distribution_id` (#4114) 

## Summary

I think this makes clearer that the `Dependency.id` is not an identifier
for the dependency itself.

No functional changes.
This commit is contained in:
Charlie Marsh 2024-06-07 11:28:54 -07:00 committed by GitHub
parent fa10679275
commit 7d1b7b99d9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 72 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
crates/uv-resolver/src/lock.rs
View File

@ -176,7 +176,7 @@ impl Lock {
}; };
for dep in deps { for dep in deps {
let dep_dist = self.find_by_id(&dep.id); let dep_dist = self.find_by_id(&dep.distribution_id);
if dep_dist if dep_dist
.marker .marker
.as_ref() .as_ref()
@ -343,7 +343,7 @@ impl TryFrom<LockWire> for Lock {
if dep1 == dep2 { if dep1 == dep2 {
return Err(LockError::duplicate_dependency( return Err(LockError::duplicate_dependency(
dist.id.clone(), dist.id.clone(),
dep1.id.clone(), dep1.clone(),
)); ));
} }
} }
@ -356,7 +356,7 @@ impl TryFrom<LockWire> for Lock {
if dep1 == dep2 { if dep1 == dep2 {
return Err(LockError::duplicate_dependency( return Err(LockError::duplicate_dependency(
dist.id.clone(), dist.id.clone(),
dep1.id.clone(), dep1.clone(),
)); ));
} }
} }
@ -370,7 +370,7 @@ impl TryFrom<LockWire> for Lock {
if dep1 == dep2 { if dep1 == dep2 {
return Err(LockError::duplicate_dependency( return Err(LockError::duplicate_dependency(
dist.id.clone(), dist.id.clone(),
dep1.id.clone(), dep1.clone(),
)); ));
} }
} }
@ -393,13 +393,13 @@ impl TryFrom<LockWire> for Lock {
// distribution. // distribution.
for dist in &wire.distributions { for dist in &wire.distributions {
for dep in &dist.dependencies { for dep in &dist.dependencies {
if let Some(index) = by_id.get(&dep.id) { if let Some(index) = by_id.get(&dep.distribution_id) {
let dep_dist = &wire.distributions[*index]; let dep_dist = &wire.distributions[*index];
if let Some(extra) = &dep.extra { if let Some(extra) = &dep.extra {
if !dep_dist.optional_dependencies.contains_key(extra) { if !dep_dist.optional_dependencies.contains_key(extra) {
return Err(LockError::unrecognized_extra( return Err(LockError::unrecognized_extra(
dist.id.clone(), dist.id.clone(),
dep.id.clone(), dep.clone(),
extra.clone(), extra.clone(),
)); ));
} }
@ -407,7 +407,7 @@ impl TryFrom<LockWire> for Lock {
} else { } else {
return Err(LockError::unrecognized_dependency( return Err(LockError::unrecognized_dependency(
dist.id.clone(), dist.id.clone(),
dep.id.clone(), dep.clone(),
)); ));
} }
} }
@ -415,13 +415,13 @@ impl TryFrom<LockWire> for Lock {
// Perform the same validation for optional dependencies. // Perform the same validation for optional dependencies.
for (extra, dependencies) in &dist.optional_dependencies { for (extra, dependencies) in &dist.optional_dependencies {
for dep in dependencies { for dep in dependencies {
if let Some(index) = by_id.get(&dep.id) { if let Some(index) = by_id.get(&dep.distribution_id) {
let dep_dist = &wire.distributions[*index]; let dep_dist = &wire.distributions[*index];
if let Some(extra) = &dep.extra { if let Some(extra) = &dep.extra {
if !dep_dist.optional_dependencies.contains_key(extra) { if !dep_dist.optional_dependencies.contains_key(extra) {
return Err(LockError::unrecognized_extra( return Err(LockError::unrecognized_extra(
dist.id.clone(), dist.id.clone(),
dep.id.clone(), dep.clone(),
extra.clone(), extra.clone(),
)); ));
} }
@ -429,7 +429,7 @@ impl TryFrom<LockWire> for Lock {
} else { } else {
return Err(LockError::unrecognized_dependency( return Err(LockError::unrecognized_dependency(
dist.id.clone(), dist.id.clone(),
dep.id.clone(), dep.clone(),
)); ));
} }
} }
@ -438,13 +438,13 @@ impl TryFrom<LockWire> for Lock {
// Perform the same validation for dev dependencies. // Perform the same validation for dev dependencies.
for (group, dependencies) in &dist.dev_dependencies { for (group, dependencies) in &dist.dev_dependencies {
for dep in dependencies { for dep in dependencies {
if let Some(index) = by_id.get(&dep.id) { if let Some(index) = by_id.get(&dep.distribution_id) {
let dep_dist = &wire.distributions[*index]; let dep_dist = &wire.distributions[*index];
if let Some(extra) = &dep.extra { if let Some(extra) = &dep.extra {
if !dep_dist.optional_dependencies.contains_key(extra) { if !dep_dist.optional_dependencies.contains_key(extra) {
return Err(LockError::unrecognized_extra( return Err(LockError::unrecognized_extra(
dist.id.clone(), dist.id.clone(),
dep.id.clone(), dep.clone(),
extra.clone(), extra.clone(),
)); ));
} }
@ -452,7 +452,7 @@ impl TryFrom<LockWire> for Lock {
} else { } else {
return Err(LockError::unrecognized_dependency( return Err(LockError::unrecognized_dependency(
dist.id.clone(), dist.id.clone(),
dep.id.clone(), dep.clone(),
)); ));
} }
} }
@ -759,7 +759,7 @@ impl DistributionId {
impl std::fmt::Display for DistributionId { impl std::fmt::Display for DistributionId {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{} {} {}", self.name, self.version, self.source) write!(f, "{}=={} @ {}", self.name, self.version, self.source)
} }
} }
@ -1466,24 +1466,27 @@ impl TryFrom<WheelWire> for Wheel {
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, serde::Deserialize)] #[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, serde::Deserialize)]
struct Dependency { struct Dependency {
#[serde(flatten)] #[serde(flatten)]
id: DistributionId, distribution_id: DistributionId,
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
extra: Option<ExtraName>, extra: Option<ExtraName>,
} }
impl Dependency { impl Dependency {
fn from_annotated_dist(annotated_dist: &AnnotatedDist) -> Dependency { fn from_annotated_dist(annotated_dist: &AnnotatedDist) -> Dependency {
let id = DistributionId::from_annotated_dist(annotated_dist); let distribution_id = DistributionId::from_annotated_dist(annotated_dist);
let extra = annotated_dist.extra.clone(); let extra = annotated_dist.extra.clone();
Dependency { id, extra } Dependency {
distribution_id,
extra,
}
} }
/// Returns the TOML representation of this dependency. /// Returns the TOML representation of this dependency.
fn to_toml(&self) -> Table { fn to_toml(&self) -> Table {
let mut table = Table::new(); let mut table = Table::new();
table.insert("name", value(self.id.name.to_string())); table.insert("name", value(self.distribution_id.name.to_string()));
table.insert("version", value(self.id.version.to_string())); table.insert("version", value(self.distribution_id.version.to_string()));
table.insert("source", value(self.id.source.to_string())); table.insert("source", value(self.distribution_id.source.to_string()));
if let Some(ref extra) = self.extra { if let Some(ref extra) = self.extra {
table.insert("extra", value(extra.to_string())); table.insert("extra", value(extra.to_string()));
} }
@ -1492,6 +1495,29 @@ impl Dependency {
} }
} }
impl std::fmt::Display for Dependency {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
if let Some(ref extra) = self.extra {
write!(
f,
"{}[{}]=={} @ {}",
self.distribution_id.name,
extra,
self.distribution_id.version,
self.distribution_id.source
)
} else {
write!(
f,
"{}=={} @ {}",
self.distribution_id.name,
self.distribution_id.version,
self.distribution_id.source
)
}
}
}
/// A single hash for a distribution artifact in a lock file. /// A single hash for a distribution artifact in a lock file.
/// ///
/// A hash is encoded as a single TOML string in the format /// A hash is encoded as a single TOML string in the format
@ -1557,8 +1583,8 @@ impl LockError {
} }
} }
fn duplicate_dependency(id: DistributionId, dependency_id: DistributionId) -> LockError { fn duplicate_dependency(id: DistributionId, dependency: Dependency) -> LockError {
let kind = LockErrorKind::DuplicateDependency { id, dependency_id }; let kind = LockErrorKind::DuplicateDependency { id, dependency };
LockError { LockError {
kind: Box::new(kind), kind: Box::new(kind),
} }
@ -1567,12 +1593,12 @@ impl LockError {
fn duplicate_optional_dependency( fn duplicate_optional_dependency(
id: DistributionId, id: DistributionId,
extra: ExtraName, extra: ExtraName,
dependency_id: DistributionId, dependency: Dependency,
) -> LockError { ) -> LockError {
let kind = LockErrorKind::DuplicateOptionalDependency { let kind = LockErrorKind::DuplicateOptionalDependency {
id, id,
extra, extra,
dependency_id, dependency,
}; };
LockError { LockError {
kind: Box::new(kind), kind: Box::new(kind),
@ -1582,12 +1608,12 @@ impl LockError {
fn duplicate_dev_dependency( fn duplicate_dev_dependency(
id: DistributionId, id: DistributionId,
group: GroupName, group: GroupName,
dependency_id: DistributionId, dependency: Dependency,
) -> LockError { ) -> LockError {
let kind = LockErrorKind::DuplicateDevDependency { let kind = LockErrorKind::DuplicateDevDependency {
id, id,
group, group,
dependency_id, dependency,
}; };
LockError { LockError {
kind: Box::new(kind), kind: Box::new(kind),
@ -1601,8 +1627,8 @@ impl LockError {
} }
} }
fn unrecognized_dependency(id: DistributionId, dependency_id: DistributionId) -> LockError { fn unrecognized_dependency(id: DistributionId, dependency: Dependency) -> LockError {
let err = UnrecognizedDependencyError { id, dependency_id }; let err = UnrecognizedDependencyError { id, dependency };
let kind = LockErrorKind::UnrecognizedDependency { err }; let kind = LockErrorKind::UnrecognizedDependency { err };
LockError { LockError {
kind: Box::new(kind), kind: Box::new(kind),
@ -1611,12 +1637,12 @@ impl LockError {
fn unrecognized_extra( fn unrecognized_extra(
id: DistributionId, id: DistributionId,
dependency_id: DistributionId, dependency: Dependency,
extra: ExtraName, extra: ExtraName,
) -> LockError { ) -> LockError {
let kind = LockErrorKind::UnrecognizedExtra { let kind = LockErrorKind::UnrecognizedExtra {
id, id,
dependency_id, dependency,
extra, extra,
}; };
LockError { LockError {
@ -1675,31 +1701,31 @@ impl std::fmt::Display for LockError {
} }
LockErrorKind::DuplicateDependency { LockErrorKind::DuplicateDependency {
ref id, ref id,
ref dependency_id, ref dependency,
} => { } => {
write!( write!(
f, f,
"for distribution `{id}`, found duplicate dependency `{dependency_id}`" "for distribution `{id}`, found duplicate dependency `{dependency}`"
) )
} }
LockErrorKind::DuplicateOptionalDependency { LockErrorKind::DuplicateOptionalDependency {
ref id, ref id,
ref extra, ref extra,
ref dependency_id, ref dependency,
} => { } => {
write!( write!(
f, f,
"for distribution `{id}[{extra}]`, found duplicate dependency `{dependency_id}`" "for distribution `{id}[{extra}]`, found duplicate dependency `{dependency}`"
) )
} }
LockErrorKind::DuplicateDevDependency { LockErrorKind::DuplicateDevDependency {
ref id, ref id,
ref group, ref group,
ref dependency_id, ref dependency,
} => { } => {
write!( write!(
f, f,
"for distribution `{id}:{group}`, found duplicate dependency `{dependency_id}`" "for distribution `{id}:{group}`, found duplicate dependency `{dependency}`"
) )
} }
LockErrorKind::InvalidFileUrl { .. } => { LockErrorKind::InvalidFileUrl { .. } => {
@ -1710,12 +1736,12 @@ impl std::fmt::Display for LockError {
} }
LockErrorKind::UnrecognizedExtra { LockErrorKind::UnrecognizedExtra {
ref id, ref id,
ref dependency_id, ref dependency,
ref extra, ref extra,
} => { } => {
write!( write!(
f, f,
"for distribution `{id}`, found dependency `{dependency_id}` with unrecognized extra `{extra}`" "for distribution `{id}`, found dependency `{dependency}` with unrecognized extra `{extra}`"
) )
} }
LockErrorKind::Hash { LockErrorKind::Hash {
@ -1773,7 +1799,7 @@ enum LockErrorKind {
/// found. /// found.
id: DistributionId, id: DistributionId,
/// The ID of the conflicting dependency. /// The ID of the conflicting dependency.
dependency_id: DistributionId, dependency: Dependency,
}, },
/// An error that occurs when there are multiple dependencies for the /// An error that occurs when there are multiple dependencies for the
/// same distribution that have identical identifiers, as part of the /// same distribution that have identical identifiers, as part of the
@ -1785,7 +1811,7 @@ enum LockErrorKind {
/// The name of the optional dependency group. /// The name of the optional dependency group.
extra: ExtraName, extra: ExtraName,
/// The ID of the conflicting dependency. /// The ID of the conflicting dependency.
dependency_id: DistributionId, dependency: Dependency,
}, },
/// An error that occurs when there are multiple dependencies for the /// An error that occurs when there are multiple dependencies for the
/// same distribution that have identical identifiers, as part of the /// same distribution that have identical identifiers, as part of the
@ -1797,7 +1823,7 @@ enum LockErrorKind {
/// The name of the dev dependency group. /// The name of the dev dependency group.
group: GroupName, group: GroupName,
/// The ID of the conflicting dependency. /// The ID of the conflicting dependency.
dependency_id: DistributionId, dependency: Dependency,
}, },
/// An error that occurs when the URL to a file for a wheel or /// An error that occurs when the URL to a file for a wheel or
/// source dist could not be converted to a structured `url::Url`. /// source dist could not be converted to a structured `url::Url`.
@ -1820,7 +1846,7 @@ enum LockErrorKind {
id: DistributionId, id: DistributionId,
/// The ID of the dependency that doesn't have a corresponding distribution /// The ID of the dependency that doesn't have a corresponding distribution
/// entry. /// entry.
dependency_id: DistributionId, dependency: Dependency,
/// The extra name that requested. /// The extra name that requested.
extra: ExtraName, extra: ExtraName,
}, },
@ -1863,7 +1889,7 @@ struct UnrecognizedDependencyError {
id: DistributionId, id: DistributionId,
/// The ID of the dependency that doesn't have a corresponding distribution /// The ID of the dependency that doesn't have a corresponding distribution
/// entry. /// entry.
dependency_id: DistributionId, dependency: Dependency,
} }
impl std::error::Error for UnrecognizedDependencyError {} impl std::error::Error for UnrecognizedDependencyError {}
@ -1872,11 +1898,11 @@ impl std::fmt::Display for UnrecognizedDependencyError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let UnrecognizedDependencyError { let UnrecognizedDependencyError {
ref id, ref id,
ref dependency_id, ref dependency,
} = *self; } = *self;
write!( write!(
f, f,
"found dependency `{dependency_id}` for `{id}` with no locked distribution" "found dependency `{dependency}` for `{id}` with no locked distribution"
) )
} }
} }

2
crates/uv-resolver/src/snapshots/uv_resolver__lock__tests__hash_required_present.snap
View File

@ -6,7 +6,7 @@ Err(
Error { Error {
inner: Error { inner: Error {
inner: TomlError { inner: TomlError {
message: "since the distribution `anyio 4.3.0 registry+https://pypi.org/simple` comes from a registry dependency, a hash was expected but one was not found for wheel", message: "since the distribution `anyio==4.3.0 @ registry+https://pypi.org/simple` comes from a registry dependency, a hash was expected but one was not found for wheel",
raw: None, raw: None,
keys: [], keys: [],
span: None, span: None,