Support installing additional executables in `uv tool install` by lucab · Pull Request #7592 · astral-sh/uv

lucab · 2024-09-20T17:04:46Z

This enhances uv tool install in order to allow installing executables from multiple packages in a single call.

Closes #6314

zanieb

Nice! This seems like a great start.

crates/uv-cli/src/lib.rs

crates/uv/tests/tool_install.rs

zanieb · 2024-09-20T17:20:34Z

crates/uv/tests/tool_install.rs

+    Installed 11 executables: ansible, ansible-config, ansible-connection, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull, ansible-test, ansible-vault
+    Installed 1 executable: ansible-lint
+    Installed 1 executable: ansible-community


We'll probably want to collapse these and/or include the "from" package

Do you have a preference on how this should look like?
For the moment I've updated it to:

Installed 11 additional executables from `ansible-core`: ansible, ansible-config, ansible-connection, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull, ansible-test, ansible-vault Installed 1 additional executable from `ansible-lint`: ansible-lint Installed 1 executable: ansible-community

I'm absolutely not sold on this being the final form.

The part that stands out to me there is that it's a bit weird to say "additional" before we show the main group of executables we installed.

I think I'd go with whatever is decent and simple here, then revisit the output entirely. For example, I think this should probably match the style of our install commands? Like:

Installed 13 executables + ansible (from ansible-core) + ansible-config (from ansible-core) + ansible-lint + ansible-community ...

If the package name matches the executable name I'd probably omit the "from" portion.

Anyway, I think that is separate from the goal here and we should avoid going down that road in this pull request.

zanieb · 2024-09-20T17:21:01Z

crates/uv/tests/tool_install.rs

+        .arg("--i-want-ponies")
+        .arg("ansible-core")
+        .arg("--i-want-ponies")
+        .arg("ansible-lint")
+        .arg("ansible==9.3.0")


Minor note: This is probably an expensive test because the package is big. We might want to find a smaller package to keep the test case minimal.

Many dependencies were coming from ansible-lint, which is an extra package providing an additional entrypoint. I replaced that with black, as it covers the same scenario with fewer transitive deps.

If you have an idea about a better combo than ansible and ansible-core, I'll happily replace them here.

crates/uv/src/lib.rs

crates/uv/tests/tool_install.rs

lucab · 2024-09-25T10:48:52Z

crates/uv/tests/tool_install.rs

+     + pycparser==2.21
+     + pyyaml==6.0.1
+     + resolvelib==1.0.1
+    Installed 11 executables from `ansible-core`: ansible, ansible-config, ansible-connection, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull, ansible-test, ansible-vault


There is a funny issue here, it seems that on Windows only there is a different sorting for the strings ansible and ansible-<whatever>:

- Installed 11 executables from `ansible-core`: ansible, ansible-config, ansible-connection, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull, ansible-test, ansible-vault + Installed 11 executables from `ansible-core`: ansible-config, ansible-connection, ansible-console, ansible-doc, ansible-galaxy, ansible-inventory, ansible-playbook, ansible-pull, ansible-test, ansible-vault, ansible

That's horrible :(

I had to abuse CI a bit to get to the bottom of this (sorry if I flooded you with notifications).
It turns out there is a .exe suffix (filtered out in test output) and thus ansible < ansible-config(.exe) < ansible.exe (due to the ASCII order of - vs .).
The same suffix is also present in the receipt, making its ordering OS-dependant.

I'm used to Charlie force-pushing 1000 times per pull request so no worries.

Ah that's really interesting. Good sleuthing. I was about to suggest trimming the suffix for sorts but it looks like you're on it in 0c9f450 — should you use the std::env::consts::EXE_SUFFIX const there?

The filtering can be quite misleading like that sometimes. I wonder if we can output an unfiltered snapshot on failure too? cc @konstin the snapshot macro master.

lucab · 2024-09-30T14:13:54Z

I think this should be in a complete state now, and there are functional tests for install/upgrade/uninstall flows.

The main remaining thing to decide is the name of the flag, in order to finalize the PR.
My personal suggestion would be --with-commands-from, as it blends with existing nomenclature.
But I'm happy to go with whatever @zanieb or @charliermarsh actually prefer, just let me know here.

zanieb · 2024-10-03T23:45:35Z

Thanks! I'll try to review this tomorrow.

edit: I had some time to give it a quick look now

crates/uv-cli/src/lib.rs

crates/uv/src/commands/tool/install.rs

zanieb · 2024-10-04T00:02:57Z

crates/uv-tool/src/tool.rs

+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub from: Option<String>,


Will adding this break old tool installs, i.e., if it's missing?

The only other location from is used is in upgrade.rs to collect dependency packages (excluding the main tool) that have entry points. If from is None, then only entry points from site packages are installed in install_executables.

gaborbernat · 2025-03-26T20:01:03Z

Anything is left here to do? from the latest review seems to be implied that it's ready.

zanieb · 2025-03-26T20:07:39Z

Yeah there's still work to do here. i.e., #7592 (comment) is important. I'd have to go deeper on the topic again to see if there's more. Are you interested in picking it up?

mykelalvis · 2025-07-16T12:50:06Z

Bumping this as "very nice to have". If there is testing to perform, I'm willing to help out, but my knowledge of this codebase is low and my available time is limited.

Close #6314 ## Summary Continuing from #7592. Created a new PR to rebase the old branch with `main`, cleaned up test errors, and improved readability. ## Test Plan Same test cases as in #7592. --------- Co-authored-by: Zanie Blue <contact@zanie.dev>

zanieb reviewed Sep 20, 2024

View reviewed changes

lucab force-pushed the ups/tool-install-additional-exes branch from 67a3ac0 to e40e3ff Compare September 20, 2024 17:46

zanieb added enhancement New feature or improvement to existing functionality uv tool Related to the uv tool interface labels Sep 20, 2024

lucab force-pushed the ups/tool-install-additional-exes branch 2 times, most recently from 49cb25e to 3a05460 Compare September 25, 2024 10:46

lucab commented Sep 25, 2024

View reviewed changes

lucab force-pushed the ups/tool-install-additional-exes branch 14 times, most recently from ab8e780 to 0c9f450 Compare September 27, 2024 15:31

lucab changed the title ~~[WIP] Support installing additional executables in uv tool install~~ Support installing additional executables in uv tool install Sep 30, 2024

zanieb self-assigned this Sep 30, 2024

lucab added 6 commits October 3, 2024 09:46

wip: Support installing additional executables in uv tool install

d1f0ac5

fix duplicate additional entrypoints

a884fab

reword output

74f70ac

fix: use a BTreeSet<PackageName>

8ed5b4b

fix: reword output

2206ccb

fix: remove spurious warning

26e9aff

lucab added 8 commits October 3, 2024 09:46

tests: use smaller package and add tool receipt

090b9c7

tests: update receipt snapshots

3780a9f

tests: update error outputs

c9fddd8

fix: trim final exe suffix for stable sorting

0d3b357

fix: use EXE_SUFFIX

7fbf7bf

tool/upgrade: reinstall all entrypoints

16fb13a

fix imports

09d4916

fix: rename flag

67f7214

lucab force-pushed the ups/tool-install-additional-exes branch from d291b85 to 0f39fcb Compare October 3, 2024 08:11

docs/guides/tools: add example for multiple commands install

fe56b74

lucab force-pushed the ups/tool-install-additional-exes branch from 0f39fcb to fe56b74 Compare October 3, 2024 08:22

lucab marked this pull request as ready for review October 3, 2024 09:23

zanieb reviewed Oct 3, 2024

View reviewed changes

crates/uv-cli/src/lib.rs Outdated Show resolved Hide resolved

zanieb reviewed Oct 4, 2024

View reviewed changes

crates/uv/src/commands/tool/install.rs Outdated Show resolved Hide resolved

zanieb reviewed Oct 4, 2024

View reviewed changes

zanieb added 5 commits November 27, 2024 14:10

Update crates/uv-cli/src/lib.rs

04899a0

Review

6812a0b

Merge branch 'main' into ups/tool-install-additional-exes

d786b15

Fixup

9e8898d

Fix typo

7cfa7f2

aaron-ang mentioned this pull request Jun 13, 2025

Support installing additional executables in uv tool install #14014

Merged

zanieb closed this Jul 30, 2025

		#[serde(skip_serializing_if = "Option::is_none")]
		pub from: Option<String>,

Conversation

lucab commented Sep 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zanieb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lucab commented Sep 30, 2024

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gaborbernat commented Mar 26, 2025

Uh oh!

zanieb commented Mar 26, 2025

Uh oh!

mykelalvis commented Jul 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

lucab commented Sep 20, 2024 •

edited

Loading

zanieb commented Oct 3, 2024 •

edited

Loading