python: respect defaultInterpreterPath when specified (#6414)

isabelizimm · seeM · sharon-wang · web-flow · commit 5140ddd59a30 · 2025-03-11T13:34:46.000-04:00
Adds in a selection process for implicitly or immediately starting a runtime before discovery in `recommendWorkspaceRuntime()`. The hope here is that, if there is a local env or a user-defined environment we know about _before_ discovery, we can automatically select it. ### Release Notes  #### New Features - #6281 - #6204 #### Bug Fixes - N/A ### QA Notes  I have a few scenarios highlighted and what is expected. Since this part of the codebase cares a lot about past selections, I'd highly recommend clearing state and then restoring settings by running: ``` rm -rf ~/.vscode-oss-dev/; rm -rf ~/.positron-dev; mkdir -p ~/.vscode-oss-dev/User; touch ~/.vscode-oss-dev/User/settings.json; echo '{"python.defaultInterpreterPath": "PATH TO SOME PYTHON"}' > ~/.vscode-oss-dev/User/settings.json ``` | scenario | expected | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | | in workspace:<br>has .venv<br>has user level defaultInterpreterPath set | .venv<br>immediate startup | | in workspace:<br>had active runtime when Positron shut down<br>has user level defaultInterpreterPath | previous active runtime<br>immediate startup<br> | | in workspace:<br>brand new, no affiliated runtime<br>has user level defaultInterpreterPath set | user level defaultInterpreterPath<br>implicit startup | | in workspace:<br>no affiliated runtime<br>has workspace level defaultInterpreterPath set<br>has user level defaultInterpreterPath set | workspace level defaultInterpreterPath<br>implicit startup | | no workspace:<br>has user level defaultInterpreterPath set | user level defaultInterpreterPath<br>implicit startup | --------- Signed-off-by: Isabel Zimmerman <54685329+isabelizimm@users.noreply.github.com> Co-authored-by: Wasim Lorgat <mwlorgat@gmail.com> Co-authored-by: sharon <sharon-wang@users.noreply.github.com>
diff --git a/extensions/positron-python/package.nls.json b/extensions/positron-python/package.nls.json
@@ -50,7 +50,7 @@
     "python.condaPath.description": "Path to the conda executable to use for activation (version 4.4+).",
     "python.environmentProviders.enable.markdownDescription": "Configures which Python environment providers are enabled in Positron. Check the box to enable or uncheck the box to disable an environment provider.\n\nRequires a restart to take effect.",
     "python.debugger.deprecatedMessage": "This configuration will be deprecated soon. Please replace `python` with `debugpy` to use the new Python Debugger extension.",
-    "python.defaultInterpreterPath.description": "Path to default Python to use when extension loads up for the first time, no longer used once an interpreter is selected for the workspace. See [here](https://aka.ms/AAfekmf) to understand when this is used",
+    "python.defaultInterpreterPath.description": "Path to default Python to use when extension loads up for the first time, no longer used once an interpreter is selected for the workspace. Must be an absolute path.",
     "python.interpreters.include.markdownDescription": "List of folders (absolute paths) to search for Python installations. These folders are searched in addition to the default folders for your operating system.\n\nExample: if you have Python located at `/custom/pythons/3.10.4/bin/python`, add path `/custom/pythons` or `/custom/pythons/3.10.4` to this setting.\n\nNote:  If an interpreter is both included via `python.interpreters.include` and excluded via `python.interpreters.exclude`, it will not be displayed in the Positron UI.\n\nRequires a restart to take effect.",
     "python.interpreters.exclude.markdownDescription": "List of interpreter paths or folders (absolute paths) to exclude from the available Python installations. These interpreters will not be displayed in the Positron UI.\n\nExample: Add `/usr/bin/python3` to exclude the specific interpreter, or `/opt/homebrew` to exclude all brew-installed Pythons on macOS.\n\nRequires a restart to take effect.",
     "python.envFile.description": "Absolute path to a file containing environment variable definitions.",
diff --git a/extensions/positron-python/src/client/common/interpreterPathService.ts b/extensions/positron-python/src/client/common/interpreterPathService.ts
@@ -111,11 +111,14 @@ export class InterpreterPathService implements IInterpreterPathService {
     ): Promise<void> {
         resource = PythonSettings.getSettingsUriAndTarget(resource, this.workspaceService).uri;
         if (configTarget === ConfigurationTarget.Global) {
-            const pythonConfig = this.workspaceService.getConfiguration('python');
-            const globalValue = pythonConfig.inspect<string>('defaultInterpreterPath')!.globalValue;
-            if (globalValue !== pythonPath) {
-                await pythonConfig.update('defaultInterpreterPath', pythonPath, true);
-            }
+            // --- Start Positron ---
+            // do not update global interpreter path setting via the Select Interpreter dropdown
+            // const pythonConfig = this.workspaceService.getConfiguration('python');
+            // const globalValue = pythonConfig.inspect<string>('defaultInterpreterPath')!.globalValue;
+            // if (globalValue !== pythonPath) {
+            //     await pythonConfig.update('defaultInterpreterPath', pythonPath, true);
+            // }
+            // --- End Positron ---
             return;
         }
         if (!resource) {
diff --git a/extensions/positron-python/src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts b/extensions/positron-python/src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts
@@ -15,6 +15,9 @@ import { sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
 import { IPythonPathUpdaterServiceManager } from '../configuration/types';
 import { IActivatedEnvironmentLaunch, IInterpreterService } from '../contracts';
+// --- Start Positron ---
+import { getUserDefaultInterpreter } from '../../positron/interpreterSettings';
+// --- End Positron ---
 
 @injectable()
 export class ActivatedEnvironmentLaunch implements IActivatedEnvironmentLaunch {
@@ -101,6 +104,12 @@ export class ActivatedEnvironmentLaunch implements IActivatedEnvironmentLaunch {
         }
         this.wasSelected = true;
         this.inMemorySelection = prefix;
+        // --- Start Positron ---
+        // prefer user setting defaultInterpreterPath (if set) if no workspace is opened
+        if (getUserDefaultInterpreter().globalValue && !this.workspaceService.workspaceFolders) {
+            return undefined;
+        }
+        // --- End Positron ---
         traceLog(
             `VS Code was launched from an activated environment: '${path.basename(
                 prefix,
diff --git a/extensions/positron-python/src/client/positron/discoverer.ts b/extensions/positron-python/src/client/positron/discoverer.ts
@@ -16,6 +16,7 @@ import { createPythonRuntimeMetadata } from './runtime';
 import { comparePythonVersionDescending } from '../interpreter/configuration/environmentTypeComparer';
 import { MINIMUM_PYTHON_VERSION } from '../common/constants';
 import { isVersionSupported, shouldIncludeInterpreter } from './interpreterSettings';
+import { hasFiles } from './util';
 
 /**
  * Provides Python language runtime metadata to Positron; called during the
@@ -151,11 +152,3 @@ function sortInterpreters(
     });
     return copy;
 }
-
-// Check if the current workspace contains files matching any of the passed glob ptaterns
-async function hasFiles(includes: string[]): Promise<boolean> {
-    // Create a single glob pattern e.g. ['a', 'b'] => '{a,b}'
-    const include = `{${includes.join(',')}}`;
-    // Exclude node_modules for performance reasons
-    return (await vscode.workspace.findFiles(include, '**/node_modules/**', 1)).length > 0;
-}
diff --git a/extensions/positron-python/src/client/positron/interpreterSettings.ts b/extensions/positron-python/src/client/positron/interpreterSettings.ts
@@ -4,7 +4,6 @@
  *--------------------------------------------------------------------------------------------*/
 
 import path from 'path';
-
 import { traceInfo, traceVerbose } from '../logging';
 import { getConfiguration } from '../common/vscodeApis/workspaceApis';
 import { arePathsSame, isParentPath } from '../pythonEnvironments/common/externalDependencies';
@@ -16,6 +15,7 @@ import {
 import { untildify } from '../common/helpers';
 import { PythonEnvironment } from '../pythonEnvironments/info';
 import { PythonVersion } from '../pythonEnvironments/info/pythonVersion';
+import { Resource, InspectInterpreterSettingType } from '../common/types';
 import { comparePythonVersionDescending } from '../interpreter/configuration/environmentTypeComparer';
 
 /**
@@ -209,3 +209,35 @@ export function printInterpreterDebugInfo(interpreters: PythonEnvironment[]): vo
     traceInfo('================ [END] PYTHON INTERPRETER DEBUG INFO ================');
     traceInfo('=====================================================================');
 }
+
+/**
+ * Retrieves the user's default Python interpreter path from VS Code settings
+ *
+ * @returns The configured Python interpreter path if it exists and is not 'python',
+ *          otherwise returns an empty string
+ */
+export function getUserDefaultInterpreter(scope?: Resource): InspectInterpreterSettingType {
+    const configuration = getConfiguration('python', scope);
+    const defaultInterpreterPath: InspectInterpreterSettingType =
+        configuration?.inspect<string>('defaultInterpreterPath') ?? {};
+
+    const processPath = (value: string | undefined): string => {
+        // 'python' is the default for this setting. we only want to know if it has changed
+        if (value === 'python') {
+            return '';
+        }
+        if (value) {
+            if (!path.isAbsolute(value)) {
+                traceInfo(`[getUserDefaultInterpreter]: interpreter path ${value} is not absolute...ignoring`);
+                return '';
+            }
+            return value;
+        }
+        return value ?? '';
+    };
+
+    defaultInterpreterPath.globalValue = processPath(defaultInterpreterPath.globalValue);
+    defaultInterpreterPath.workspaceValue = processPath(defaultInterpreterPath.workspaceValue);
+    defaultInterpreterPath.workspaceFolderValue = processPath(defaultInterpreterPath.workspaceFolderValue);
+    return defaultInterpreterPath;
+}
diff --git a/extensions/positron-python/src/client/positron/manager.ts b/extensions/positron-python/src/client/positron/manager.ts
@@ -25,9 +25,10 @@ import { EXTENSION_ROOT_DIR, MINIMUM_PYTHON_VERSION } from '../common/constants'
 import { JupyterKernelSpec } from '../positron-supervisor.d';
 import { IEnvironmentVariablesProvider } from '../common/variables/types';
 import { checkAndInstallPython } from './extension';
-import { shouldIncludeInterpreter, isVersionSupported } from './interpreterSettings';
+import { shouldIncludeInterpreter, isVersionSupported, getUserDefaultInterpreter } from './interpreterSettings';
 import { parseVersion, toSemverLikeVersion } from '../pythonEnvironments/base/info/pythonVersion';
 import { PythonVersion } from '../pythonEnvironments/info/pythonVersion';
+import { hasFiles } from './util';
 
 export const IPythonRuntimeManager = Symbol('IPythonRuntimeManager');
 
@@ -97,12 +98,63 @@ export class PythonRuntimeManager implements IPythonRuntimeManager {
         return this.discoverPythonRuntimes();
     }
 
+    /**
+     * Get the recommended Python interpreter path for the workspace.
+     * Returns an object with the path and whether it should be immediately selected.
+     */
+    private async recommendedWorkspaceInterpreterPath(
+        workspaceUri: vscode.Uri | undefined,
+    ): Promise<{ path: string | undefined; isImmediate: boolean }> {
+        const userInterpreterSettings = getUserDefaultInterpreter(workspaceUri);
+        let interpreterPath: string | undefined;
+        let isImmediate = false;
+
+        if (!workspaceUri) {
+            if (userInterpreterSettings.globalValue) {
+                interpreterPath = userInterpreterSettings.globalValue;
+            } else {
+                return { path: undefined, isImmediate };
+            }
+        } else if (await hasFiles(['.venv/**/*'])) {
+            interpreterPath = path.join(workspaceUri.fsPath, '.venv', 'bin', 'python');
+            isImmediate = true;
+        } else if (await hasFiles(['.conda/**/*'])) {
+            interpreterPath = path.join(workspaceUri.fsPath, '.conda', 'bin', 'python');
+            isImmediate = true;
+        } else if (await hasFiles(['*/bin/python'])) {
+            // if we found */bin/python but not .venv or .conda, use the first one we find
+            const files = await vscode.workspace.findFiles('*/bin/python', '**/node_modules/**');
+            if (files.length > 0) {
+                interpreterPath = files[0].fsPath;
+                isImmediate = true;
+            }
+        } else {
+            interpreterPath =
+                userInterpreterSettings.workspaceValue ||
+                userInterpreterSettings.workspaceFolderValue ||
+                userInterpreterSettings.globalValue;
+        }
+
+        return { path: interpreterPath, isImmediate };
+    }
+
     /**
      * Recommend a Python language runtime based on the workspace.
      */
     async recommendedWorkspaceRuntime(): Promise<positron.LanguageRuntimeMetadata | undefined> {
-        // TODO: This is where we could recommend a runtime based on the
-        // workspace, e.g. if it contains a virtualenv
+        // TODO: may need other handling for multiroot workspaces
+        const workspaceUri = vscode.workspace.workspaceFolders?.[0]?.uri;
+        const { path: interpreterPath, isImmediate } = await this.recommendedWorkspaceInterpreterPath(workspaceUri);
+
+        if (interpreterPath) {
+            const interpreter = await this.interpreterService.getInterpreterDetails(interpreterPath, workspaceUri);
+            if (interpreter) {
+                const metadata = await createPythonRuntimeMetadata(interpreter, this.serviceContainer, isImmediate);
+                traceInfo(`Recommended runtime for workspace: ${interpreter.path}`);
+                return metadata;
+            }
+        }
+        traceInfo('No recommended workspace runtime found.');
         return undefined;
     }
 
diff --git a/extensions/positron-python/src/client/positron/util.ts b/extensions/positron-python/src/client/positron/util.ts
@@ -3,6 +3,9 @@
  *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import * as vscode from 'vscode';
+import { traceVerbose } from '../logging';
+
 export class PromiseHandles<T> {
     resolve!: (value: T | Promise<T>) => void;
 
@@ -26,3 +29,16 @@ export async function whenTimeout<T>(ms: number, fn: () => T): Promise<T> {
     await delay(ms);
     return fn();
 }
+
+// Check if the current workspace contains files matching any of the passed glob ptaterns
+export async function hasFiles(includes: string[]): Promise<boolean> {
+    // Create a single glob pattern e.g. ['a', 'b'] => '{a,b}'
+    const include = `{${includes.join(',')}}`;
+    traceVerbose(`Searching for _files_ with pattern: ${include}`);
+
+    // Exclude node_modules for performance reasons
+    const files = await vscode.workspace.findFiles(include, '**/node_modules/**', 1);
+    traceVerbose(`Found _files_: ${files.map((file) => file.fsPath)}`);
+
+    return files.length > 0;
+}
diff --git a/extensions/positron-python/src/test/common/interpreterPathService.unit.test.ts b/extensions/positron-python/src/test/common/interpreterPathService.unit.test.ts
@@ -95,7 +95,10 @@ suite('Interpreter Path Service', async () => {
         workspaceConfig
             .setup((w) => w.update('defaultInterpreterPath', interpreterPath, true))
             .returns(() => Promise.resolve())
-            .verifiable(TypeMoq.Times.once());
+            /// --- Start Positron ---
+            // Do not reset defaultInterpreterPath setting unless the user does
+            .verifiable(TypeMoq.Times.never());
+        // --- End Positron ---
 
         await interpreterPathService.update(resource, ConfigurationTarget.Global, interpreterPath);
 
diff --git a/extensions/positron-python/src/test/positron/manager.unit.test.ts b/extensions/positron-python/src/test/positron/manager.unit.test.ts
