Add `python.interpreters.include` and `python.interpreters.exclude` settings #6398

sharon-wang · 2025-02-19T16:42:16Z

Summary

addresses Python: provide inclusion/exclusion of language runtimes #3574 for both the JS and native locators
also implements Python: add /opt/python to discovery paths #6254 for the JS locator (previously only implemented for the native locator)
introduces new settings
- python.interpreters.include: List of folders to search for Python installations. These folders are searched in addition to the default folders for your operating system.
- python.interpreters.exclude: List of interpreter paths or folders to exclude from the available Python installations. These interpreters will not be displayed in the Positron UI.

Settings UI

Settings JSON

    "python.interpreters.include": [
        "/Users/sashimi/scratch",
        "a/relative/path",
        "/this/is/a/bogus/path"
    ],
    "python.interpreters.exclude": [
        "/usr/bin/python3",
        "/opt/homebrew",
        "/usr/local/bin"
    ]

Python Language Pack Output

Some log prefixes/messages to search for:

pythonRuntimeDiscoverer: to find out if any runtimes were filtered out during discovery
shouldIncludeInterpreter: whether or not the interpreter will be included based on the user settings
Not registering runtime ${extraData.pythonPath} as it is excluded via user settings.: if the runtime is not getting registered because the user excluded it
getAdditionalEnvDirs: native python finder -- list all the additional directories being searched, such as the user-included dirs

Release Notes

New Features

New settings to include additional Python interpreter search directories or exclude Python interpreters from the UI (Python: provide inclusion/exclusion of language runtimes #3574)

Bug Fixes

N/A

QA Notes

Please verify these options using both the JS and Native locators. Toggle between the locators by updating setting python.locator.
Positron will need to be restarted upon changing the python.interpreters.include/python.interpreters.exclude settings so that discovery can re-run with the settings applied
If an interpreter path is captured in both options, it will be included
If a user has a python install they want to include at path /1/2/3/4/5/3.10.4/bin/python, they should use /1/2/3/4/5 as the included directory.
Windows users can specify paths with either path separator
If a user starts an interpreter, then excludes or un-includes it and restarts Positron, it will still be selected upon restart
- if they shut it down and then restart, it should no longer show

This option allows user-specified Python search paths to be included as part of Python installation discovery. This is useful when the Python interpreter is not installed in a standard location. The option is a list of unique paths to include in the search for Python interpreters. The paths can be absolute or relative to the user's home directory. The default value is an empty list.

…uite working yet

…setting

github-actions · 2025-02-19T16:42:37Z

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

^readme ^{valid tags}

this is needed because the config api is now used to check for included/excluded runtimes as part of registering runtimes.

…g messages

sharon-wang · 2025-02-20T15:58:44Z

Opening this up for review, but I am working on adding a JS locator test for the new UserSpecifiedEnvironmentLocator that I'll push when done.

QUESTION: For the native locator, shall I just leave a note in nativePythonFinder.unit.test.ts to add
testing for python.interpreters.include once we switch over? Currently the test is skipped and I'm not sure off the top of my head how to switch the locator for the unit tests.

melissa-barca · 2025-02-20T19:34:17Z

extensions/positron-python/src/client/positron/interpreterSettings.ts

+ * Gets the list of interpreters that the user has explicitly included in the settings. Converts
+ * relative and aliased paths to absolute paths.
+ * @returns List of interpreters that the user has explicitly included in the settings.


Where are we converting relative and aliases paths? It looks like we're just ignoring them.

oops good catch! I meant to resolve aliased paths and not include relative paths. I just pushed a commit to resolve aliased paths.

For relative paths, my thinking is that it's ambiguous where the paths are relative to. Are they relative to the home directory or to the project directory? Does it make sense for an admin to set a relative path as a default? I figured we can document that only absolute or absolute-but-aliased paths are valid here.

melissa-barca · 2025-02-20T19:41:07Z

extensions/positron-python/src/client/positron/interpreterSettings.ts

+
+/**
+ * Check whether an interpreter should be included in the list of discovered interpreters.
+ * If an interpreter is both explicitly included and excluded, it will be included.


Are you confident this is the right approach? I'm wondering if we'd run into a situation where a Workbench admin has explicitly excluded an interpreter, but then a confused user tries to include it. We might want to consider implementing a way to log this use for admins, but we don't have monitoring implemented yet in Workbench for VS Code or Positron.

The language pack output will have a bit of info about why certain interpreters were included/excluded, but longer term, I'm hoping to better surface this information in a dedicated pane or something similar.

I think this approach makes sense for the Desktop user case, but let me think on the admin situation a bit! I feel like we will want a separate flag/option elsewhere, like an "admin policy" to enforce certain options

added a comment to the native python finder to add a test in the future

seeM

Code changes LGTM! I tested locally and it seems to work well, except that the interpreters are still shown in the "Python: Select Interpreter" command. Is that expected?

extensions/positron-python/src/client/positron/interpreterSettings.ts

sharon-wang · 2025-02-21T16:24:45Z

...n-python/src/client/interpreter/configuration/interpreterSelector/commands/setInterpreter.ts

+
+// --- Start Positron ---
+/**
+ * Wraps the original filter function to include additional filtering logic.
+ * If no filter is provided, the returned function will only include the additional filtering logic.
+ * @param filter The original filter function
+ * @returns A new filter function that includes the original filter function and the additional filtering logic
+ */
+function filterWrapper(filter: ((i: PythonEnvironment) => boolean) | undefined) {
+    return (i: PythonEnvironment) => (filter ? filter(i) : true) && shouldIncludeInterpreter(i.path);
+}
+// --- End Positron ---


@seeM

the interpreters are still shown in the "Python: Select Interpreter" command. Is that expected?

Thank you for catching this! I checked the "include" case, but missed the "exclude" case for the quickpick. This should be fixed now!

isabelizimm

Question: If I have started an interpreter, say, a pyenv interpreter, then I exclude ~/.pyenv, should I expect to see the interpreter on restart?

It will not show if I have shut down the interpreter, but if I leave it running and then quit/reopen Positron, the interpreter persists. This feels like the right choice, but just making sure it is intentional!

++ to @seeM comment, this does not affect the Python: Select Interpreter list. With the upcoming changes to our interpreter, we might want to make sure include/exclude works there as well

...ons/positron-python/src/client/pythonEnvironments/base/locators/common/nativePythonFinder.ts

isabelizimm · 2025-02-21T16:27:55Z

extensions/positron-python/src/test/pythonEnvironments/nativePythonFinder.unit.test.ts

@@ -17,6 +17,7 @@ import * as workspaceApis from '../../client/common/vscodeApis/workspaceApis';

 // --- Start Positron ---
 // re-enable when Native Finder is used for discovery
+// TODO: add test for python.interpreters.include here once we switch to Native Finder


this is fine for now, I'll log an issue to turn these back on (probably for the next milestone)

isabelizimm · 2025-02-21T16:33:42Z

oh gosh, I reviewed just a few mins too late! I see the Python: Select Interpreter changes 🚀

isabelizimm

good with me once ci is green ✅

sharon-wang · 2025-02-21T17:05:36Z

@isabelizimm

Question: If I have started an interpreter, say, a pyenv interpreter, then I exclude ~/.pyenv, should I expect to see the interpreter on restart?

It will not show if I have shut down the interpreter, but if I leave it running and then quit/reopen Positron, the interpreter persists. This feels like the right choice, but just making sure it is intentional!

Yes this feels right to me as well 👍 Thanks for calling this out! I added a note to the QA Notes section to mention this case

### Release Notes  #### New Features - N/A #### Bug Fixes - #3740 filters out unsupported (<3.8) Python versions from the `Python: Select Interpreter` dropdown ### QA Notes 1. create a Python interpreter <3.8 (if you are a pyenv user, you can do `pyenv install 3.6`) 2. go to `Python: Select Interpreter` 3. should not appear in dropdown

sharon-wang added 6 commits February 14, 2025 11:10

add python.interpreters.exclude which is being recognized but not q…

fe6ffa0

…uite working yet

don't register user-excluded runtimes

5759873

add interpreters.include/exclude to python settings interfaces

1180819

add user-specified envs js locator for python.interpreters.include …

ff348d5

…setting

add /opt/python path to js locator search dirs

83f6a86

sharon-wang added 5 commits February 19, 2025 11:58

add more detail to settings descriptions

345cf05

move additional dirs code to avoid circular dependency

2462ce1

add more logging around additional dirs discovery

6fbaa54

stub config apis for python runtime manager test

2490a92

this is needed because the config api is now used to check for included/excluded runtimes as part of registering runtimes.

use shouldIncludeInterpreter prefix for all interpreter settings lo…

2e3da70

…g messages

sharon-wang marked this pull request as ready for review February 20, 2025 15:53

sharon-wang requested review from seeM, isabelizimm and jmcphers and removed request for seeM and isabelizimm February 20, 2025 15:53

sharon-wang requested review from melissa-barca and removed request for jmcphers February 20, 2025 16:48

melissa-barca reviewed Feb 20, 2025

View reviewed changes

sharon-wang added 3 commits February 20, 2025 16:59

add js user specified locator unit test

47d17b0

added a comment to the native python finder to add a test in the future

convert aliased paths to absolute paths

6a8d966

💅 run prettier

01c7f97

seeM reviewed Feb 21, 2025

View reviewed changes

extensions/positron-python/src/client/positron/interpreterSettings.ts Outdated Show resolved Hide resolved

sharon-wang added 2 commits February 21, 2025 11:12

wrap setInterpreter quickpick filter to also filter by user settings

883b3b7

format and comment fixes

47e68d2

traceInfo ignored relative paths instead of traceVerbose

3556dd6

sharon-wang commented Feb 21, 2025

View reviewed changes

💅

cde7b34

isabelizimm reviewed Feb 21, 2025

View reviewed changes

sharon-wang added 2 commits February 21, 2025 11:38

add mocks/stubs for setInterpreter test

f1efccd

move traceVerbose import into positron fence

547909f

isabelizimm previously approved these changes Feb 21, 2025

View reviewed changes

fix lint

ba4aca0

sharon-wang dismissed isabelizimm’s stale review via ba4aca0 February 21, 2025 16:58

sharon-wang mentioned this pull request Feb 21, 2025

python: filter versions less than 3.8 from interpreter dropdown #6433

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `python.interpreters.include` and `python.interpreters.exclude` settings #6398

Add `python.interpreters.include` and `python.interpreters.exclude` settings #6398

sharon-wang commented Feb 19, 2025 •

edited

Loading

github-actions bot commented Feb 19, 2025 •

edited

Loading

sharon-wang commented Feb 20, 2025

melissa-barca Feb 20, 2025

sharon-wang Feb 20, 2025

melissa-barca Feb 20, 2025

sharon-wang Feb 20, 2025

seeM left a comment

sharon-wang Feb 21, 2025

isabelizimm left a comment

isabelizimm Feb 21, 2025

isabelizimm commented Feb 21, 2025 •

edited

Loading

isabelizimm left a comment

sharon-wang commented Feb 21, 2025

Add python.interpreters.include and python.interpreters.exclude settings #6398

Are you sure you want to change the base?

Add python.interpreters.include and python.interpreters.exclude settings #6398

Conversation

sharon-wang commented Feb 19, 2025 • edited Loading

Summary

Settings UI

Settings JSON

Python Language Pack Output

Release Notes

New Features

Bug Fixes

QA Notes

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

sharon-wang commented Feb 20, 2025

melissa-barca Feb 20, 2025

Choose a reason for hiding this comment

sharon-wang Feb 20, 2025

Choose a reason for hiding this comment

melissa-barca Feb 20, 2025

Choose a reason for hiding this comment

sharon-wang Feb 20, 2025

Choose a reason for hiding this comment

seeM left a comment

Choose a reason for hiding this comment

sharon-wang Feb 21, 2025

Choose a reason for hiding this comment

isabelizimm left a comment

Choose a reason for hiding this comment

isabelizimm Feb 21, 2025

Choose a reason for hiding this comment

isabelizimm commented Feb 21, 2025 • edited Loading

isabelizimm left a comment

Choose a reason for hiding this comment

sharon-wang commented Feb 21, 2025

Add `python.interpreters.include` and `python.interpreters.exclude` settings #6398

Add `python.interpreters.include` and `python.interpreters.exclude` settings #6398

sharon-wang commented Feb 19, 2025 •

edited

Loading

github-actions bot commented Feb 19, 2025 •

edited

Loading

isabelizimm commented Feb 21, 2025 •

edited

Loading