diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 13224adc7f9f..41f25048dc3c 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3283,6 +3283,15 @@ pub struct SyncArgs { value_parser = parse_maybe_string, )] pub python: Option>, + + /// Check if the Python environment is synchronized with the project. + /// + /// If the environment is not up to date, uv will exit with an error. + #[arg(long, overrides_with("no_check"))] + pub check: bool, + + #[arg(long, overrides_with("check"), hide = true)] + pub no_check: bool, } #[derive(Args)] diff --git a/crates/uv-configuration/src/dry_run.rs b/crates/uv-configuration/src/dry_run.rs index 528e31654676..cf28a1f6b2e1 100644 --- a/crates/uv-configuration/src/dry_run.rs +++ b/crates/uv-configuration/src/dry_run.rs @@ -2,6 +2,9 @@ pub enum DryRun { /// The operation should execute in dry run mode. Enabled, + /// The operation should execute in dry run mode and check if the current environment is + /// synced. + Check, /// The operation should execute in normal mode. #[default] Disabled, @@ -19,6 +22,6 @@ impl DryRun { /// Returns `true` if dry run mode is enabled. pub const fn enabled(&self) -> bool { - matches!(self, DryRun::Enabled) + matches!(self, DryRun::Enabled) || matches!(self, DryRun::Check) } } diff --git a/crates/uv/src/commands/pip/operations.rs b/crates/uv/src/commands/pip/operations.rs index 60f1cc4fbc7f..9979207b8b25 100644 --- a/crates/uv/src/commands/pip/operations.rs +++ b/crates/uv/src/commands/pip/operations.rs @@ -438,7 +438,7 @@ pub(crate) async fn install( .context("Failed to determine installation plan")?; if dry_run.enabled() { - report_dry_run(resolution, plan, modifications, start, printer)?; + report_dry_run(dry_run, resolution, plan, modifications, start, printer)?; return Ok(Changelog::default()); } @@ -665,6 +665,7 @@ pub(crate) fn report_target_environment( /// Report on the results of a dry-run installation. fn report_dry_run( + dry_run: DryRun, resolution: &Resolution, plan: Plan, modifications: Modifications, @@ -788,6 +789,10 @@ fn report_dry_run( } } + if matches!(dry_run, DryRun::Check) { + return Err(Error::OutdatedEnvironment); + } + Ok(()) } @@ -859,4 +864,7 @@ pub(crate) enum Error { #[error(transparent)] Anyhow(#[from] anyhow::Error), + + #[error("The environment is outdated; run `{}` to update the environment", "uv sync".cyan())] + OutdatedEnvironment, } diff --git a/crates/uv/src/settings.rs b/crates/uv/src/settings.rs index a9674b3b0638..9e1bfefcbdc7 100644 --- a/crates/uv/src/settings.rs +++ b/crates/uv/src/settings.rs @@ -1074,6 +1074,8 @@ impl SyncSettings { package, script, python, + check, + no_check, } = args; let install_mirrors = filesystem .clone() @@ -1085,10 +1087,17 @@ impl SyncSettings { filesystem, ); + let check = flag(check, no_check).unwrap_or_default(); + let dry_run = if check { + DryRun::Check + } else { + DryRun::from_args(dry_run) + }; + Self { locked, frozen, - dry_run: DryRun::from_args(dry_run), + dry_run, script, active: flag(active, no_active), extras: ExtrasSpecification::from_args( diff --git a/crates/uv/tests/it/sync.rs b/crates/uv/tests/it/sync.rs index edd69abec35e..18ac85d3d650 100644 --- a/crates/uv/tests/it/sync.rs +++ b/crates/uv/tests/it/sync.rs @@ -352,6 +352,68 @@ fn mixed_requires_python() -> Result<()> { Ok(()) } +#[test] +fn check() -> Result<()> { + let context = TestContext::new("3.12"); + + let pyproject_toml = context.temp_dir.child("pyproject.toml"); + pyproject_toml.write_str( + r#" + [project] + name = "project" + version = "0.1.0" + requires-python = ">=3.12" + dependencies = ["iniconfig"] + "#, + )?; + + // Running `uv sync --check` should fail. + uv_snapshot!(context.filters(), context.sync().arg("--check"), @r###" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + Discovered existing environment at: .venv + Resolved 2 packages in [TIME] + Would create lockfile at: uv.lock + Would download 1 package + Would install 1 package + + iniconfig==2.0.0 + error: The environment is outdated; run `uv sync` to update the environment + "###); + + // Sync the environment. + uv_snapshot!(context.filters(), context.sync(), @r###" + success: true + exit_code: 0 + ----- stdout ----- + + ----- stderr ----- + Resolved 2 packages in [TIME] + Prepared 1 package in [TIME] + Installed 1 package in [TIME] + + iniconfig==2.0.0 + "###); + + assert!(context.temp_dir.child("uv.lock").exists()); + + // Running `uv sync --check` should pass now that the environment is up to date. + uv_snapshot!(context.filters(), context.sync().arg("--check"), @r###" + success: true + exit_code: 0 + ----- stdout ----- + + ----- stderr ----- + Discovered existing environment at: .venv + Resolved 2 packages in [TIME] + Found up-to-date lockfile at: uv.lock + Audited 1 package in [TIME] + Would make no changes + "###); + Ok(()) +} + /// Sync development dependencies in a (legacy) non-project workspace root. #[test] fn sync_legacy_non_project_dev_dependencies() -> Result<()> { diff --git a/docs/reference/cli.md b/docs/reference/cli.md index d9c428a8146f..3c8c5ac29cb8 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -1513,6 +1513,10 @@ uv sync [OPTIONS]

To view the location of the cache directory, run uv cache dir.

May also be set with the UV_CACHE_DIR environment variable.

+
--check

Check if the Python environment is synchronized with the project.

+ +

If the environment is not up to date, uv will exit with an error.

+
--color color-choice

Control the use of color in output.

By default, uv will automatically detect support for colors when writing to a terminal.