Use ${command:python.interpreterPath} to get selected interpreter path in launch.json and tasks.json (microsoft#11840)

* Added implementation * Replace config with command * Added migrations * Added tests * Added tests * Undo * News entry * Remove variable

Author: Kartik Raj

news/2 Fixes/11789.md

@@ -0,0 +1 @@
+Use `${command:python.interpreterPath}` to get selected interpreter path in `launch.json` and `tasks.json`.

package.json

@@ -1212,7 +1212,7 @@
  "pythonPath": {
  "type": "string",
  "description": "Path (fully qualified) to python executable. Defaults to the value in settings",
- "default": "${config:python.interpreterPath}"
+ "default": "${command:python.interpreterPath}"
  },
  "args": {
  "type": "array",
@@ -1350,7 +1350,7 @@
  "pythonPath": {
  "type": "string",
  "description": "Path (fully qualified) to python executable. Defaults to the value in settings",
- "default": "${config:python.interpreterPath}"
+ "default": "${command:python.interpreterPath}"
  },
  "stopOnEntry": {
  "type": "boolean",

src/client/application/diagnostics/checks/invalidLaunchJsonDebugger.ts

@@ -113,7 +113,10 @@ export class InvalidLaunchJsonDebuggerService extends BaseDiagnosticsService {
  if (fileContents.indexOf('"console": "none"') > 0) {
  diagnostics.push(new InvalidLaunchJsonDebuggerDiagnostic(DiagnosticCodes.ConsoleTypeDiagnostic, resource));
  }
- if (fileContents.indexOf('{config:python.pythonPath}') > 0) {
+ if (
+ fileContents.indexOf('{config:python.pythonPath}') > 0 ||
+ fileContents.indexOf('{config:python.interpreterPath}') > 0
+ ) {
  diagnostics.push(
  new InvalidLaunchJsonDebuggerDiagnostic(DiagnosticCodes.ConfigPythonPathDiagnostic, resource, false)
  );
@@ -169,7 +172,12 @@ export class InvalidLaunchJsonDebuggerService extends BaseDiagnosticsService {
  fileContents = this.findAndReplace(
  fileContents,
  '{config:python.pythonPath}',
- '{config:python.interpreterPath}'
+ '{command:python.interpreterPath}'
+ );
+ fileContents = this.findAndReplace(
+ fileContents,
+ '{config:python.interpreterPath}',
+ '{command:python.interpreterPath}'
  );
  break;
  }

src/client/application/diagnostics/checks/invalidPythonPathInDebugger.ts

@@ -76,7 +76,7 @@ export class InvalidPythonPathInDebuggerService extends BaseDiagnosticsService
  public async validatePythonPath(pythonPath?: string, pythonPathSource?: PythonPathSource, resource?: Uri) {
  pythonPath = pythonPath ? this.resolveVariables(pythonPath, resource) : undefined;
  // tslint:disable-next-line:no-invalid-template-strings
- if (pythonPath === '${config:python.interpreterPath}' || !pythonPath) {
+ if (pythonPath === '${command:python.interpreterPath}' || !pythonPath) {
  pythonPath = this.configService.getSettings(resource).pythonPath;
  }
  if (await this.interpreterHelper.getInterpreterInformation(pythonPath).catch(() => undefined)) {

src/client/common/application/commands.ts

@@ -94,6 +94,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
  ['vscode.open']: [Uri];
  ['workbench.action.files.saveAs']: [Uri];
  ['workbench.action.files.save']: [Uri];
+ [Commands.GetSelectedInterpreterPath]: [{ workspaceFolder: string } | string[]];
  [Commands.Build_Workspace_Symbols]: [boolean, CancellationToken];
  [Commands.Sort_Imports]: [undefined, Uri];
  [Commands.Exec_In_Terminal]: [undefined, Uri];

src/client/common/constants.ts

@@ -63,6 +63,7 @@ export namespace Commands {
  export const SwitchToInsidersDaily = 'python.switchToDailyChannel';
  export const SwitchToInsidersWeekly = 'python.switchToWeeklyChannel';
  export const PickLocalProcess = 'python.pickLocalProcess';
+ export const GetSelectedInterpreterPath = 'python.interpreterPath';
  export const ClearWorkspaceInterpreter = 'python.clearWorkspaceInterpreter';
  export const ResetInterpreterSecurityStorage = 'python.resetInterpreterSecurityStorage';
 }

src/client/debugger/extension/configuration/launch.json/interpreterPathCommand.ts

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { inject, injectable } from 'inversify';
+import { Uri } from 'vscode';
+import { IExtensionSingleActivationService } from '../../../../activation/types';
+import { ICommandManager } from '../../../../common/application/types';
+import { Commands } from '../../../../common/constants';
+import { IConfigurationService, IDisposable, IDisposableRegistry } from '../../../../common/types';
+
+@injectable()
+export class InterpreterPathCommand implements IExtensionSingleActivationService {
+ constructor(
+ @inject(ICommandManager) private readonly commandManager: ICommandManager,
+ @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
+ @inject(IDisposableRegistry) private readonly disposables: IDisposable[]
+ ) {}
+
+ public async activate() {
+ this.disposables.push(
+ this.commandManager.registerCommand(Commands.GetSelectedInterpreterPath, (args) => {
+ return this._getSelectedInterpreterPath(args);
+ })
+ );
+ }
+
+ public _getSelectedInterpreterPath(args: { workspaceFolder: string } | string[]): string {
+ // If `launch.json` is launching this command, `args.workspaceFolder` carries the workspaceFolder
+ // If `tasks.json` is launching this command, `args[1]` carries the workspaceFolder
+ const workspaceFolder = 'workspaceFolder' in args ? args.workspaceFolder : args[1] ? args[1] : undefined;
+ return this.configurationService.getSettings(workspaceFolder ? Uri.parse(workspaceFolder) : undefined)
+ .pythonPath;
+ }
+}

src/client/debugger/extension/configuration/resolvers/base.ts

@@ -91,7 +91,7 @@ export abstract class BaseConfigurationResolver<T extends DebugConfiguration>
  if (!debugConfiguration) {
  return;
  }
- if (debugConfiguration.pythonPath === '${config:python.interpreterPath}' || !debugConfiguration.pythonPath) {
+ if (debugConfiguration.pythonPath === '${command:python.interpreterPath}' || !debugConfiguration.pythonPath) {
  const pythonPath = this.configurationService.getSettings(workspaceFolder).pythonPath;
  debugConfiguration.pythonPath = pythonPath;
  this.pythonPathSource = PythonPathSource.settingsJson;

src/client/debugger/extension/serviceRegistry.ts

@@ -15,6 +15,7 @@ import { IAttachProcessProviderFactory } from './attachQuickPick/types';
 import { DebuggerBanner } from './banner';
 import { PythonDebugConfigurationService } from './configuration/debugConfigurationService';
 import { LaunchJsonCompletionProvider } from './configuration/launch.json/completionProvider';
+import { InterpreterPathCommand } from './configuration/launch.json/interpreterPathCommand';
 import { LaunchJsonUpdaterService } from './configuration/launch.json/updaterService';
 import { DjangoLaunchDebugConfigurationProvider } from './configuration/providers/djangoLaunch';
 import { FileLaunchDebugConfigurationProvider } from './configuration/providers/fileLaunch';
@@ -51,6 +52,10 @@ export function registerTypes(serviceManager: IServiceManager) {
  IExtensionSingleActivationService,
  LaunchJsonCompletionProvider
  );
+ serviceManager.addSingleton<IExtensionSingleActivationService>(
+ IExtensionSingleActivationService,
+ InterpreterPathCommand
+ );
  serviceManager.addSingleton<IExtensionSingleActivationService>(
  IExtensionSingleActivationService,
  LaunchJsonUpdaterService

src/test/application/diagnostics/checks/invalidLaunchJsonDebugger.unit.test.ts

@@ -218,6 +218,31 @@ suite('Application Diagnostics - Checks if launch.json is invalid', () => {
  fs.verifyAll();
  });
 
+ test('Should return ConfigPythonPathDiagnostic if file launch.json contains string "{config:python.interpreterPath}"', async () => {
+ const fileContents = 'Hello I am launch.json, I contain string {config:python.interpreterPath}';
+ workspaceService
+ .setup((w) => w.hasWorkspaceFolders)
+ .returns(() => true)
+ .verifiable(TypeMoq.Times.once());
+ workspaceService
+ .setup((w) => w.workspaceFolders)
+ .returns(() => [workspaceFolder])
+ .verifiable(TypeMoq.Times.once());
+ fs.setup((w) => w.fileExists(TypeMoq.It.isAny()))
+ .returns(() => Promise.resolve(true))
+ .verifiable(TypeMoq.Times.once());
+ fs.setup((w) => w.readFile(TypeMoq.It.isAny()))
+ .returns(() => Promise.resolve(fileContents))
+ .verifiable(TypeMoq.Times.once());
+ const diagnostics = await diagnosticService.diagnose(undefined);
+ expect(diagnostics).to.be.deep.equal(
+ [new InvalidLaunchJsonDebuggerDiagnostic(DiagnosticCodes.ConfigPythonPathDiagnostic, undefined, false)],
+ 'Diagnostics returned are not as expected'
+ );
+ workspaceService.verifyAll();
+ fs.verifyAll();
+ });
+
  test('Should return both diagnostics if file launch.json contains string "debugStdLib" and "pythonExperimental"', async () => {
  const fileContents = 'Hello I am launch.json, I contain both "debugStdLib" and "pythonExperimental"';
  workspaceService
@@ -471,8 +496,9 @@ suite('Application Diagnostics - Checks if launch.json is invalid', () => {
  });
 
  test('File launch.json is fixed correctly when code equals ConfigPythonPathDiagnostic ', async () => {
- const launchJson = 'This string contains {config:python.pythonPath}';
- const correctedlaunchJson = 'This string contains {config:python.interpreterPath}';
+ const launchJson = 'This string contains {config:python.pythonPath} & {config:python.interpreterPath}';
+ const correctedlaunchJson =
+ 'This string contains {command:python.interpreterPath} & {command:python.interpreterPath}';
  workspaceService
  .setup((w) => w.hasWorkspaceFolders)
  .returns(() => true)