Skip to content

Use a 'minor' version field (revision) in the lockfile #11500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zanieb merged 2 commits into from
Feb 14, 2025
Merged

Use a 'minor' version field (revision) in the lockfile #11500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9570a74
Use a 'minor' version field in the lockfile
charliermarsh Feb 14, 2025
d11e76c
Add version check
zanieb Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 71 additions & 45 deletions crates/uv-resolver/src/lock/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ mod tree;
/// The current version of the lockfile format.
pub const VERSION: u32 = 1;

/// The current revision of the lockfile format.
const REVISION: u32 = 1;

static LINUX_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
let pep508 = MarkerTree::from_str("os_name == 'posix' and sys_platform == 'linux'").unwrap();
UniversalMarker::new(pep508, ConflictMarker::TRUE)
Expand Down Expand Up @@ -101,7 +104,21 @@ static X86_MARKERS: LazyLock<UniversalMarker> = LazyLock::new(|| {
#[derive(Clone, Debug, serde::Deserialize)]
#[serde(try_from = "LockWire")]
pub struct Lock {
/// The (major) version of the lockfile format.
///
/// Changes to the major version indicate backwards- and forwards-incompatible changes to the
/// lockfile format. A given uv version only supports a single major version of the lockfile
/// format.
///
/// In other words, a version of uv that supports version 2 of the lockfile format will not be
/// able to read lockfiles generated under version 1 or 3.
version: u32,
/// The revision of the lockfile format.
///
/// Changes to the revision indicate backwards-compatible changes to the lockfile format.
/// In other words, versions of uv that only support revision 1 _will_ be able to read lockfiles
/// with a revision greater than 1 (though they may ignore newer fields).
revision: u32,
/// If this lockfile was built from a forking resolution with non-identical forks, store the
/// forks in the lockfile so we can recreate them in subsequent resolutions.
fork_markers: Vec<UniversalMarker>,
Expand Down Expand Up @@ -262,6 +279,7 @@ impl Lock {
};
let lock = Self::new(
VERSION,
REVISION,
packages,
requires_python,
options,
Expand Down Expand Up @@ -347,6 +365,7 @@ impl Lock {
/// Initialize a [`Lock`] from a list of [`Package`] entries.
fn new(
version: u32,
revision: u32,
mut packages: Vec<Package>,
requires_python: RequiresPython,
options: ResolverOptions,
Expand Down Expand Up @@ -500,6 +519,7 @@ impl Lock {
}
let lock = Self {
version,
revision,
fork_markers,
conflicts,
supported_environments,
Expand Down Expand Up @@ -550,6 +570,11 @@ impl Lock {
self.version
}

/// Returns the lockfile revision.
pub fn revision(&self) -> u32 {
self.revision
}

/// Returns the number of packages in the lockfile.
pub fn len(&self) -> usize {
self.packages.len()
Expand Down Expand Up @@ -661,6 +686,10 @@ impl Lock {
let mut doc = toml_edit::DocumentMut::new();
doc.insert("version", value(i64::from(self.version)));

if self.revision > 0 {
doc.insert("revision", value(i64::from(self.revision)));
}

doc.insert("requires-python", value(self.requires_python.to_string()));

if !self.fork_markers.is_empty() {
Expand Down Expand Up @@ -981,7 +1010,6 @@ impl Lock {
.metadata
.requires_dist
.iter()
.flatten()
.cloned()
.map(|requirement| normalize_requirement(requirement, root))
.collect::<Result<_, _>>()?;
Expand Down Expand Up @@ -1662,6 +1690,7 @@ impl ResolverManifest {
#[serde(rename_all = "kebab-case")]
struct LockWire {
version: u32,
revision: Option<u32>,
requires_python: RequiresPython,
/// If this lockfile was built from a forking resolution with non-identical forks, store the
/// forks in the lockfile so we can recreate them in subsequent resolutions.
Expand Down Expand Up @@ -1719,6 +1748,7 @@ impl TryFrom<LockWire> for Lock {
.collect();
let lock = Lock::new(
wire.version,
wire.revision.unwrap_or(0),
packages,
wire.requires_python,
wire.options,
Expand Down Expand Up @@ -1778,32 +1808,28 @@ impl Package {
let sdist = SourceDist::from_annotated_dist(&id, annotated_dist)?;
let wheels = Wheel::from_annotated_dist(annotated_dist)?;
let requires_dist = if id.source.is_immutable() {
None
BTreeSet::default()
} else {
Some(
annotated_dist
.metadata
.as_ref()
.expect("metadata is present")
.requires_dist
.iter()
.cloned()
.map(|requirement| requirement.relative_to(root))
.collect::<Result<_, _>>()
.map_err(LockErrorKind::RequirementRelativePath)?,
)
annotated_dist
.metadata
.as_ref()
.expect("metadata is present")
.requires_dist
.iter()
.cloned()
.map(|requirement| requirement.relative_to(root))
.collect::<Result<_, _>>()
.map_err(LockErrorKind::RequirementRelativePath)?
};
let provides_extras = if id.source.is_immutable() {
None
Vec::default()
} else {
Some(
annotated_dist
.metadata
.as_ref()
.expect("metadata is present")
.provides_extras
.clone(),
)
annotated_dist
.metadata
.as_ref()
.expect("metadata is present")
.provides_extras
.clone()
};
let dependency_groups = if id.source.is_immutable() {
BTreeMap::default()
Expand Down Expand Up @@ -2418,22 +2444,10 @@ impl Package {
{
let mut metadata_table = Table::new();

// Even output the empty list to signal it's *known* empty.
if let Some(provides_extras) = &self.metadata.provides_extras {
let provides_extras = provides_extras
.iter()
.map(|extra| {
serde::Serialize::serialize(&extra, toml_edit::ser::ValueSerializer::new())
})
.collect::<Result<Vec<_>, _>>()?;
// This is just a list of names, so linebreaking it is excessive.
let provides_extras = Array::from_iter(provides_extras);
metadata_table.insert("provides-extras", value(provides_extras));
}

// Even output the empty set to signal it's *known* empty.
if let Some(requires_dist) = &self.metadata.requires_dist {
let requires_dist = requires_dist
if !self.metadata.requires_dist.is_empty() {
let requires_dist = self
.metadata
.requires_dist
.iter()
.map(|requirement| {
serde::Serialize::serialize(
Expand Down Expand Up @@ -2474,6 +2488,20 @@ impl Package {
}
}

if !self.metadata.provides_extras.is_empty() {
let provides_extras = self
.metadata
.provides_extras
.iter()
.map(|extra| {
serde::Serialize::serialize(&extra, toml_edit::ser::ValueSerializer::new())
})
.collect::<Result<Vec<_>, _>>()?;
// This is just a list of names, so linebreaking it is excessive.
let provides_extras = Array::from_iter(provides_extras);
metadata_table.insert("provides-extras", value(provides_extras));
}

if !metadata_table.is_empty() {
table.insert("metadata", Item::Table(metadata_table));
}
Expand Down Expand Up @@ -2619,8 +2647,8 @@ impl Package {
}

/// Returns the extras the package provides, if any.
pub fn provides_extras(&self) -> Option<&Vec<ExtraName>> {
self.metadata.provides_extras.as_ref()
pub fn provides_extras(&self) -> &[ExtraName] {
&self.metadata.provides_extras
}
}

Expand Down Expand Up @@ -2665,12 +2693,10 @@ struct PackageWire {
#[derive(Clone, Default, Debug, Eq, PartialEq, serde::Deserialize)]
#[serde(rename_all = "kebab-case")]
struct PackageMetadata {
// The Options here are so we can distinguish "no info available"
// from "known and empty".
#[serde(default)]
requires_dist: Option<BTreeSet<Requirement>>,
requires_dist: BTreeSet<Requirement>,
#[serde(default)]
provides_extras: Option<Vec<ExtraName>>,
provides_extras: Vec<ExtraName>,
#[serde(default, rename = "requires-dev", alias = "dependency-groups")]
dependency_groups: BTreeMap<GroupName, BTreeSet<Requirement>>,
}
Expand Down
5 changes: 3 additions & 2 deletions crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_optional_missing.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ expression: result
Ok(
Lock {
version: 1,
revision: 0,
fork_markers: [],
conflicts: Conflicts(
[],
Expand Down Expand Up @@ -86,8 +87,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down
5 changes: 3 additions & 2 deletions crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_optional_present.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ expression: result
Ok(
Lock {
version: 1,
revision: 0,
fork_markers: [],
conflicts: Conflicts(
[],
Expand Down Expand Up @@ -93,8 +94,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down
5 changes: 3 additions & 2 deletions crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_required_present.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ expression: result
Ok(
Lock {
version: 1,
revision: 0,
fork_markers: [],
conflicts: Conflicts(
[],
Expand Down Expand Up @@ -89,8 +90,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down
9 changes: 5 additions & 4 deletions ...r/src/lock/snapshots/uv_resolver__lock__tests__missing_dependency_source_unambiguous.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ expression: result
Ok(
Lock {
version: 1,
revision: 0,
fork_markers: [],
conflicts: Conflicts(
[],
Expand Down Expand Up @@ -79,8 +80,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down Expand Up @@ -149,8 +150,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down
9 changes: 5 additions & 4 deletions ...ck/snapshots/uv_resolver__lock__tests__missing_dependency_source_version_unambiguous.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ expression: result
Ok(
Lock {
version: 1,
revision: 0,
fork_markers: [],
conflicts: Conflicts(
[],
Expand Down Expand Up @@ -79,8 +80,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down Expand Up @@ -149,8 +150,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down
13 changes: 7 additions & 6 deletions ...lver/src/lock/snapshots/uv_resolver__lock__tests__missing_dependency_version_dynamic.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ expression: result
Ok(
Lock {
version: 1,
revision: 0,
fork_markers: [],
conflicts: Conflicts(
[],
Expand Down Expand Up @@ -54,8 +55,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down Expand Up @@ -101,8 +102,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down Expand Up @@ -165,8 +166,8 @@ Ok(
optional_dependencies: {},
dependency_groups: {},
metadata: PackageMetadata {
requires_dist: None,
provides_extras: None,
requires_dist: {},
provides_extras: [],
dependency_groups: {},
},
},
Expand Down
Loading