Merge branch 'main' of https://github.com/microsoft/vscode-python into envcollection

Author: Kartik Raj

gulpfile.js

@@ -82,7 +82,7 @@ async function addExtensionPackDependencies() {
     // extension dependencies need not be installed during development
     const packageJsonContents = await fsExtra.readFile('package.json', 'utf-8');
     const packageJson = JSON.parse(packageJsonContents);
-    packageJson.extensionPack = ['ms-toolsai.jupyter', 'ms-python.vscode-pylance', 'ms-python.isort'].concat(
+    packageJson.extensionPack = ['ms-toolsai.jupyter', 'ms-python.vscode-pylance'].concat(
         packageJson.extensionPack ? packageJson.extensionPack : [],
     );
     await fsExtra.writeFile('package.json', JSON.stringify(packageJson, null, 4), 'utf-8');

pythonFiles/sortImports.py

@@ -13,10 +13,10 @@ import {
 import { ConfigurationItem } from 'vscode-languageserver-protocol';
 
 import { HiddenFilePrefix } from '../common/constants';
-import { IConfigurationService } from '../common/types';
 import { createDeferred, isThenable } from '../common/utils/async';
 import { StopWatch } from '../common/utils/stopWatch';
 import { IEnvironmentVariablesProvider } from '../common/variables/types';
+import { IInterpreterService } from '../interpreter/contracts';
 import { IServiceContainer } from '../ioc/types';
 import { EventName } from '../telemetry/constants';
 import { LanguageServerType } from './types';
@@ -66,7 +66,7 @@ export class LanguageClientMiddlewareBase implements Middleware {
                 return next(params, token);
             }
 
-            const configService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
+            const interpreterService = this.serviceContainer.get<IInterpreterService>(IInterpreterService);
             const envService = this.serviceContainer.get<IEnvironmentVariablesProvider>(IEnvironmentVariablesProvider);
 
             let settings = next(params, token);
@@ -87,9 +87,10 @@ export class LanguageClientMiddlewareBase implements Middleware {
                     const settingDict: LSPObject & { pythonPath: string; _envPYTHONPATH: string } = settings[
                         i
                     ] as LSPObject & { pythonPath: string; _envPYTHONPATH: string };
-
                     settingDict.pythonPath =
-                        (await this.getPythonPathOverride(uri)) ?? configService.getSettings(uri).pythonPath;
+                        (await this.getPythonPathOverride(uri)) ??
+                        (await interpreterService.getActiveInterpreter(uri))?.path ??
+                        'python';
 
                     const env = await envService.getEnvironmentVariables(uri);
                     const envPYTHONPATH = env.PYTHONPATH;

src/client/activation/languageClientMiddlewareBase.ts

@@ -58,23 +58,6 @@ export function interpreterInfo(): [string[], (out: string) => InterpreterInfoJs
     return [args, parse];
 }
 
-// sortImports.py
-
-export function sortImports(filename: string, sortArgs?: string[]): [string[], (out: string) => string] {
-    const script = path.join(SCRIPTS_DIR, 'sortImports.py');
-    const args = [script, filename, '--diff'];
-    if (sortArgs) {
-        args.push(...sortArgs);
-    }
-
-    function parse(out: string) {
-        // It should just be a diff that the extension will use directly.
-        return out;
-    }
-
-    return [args, parse];
-}
-
 // normalizeSelection.py
 
 export function normalizeSelection(): [string[], (out: string) => string] {

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

@@ -467,6 +467,10 @@ export namespace ToolsExtensions {
     export const pylintPromptMessage = l10n.t(
         'Use the Pylint extension to enable easier configuration and new features such as quick fixes.',
     );
+    export const isortPromptMessage = l10n.t(
+        'To use sort imports, please install the isort extension. It provides easier configuration and new features such as code actions.',
+    );
     export const installPylintExtension = l10n.t('Install Pylint extension');
     export const installFlake8Extension = l10n.t('Install Flake8 extension');
+    export const installISortExtension = l10n.t('Install isort extension');
 }

src/client/common/utils/localize.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import * as path from 'path';
+import * as fs from 'fs-extra';
+import { Extension, extensions } from 'vscode';
+import { PVSC_EXTENSION_ID } from '../constants';
+
+export function getExtension<T = unknown>(extensionId: string): Extension<T> | undefined {
+    return extensions.getExtension(extensionId);
+}
+
+export function isExtensionEnabled(extensionId: string): boolean {
+    return extensions.getExtension(extensionId) !== undefined;
+}
+
+export function isExtensionDisabled(extensionId: string): boolean {
+    // We need an enabled extension to find the extensions dir.
+    const pythonExt = getExtension(PVSC_EXTENSION_ID);
+    if (pythonExt) {
+        let found = false;
+        fs.readdirSync(path.dirname(pythonExt.extensionPath), { withFileTypes: false }).forEach((s) => {
+            if (s.toString().startsWith(extensionId)) {
+                found = true;
+            }
+        });
+        return found;
+    }
+    return false;
+}

src/client/common/vscodeApis/extensionsApi.ts

@@ -1,5 +1,4 @@
 import { inject, injectable } from 'inversify';
-import * as path from 'path';
 import { ConfigurationTarget, l10n, Uri, window } from 'vscode';
 import { StopWatch } from '../../common/utils/stopWatch';
 import { SystemVariables } from '../../common/variables/systemVariables';
@@ -28,7 +27,7 @@ export class PythonPathUpdaterService implements IPythonPathUpdaterServiceManage
         const pythonPathUpdater = this.getPythonUpdaterService(configTarget, wkspace);
         let failed = false;
         try {
-            await pythonPathUpdater.updatePythonPath(pythonPath ? path.normalize(pythonPath) : undefined);
+            await pythonPathUpdater.updatePythonPath(pythonPath);
         } catch (err) {
             failed = true;
             const reason = err as Error;

src/client/interpreter/configuration/pythonPathUpdaterService.ts

@@ -1,4 +1,3 @@
-import * as path from 'path';
 import { ConfigurationTarget, Uri } from 'vscode';
 import { IInterpreterPathService } from '../../../common/types';
 import { IPythonPathUpdaterService } from '../types';
@@ -11,9 +10,6 @@ export class WorkspaceFolderPythonPathUpdaterService implements IPythonPathUpdat
         if (pythonPathValue && pythonPathValue.workspaceFolderValue === pythonPath) {
             return;
         }
-        if (pythonPath && pythonPath.startsWith(this.workspaceFolder.fsPath)) {
-            pythonPath = path.relative(this.workspaceFolder.fsPath, pythonPath);
-        }
         await this.interpreterPathService.update(this.workspaceFolder, ConfigurationTarget.WorkspaceFolder, pythonPath);
     }
 }

src/client/interpreter/configuration/services/workspaceFolderUpdaterService.ts

@@ -1,4 +1,3 @@
-import * as path from 'path';
 import { ConfigurationTarget, Uri } from 'vscode';
 import { IInterpreterPathService } from '../../../common/types';
 import { IPythonPathUpdaterService } from '../types';
@@ -11,9 +10,6 @@ export class WorkspacePythonPathUpdaterService implements IPythonPathUpdaterServ
         if (pythonPathValue && pythonPathValue.workspaceValue === pythonPath) {
             return;
         }
-        if (pythonPath && pythonPath.startsWith(this.workspace.fsPath)) {
-            pythonPath = path.relative(this.workspace.fsPath, pythonPath);
-        }
         await this.interpreterPathService.update(this.workspace, ConfigurationTarget.Workspace, pythonPath);
     }
 }

src/client/interpreter/configuration/services/workspaceUpdaterService.ts

@@ -186,28 +186,28 @@ export class InterpreterService implements Disposable, IInterpreterService {
         // However we need not wait on the update to take place, as we can use the value directly.
         if (!path) {
             path = this.configService.getSettings(resource).pythonPath;
-        }
-        if (pathUtils.basename(path) === path) {
-            // Value can be `python`, `python3`, `python3.9` etc.
-            // Note the following triggers autoselection if no interpreter is explictly
-            // selected, i.e the value is `python`.
-            // During shutdown we might not be able to get items out of the service container.
-            const pythonExecutionFactory = this.serviceContainer.tryGet<IPythonExecutionFactory>(
-                IPythonExecutionFactory,
-            );
-            const pythonExecutionService = pythonExecutionFactory
-                ? await pythonExecutionFactory.create({ resource })
-                : undefined;
-            const fullyQualifiedPath = pythonExecutionService
-                ? await pythonExecutionService.getExecutablePath().catch((ex) => {
-                      traceError(ex);
-                  })
-                : undefined;
-            // Python path is invalid or python isn't installed.
-            if (!fullyQualifiedPath) {
-                return undefined;
+            if (pathUtils.basename(path) === path) {
+                // Value can be `python`, `python3`, `python3.9` etc.
+                // Note the following triggers autoselection if no interpreter is explictly
+                // selected, i.e the value is `python`.
+                // During shutdown we might not be able to get items out of the service container.
+                const pythonExecutionFactory = this.serviceContainer.tryGet<IPythonExecutionFactory>(
+                    IPythonExecutionFactory,
+                );
+                const pythonExecutionService = pythonExecutionFactory
+                    ? await pythonExecutionFactory.create({ resource })
+                    : undefined;
+                const fullyQualifiedPath = pythonExecutionService
+                    ? await pythonExecutionService.getExecutablePath().catch((ex) => {
+                          traceError(ex);
+                      })
+                    : undefined;
+                // Python path is invalid or python isn't installed.
+                if (!fullyQualifiedPath) {
+                    return undefined;
+                }
+                path = fullyQualifiedPath;
             }
-            path = fullyQualifiedPath;
         }
         return this.getInterpreterDetails(path);
     }