Skip to content

Commit

Permalink
Skip override resolution in lock
Browse files Browse the repository at this point in the history
  • Loading branch information
@charliermarsh
charliermarsh committed Aug 21, 2024
1 parent d954a76 commit 8f2231b
Show file tree
Hide file tree
Showing 6 changed files with 233 additions and 23 deletions.
51 changes: 51 additions & 0 deletions crates/uv-resolver/src/lock.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
let constraints = self
.manifest
Expand Down Expand Up @@ -657,6 +677,7 @@ impl Lock {
&self,
workspace: &Workspace,
members: &[PackageName],
requirements: &[Requirement],
constraints: &[Requirement],
overrides: &[Requirement],
indexes: Option<&IndexLocations>,
Expand All @@ -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.
{
let expected: BTreeSet<_> = constraints
Expand Down Expand Up @@ -901,6 +945,8 @@ pub enum SatisfiesResult<'lock> {
Satisfied,
/// The lockfile uses a different set of workspace members.
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.
MismatchedConstraints(BTreeSet<Requirement>, BTreeSet<Requirement>),
/// The lockfile uses a different set of overrides.
Expand Down Expand Up @@ -947,6 +993,9 @@ pub struct ResolverManifest {
/// The workspace members included in the lockfile.
#[serde(default)]
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.
#[serde(default)]
constraints: BTreeSet<Requirement>,
Expand All @@ -958,11 +1007,13 @@ pub struct ResolverManifest {
impl ResolverManifest {
pub fn new(
members: impl IntoIterator<Item = PackageName>,
requirements: impl IntoIterator<Item = Requirement>,
constraints: impl IntoIterator<Item = Requirement>,
overrides: impl IntoIterator<Item = Requirement>,
) -> Self {
Self {
members: members.into_iter().collect(),
requirements: requirements.into_iter().collect(),
constraints: constraints.into_iter().collect(),
overrides: overrides.into_iter().collect(),
}
Expand Down
47 changes: 24 additions & 23 deletions crates/uv/src/commands/project/lock.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ use uv_git::ResolvedRepositoryReference;
use uv_normalize::{PackageName, DEV_DEPENDENCIES};
use uv_python::{Interpreter, PythonDownloads, PythonEnvironment, PythonPreference, PythonRequest};
use uv_requirements::upgrade::{read_lock_requirements, LockedRequirements};
use uv_requirements::NamedRequirementsResolver;
use uv_resolver::{
FlatIndex, Lock, Options, OptionsBuilder, PythonRequirement, RequiresPython, ResolverManifest,
ResolverMarkers, SatisfiesResult,
Expand All @@ -33,7 +32,6 @@ use uv_workspace::{DiscoveryOptions, SupportedEnvironments, Workspace};

use crate::commands::pip::loggers::{DefaultResolveLogger, ResolveLogger, SummaryResolveLogger};
use crate::commands::project::{find_requires_python, FoundInterpreter, ProjectError, SharedState};
use crate::commands::reporters::ResolverReporter;
use crate::commands::{pip, ExitStatus};
use crate::printer::Printer;
use crate::settings::{ResolverSettings, ResolverSettingsRef};
Expand Down Expand Up @@ -251,17 +249,12 @@ async fn do_lock(
sources,
} = settings;

// When locking, include the project itself (as editable).
// Collect the requirements, etc.
let requirements = workspace
.members_requirements()
.chain(workspace.root_requirements())
.map(UnresolvedRequirementSpecification::from)
.collect::<Vec<_>>();
let overrides = workspace
.overrides()
.root_requirements()
.into_iter()
.map(UnresolvedRequirementSpecification::from)
.collect::<Vec<_>>();
let overrides = workspace.overrides().into_iter().collect::<Vec<_>>();
let constraints = workspace.constraints();
let dev = vec![DEV_DEPENDENCIES.clone()];
let source_trees = vec![];
Expand Down Expand Up @@ -414,23 +407,13 @@ async fn do_lock(

let database = DistributionDatabase::new(&client, &build_dispatch, concurrency.downloads);

// Annoyingly, we have to resolve any unnamed overrides upfront.
let overrides = NamedRequirementsResolver::new(
overrides,
&hasher,
&state.index,
DistributionDatabase::new(&client, &build_dispatch, concurrency.downloads),
)
.with_reporter(ResolverReporter::from(printer))
.resolve()
.await?;

// If any of the resolution-determining settings changed, invalidate the lock.
let existing_lock = if let Some(existing_lock) = existing_lock {
match ValidatedLock::validate(
existing_lock,
workspace,
&members,
&requirements,
&constraints,
&overrides,
environments,
Expand Down Expand Up @@ -504,7 +487,11 @@ async fn do_lock(

// Resolve the requirements.
let resolution = pip::operations::resolve(
requirements,
workspace
.members_requirements()
.chain(requirements.iter().cloned())
.map(UnresolvedRequirementSpecification::from)
.collect(),
constraints.clone(),
overrides
.iter()
Expand Down Expand Up @@ -543,7 +530,12 @@ async fn do_lock(

let previous = existing_lock.map(ValidatedLock::into_lock);
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(
environments
.cloned()
Expand Down Expand Up @@ -573,6 +565,7 @@ impl ValidatedLock {
lock: Lock,
workspace: &Workspace,
members: &[PackageName],
requirements: &[Requirement],
constraints: &[Requirement],
overrides: &[Requirement],
environments: Option<&SupportedEnvironments>,
Expand Down Expand Up @@ -693,6 +686,7 @@ impl ValidatedLock {
.satisfies(
workspace,
members,
requirements,
constraints,
overrides,
indexes,
Expand All @@ -712,6 +706,13 @@ impl ValidatedLock {
);
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) => {
debug!(
"Ignoring existing lockfile due to mismatched constraints:\n Expected: {:?}\n Actual: {:?}",
Expand Down
139 changes: 139 additions & 0 deletions crates/uv/tests/lock.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10027,3 +10027,142 @@ fn lock_overlapping_environment() -> Result<()> {

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(())
}
Empty file added foo/README.md
View file
Empty file.
17 changes: 17 additions & 0 deletions foo/pyproject.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[tool.uv.workspace]
members = []

[tool.uv]
dev-dependencies = [
"mkdocs>=1.6, <1.7",
"mkdocs-material>=9.5.24, <9.6",
# Versioning of documentation
"mike>=2.1.1, <3",
# (Py)Markdown extensions
"mdx-truly-sane-lists >=1.3, <2",
"mdx-breakless-lists >=1.0.1, <1.1",
# Allows setting up redirects when renaming docs files
"mkdocs-redirects >=1.2.1, <1.3",
# Used for the CLI reference
"mkdocs-include-markdown-plugin >=6.0.4, <6.1",
]
2 changes: 2 additions & 0 deletions foo/uv.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8f2231b

Please sign in to comment.