Add `uv python install --default` #8650

zanieb · 2024-10-28T22:48:47Z

This pull request is best viewed with whitespace hidden

Adds a --default flag to uv python install in preview. This includes a python and python{major} executable in addition to the python{major}.{minor} executable. We will replace uv-managed executables, but externally managed executables require the --force flag to overwrite.

If you run uv python install (without arguments), we include the --default flag implicitly to populate python and python3 for the "default" install version.

In the future, we should add a warning if the installed executable isn't at the front of the PATH.

…v python install` (#8458) Updates `uv python install` to link `python3.x` in the executable directory (i.e., `~/.local/bin`) to the the managed interpreter path. Includes - #8569 - #8571 Remaining work - #8663 - #8650 - Add an opt-out setting and flag - Update documentation

Pulling out of #8650 for readability. Trying to clean this up to simplify extensions in the future. This is not a strict refactor, there are behavioral changes here. - Adds some structs for managing state. - Addresses some likely inconsistent behavior for weird edge-cases. - We fill platform information before checking if a request is satisfied. - We error earlier if we can't find a download for the request, i.e., even if you somehow have it installed. - Only reports versions as uninstalled if a download actually replaces them. - Moves some of the default output to tracing messages. - Even if an installation was already satisfied, we'll check that it is setup properly

…versions (#8713) Cherry-picked from #8650

zanieb · 2024-11-26T23:38:57Z

Thanks, I can look into fixing that.

jooon · 2024-11-27T00:09:40Z

I am a bit confused how the default versions are replaced. I know I can force replace them by adding --force, but if I don't, what is replaced feels a bit off.

Starting from scratch, install and set 3.12.6 as default

$ uv python install --default 3.12.6
Installed Python 3.12.6 in 4.55s
 + cpython-3.12.6-linux-x86_64-gnu (python, python3, python3.12)

OK!

New version released, install and set 3.12.7 as default

$ uv python install --default 3.12.7
Installed Python 3.12.7 in 4.60s
 + cpython-3.12.7-linux-x86_64-gnu (python, python3, python3.12)

OK!

New minor version released, install and set 3.13 as default.

$ uv python install --default 3.13
Installed Python 3.13.0 in 4.17s
 + cpython-3.13.0-linux-x86_64-gnu (python3.13)

hmm?

zanieb · 2024-11-27T00:18:12Z

That looks wrong indeed :) thanks for giving it a try.

jooon · 2024-11-27T00:26:52Z

Should --default maybe always imply --force?

From scratch again:

$ uv python install --default 3.13 3.12
Installed 2 versions in 7.93s
 + cpython-3.12.7-linux-x86_64-gnu (python3.12)
 + cpython-3.13.0-linux-x86_64-gnu (python, python3, python3.13)
$ uv python install --default 3.12
$ echo $?
0
$ python
Python 3.13.0 (main, Oct 16 2024, 03:23:02) [Clang 18.1.8 ] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

The install command returns success because it has successfully made sure there is a 3.12 version installed. However, in my mind, it "failed" to set 3.12 as default.

zanieb · 2024-11-27T00:28:27Z

~~If you use --default with multiple versions we'll set the first one as the default.~~ Sorry, missed a command invocation there. We should definitely override uv managed executables with --default. --force implies overriding executables not managed by uv. For reference, the verbose logs are:

❯ cargo run -- python install --preview --default 3.12 -v
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.17s
     Running `target/debug/uv python install --preview --default 3.12 -v`
DEBUG uv 0.5.4 (c1619ee49 2024-11-26)
DEBUG Acquired lock for `/Users/zb/.local/share/uv/python`
DEBUG Found `cpython-3.12.7-macos-aarch64-none` for request `Python 3.12`
DEBUG Using request timeout of 30s
DEBUG Inspecting existing executable at `/Users/zb/.local/bin/python3.12`
DEBUG Executable at `/Users/zb/.local/bin/python3.12` is already for `cpython-3.12.7-macos-aarch64-none`
DEBUG Inspecting existing executable at `/Users/zb/.local/bin/python3`
DEBUG Executable already exists at `cpython-3.13.0-macos-aarch64-none` for `/Users/zb/.local/bin/python3`. Use `--force` to replace it
DEBUG Inspecting existing executable at `/Users/zb/.local/bin/python`
DEBUG Executable already exists at `cpython-3.13.0-macos-aarch64-none` for `/Users/zb/.local/bin/python`. Use `--force` to replace it
DEBUG Released lock at `/Users/zb/.local/share/uv/python/.lock`

zanieb · 2024-11-27T00:37:32Z

That's fixed now.

jooon · 2024-11-27T00:58:30Z

--default works as I expected now!

--force seems to both be needed to replace executables not managed by uv as well as allowing minor versions managed by uv to be downgraded.

$ touch $HOME/.local/bin/python3.12

$ uv python install 3.12.5
Installed Python 3.12.5 in 4.85s
 + cpython-3.12.5-linux-x86_64-gnu
error: Failed to install cpython-3.12.5-linux-x86_64-gnu
  Caused by: Executable already exists at `/home/jon/.local/bin/python3.12` but is not managed by uv; use `--force` to replace it

$ uv python install --force 3.12.5
Installed Python 3.12.5 in 7ms
 + cpython-3.12.5-linux-x86_64-gnu (python3.12)

$ uv python install 3.12.7
Installed Python 3.12.7 in 4.57s
 + cpython-3.12.7-linux-x86_64-gnu (python3.12)

$ uv python install 3.12.6
Installed Python 3.12.6 in 4.44s
 + cpython-3.12.6-linux-x86_64-gnu

$ uv python install --force 3.12.6
Installed Python 3.12.6 in 6ms
 + cpython-3.12.6-linux-x86_64-gnu (python3.12)

zanieb · 2024-11-27T01:05:41Z

The latter is intentional. Do you think we should make the log more visible explaining that behavior?

jooon · 2024-11-27T01:13:47Z

I think it makes perfect sense and I don't think it needs to be clarified. More information can also confuse.

I think I was mostly confused by your comment above that --force was for replacing executables not managed by uv. I just had never encountered that before.

These were erroneously being filtered, interfering with the snapshots in #8650

zanieb · 2024-11-27T16:03:53Z

In a follow-up, I'd like to change the executable display to include all the executables available for the version not just the ones we added in this invocation.

charliermarsh

Generally looks good, just a few comments.

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

crates/uv-cli/src/lib.rs

charliermarsh · 2024-12-02T22:36:44Z

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

@@ -302,114 +312,136 @@ pub(crate) async fn install(
            .expect("We should have a bin directory with preview enabled")
            .as_path();

-        let target = bin.join(installation.key().versioned_executable_name());
+        let targets = if (default || is_default_install)


Why is_default_install here? I thought that meant something distinct from default.

If you run uv python install (without arguments), we include the --default flag implicitly to populate python and python3 for the "default" install version.

When you run uv python install without arguments, it's a "default install". The idea is for that bootstrapping experience to get you a complete installation. Using the --default flag in subsequent operations would be used to change the default.

(If you've previously installed Python with uv, using uv python install without arguments has no effect)

I see, ok. But if there's a .python-version file, it does not count as a "default" install.

Yeah, I'm not really sure if it makes sense but I would find it surprising for my "default" version to be set when installing the Python versions needed for a project, e.g., I noticed this for uv. It's pretty niche though.

charliermarsh · 2024-12-02T22:37:53Z

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

-                    target.simplified_display()
-                );
+        for target in targets {
+            let target = bin.join(target);


Is everything from here down mostly just an indent of the existing logic?

Yeah, and some tweaks from rebases though I've reduced those a couple times.

This pull request is best viewed with whitespace hidden

charliermarsh

(Trust you to act on feedback as you see fit!)

zanieb · 2024-12-02T22:56:37Z

Should be addressed in d3d94ce

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.5.5` -> `0.5.6` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.5.6`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#056) [Compare Source](astral-sh/uv@0.5.5...0.5.6) ##### Enhancements - Add `--dry-run` to `uv pip uninstall` ([#9557](astral-sh/uv#9557)) - Allow `--constraints` and `--overrides` in `uv tool install` ([#9547](astral-sh/uv#9547)) - Display removed Python executables on uninstall ([#9459](astral-sh/uv#9459)) - Warn when keyring has no password for `uv publish` ([#8827](astral-sh/uv#8827)) - Add suggested action when `.python-version` pin is incompatible with the project ([#9590](astral-sh/uv#9590)) - Improve error messages for mismatches in `tool.uv.sources` ([#9482](astral-sh/uv#9482)) - Use constraints in trace rather than irrelevant `requires-python` ([#9529](astral-sh/uv#9529)) ##### Preview features - Add `uv python install --default` ([#8650](astral-sh/uv#8650)) - Fix Python executable installation when multiple patch versions are requested ([#9607](astral-sh/uv#9607)) - Build backend: Revamp `include` / `exclude` ([#9525](astral-sh/uv#9525)) - Build backend: Add fast path ([#9556](astral-sh/uv#9556)) - Build backend: Add functions to collect file list ([#9602](astral-sh/uv#9602)) - Build backend: Default excludes ([#9552](astral-sh/uv#9552)) - Build backend: Refactoring before list ([#9558](astral-sh/uv#9558)) - Build backend: Warn when visiting over 10k files ([#9523](astral-sh/uv#9523)) ##### Configuration - Make `check-url` available in configuration files ([#9032](astral-sh/uv#9032)) ##### Performance - Avoid adding non-extra package with extra dependencies ([#9540](astral-sh/uv#9540)) - Avoid cloning `String` in marker evaluation ([#9598](astral-sh/uv#9598)) ##### Rust API - `uv-pep508`: Add more methods for simplifying `extra`-related expressions ([#9469](astral-sh/uv#9469)) ##### Bug fixes - Allow `file:` URLs to include package names ([#9493](astral-sh/uv#9493)) - Avoid using IDs across PubGrub states ([#9538](astral-sh/uv#9538)) - Consistently enforce requested-vs.-built metadata when retrieving wheels ([#9484](astral-sh/uv#9484)) - Do not show empty version specifier in `uv tool list` ([#9605](astral-sh/uv#9605)) - Include Git member information when getting metadata from cache ([#9388](astral-sh/uv#9388)) - Include base installation directory in uv run PATH ([#9585](astral-sh/uv#9585)) - Insert backslash when appending to system drive ([#9488](astral-sh/uv#9488)) - Normalize paths when lowering Git dependencies ([#9595](astral-sh/uv#9595)) - Omit origin when comparing requirements ([#9570](astral-sh/uv#9570)) - Override `manylinux_compatible` with `--python-platform` ([#9526](astral-sh/uv#9526)) - Pass extra when evaluating lockfile markers ([#9539](astral-sh/uv#9539)) - Propagate markers for recursive extras in resolver ([#9509](astral-sh/uv#9509)) - Respect path dependencies within Git dependencies ([#9594](astral-sh/uv#9594)) - Support recursive extras with marker in `pip compile -r pyproject.toml` ([#9535](astral-sh/uv#9535)) - Don't emit unpinned warning for proxy packages ([#9497](astral-sh/uv#9497)) - Fix `--refresh-package` flag mentioned as `--refresh-dependency` ([#9486](astral-sh/uv#9486)) - Handle Windows AV/EDR file locks during script installations ([#9543](astral-sh/uv#9543)) - Re-enable conflicting extra/group tests and fix regression from [#9540](astral-sh/uv#9540) ([#9582](astral-sh/uv#9582)) ##### Documentation - Add missing word to docs for `run.md` ([#9527](astral-sh/uv#9527)) - Add policies reference section and license document ([#9367](astral-sh/uv#9367)) - Fix typo in entry point docs ([#9491](astral-sh/uv#9491)) - Fix up version in prior uninstall instructions ([#9485](astral-sh/uv#9485)) - Mention `uv pip` behavior in build system note ([#9586](astral-sh/uv#9586)) - Update build failures document ([#9584](astral-sh/uv#9584)) - Correct wording for multiple sources section ([#9504](astral-sh/uv#9504)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

zanieb force-pushed the zb/python-exec-default branch 2 times, most recently from 457a318 to 4579f3f Compare October 29, 2024 15:41

zanieb force-pushed the zb/python-exec-dir branch 2 times, most recently from 783e70d to 00873e2 Compare October 29, 2024 16:28

zanieb force-pushed the zb/python-exec-default branch from 4579f3f to 7e14476 Compare October 29, 2024 16:28

zanieb mentioned this pull request Oct 29, 2024

Install versioned Python executables into the bin directory during uv python install #8458

Merged

zanieb force-pushed the zb/python-exec-default branch 3 times, most recently from 5280eab to 0598d60 Compare October 29, 2024 22:29

zanieb force-pushed the zb/python-exec-dir branch 5 times, most recently from bb90cbd to ae37a24 Compare October 30, 2024 14:05

Base automatically changed from zb/python-exec-dir to main October 30, 2024 14:13

zanieb force-pushed the zb/python-exec-default branch 2 times, most recently from 032950f to 43e7779 Compare October 30, 2024 15:15

zanieb mentioned this pull request Oct 30, 2024

Refactor uv python install #8701

Merged

zanieb force-pushed the zb/python-exec-default branch 2 times, most recently from 2981c8d to 4e4d3cd Compare October 31, 2024 00:59

zanieb added the preview Experimental behavior label Oct 31, 2024

zanieb force-pushed the zb/python-exec-default branch from 4e4d3cd to 40c88cd Compare October 31, 2024 01:09

zanieb mentioned this pull request Oct 31, 2024

Fix test context filtering of Python platform keys with elided patch versions #8713

Merged

zanieb added a commit that referenced this pull request Oct 31, 2024

Fix test context filtering of Python platform keys with elided patch …

1b760af

…versions (#8713) Cherry-picked from #8650

zanieb force-pushed the zb/python-exec-default branch 4 times, most recently from af592db to 25ad2fe Compare November 1, 2024 13:28

zanieb mentioned this pull request Nov 27, 2024

Avoid filtering Python executables names during install tests #9458

Merged

zanieb force-pushed the zb/python-exec-default branch from c1619ee to c697111 Compare November 27, 2024 00:37

zanieb added a commit that referenced this pull request Nov 27, 2024

Avoid filtering Python executables names during install tests (#9458)

b503a25

These were erroneously being filtered, interfering with the snapshots in #8650

zanieb force-pushed the zb/python-exec-default branch 3 times, most recently from 44b018a to fc46546 Compare November 27, 2024 14:58

Add uv python install --default

c2b582a

zanieb force-pushed the zb/python-exec-default branch from fc46546 to c2b582a Compare November 27, 2024 15:40

zanieb requested a review from charliermarsh November 27, 2024 16:03

charliermarsh reviewed Dec 2, 2024

View reviewed changes

charliermarsh approved these changes Dec 2, 2024

View reviewed changes

Review feedback

d95fe76

zanieb force-pushed the zb/python-exec-default branch from d3d94ce to d95fe76 Compare December 2, 2024 23:51

zanieb merged commit 63443f1 into main Dec 3, 2024
64 checks passed

zanieb deleted the zb/python-exec-default branch December 3, 2024 01:05

BrewTestBot mentioned this pull request Dec 3, 2024

uv 0.5.6 Homebrew/homebrew-core#199944

Merged

Vynce mentioned this pull request Dec 11, 2024

Skip python.exe with uv install python --default #9817

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `uv python install --default` #8650

Add `uv python install --default` #8650

zanieb commented Oct 28, 2024 •

edited

Loading

zanieb commented Nov 26, 2024

jooon commented Nov 27, 2024

zanieb commented Nov 27, 2024

jooon commented Nov 27, 2024

zanieb commented Nov 27, 2024 •

edited

Loading

zanieb commented Nov 27, 2024

jooon commented Nov 27, 2024 •

edited

Loading

zanieb commented Nov 27, 2024

jooon commented Nov 27, 2024

zanieb commented Nov 27, 2024

charliermarsh left a comment

charliermarsh Dec 2, 2024

zanieb Dec 2, 2024 •

edited

Loading

zanieb Dec 2, 2024

charliermarsh Dec 2, 2024

zanieb Dec 2, 2024 •

edited

Loading

charliermarsh Dec 2, 2024

zanieb Dec 2, 2024

charliermarsh left a comment

zanieb commented Dec 2, 2024

Add uv python install --default #8650

Add uv python install --default #8650

Conversation

zanieb commented Oct 28, 2024 • edited Loading

zanieb commented Nov 26, 2024

jooon commented Nov 27, 2024

zanieb commented Nov 27, 2024

jooon commented Nov 27, 2024

zanieb commented Nov 27, 2024 • edited Loading

zanieb commented Nov 27, 2024

jooon commented Nov 27, 2024 • edited Loading

zanieb commented Nov 27, 2024

jooon commented Nov 27, 2024

zanieb commented Nov 27, 2024

charliermarsh left a comment

Choose a reason for hiding this comment

charliermarsh Dec 2, 2024

Choose a reason for hiding this comment

zanieb Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

zanieb Dec 2, 2024

Choose a reason for hiding this comment

charliermarsh Dec 2, 2024

Choose a reason for hiding this comment

zanieb Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

charliermarsh Dec 2, 2024

Choose a reason for hiding this comment

zanieb Dec 2, 2024

Choose a reason for hiding this comment

charliermarsh left a comment

Choose a reason for hiding this comment

zanieb commented Dec 2, 2024

Add `uv python install --default` #8650

Add `uv python install --default` #8650

zanieb commented Oct 28, 2024 •

edited

Loading

zanieb commented Nov 27, 2024 •

edited

Loading

jooon commented Nov 27, 2024 •

edited

Loading

zanieb Dec 2, 2024 •

edited

Loading

zanieb Dec 2, 2024 •

edited

Loading