#1228 multiroot interpreter display

.vscode/launch.json

@@ -1,25 +1,7 @@
 // A launch configuration that compiles the extension and then opens it inside a new window
 {
 	"version": "0.1.0",
-	"configurations": [{
-			"name": "CompletionServer.ppy",
-			"type": "python",
-			"request": "launch",
-			"stopOnEntry": true,
-			"pythonPath": "python",
-			"program": "${workspaceRoot}/pythonFiles/completionServer.py",
-			"cwd": "${workspaceRoot}",
-			"env": {},
-			"args": [
-				"123"
-			],
-			"envFile": "${workspaceRoot}/.env",
-			"debugOptions": [
-				"WaitOnAbnormalExit",
-				"WaitOnNormalExit",
-				"RedirectOutput"
-			]
-		},
+	"configurations": [
 		{
 			"name": "Launch Extension",
 			"type": "extensionHost",
@@ -83,28 +65,15 @@
 				"${workspaceRoot}/out/**/*.js"
 			],
 			"preLaunchTask": "compile"
-		},
-		{
-			"name": "Python",
-			"type": "python",
-			"request": "launch",
-			"stopOnEntry": true,
-			"pythonPath": "python",
-			"program": "${file}",
-			"console": "integratedTerminal",
-			"args": [],
-			"debugOptions": [
-				"WaitOnAbnormalExit",
-				"WaitOnNormalExit",
-				"RedirectOutput"
-			],
-			"cwd": "${workspaceRoot}"
 		}
 	],
-	"compounds": [{
-		"name": "Extension + Debugger",
-		"configurations": [
-			"Launch Extension", "Launch Extension as debugServer"
-		]
-	}]
+	"compounds": [
+		{
+			"name": "Extension + Debugger",
+			"configurations": [
+				"Launch Extension",
+				"Launch Extension as debugServer"
+			]
+		}
+	]
 }

pythonFiles/PythonTools/ipythonServer.py

@@ -55,7 +55,7 @@
     from queue import Empty, Queue  # Python 3
 
 DEBUG = os.environ.get('DEBUG_DJAYAMANNE_IPYTHON', '0') == '1'
-TEST = os.environ.get('PYTHON_DONJAYAMANNE_TEST', '0') == '1'
+TEST = os.environ.get('VSC_PYTHON_CI_TEST', '0') == '1'
 
 # The great "support IPython 2, 3, 4" strat begins
 if not TEST:

pythonFiles/completionServer.py

@@ -55,7 +55,7 @@
     from queue import Empty, Queue  # Python 3
 
 DEBUG = os.environ.get('DEBUG_DJAYAMANNE_IPYTHON', '0') == '1'
-TEST = os.environ.get('PYTHON_DONJAYAMANNE_TEST', '0') == '1'
+TEST = os.environ.get('VSC_PYTHON_CI_TEST', '0') == '1'
 
 def _debug_write(out):
     if DEBUG:

src/client/common/configSettings.ts

@@ -5,7 +5,9 @@ import { EventEmitter } from 'events';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import { Uri } from 'vscode';
+import { InterpreterInfoCache } from './interpreterInfoCache';
 import { SystemVariables } from './systemVariables';
+
 // tslint:disable-next-line:no-require-imports no-var-requires
 const untildify = require('untildify');
 
@@ -135,7 +137,7 @@ export interface JupyterSettings {
 }
 
 // tslint:disable-next-line:no-string-literal
-const IS_TEST_EXECUTION = process.env['PYTHON_DONJAYAMANNE_TEST'] === '1';
+const IS_TEST_EXECUTION = process.env['VSC_PYTHON_CI_TEST'] === '1';
 
 // tslint:disable-next-line:completed-docs
 export class PythonSettings extends EventEmitter implements IPythonSettings {
@@ -197,10 +199,12 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         // tslint:disable-next-line:no-unsafe-any
         this.disposables.forEach(disposable => disposable.dispose());
         this.disposables = [];
+        InterpreterInfoCache.clear();
     }
 
     // tslint:disable-next-line:cyclomatic-complexity max-func-body-length
     private initializeSettings() {
+        InterpreterInfoCache.clear();
         const workspaceRoot = this.workspaceRoot.fsPath;
         const systemVariables: SystemVariables = new SystemVariables(this.workspaceRoot ? this.workspaceRoot.fsPath : undefined);
         const pythonSettings = vscode.workspace.getConfiguration('python', this.workspaceRoot);
@@ -213,8 +217,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         this.jediPath = systemVariables.resolveAny(pythonSettings.get<string>('jediPath'))!;
         if (typeof this.jediPath === 'string' && this.jediPath.length > 0) {
             this.jediPath = getAbsolutePath(systemVariables.resolveAny(this.jediPath), workspaceRoot);
-        }
-        else {
+        } else {
             this.jediPath = '';
         }
         // tslint:disable-next-line:no-backbone-get-set-outside-model no-non-null-assertion
@@ -230,16 +233,14 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         this.disablePromptForFeatures = Array.isArray(this.disablePromptForFeatures) ? this.disablePromptForFeatures : [];
         if (this.linting) {
             Object.assign<ILintingSettings, ILintingSettings>(this.linting, lintingSettings);
-        }
-        else {
+        } else {
             this.linting = lintingSettings;
         }
         // tslint:disable-next-line:no-backbone-get-set-outside-model no-non-null-assertion
         const sortImportSettings = systemVariables.resolveAny(pythonSettings.get<ISortImportSettings>('sortImports'))!;
         if (this.sortImports) {
             Object.assign<ISortImportSettings, ISortImportSettings>(this.sortImports, sortImportSettings);
-        }
-        else {
+        } else {
             this.sortImports = sortImportSettings;
         }
         // Support for travis.
@@ -290,8 +291,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         const formattingSettings = systemVariables.resolveAny(pythonSettings.get<IFormattingSettings>('formatting'))!;
         if (this.formatting) {
             Object.assign<IFormattingSettings, IFormattingSettings>(this.formatting, formattingSettings);
-        }
-        else {
+        } else {
             this.formatting = formattingSettings;
         }
         // Support for travis.
@@ -309,8 +309,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         const autoCompleteSettings = systemVariables.resolveAny(pythonSettings.get<IAutoCompeteSettings>('autoComplete'))!;
         if (this.autoComplete) {
             Object.assign<IAutoCompeteSettings, IAutoCompeteSettings>(this.autoComplete, autoCompleteSettings);
-        }
-        else {
+        } else {
             this.autoComplete = autoCompleteSettings;
         }
         // Support for travis.
@@ -324,8 +323,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         const workspaceSymbolsSettings = systemVariables.resolveAny(pythonSettings.get<IWorkspaceSymbolSettings>('workspaceSymbols'))!;
         if (this.workspaceSymbols) {
             Object.assign<IWorkspaceSymbolSettings, IWorkspaceSymbolSettings>(this.workspaceSymbols, workspaceSymbolsSettings);
-        }
-        else {
+        } else {
             this.workspaceSymbols = workspaceSymbolsSettings;
         }
         // Support for travis.
@@ -343,8 +341,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         const unitTestSettings = systemVariables.resolveAny(pythonSettings.get<IUnitTestSettings>('unitTest'))!;
         if (this.unitTest) {
             Object.assign<IUnitTestSettings, IUnitTestSettings>(this.unitTest, unitTestSettings);
-        }
-        else {
+        } else {
             this.unitTest = unitTestSettings;
             if (IS_TEST_EXECUTION && !this.unitTest) {
                 // tslint:disable-next-line:prefer-type-cast
@@ -381,8 +378,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         const terminalSettings = systemVariables.resolveAny(pythonSettings.get<ITerminalSettings>('terminal'))!;
         if (this.terminal) {
             Object.assign<ITerminalSettings, ITerminalSettings>(this.terminal, terminalSettings);
-        }
-        else {
+        } else {
             this.terminal = terminalSettings;
             if (IS_TEST_EXECUTION && !this.terminal) {
                 // tslint:disable-next-line:prefer-type-cast
@@ -402,7 +398,9 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
             appendResults: true, defaultKernel: '', startupCode: []
         };
 
-        this.emit('change');
+        // If workspace config changes, then we could have a cascading effect of on change events.
+        // Let's defer the change notification.
+        setTimeout(() => this.emit('change'), 1);
     }
 
     public get pythonPath(): string {
@@ -416,8 +414,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         // E.g. virtual directory name.
         try {
             this._pythonPath = getPythonExecutable(value);
-        }
-        catch (ex) {
+        } catch (ex) {
             this._pythonPath = value;
         }
     }
@@ -461,8 +458,7 @@ function getPythonExecutable(pythonPath: string): string {
             if (isValidPythonPath(path.join(pythonPath, 'scripts', executableName))) {
                 return path.join(pythonPath, 'scripts', executableName);
             }
-        }
-        else {
+        } else {
             if (isValidPythonPath(path.join(pythonPath, executableName))) {
                 return path.join(pythonPath, executableName);
             }
@@ -479,8 +475,7 @@ function isValidPythonPath(pythonPath: string): boolean {
     try {
         const output = child_process.execFileSync(pythonPath, ['-c', 'print(1234)'], { encoding: 'utf8' });
         return output.startsWith('1234');
-    }
-    catch (ex) {
+    } catch (ex) {
         return false;
     }
 }

src/client/common/installer.ts

@@ -263,15 +263,15 @@ export class Installer implements vscode.Disposable {
         if (this.outputChannel && installArgs[0] === '-m') {
             // Errors are just displayed to the user
             this.outputChannel.show();
-            installationPromise = execPythonFile(settings.PythonSettings.getInstance(resource).pythonPath,
+            installationPromise = execPythonFile(resource, settings.PythonSettings.getInstance(resource).pythonPath,
                 installArgs, getCwdForInstallScript(resource), true, (data) => { this.outputChannel!.append(data); });
         }
         else {
             // When using terminal get the fully qualitified path
             // Cuz people may launch vs code from terminal when they have activated the appropriate virtual env
             // Problem is terminal doesn't use the currently activated virtual env
             // Must have something to do with the process being launched in the terminal
-            installationPromise = getFullyQualifiedPythonInterpreterPath()
+            installationPromise = getFullyQualifiedPythonInterpreterPath(resource)
                 .then(pythonPath => {
                     let installScript = installArgs.join(' ');
 
@@ -340,7 +340,7 @@ async function isProductInstalled(product: Product, resource?: Uri): Promise<boo
     }
     const prodExec = ProductExecutableAndArgs.get(product)!;
     const cwd = getCwdForInstallScript(resource);
-    return execPythonFile(prodExec.executable, prodExec.args.concat(['--version']), cwd, false)
+    return execPythonFile(resource, prodExec.executable, prodExec.args.concat(['--version']), cwd, false)
         .then(() => true)
         .catch(reason => !isNotInstalledError(reason));
 }
@@ -350,5 +350,5 @@ function uninstallproduct(product: Product, resource?: Uri): Promise<any> {
         return Promise.resolve();
     }
     const uninstallArgs = ProductUninstallScripts.get(product)!;
-    return execPythonFile('python', uninstallArgs, getCwdForInstallScript(resource), false);
-}
+    return execPythonFile(resource, 'python', uninstallArgs, getCwdForInstallScript(resource), false);
+}

src/client/common/interpreterInfoCache.ts

@@ -0,0 +1,54 @@
+import { Uri, workspace } from 'vscode';
+
+type InterpreterCache = {
+    pythonInterpreterDirectory?: string;
+    pythonInterpreterPath?: string;
+    pythonSettingsPath?: string;
+    // tslint:disable-next-line:no-any
+    customEnvVariables?: any;
+};
+
+const cache = new Map<string, InterpreterCache>();
+
+// tslint:disable-next-line:no-stateless-class
+export class InterpreterInfoCache {
+    // tslint:disable-next-line:function-name
+    public static clear(): void {
+        cache.clear();
+    }
+    // tslint:disable-next-line:function-name
+    public static get(resource?: Uri) {
+        const cacheKey = InterpreterInfoCache.getCacheKey(resource) || '';
+        return cache.has(cacheKey) ? cache.get(cacheKey) : {};
+    }
+    // tslint:disable-next-line:function-name
+    public static setPaths(resource?: Uri, pythonSettingsPath?: string, pythonInterpreterPath?: string, pythonInterpreterDirectory?: string) {
+        InterpreterInfoCache.setCacheData('pythonInterpreterDirectory', resource, pythonInterpreterDirectory);
+        InterpreterInfoCache.setCacheData('pythonInterpreterPath', resource, pythonInterpreterPath);
+        InterpreterInfoCache.setCacheData('pythonSettingsPath', resource, pythonSettingsPath);
+    }
+
+    // tslint:disable-next-line:no-any function-name
+    public static setCustomEnvVariables(resource?: Uri, envVars?: any) {
+        // tslint:disable-next-line:no-any
+        InterpreterInfoCache.setCacheData('customEnvVariables', resource, envVars);
+    }
+    // tslint:disable-next-line:no-any function-name
+    private static setCacheData(property: keyof InterpreterCache, resource?: Uri, value?: any) {
+        const cacheKey = InterpreterInfoCache.getCacheKey(resource) || '';
+        // tslint:disable-next-line:prefer-type-cast
+        const data = cache.has(cacheKey) ? cache.get(cacheKey) : {} as InterpreterCache;
+        data[property] = value;
+        cache.set(cacheKey, data);
+    }
+    private static getCacheKey(resource?: Uri): string {
+        if (!Array.isArray(workspace.workspaceFolders) || workspace.workspaceFolders.length === 0) {
+            return '';
+        }
+        if (!resource || workspace.workspaceFolders.length === 1) {
+            return workspace.workspaceFolders[0].uri.fsPath;
+        }
+        const folder = workspace.getWorkspaceFolder(resource);
+        return folder ? folder.uri.fsPath : '';
+    }
+}

src/client/common/logger.ts

@@ -22,7 +22,7 @@ class Logger {
         Logger.writeLine(category, message);
     }
     static writeLine(category: string = "log", line: any) {
-        if (process.env['PYTHON_DONJAYAMANNE_TEST'] !== '1') {
+        if (process.env['VSC_PYTHON_CI_TEST'] !== '1') {
             console[category](line);
         }
         if (outChannel) {