mirror of
https://github.com/astral-sh/uv.git
synced 2025-11-03 13:14:41 +00:00
Invalidate uv.lock when virtual dev-dependencies change (#6291)
## Summary For non-virtual workspaces, these are covered by the _members_. But for virtual workspaces, they aren't captured anywhere else in the lock. So, we weren't invalidating `uv.lock` when the dev dependencies changed, which led to a panic. Closes https://github.com/astral-sh/uv/issues/6288
This commit is contained in:
parent
6f34a251e6
commit
2e02d579a0
14 changed files with 224 additions and 9 deletions
|
|
@ -567,6 +567,26 @@ impl Lock {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if !self.manifest.requirements.is_empty() {
|
||||||
|
let requirements = self
|
||||||
|
.manifest
|
||||||
|
.requirements
|
||||||
|
.iter()
|
||||||
|
.map(|requirement| {
|
||||||
|
serde::Serialize::serialize(
|
||||||
|
&requirement,
|
||||||
|
toml_edit::ser::ValueSerializer::new(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect::<Result<Vec<_>, _>>()?;
|
||||||
|
let requirements = match requirements.as_slice() {
|
||||||
|
[] => Array::new(),
|
||||||
|
[requirement] => Array::from_iter([requirement]),
|
||||||
|
requirements => each_element_on_its_line_array(requirements.iter()),
|
||||||
|
};
|
||||||
|
manifest_table.insert("requirements", value(requirements));
|
||||||
|
}
|
||||||
|
|
||||||
if !self.manifest.constraints.is_empty() {
|
if !self.manifest.constraints.is_empty() {
|
||||||
let constraints = self
|
let constraints = self
|
||||||
.manifest
|
.manifest
|
||||||
|
|
@ -657,6 +677,7 @@ impl Lock {
|
||||||
&self,
|
&self,
|
||||||
workspace: &Workspace,
|
workspace: &Workspace,
|
||||||
members: &[PackageName],
|
members: &[PackageName],
|
||||||
|
requirements: &[Requirement],
|
||||||
constraints: &[Requirement],
|
constraints: &[Requirement],
|
||||||
overrides: &[Requirement],
|
overrides: &[Requirement],
|
||||||
indexes: Option<&IndexLocations>,
|
indexes: Option<&IndexLocations>,
|
||||||
|
|
@ -679,6 +700,29 @@ impl Lock {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validate that the lockfile was generated with the same requirements.
|
||||||
|
{
|
||||||
|
let expected: BTreeSet<_> = requirements
|
||||||
|
.iter()
|
||||||
|
.cloned()
|
||||||
|
.map(|requirement| normalize_requirement(requirement, workspace))
|
||||||
|
.collect::<Result<_, _>>()?;
|
||||||
|
let actual: BTreeSet<_> = self
|
||||||
|
.manifest
|
||||||
|
.requirements
|
||||||
|
.iter()
|
||||||
|
.cloned()
|
||||||
|
.map(|requirement| normalize_requirement(requirement, workspace))
|
||||||
|
.collect::<Result<_, _>>()?;
|
||||||
|
if expected != actual {
|
||||||
|
debug!(
|
||||||
|
"Mismatched requirements:\n expected: {:?}\n found: {:?}",
|
||||||
|
expected, actual
|
||||||
|
);
|
||||||
|
return Ok(SatisfiesResult::MismatchedConstraints(expected, actual));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Validate that the lockfile was generated with the same constraints.
|
// Validate that the lockfile was generated with the same constraints.
|
||||||
{
|
{
|
||||||
let expected: BTreeSet<_> = constraints
|
let expected: BTreeSet<_> = constraints
|
||||||
|
|
@ -901,6 +945,8 @@ pub enum SatisfiesResult<'lock> {
|
||||||
Satisfied,
|
Satisfied,
|
||||||
/// The lockfile uses a different set of workspace members.
|
/// The lockfile uses a different set of workspace members.
|
||||||
MismatchedMembers(BTreeSet<PackageName>, &'lock BTreeSet<PackageName>),
|
MismatchedMembers(BTreeSet<PackageName>, &'lock BTreeSet<PackageName>),
|
||||||
|
/// The lockfile uses a different set of requirements.
|
||||||
|
MismatchedRequirements(BTreeSet<Requirement>, BTreeSet<Requirement>),
|
||||||
/// The lockfile uses a different set of constraints.
|
/// The lockfile uses a different set of constraints.
|
||||||
MismatchedConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
|
MismatchedConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
|
||||||
/// The lockfile uses a different set of overrides.
|
/// The lockfile uses a different set of overrides.
|
||||||
|
|
@ -947,6 +993,9 @@ pub struct ResolverManifest {
|
||||||
/// The workspace members included in the lockfile.
|
/// The workspace members included in the lockfile.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
members: BTreeSet<PackageName>,
|
members: BTreeSet<PackageName>,
|
||||||
|
/// The requirements provided to the resolver, exclusive of the workspace members.
|
||||||
|
#[serde(default)]
|
||||||
|
requirements: BTreeSet<Requirement>,
|
||||||
/// The constraints provided to the resolver.
|
/// The constraints provided to the resolver.
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
constraints: BTreeSet<Requirement>,
|
constraints: BTreeSet<Requirement>,
|
||||||
|
|
@ -958,11 +1007,13 @@ pub struct ResolverManifest {
|
||||||
impl ResolverManifest {
|
impl ResolverManifest {
|
||||||
pub fn new(
|
pub fn new(
|
||||||
members: impl IntoIterator<Item = PackageName>,
|
members: impl IntoIterator<Item = PackageName>,
|
||||||
|
requirements: impl IntoIterator<Item = Requirement>,
|
||||||
constraints: impl IntoIterator<Item = Requirement>,
|
constraints: impl IntoIterator<Item = Requirement>,
|
||||||
overrides: impl IntoIterator<Item = Requirement>,
|
overrides: impl IntoIterator<Item = Requirement>,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Self {
|
Self {
|
||||||
members: members.into_iter().collect(),
|
members: members.into_iter().collect(),
|
||||||
|
requirements: requirements.into_iter().collect(),
|
||||||
constraints: constraints.into_iter().collect(),
|
constraints: constraints.into_iter().collect(),
|
||||||
overrides: overrides.into_iter().collect(),
|
overrides: overrides.into_iter().collect(),
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -79,6 +79,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -86,6 +86,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -82,6 +82,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -141,6 +141,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -141,6 +141,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -141,6 +141,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -63,6 +63,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -59,6 +59,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -49,6 +49,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -49,6 +49,7 @@ Ok(
|
||||||
},
|
},
|
||||||
manifest: ResolverManifest {
|
manifest: ResolverManifest {
|
||||||
members: {},
|
members: {},
|
||||||
|
requirements: {},
|
||||||
constraints: {},
|
constraints: {},
|
||||||
overrides: {},
|
overrides: {},
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -249,11 +249,8 @@ async fn do_lock(
|
||||||
sources,
|
sources,
|
||||||
} = settings;
|
} = settings;
|
||||||
|
|
||||||
// When locking, include the project itself (as editable).
|
// Collect the requirements, etc.
|
||||||
let requirements = workspace
|
let requirements = workspace.root_requirements().collect::<Vec<_>>();
|
||||||
.members_requirements()
|
|
||||||
.chain(workspace.root_requirements())
|
|
||||||
.collect::<Vec<_>>();
|
|
||||||
let overrides = workspace.overrides().into_iter().collect::<Vec<_>>();
|
let overrides = workspace.overrides().into_iter().collect::<Vec<_>>();
|
||||||
let constraints = workspace.constraints();
|
let constraints = workspace.constraints();
|
||||||
let dev = vec![DEV_DEPENDENCIES.clone()];
|
let dev = vec![DEV_DEPENDENCIES.clone()];
|
||||||
|
|
@ -413,6 +410,7 @@ async fn do_lock(
|
||||||
existing_lock,
|
existing_lock,
|
||||||
workspace,
|
workspace,
|
||||||
&members,
|
&members,
|
||||||
|
&requirements,
|
||||||
&constraints,
|
&constraints,
|
||||||
&overrides,
|
&overrides,
|
||||||
environments,
|
environments,
|
||||||
|
|
@ -486,9 +484,9 @@ async fn do_lock(
|
||||||
|
|
||||||
// Resolve the requirements.
|
// Resolve the requirements.
|
||||||
let resolution = pip::operations::resolve(
|
let resolution = pip::operations::resolve(
|
||||||
requirements
|
workspace
|
||||||
.iter()
|
.members_requirements()
|
||||||
.cloned()
|
.chain(requirements.iter().cloned())
|
||||||
.map(UnresolvedRequirementSpecification::from)
|
.map(UnresolvedRequirementSpecification::from)
|
||||||
.collect(),
|
.collect(),
|
||||||
constraints.clone(),
|
constraints.clone(),
|
||||||
|
|
@ -529,7 +527,12 @@ async fn do_lock(
|
||||||
|
|
||||||
let previous = existing_lock.map(ValidatedLock::into_lock);
|
let previous = existing_lock.map(ValidatedLock::into_lock);
|
||||||
let lock = Lock::from_resolution_graph(&resolution)?
|
let lock = Lock::from_resolution_graph(&resolution)?
|
||||||
.with_manifest(ResolverManifest::new(members, constraints, overrides))
|
.with_manifest(ResolverManifest::new(
|
||||||
|
members,
|
||||||
|
requirements,
|
||||||
|
constraints,
|
||||||
|
overrides,
|
||||||
|
))
|
||||||
.with_supported_environments(
|
.with_supported_environments(
|
||||||
environments
|
environments
|
||||||
.cloned()
|
.cloned()
|
||||||
|
|
@ -559,6 +562,7 @@ impl ValidatedLock {
|
||||||
lock: Lock,
|
lock: Lock,
|
||||||
workspace: &Workspace,
|
workspace: &Workspace,
|
||||||
members: &[PackageName],
|
members: &[PackageName],
|
||||||
|
requirements: &[Requirement],
|
||||||
constraints: &[Requirement],
|
constraints: &[Requirement],
|
||||||
overrides: &[Requirement],
|
overrides: &[Requirement],
|
||||||
environments: Option<&SupportedEnvironments>,
|
environments: Option<&SupportedEnvironments>,
|
||||||
|
|
@ -679,6 +683,7 @@ impl ValidatedLock {
|
||||||
.satisfies(
|
.satisfies(
|
||||||
workspace,
|
workspace,
|
||||||
members,
|
members,
|
||||||
|
requirements,
|
||||||
constraints,
|
constraints,
|
||||||
overrides,
|
overrides,
|
||||||
indexes,
|
indexes,
|
||||||
|
|
@ -698,6 +703,13 @@ impl ValidatedLock {
|
||||||
);
|
);
|
||||||
Ok(Self::Preferable(lock))
|
Ok(Self::Preferable(lock))
|
||||||
}
|
}
|
||||||
|
SatisfiesResult::MismatchedRequirements(expected, actual) => {
|
||||||
|
debug!(
|
||||||
|
"Ignoring existing lockfile due to mismatched requirements:\n Expected: {:?}\n Actual: {:?}",
|
||||||
|
expected, actual
|
||||||
|
);
|
||||||
|
Ok(Self::Preferable(lock))
|
||||||
|
}
|
||||||
SatisfiesResult::MismatchedConstraints(expected, actual) => {
|
SatisfiesResult::MismatchedConstraints(expected, actual) => {
|
||||||
debug!(
|
debug!(
|
||||||
"Ignoring existing lockfile due to mismatched constraints:\n Expected: {:?}\n Actual: {:?}",
|
"Ignoring existing lockfile due to mismatched constraints:\n Expected: {:?}\n Actual: {:?}",
|
||||||
|
|
|
||||||
|
|
@ -3227,6 +3227,9 @@ fn add_virtual() -> Result<()> {
|
||||||
[options]
|
[options]
|
||||||
exclude-newer = "2024-03-25T00:00:00Z"
|
exclude-newer = "2024-03-25T00:00:00Z"
|
||||||
|
|
||||||
|
[manifest]
|
||||||
|
requirements = [{ name = "iniconfig" }]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "iniconfig"
|
name = "iniconfig"
|
||||||
version = "2.0.0"
|
version = "2.0.0"
|
||||||
|
|
|
||||||
|
|
@ -10027,3 +10027,142 @@ fn lock_overlapping_environment() -> Result<()> {
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Lock a requirement from PyPI.
|
||||||
|
#[test]
|
||||||
|
fn lock_virtual() -> Result<()> {
|
||||||
|
let context = TestContext::new("3.12");
|
||||||
|
|
||||||
|
let pyproject_toml = context.temp_dir.child("pyproject.toml");
|
||||||
|
pyproject_toml.write_str(
|
||||||
|
r#"
|
||||||
|
[tool.uv.workspace]
|
||||||
|
members = []
|
||||||
|
|
||||||
|
[tool.uv]
|
||||||
|
dev-dependencies = [
|
||||||
|
"anyio"
|
||||||
|
]
|
||||||
|
"#,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
uv_snapshot!(context.filters(), context.lock(), @r###"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
Resolved 3 packages in [TIME]
|
||||||
|
"###);
|
||||||
|
|
||||||
|
let lock = fs_err::read_to_string(context.temp_dir.join("uv.lock")).unwrap();
|
||||||
|
|
||||||
|
insta::with_settings!({
|
||||||
|
filters => context.filters(),
|
||||||
|
}, {
|
||||||
|
assert_snapshot!(
|
||||||
|
lock, @r###"
|
||||||
|
version = 1
|
||||||
|
requires-python = ">=3.12"
|
||||||
|
|
||||||
|
[options]
|
||||||
|
exclude-newer = "2024-03-25T00:00:00Z"
|
||||||
|
|
||||||
|
[manifest]
|
||||||
|
requirements = [{ name = "anyio" }]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "anyio"
|
||||||
|
version = "4.3.0"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
dependencies = [
|
||||||
|
{ name = "idna" },
|
||||||
|
{ name = "sniffio" },
|
||||||
|
]
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/db/4d/3970183622f0330d3c23d9b8a5f52e365e50381fd484d08e3285104333d3/anyio-4.3.0.tar.gz", hash = "sha256:f75253795a87df48568485fd18cdd2a3fa5c4f7c5be8e5e36637733fce06fed6", size = 159642 }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/14/fd/2f20c40b45e4fb4324834aea24bd4afdf1143390242c0b33774da0e2e34f/anyio-4.3.0-py3-none-any.whl", hash = "sha256:048e05d0f6caeed70d731f3db756d35dcc1f35747c8c403364a8332c630441b8", size = 85584 },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "idna"
|
||||||
|
version = "3.6"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/bf/3f/ea4b9117521a1e9c50344b909be7886dd00a519552724809bb1f486986c2/idna-3.6.tar.gz", hash = "sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca", size = 175426 }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/c2/e7/a82b05cf63a603df6e68d59ae6a68bf5064484a0718ea5033660af4b54a9/idna-3.6-py3-none-any.whl", hash = "sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f", size = 61567 },
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "sniffio"
|
||||||
|
version = "1.3.1"
|
||||||
|
source = { registry = "https://pypi.org/simple" }
|
||||||
|
sdist = { url = "https://files.pythonhosted.org/packages/a2/87/a6771e1546d97e7e041b6ae58d80074f81b7d5121207425c964ddf5cfdbd/sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc", size = 20372 }
|
||||||
|
wheels = [
|
||||||
|
{ url = "https://files.pythonhosted.org/packages/e9/44/75a9c9421471a6c4805dbf2356f7c181a29c1879239abab1ea2cc8f38b40/sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2", size = 10235 },
|
||||||
|
]
|
||||||
|
"###
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Re-run with `--locked`.
|
||||||
|
uv_snapshot!(context.filters(), context.lock().arg("--locked"), @r###"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
Resolved 3 packages in [TIME]
|
||||||
|
"###);
|
||||||
|
|
||||||
|
// Re-run with `--offline`. We shouldn't need a network connection to validate an
|
||||||
|
// already-correct lockfile with immutable metadata.
|
||||||
|
uv_snapshot!(context.filters(), context.lock().arg("--locked").arg("--offline").arg("--no-cache"), @r###"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
Resolved 3 packages in [TIME]
|
||||||
|
"###);
|
||||||
|
|
||||||
|
// Add `iniconfig`.
|
||||||
|
pyproject_toml.write_str(
|
||||||
|
r#"
|
||||||
|
[tool.uv.workspace]
|
||||||
|
members = []
|
||||||
|
|
||||||
|
[tool.uv]
|
||||||
|
dev-dependencies = [
|
||||||
|
"anyio",
|
||||||
|
"iniconfig"
|
||||||
|
]
|
||||||
|
"#,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
uv_snapshot!(context.filters(), context.lock(), @r###"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
Resolved 4 packages in [TIME]
|
||||||
|
Added iniconfig v2.0.0
|
||||||
|
"###);
|
||||||
|
|
||||||
|
uv_snapshot!(context.filters(), context.sync().arg("--frozen"), @r###"
|
||||||
|
success: true
|
||||||
|
exit_code: 0
|
||||||
|
----- stdout -----
|
||||||
|
|
||||||
|
----- stderr -----
|
||||||
|
Prepared 4 packages in [TIME]
|
||||||
|
Installed 4 packages in [TIME]
|
||||||
|
+ anyio==4.3.0
|
||||||
|
+ idna==3.6
|
||||||
|
+ iniconfig==2.0.0
|
||||||
|
+ sniffio==1.3.1
|
||||||
|
"###);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue