Merging isolate branch changes to main (#14966)

* Add setting to control isolation (#14845)

* Add placeholder setting field to control isolation

* Set field value from settings.

* Update tests

* Change description text for useIsolation

* Check useIsolation setting when using internal scripts (#14952)

* Check useIsolation setting when using internal scripts

* fix lint

* handle case when python settings are not available

* Use isolation setting with custom python code

* Address comments

Author: karthiknadig

package.json

@@ -1772,6 +1772,12 @@
                     "description": "Enable auto run test discovery when saving a test file.",
                     "scope": "resource"
                 },
+                "python.useIsolation": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Execute tools in isolation from the workspace.",
+                    "scope": "machine"
+                },
                 "python.venvFolders": {
                     "type": "array",
                     "default": [],

src/client/common/configSettings.ts

@@ -113,6 +113,7 @@ export class PythonSettings implements IPythonSettings {
     public experiments!: IExperiments;
     public languageServer: LanguageServerType = LanguageServerType.Microsoft;
     public logging: ILoggingSettings = { level: LogLevel.Error };
+    public useIsolation: boolean = true;
 
     protected readonly changed = new EventEmitter<void>();
     private workspaceRoot: Resource;
@@ -244,6 +245,8 @@ export class PythonSettings implements IPythonSettings {
             pythonSettings.get<boolean>('autoUpdateLanguageServer', true)
         )!;
 
+        this.useIsolation = systemVariables.resolveAny(pythonSettings.get<boolean>('useIsolation', true))!;
+
         let ls = pythonSettings.get<LanguageServerType>('languageServer') ?? LanguageServerType.Jedi;
         ls = systemVariables.resolveAny(ls);
         if (!Object.values(LanguageServerType).includes(ls)) {

src/client/common/process/internal/python.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { _ISOLATED as ISOLATED } from './scripts';
+import { _ISOLATED as ISOLATED, getUseIsolationSetting, maybeIsolated } from './scripts';
 
 // "python" contains functions corresponding to the various ways that
 // the extension invokes a Python executable internally.  Each function
@@ -16,9 +16,9 @@ import { _ISOLATED as ISOLATED } from './scripts';
 // string as the stdout text and returns the relevant data.
 
 export function execCode(code: string, isolated = true): string[] {
-    const args = ['-c', code];
+    let args = ['-c', code];
     if (isolated) {
-        args.splice(0, 0, ISOLATED);
+        args = maybeIsolated(args);
     }
     // "code" isn't specific enough to know how to parse it,
     // so we only return the args.
@@ -27,7 +27,7 @@ export function execCode(code: string, isolated = true): string[] {
 
 export function execModule(name: string, moduleArgs: string[], isolated = true): string[] {
     const args = ['-m', name, ...moduleArgs];
-    if (isolated) {
+    if (isolated && getUseIsolationSetting()) {
         args[0] = ISOLATED; // replace
     }
     // "code" isn't specific enough to know how to parse it,
@@ -47,7 +47,7 @@ export function getVersion(): [string[], (out: string) => string] {
 }
 
 export function getSysPrefix(): [string[], (out: string) => string] {
-    const args = [ISOLATED, '-c', 'import sys;print(sys.prefix)'];
+    const args = maybeIsolated(['-c', 'import sys;print(sys.prefix)']);
 
     function parse(out: string): string {
         return out.trim();
@@ -57,7 +57,7 @@ export function getSysPrefix(): [string[], (out: string) => string] {
 }
 
 export function getExecutable(): [string[], (out: string) => string] {
-    const args = [ISOLATED, '-c', 'import sys;print(sys.executable)'];
+    const args = maybeIsolated(['-c', 'import sys;print(sys.executable)']);
 
     function parse(out: string): string {
         return out.trim();
@@ -67,14 +67,10 @@ export function getExecutable(): [string[], (out: string) => string] {
 }
 
 export function getSitePackages(): [string[], (out: string) => string] {
-    const args = [
-        ISOLATED,
-        '-c',
-        // On windows we also need the libs path (second item will
-        // return c:\xxx\lib\site-packages).  This is returned by
-        // the following:
-        'from distutils.sysconfig import get_python_lib; print(get_python_lib())'
-    ];
+    // On windows we also need the libs path (second item will
+    // return c:\xxx\lib\site-packages).  This is returned by
+    // the following: get_python_lib
+    const args = maybeIsolated(['-c', 'from distutils.sysconfig import get_python_lib; print(get_python_lib())']);
 
     function parse(out: string): string {
         return out.trim();
@@ -84,7 +80,7 @@ export function getSitePackages(): [string[], (out: string) => string] {
 }
 
 export function getUserSitePackages(): [string[], (out: string) => string] {
-    const args = [ISOLATED, 'site', '--user-site'];
+    const args = maybeIsolated(['site', '--user-site']);
 
     function parse(out: string): string {
         return out.trim();
@@ -105,7 +101,7 @@ export function isValid(): [string[], (out: string) => boolean] {
 }
 
 export function isModuleInstalled(name: string): [string[], (out: string) => boolean] {
-    const args = [ISOLATED, '-c', `import ${name}`];
+    const args = maybeIsolated(['-c', `import ${name}`]);
 
     function parse(_out: string): boolean {
         // If the command did not fail then the module is installed.
@@ -116,7 +112,7 @@ export function isModuleInstalled(name: string): [string[], (out: string) => boo
 }
 
 export function getModuleVersion(name: string): [string[], (out: string) => string] {
-    const args = [ISOLATED, name, '--version'];
+    const args = maybeIsolated([name, '--version']);
 
     function parse(out: string): string {
         return out.trim();

src/client/common/process/internal/scripts/index.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import * as path from 'path';
+import { workspace } from 'vscode';
 import { EXTENSION_ROOT_DIR } from '../../../constants';
 
 // It is simpler to hard-code it instead of using vscode.ExtensionContext.extensionPath.
@@ -10,6 +11,22 @@ const SCRIPTS_DIR = _SCRIPTS_DIR;
 export const _ISOLATED = path.join(_SCRIPTS_DIR, 'pyvsc-run-isolated.py');
 const ISOLATED = _ISOLATED;
 
+export function getUseIsolationSetting(): boolean {
+    try {
+        return workspace.getConfiguration('python').get<boolean>('useIsolation', true);
+    } catch (ex) {
+        // If we can't get the setting for any reason we assume default
+        return true;
+    }
+}
+
+export function maybeIsolated(args: string[]): string[] {
+    if (getUseIsolationSetting()) {
+        args.splice(0, 0, ISOLATED);
+    }
+    return args;
+}
+
 // "scripts" contains everything relevant to the scripts found under
 // the top-level "pythonFiles" directory.  Each of those scripts has
 // a function in this module which matches the script's filename.
@@ -49,7 +66,7 @@ export type InterpreterInfoJson = {
 
 export function interpreterInfo(): [string[], (out: string) => InterpreterInfoJson] {
     const script = path.join(SCRIPTS_DIR, 'interpreterInfo.py');
-    const args = [ISOLATED, script];
+    const args = maybeIsolated([script]);
 
     function parse(out: string): InterpreterInfoJson {
         let json: InterpreterInfoJson;
@@ -159,7 +176,7 @@ namespace _completion {
 
 export function completion(jediPath?: string): [string[], (out: string) => _completion.Response[]] {
     const script = path.join(SCRIPTS_DIR, 'completion.py');
-    const args = [ISOLATED, script];
+    const args = maybeIsolated([script]);
     if (jediPath) {
         args.push('custom');
         args.push(jediPath);
@@ -177,7 +194,7 @@ export function completion(jediPath?: string): [string[], (out: string) => _comp
 
 export function sortImports(filename: string, sortArgs?: string[]): [string[], (out: string) => string] {
     const script = path.join(SCRIPTS_DIR, 'sortImports.py');
-    const args = [ISOLATED, script, filename, '--diff'];
+    const args = maybeIsolated([script, filename, '--diff']);
     if (sortArgs) {
         args.push(...sortArgs);
     }
@@ -195,7 +212,7 @@ export function sortImports(filename: string, sortArgs?: string[]): [string[], (
 
 export function refactor(root: string): [string[], (out: string) => object[]] {
     const script = path.join(SCRIPTS_DIR, 'refactor.py');
-    const args = [ISOLATED, script, root];
+    const args = maybeIsolated([script, root]);
 
     // tslint:disable-next-line:no-suspicious-comment
     // TODO: Make the return type more specific, like we did
@@ -217,7 +234,7 @@ export function refactor(root: string): [string[], (out: string) => object[]] {
 
 export function normalizeForInterpreter(): [string[], (out: string) => string] {
     const script = path.join(SCRIPTS_DIR, 'normalizeForInterpreter.py');
-    const args = [ISOLATED, script];
+    const args = maybeIsolated([script]);
 
     function parse(out: string) {
         // The text will be used as-is.
@@ -232,7 +249,7 @@ export function normalizeForInterpreter(): [string[], (out: string) => string] {
 
 export function normalizeSelection(): [string[], (out: string) => string] {
     const script = path.join(SCRIPTS_DIR, 'normalizeSelection.py');
-    const args = [ISOLATED, script];
+    const args = maybeIsolated([script]);
 
     function parse(out: string) {
         // The text will be used as-is.
@@ -272,7 +289,7 @@ export function symbolProvider(
     text?: string
 ): [string[], (out: string) => _symbolProvider.Symbols] {
     const script = path.join(SCRIPTS_DIR, 'symbolProvider.py');
-    const args = [ISOLATED, script, filename];
+    const args = maybeIsolated([script, filename]);
     if (text) {
         args.push(text);
     }
@@ -289,7 +306,7 @@ export function symbolProvider(
 
 export function printEnvVariables(): [string[], (out: string) => NodeJS.ProcessEnv] {
     const script = path.join(SCRIPTS_DIR, 'printEnvVariables.py').fileToCommandArgument();
-    const args = [ISOLATED, script];
+    const args = maybeIsolated([script]);
 
     function parse(out: string): NodeJS.ProcessEnv {
         return JSON.parse(out);
@@ -303,7 +320,7 @@ export function printEnvVariables(): [string[], (out: string) => NodeJS.ProcessE
 
 export function printEnvVariablesToFile(filename: string): [string[], (out: string) => NodeJS.ProcessEnv] {
     const script = path.join(SCRIPTS_DIR, 'printEnvVariablesToFile.py');
-    const args = [ISOLATED, script, filename.fileToCommandArgument()];
+    const args = maybeIsolated([script, filename.fileToCommandArgument()]);
 
     function parse(out: string): NodeJS.ProcessEnv {
         return JSON.parse(out);
@@ -319,15 +336,14 @@ export function shell_exec(command: string, lockfile: string, shellArgs: string[
     const script = path.join(SCRIPTS_DIR, 'shell_exec.py');
     // We don't bother with a "parse" function since the output
     // could be anything.
-    return [
-        ISOLATED,
+    return maybeIsolated([
         script,
         command.fileToCommandArgument(),
         // The shell args must come after the command
         // but before the lockfile.
         ...shellArgs,
         lockfile.fileToCommandArgument()
-    ];
+    ]);
 }
 
 //============================
@@ -336,7 +352,7 @@ export function shell_exec(command: string, lockfile: string, shellArgs: string[
 export function testlauncher(testArgs: string[]): string[] {
     const script = path.join(SCRIPTS_DIR, 'testlauncher.py');
     // There is no output to parse, so we do not return a function.
-    return [ISOLATED, script, ...testArgs];
+    return maybeIsolated([script, ...testArgs]);
 }
 
 //============================
@@ -353,5 +369,5 @@ export function visualstudio_py_testlauncher(testArgs: string[]): string[] {
 
 export function tensorboardLauncher(args: string[]) {
     const script = path.join(SCRIPTS_DIR, 'tensorboard_launcher.py');
-    return [ISOLATED, script, ...args];
+    return maybeIsolated([script, ...args]);
 }

src/client/common/types.ts

@@ -190,6 +190,7 @@ export interface IPythonSettings {
     readonly languageServer: LanguageServerType;
     readonly defaultInterpreterPath: string;
     readonly logging: ILoggingSettings;
+    readonly useIsolation: boolean;
 }
 export interface ISortImportSettings {
     readonly path: string;

src/test/common/configSettings/configSettings.unit.test.ts

@@ -82,7 +82,7 @@ suite('Python Settings', async () => {
         }
 
         // boolean settings
-        for (const name of ['downloadLanguageServer', 'autoUpdateLanguageServer']) {
+        for (const name of ['downloadLanguageServer', 'autoUpdateLanguageServer', 'useIsolation']) {
             config
                 .setup((c) => c.get<boolean>(name, true))
                 // tslint:disable-next-line:no-any
@@ -148,7 +148,7 @@ suite('Python Settings', async () => {
     });
 
     suite('Boolean settings', async () => {
-        ['downloadLanguageServer', 'autoUpdateLanguageServer', 'globalModuleInstallation'].forEach(
+        ['downloadLanguageServer', 'autoUpdateLanguageServer', 'globalModuleInstallation', 'useIsolation'].forEach(
             async (settingName) => {
                 testIfValueIsUpdated(settingName, true);
             }