Add `--dry-run` flag to `uv pip install` by JacobCoffee · Pull Request #1436 · astral-sh/uv

JacobCoffee · 2024-02-16T05:42:24Z

What

Adds a --dry-run flag that ejects out of the installation process early (but after resolution) and displays only what would have installed

Closes

Closes #1244

Out of Scope

I think it may be nice to include a dry-run flag for uninstall even though pip doesn't implement this... thinking Would uninstall X packages: ...

JacobCoffee · 2024-02-16T07:17:43Z

Sorry if this is a bad way to get the version? It felt bad, anyway...
I'm not sure if we do or can store version at resolution time and use it in dry_run, install, validate, etc.

JacobCoffee · 2024-02-16T07:41:27Z

Might be cool to have a dry-run flag for uninstalling although not native to pip

crates/uv/src/commands/pip_install.rs

JacobCoffee · 2024-02-16T07:59:08Z

On the failing CI, I had some failures do to order in stdout there... but I'm wondering how we keep it consistent?

zanieb · 2024-02-17T04:24:59Z

Hey @JacobCoffee, thanks for the pull request! I think we'll actually want to implement this a bit differently e.g. by passing the dry run flag into install

uv/crates/uv/src/commands/pip_install.rs

Line 477 in 896ab1c

async fn install(

then we can use our existing display which will also show which versions we would remove (and has a sorting implementation for deterministic output)

uv/crates/uv/src/commands/pip_install.rs

Line 642 in 896ab1c

for event in reinstalls

We'll just need to tweak the install function to avoid doing any downloads, uninstalls, builds, or installs when the flag is set.

zanieb · 2024-02-22T02:13:38Z

I'll give this a try tomorrow!

zanieb · 2024-02-23T00:28:23Z

Hey! I got a chance to play with this today. I'm thinking we should match our normal output much more closely.

I put up a commit for you to build off of at #1890

We still need more test coverage i.e. install a dependency of a package first then dry run install what do we show? or install an old version then dry run install with --upgrade

JacobCoffee · 2024-02-25T19:46:19Z

Just for my notes, i am running into an issue where in testing it passes with 2 $package==$version, but in CLI usage i get 4 ====

➜ ./target/debug/uv pip install litestar==2.0.0 --dry-run --strict
Resolved 17 packages in 974ms
Would download 2 packages
Would install 17 packages
 + anyio====4.3.0
 + litestar====2.0.0
 + faker====23.2.1
 + fast-query-parsers==1.0.3

But removing the == printer config from the +/- sections remove it from the testing :|

zanieb · 2024-02-28T18:35:10Z

@JacobCoffee I'm on vacation this week but let me know when this is ready for review again

JacobCoffee · 2024-03-01T03:54:25Z

sorry ive not wrapped this - i think my remaining issue is the 4 ====, but ive just had surgery so im down for a bit on my hard thinking 😅

zanieb · 2024-03-03T03:35:50Z

I can give it a look! Get better :)

zanieb · 2024-03-04T23:10:28Z

The issue is that InstalledVersion which comes from cached distributions includes == already (fixed by fee46b3).

# Conflicts: # crates/uv/tests/pip_install.rs

crates/uv/tests/pip_install.rs

# Conflicts: # crates/uv/src/commands/mod.rs # crates/uv/tests/pip_install.rs

zanieb · 2024-03-06T02:19:28Z

I think this is vaguely ready for review

zanieb · 2024-03-06T02:21:09Z

crates/uv/src/commands/pip_install.rs

+        // Nothing to do.
+        if remote.is_empty() && local.is_empty() && reinstalls.is_empty() {
+            let s = if resolution.len() == 1 { "" } else { "s" };
+            writeln!(
+                printer,
+                "{}",
+                format!(
+                    "Audited {} in {}",
+                    format!("{} package{}", resolution.len(), s).bold(),
+                    elapsed(start.elapsed())
+                )
+                .dimmed()
+            )?;
+            writeln!(printer, "Would make no changes")?;
+            return Ok(());
+        }


I believe this is redundant as it is handled before this function is called

crates/uv/src/commands/pip_install.rs

# Conflicts: # crates/uv/src/commands/pip_install.rs

# Conflicts: # crates/uv/tests/pip_install.rs

## Summary This proposes adding the command line option `uv pip uninstall --dry-run ...`, complementing the existing `uv pip install --dry-run ...` added for #1244 in #1436. This option does not exist in PyPA's `pip uninstall`, if adopted it would be unique to `uv pip`. The code should be considered PoC, it is baby's first Rust. The initial motivation was while investigating moreati/ansible-uv#2 - to allow Ansible module `moreati.uv.pip` to work with`state: absent` in "check_mode" (Ansible's equivalent of a dry run), without requiring `packaging` or `setuptools`. ## Test Plan One new unit test has been added. I pedge to add more if the feature is desired/accepted Example usage ```console ➜ uv git:(pip-uninstall--dry-run) rm -rf .venv ➜ uv git:(pip-uninstall--dry-run) ./target/debug/uv venv Using CPython 3.13.0 Creating virtual environment at: .venv Activate with: source .venv/bin/activate ➜ uv git:(pip-uninstall--dry-run) ./target/debug/uv pip install httpx Resolved 7 packages in 178ms Prepared 5 packages in 60ms Installed 7 packages in 15ms + anyio==4.6.2.post1 + certifi==2024.8.30 + h11==0.14.0 + httpcore==1.0.7 + httpx==0.28.0 + idna==3.10 + sniffio==1.3.1 ➜ uv git:(pip-uninstall--dry-run) ./target/debug/uv pip uninstall --dry-run httpx Would uninstall 1 package - httpx==0.28.0 ➜ uv git:(pip-uninstall--dry-run) ./target/debug/uv pip list Package Version -------- ----------- anyio 4.6.2.post1 certifi 2024.8.30 h11 0.14.0 httpcore 1.0.7 httpx 0.28.0 idna 3.10 sniffio 1.3.1 ``` --------- Co-authored-by: Charlie Marsh <[email protected]>

JacobCoffee marked this pull request as draft February 16, 2024 05:42

This comment was marked as outdated.

Sign in to view

JacobCoffee commented Feb 16, 2024

View reviewed changes

crates/uv/src/commands/pip_install.rs Outdated Show resolved Hide resolved

JacobCoffee marked this pull request as ready for review February 16, 2024 07:59

zanieb self-requested a review February 16, 2024 17:09

zanieb self-assigned this Feb 16, 2024

zanieb marked this pull request as draft February 17, 2024 04:25

This comment was marked as outdated.

Sign in to view

JacobCoffee added 4 commits February 25, 2024 12:13

feat(pip-install): add --dry-run flag

ea54bee

feat(pip-install): properly print versions

9588802

test(pip-install): attempt to add (probably shitty) test

ff02255

feat(pip-install): move dry run into install function

5cd1473

JacobCoffee force-pushed the 1244-pip-install-dry-run-flag branch from b71ae74 to 5cd1473 Compare February 25, 2024 19:31

feat(pip-install): add tests, match prod formatting, add DryRunEvent

6892b17

zanieb mentioned this pull request Mar 3, 2024

Add --dry-run flag to uv pip install #1890

Closed

Fix duplicate == signs in display

fee46b3

zanieb added 3 commits March 4, 2024 17:18

Append tests to main

7eb0f93

Merge branch 'main' into 1244-pip-install-dry-run-flag

44f5e8e

# Conflicts: # crates/uv/tests/pip_install.rs

Remove unncessary to_string()

0f5a423

Clean up test cases

d5ef665

zanieb reviewed Mar 4, 2024

View reviewed changes

crates/uv/tests/pip_install.rs Outdated Show resolved Hide resolved

zanieb added 6 commits March 5, 2024 20:05

Fix display of added URLs

1b4ca0b

Add uninstall URL dependency test case

861f805

Use installed_version display for uninstalls

91ad98b

Display message when no changes would be mad

3f75e84

Include tests from main

33e723a

Merge branch 'main' into 1244-pip-install-dry-run-flag

a12d9b5

# Conflicts: # crates/uv/src/commands/mod.rs # crates/uv/tests/pip_install.rs

zanieb requested a review from charliermarsh March 6, 2024 02:19

zanieb reviewed Mar 6, 2024

View reviewed changes

crates/uv/src/commands/pip_install.rs Outdated Show resolved Hide resolved

zanieb added 3 commits March 5, 2024 21:54

Merge branch 'main' into 1244-pip-install-dry-run-flag

22dcb9e

# Conflicts: # crates/uv/src/commands/pip_install.rs

Ignore lint

415a4f4

Fix extraneous comma

73c0984

zanieb marked this pull request as ready for review March 7, 2024 17:43

zanieb added 2 commits March 7, 2024 11:46

Copy tests from main

85b06e9

Merge branch 'main' into 1244-pip-install-dry-run-flag

89f723e

# Conflicts: # crates/uv/tests/pip_install.rs

charliermarsh approved these changes Mar 12, 2024

View reviewed changes

zanieb added 2 commits March 12, 2024 00:29

Copy tests from main

4dd46df

Merge branch 'main' into 1244-pip-install-dry-run-flag

e6c8442

# Conflicts: # crates/uv/tests/pip_install.rs

zanieb changed the title ~~feat(pip-install): add --dry-run flag~~ Add --dry-run flag to uv pip install Mar 12, 2024

zanieb merged commit 15f6f9f into astral-sh:main Mar 12, 2024

zanieb added the enhancement New feature or improvement to existing functionality label Mar 12, 2024

BrewTestBot mentioned this pull request Mar 13, 2024

uv 0.1.18 Homebrew/homebrew-core#165936

Merged

moreati mentioned this pull request Dec 1, 2024

Add --dry-run to uv pip uninstall #9557

Merged

muzimuzhi mentioned this pull request Jun 21, 2025

Add --dry-run to uv tool install and uv tool uninstall #14194

Open

Comments

Conversation

JacobCoffee commented Feb 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Closes

Out of Scope

Uh oh!

This comment was marked as outdated.

JacobCoffee commented Feb 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JacobCoffee commented Feb 16, 2024

Uh oh!

Uh oh!

JacobCoffee commented Feb 16, 2024

Uh oh!

zanieb commented Feb 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

zanieb commented Feb 22, 2024

Uh oh!

zanieb commented Feb 23, 2024

Uh oh!

JacobCoffee commented Feb 25, 2024

Uh oh!

zanieb commented Feb 28, 2024

Uh oh!

JacobCoffee commented Mar 1, 2024

Uh oh!

zanieb commented Mar 3, 2024

Uh oh!

zanieb commented Mar 4, 2024

Uh oh!

Uh oh!

zanieb commented Mar 6, 2024

Uh oh!

zanieb Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JacobCoffee commented Feb 16, 2024 •

edited

Loading

JacobCoffee commented Feb 16, 2024 •

edited

Loading

zanieb commented Feb 17, 2024 •

edited

Loading