Interpreter selection not saved in workspace configuration

[schlamar]

Environment data

• VS Code version: 1.37.1
• Extension version (available under the Extensions sidebar): 2019.8.30787
• OS and version: Windows 7
• Jedi or Language Server? (i.e. what is "python.jediEnabled" set to; more info How to update the language server to the latest stable version #3977): Language Server

Expected behaviour

Python interpreter configuration is saved in the *.code-workspace file.

Actual behaviour

Python interpreter configuration is saved in the .vscode/settings.json

Steps to reproduce

1. Open a workspace
2. Select a Python interpreter in the status bar

[schlamar]

Related to #2125, but not a duplicate.

[kimadeline]

Cause

In src/client/interpreter/configuration/interpreterSelector.ts we set the configuration target to either be global or the return value of getWorkspaceToSetPythonPath():

vscode-python/src/client/interpreter/configuration/interpreterSelector.ts

Lines 57 to 64 in 8f5861e

	if (!setInterpreterGlobally) {
	const targetConfig = await this.getWorkspaceToSetPythonPath();
	if (!targetConfig) {
	return;
	}
	configTarget = targetConfig.configTarget;
	wkspace = targetConfig.folderUri;
	}

and getWorkspaceToSetPythonPath only returns workspace folder-level config targets, never workspace:

vscode-python/src/client/interpreter/configuration/interpreterSelector.ts

Lines 102 to 113 in 8f5861e

	private async getWorkspaceToSetPythonPath(): Promise<WorkspacePythonPath | undefined> {
	if (!Array.isArray(this.workspaceService.workspaceFolders) || this.workspaceService.workspaceFolders.length === 0) {
	return undefined;
	}
	if (this.workspaceService.workspaceFolders.length === 1) {
	return { folderUri: this.workspaceService.workspaceFolders[0].uri, configTarget: ConfigurationTarget.WorkspaceFolder };
	}
	// Ok we have multiple workspaces, get the user to pick a folder.
	const workspaceFolder = await this.applicationShell.showWorkspaceFolderPick({ placeHolder: 'Select a workspace' });
	return workspaceFolder ? { folderUri: workspaceFolder.uri, configTarget: ConfigurationTarget.WorkspaceFolder } : undefined;
	}

So when we call update (VS Code API doc) via updatePythonPath we never update the .code-workspace file:

vscode-python/src/client/interpreter/configuration/interpreterSelector.ts

Lines 75 to 77 in 8f5861e

	if (selection !== undefined) {
	await this.pythonPathUpdaterService.updatePythonPath(selection.path, configTarget, 'ui', wkspace);
	}

[schlamar]

BTW, the API documentation advises, that you should use the WorkspaceConfiguration.update function: https://code.visualstudio.com/api/references/vscode-api#WorkspaceConfiguration.update

Note: it is not advised to use workspace.workspaceFile to write configuration data into the file. You can use workspace.getConfiguration().update() for that purpose which will work both when a single folder is opened as well as an untitled or saved workspace.
(from https://code.visualstudio.com/api/references/vscode-api#workspace.workspaceFile)

[kimadeline]

Thank you for the heads-up 👍 it's already what we call under the hood in our implementations of IPythonPathUpdaterService.updatePythonPath():

So when we call update (VS Code API doc) via updatePythonPath we never update the .code-workspace file:

[kynan]

This still seems to be an issue with VS Code 1.45.1 and ms-python.python 2020.6.90262

Selecting an interpreter (either via the status bar or the dialog) is not setting python.pythonPath in .vscode/settings.json. This breaks other extensions that rely on that setting, like lextudio.restructuredtext.

[kimadeline]

Hi @kynan, we deprecated the use of python.pythonPath. Instead, lextudio.restructuredtext should fetch the python interpreter using the API we expose: currently formulahendry/vscode-code-runner#604 (implementation example here), but we will update it to #12596.

Please open a separate issue if you have any further questions.

Closing this issue since we don't save python.PythonPath anymore.