python: identify uv environments #6510

austin3dickey · 2025-02-27T04:24:53Z

Addresses #6476.

Release Notes

New Features

Start to recognize uv environments (Recognize uv Python sessions and include uv in their name #6476)

Bug Fixes

N/A

QA Notes

I'd recommend clearing Positron state before testing this, since there's a lot of environment caching.

Set up uv on your system: https://docs.astral.sh/uv/getting-started/installation/

Try creating a venv or two and see how they look in the picker.

@:interpreter @:extensions

github-actions · 2025-02-27T04:25:12Z

E2E Tests 🚀
This PR will run tests tagged with: @:critical @:interpreter @:extensions

^readme ^{valid tags}

austin3dickey · 2025-02-27T20:51:37Z

This is coming along pretty well, but I'm not sure it's classifying all uv-managed pythons on my system as uv. In particular I've used some of these shenanigans in the past and it still thinks those are global.

I probably want to polish up all these cases and make sure we have tests for them.

extensions/positron-python/src/client/pythonEnvironments/common/environmentManagers/uv.ts

austin3dickey · 2025-03-04T13:40:55Z

extensions/positron-python/src/client/pythonEnvironments/index.ts

@@ -253,6 +253,7 @@ function createWorkspaceLocator(ext: ExtensionState): WorkspaceLocators {
            new HatchLocator(root.fsPath),
            new PixiLocator(root.fsPath),
            new CustomWorkspaceLocator(root.fsPath),
+            // TODO: uv?


Still wrestling with whether I need to make a UvLocator and if so, what its scope should be. Right now everything seems to work even without one. I think this is because of the changes I made to the 3 files in pythonEnvironments/base/locators/lowLevel/. But that may not be the cleanest solution, and also it might be missing some? (still need to test)

Also I'm not quite sure how this interacts with PET?

I'm not sure about this one, let's see what Isabel says.

I would say it is not needed, since uv envs are the same as venvs, which are already discovered. The one thing we might want to think about is if uv puts envs in nonstandard locations; ~/.local/ is one example.

@isabelizimm saw an issue earlier where it wasn't finding e.g. ~/.local/bin/python if you used uv python install --preview to install that. This doesn't happen to me, and I think it's because ~/.local/bin is on my PATH. When I tried clearing Positron state and removing it from my PATH, that happened to me too. (Though interestingly it still found ~/.local/bin/python3.12, so that must have been picked up by something else, like a symlink from a venv or something.)

Question: is this okay behavior? Or should we always try to look in ~/.local/bin regardless of PATH?

I would be okay to always look in ~/.local/, since it is a known location for uv envs

austin3dickey · 2025-03-06T18:24:01Z

extensions/positron-python/src/client/pythonEnvironments/nativeAPI.ts

+            // --- Start Positron ---
+            if (native.executable && (await isUvEnvironment(native.executable))) {
+                traceInfo(`Found uv environment: ${native.executable}`);
+                native.kind = NativePythonEnvironmentKind.Uv;


Since PET recognizes uv envs as venvs, here's where we patch them. Related: microsoft/python-environment-tools#152 (comment)

austin3dickey · 2025-03-06T19:07:04Z

Okay I think this PR is good to go! I've been messing around locally and I think most of the issues have been worked out.

jthomasmock · 2025-03-06T19:16:54Z

Minor nit/opinion, but what do we think about:

(uv: .venv) -- suggestion
(.venv: uv) -- current
(uv venv) -- alternative that matches the CLI command?

I think that might help with visual search or comparison, and in this aspect I think the fact that it's a uv-managed environment is more important than it's a .venv.

austin3dickey · 2025-03-06T20:33:02Z

I think it's currently named this way because:

the default naming scheme for the Recommended and Workspace categories is 'folder_name': manager_name
the default naming scheme for the other categories is 'folder_name' (because the manager name is the category name)

But I agree that for uv that's not super helpful. Especially since a lot of the time the folder name is the default .venv. I can mess around and see if it's easy to change.

Maybe I could use the parent folder name instead.

jthomasmock · 2025-03-06T20:41:49Z

I think it's currently named this way because:

the default naming scheme for the Recommended and Workspace categories is 'folder_name': manager_name

the default naming scheme for the other categories is 'folder_name' (because the manager name is the category name)

But I agree that for uv that's not super helpful. Especially since a lot of the time the folder name is the default .venv. I can mess around and see if it's easy to change.

Maybe I could use the parent folder name instead.

I do think that if it's following the recommendations or common approach then that's fine, and we can open that up as a future decision (whether to orient it a bit differently across the board depending on manager)

seeM

This doesn't seem to work for me with uv 0.6.5 and Python 3.11.9:

Screen.Recording.2025-03-07.at.14.19.07.mov

austin3dickey · 2025-03-07T15:31:07Z

This doesn't seem to work for me with uv 0.6.5 and Python 3.11.9

Oh, this is wild. I notice in your video:

Using CPython 3.11.9 interpreter at: /Users/seem/.pyenv/versions/3.11.9/bin/python`

I didn't realize uv would choose interpreters not managed by uv! I probably knew this at one point (it's documented) but forgot.

I think I'll have to put back in the logic that checks whether there's a pyenv.cfg file in the venv with a uv key.

austin3dickey · 2025-03-07T17:02:18Z

Cool @seeM that should be fixed. Tested locally.

austin3dickey · 2025-03-07T17:32:23Z

Forgot to mention: if you're testing this locally it's probably good to clear Positron state first.

isabelizimm

I am seeing something a bit curious with the native locator. After refreshing interpreters, some of my ~/.local uv interpreters are under Global, not Uv, in the Select Interpreter dropdown.

However, once I choose one, start it up, and go back to Select Interpreter, it will appear under Uv.

I personally think this is small enough that it is non-blocking (I can't always repro), just log it and follow up on maybe?

isabelizimm

lgtm after it's decided if we auto-find ~/.local or not! this will be so exciting to have land 🚀

austin3dickey force-pushed the aus/uvlocator branch 5 times, most recently from 1c790f0 to 6e8bd14 Compare February 27, 2025 17:08

austin3dickey force-pushed the aus/uvlocator branch 2 times, most recently from 0751519 to b0566c5 Compare March 3, 2025 20:15

austin3dickey commented Mar 4, 2025

View reviewed changes

extensions/positron-python/src/client/pythonEnvironments/common/environmentManagers/uv.ts Outdated Show resolved Hide resolved

austin3dickey commented Mar 4, 2025

View reviewed changes

extensions/positron-python/src/client/pythonEnvironments/common/environmentManagers/uv.ts Outdated Show resolved Hide resolved

austin3dickey commented Mar 4, 2025

View reviewed changes

austin3dickey force-pushed the aus/uvlocator branch from 7ce4129 to 775003a Compare March 5, 2025 19:27

austin3dickey commented Mar 6, 2025

View reviewed changes

austin3dickey changed the title ~~WIP: python: identify uv environments~~ python: identify uv environments Mar 6, 2025

austin3dickey marked this pull request as ready for review March 6, 2025 18:29

seeM reviewed Mar 7, 2025

View reviewed changes

austin3dickey force-pushed the aus/uvlocator branch from 1eef7de to e4efae0 Compare March 7, 2025 16:44

austin3dickey added 4 commits March 7, 2025 10:44

uv implementation

f3c44a7

fix PET

bbba6e9

lint

56e8d14

check for uv pyvenv.cfg again

286cb09

austin3dickey force-pushed the aus/uvlocator branch from e4efae0 to 286cb09 Compare March 7, 2025 16:44

isabelizimm reviewed Mar 7, 2025

View reviewed changes

isabelizimm approved these changes Mar 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

python: identify uv environments #6510

python: identify uv environments #6510

austin3dickey commented Feb 27, 2025 •

edited

Loading

github-actions bot commented Feb 27, 2025 •

edited

Loading

austin3dickey commented Feb 27, 2025

austin3dickey Mar 4, 2025

austin3dickey Mar 4, 2025

seeM Mar 4, 2025

isabelizimm Mar 4, 2025

austin3dickey Mar 7, 2025

isabelizimm Mar 7, 2025

austin3dickey Mar 6, 2025

austin3dickey commented Mar 6, 2025

jthomasmock commented Mar 6, 2025

austin3dickey commented Mar 6, 2025 •

edited

Loading

jthomasmock commented Mar 6, 2025

seeM left a comment

austin3dickey commented Mar 7, 2025

austin3dickey commented Mar 7, 2025

austin3dickey commented Mar 7, 2025

isabelizimm left a comment •

edited

Loading

isabelizimm left a comment

python: identify uv environments #6510

Are you sure you want to change the base?

python: identify uv environments #6510

Conversation

austin3dickey commented Feb 27, 2025 • edited Loading

Release Notes

New Features

Bug Fixes

QA Notes

github-actions bot commented Feb 27, 2025 • edited Loading

austin3dickey commented Feb 27, 2025

austin3dickey Mar 4, 2025

Choose a reason for hiding this comment

austin3dickey Mar 4, 2025

Choose a reason for hiding this comment

seeM Mar 4, 2025

Choose a reason for hiding this comment

isabelizimm Mar 4, 2025

Choose a reason for hiding this comment

austin3dickey Mar 7, 2025

Choose a reason for hiding this comment

isabelizimm Mar 7, 2025

Choose a reason for hiding this comment

austin3dickey Mar 6, 2025

Choose a reason for hiding this comment

austin3dickey commented Mar 6, 2025

jthomasmock commented Mar 6, 2025

austin3dickey commented Mar 6, 2025 • edited Loading

jthomasmock commented Mar 6, 2025

seeM left a comment

Choose a reason for hiding this comment

austin3dickey commented Mar 7, 2025

austin3dickey commented Mar 7, 2025

austin3dickey commented Mar 7, 2025

isabelizimm left a comment • edited Loading

Choose a reason for hiding this comment

isabelizimm left a comment

Choose a reason for hiding this comment

austin3dickey commented Feb 27, 2025 •

edited

Loading

github-actions bot commented Feb 27, 2025 •

edited

Loading

austin3dickey commented Mar 6, 2025 •

edited

Loading

isabelizimm left a comment •

edited

Loading