Auto select Python Interpreter prior to validation of interpreters (#…

…3371)

For #3326

.github/test_plan.md

@@ -44,7 +44,11 @@
 - Make sure that you do not have `python.pythonPath` specified in your `settings.json` when testing automatic detection
 - Do note that the `Select Interpreter` drop-down window scrolls
 
-- [ ] Detected a single virtual environment at the top-level of the workspace folder (if you created this _after_ opening VS Code, then run `Reload Window` to pick up the new environment)
+- [ ] Detected a single virtual environment at the top-level of the workspace folder on Mac when when `python` command points to default Mac Python installation or `python` command fails in the terminal.
+  - [ ] Appropriate suffix label specified in status bar (e.g. `(venv)`)
+- [ ] Detected a single virtual environment at the top-level of the workspace folder on Windows when `python` fails in the terminal.
+  - [ ] Appropriate suffix label specified in status bar (e.g. `(venv)`)
+- [ ] Detected a single virtual environment at the top-level of the workspace folder
   - [ ] Appropriate suffix label specified in status bar (e.g. `(venv)`)
   - [ ] [`Create Terminal`](https://code.visualstudio.com/docs/python/environments#_activating-an-environment-in-the-terminal) works
     - [ ] Steals focus

news/2 Fixes/3326.md

@@ -0,0 +1 @@
+Auto select `Python Interpreter` prior to validation of interpreters and changes to messages displayed.

package.json

@@ -63,7 +63,6 @@
     "activationEvents": [
         "onLanguage:python",
         "onDebugResolve:python",
-        "onDebugResolve:python",
         "onCommand:python.execInTerminal",
         "onCommand:python.sortImports",
         "onCommand:python.runtests",

package.nls.json

@@ -84,22 +84,23 @@
     "DataScience.startingJupyter": "Starting Jupyter Server",
     "Interpreters.RefreshingInterpreters": "Refreshing Python Interpreters",
     "Interpreters.LoadingInterpreters": "Loading Python Interpreters",
-    "DataScience.restartKernelMessage" : "Do you want to restart the Jupter kernel? All variables will be lost.",
-    "DataScience.restartKernelMessageYes" : "Restart",
-    "DataScience.restartKernelMessageNo" : "Cancel",
+    "DataScience.restartKernelMessage": "Do you want to restart the Jupter kernel? All variables will be lost.",
+    "DataScience.restartKernelMessageYes": "Restart",
+    "DataScience.restartKernelMessageNo": "Cancel",
     "DataScienceSurveyBanner.bannerMessage": "Can you please take 2 minutes to tell us how the Python Data Science features are working for you?",
     "DataScienceSurveyBanner.bannerLabelYes": "Yes, take survey now",
     "DataScienceSurveyBanner.bannerLabelNo": "No, thanks",
-    "DataScience.restartingKernelStatus" : "Restarting Jupyter Kernel",
-    "DataScience.executingCode" : "Executing Cell",
-    "DataScience.collapseAll" : "Collapse all cell inputs",
-    "DataScience.expandAll" : "Expand all cell inputs",
-    "DataScience.export" : "Export as Jupyter Notebook",
-    "DataScience.restartServer" : "Restart iPython Kernel",
-    "DataScience.undo" : "Undo",
-    "DataScience.redo" : "Redo",
-    "DataScience.clearAll" : "Remove All Cells",
-    "DataScience.pythonVersionHeader" : "Python Version:",
-    "DataScience.pythonVersionHeaderNoPyKernel" : "Python Version may not match, no ipykernel found:",
-    "DataScience.pythonRestartHeader" : "Restarted Kernel:"
+    "DataScience.restartingKernelStatus": "Restarting Jupyter Kernel",
+    "DataScience.executingCode": "Executing Cell",
+    "DataScience.collapseAll": "Collapse all cell inputs",
+    "DataScience.expandAll": "Expand all cell inputs",
+    "DataScience.export": "Export as Jupyter Notebook",
+    "DataScience.restartServer": "Restart iPython Kernel",
+    "DataScience.undo": "Undo",
+    "DataScience.redo": "Redo",
+    "DataScience.clearAll": "Remove All Cells",
+    "DataScience.pythonVersionHeader": "Python Version:",
+    "DataScience.pythonVersionHeaderNoPyKernel": "Python Version may not match, no ipykernel found:",
+    "DataScience.pythonRestartHeader": "Restarted Kernel:",
+    "Linter.InstalledButNotEnabled": "Linter {0} is installed but not enabled."
 }

src/client/activation/languageServer/languageServer.ts

@@ -19,6 +19,7 @@ import {
 import { PythonSettings } from '../../common/configSettings';
 // tslint:disable-next-line:ordered-imports
 import { isTestExecution, STANDARD_OUTPUT_CHANNEL } from '../../common/constants';
+import { Logger } from '../../common/logger';
 import { IFileSystem, IPlatformService } from '../../common/platform/types';
 import {
     BANNER_NAME_LS_SURVEY, DeprecatedFeatureInfo, IConfigurationService,
@@ -225,7 +226,7 @@ export class LanguageServerExtensionActivator implements IExtensionActivator {
             const interpreterDataService = new InterpreterDataService(this.context, this.services);
             interpreterData = await interpreterDataService.getInterpreterData();
         } catch (ex) {
-            this.appShell.showWarningMessage('Unable to determine path to the Python interpreter. IntelliSense will be limited.');
+            Logger.error('Unable to determine path to the Python interpreter. IntelliSense will be limited.', ex);
         }
 
         this.interpreterHash = interpreterData ? interpreterData.hash : '';

src/client/common/utils/localize.ts

@@ -19,6 +19,10 @@ export namespace Interpreters {
     export const refreshing = localize('Interpreters.RefreshingInterpreters', 'Refreshing Python Interpreters');
 }
 
+export namespace Linters {
+    export const installedButNotEnabled = localize('Linter.InstalledButNotEnabled', 'Linter {0} is installed but not enabled.');
+}
+
 export namespace DataScienceSurveyBanner {
     export const bannerMessage = localize('DataScienceSurveyBanner.bannerMessage', 'Can you please take 2 minutes to tell us how the Python Data Science features are working for you?');
     export const bannerLabelYes = localize('DataScienceSurveyBanner.bannerLabelYes', 'Yes, take survey now');

src/client/extension.ts

@@ -77,15 +77,15 @@ export async function activate(context: ExtensionContext): Promise<IExtensionApi
     registerServices(context, serviceManager, serviceContainer);
     initializeServices(context, serviceManager, serviceContainer);
 
+    const interpreterManager = serviceContainer.get<IInterpreterService>(IInterpreterService);
+    await interpreterManager.autoSetInterpreter();
+
     // When testing, do not perform health checks, as modal dialogs can be displayed.
     if (!isTestExecution()) {
         const appDiagnostics = serviceContainer.get<IApplicationDiagnostics>(IApplicationDiagnostics);
         await appDiagnostics.performPreStartupHealthCheck();
     }
 
-    const interpreterManager = serviceContainer.get<IInterpreterService>(IInterpreterService);
-    await interpreterManager.autoSetInterpreter();
-
     serviceManager.get<ITerminalAutoActivation>(ITerminalAutoActivation).register();
     const configuration = serviceManager.get<IConfigurationService>(IConfigurationService);
     const pythonSettings = configuration.getSettings();

src/client/interpreter/contracts.ts

@@ -29,7 +29,7 @@ export const IInterpreterLocatorService = Symbol('IInterpreterLocatorService');
 
 export interface IInterpreterLocatorService extends Disposable {
     readonly onLocating: Event<Promise<PythonInterpreter[]>>;
-    getInterpreters(resource?: Uri): Promise<PythonInterpreter[]>;
+    getInterpreters(resource?: Uri, ignoreCache?: boolean): Promise<PythonInterpreter[]>;
 }
 
 export type CondaInfo = {

src/client/interpreter/interpreterService.ts

@@ -66,14 +66,14 @@ export class InterpreterService implements Disposable, IInterpreterService {
         }
         // Check pipenv first.
         const pipenvService = this.serviceContainer.get<IInterpreterLocatorService>(IInterpreterLocatorService, PIPENV_SERVICE);
-        let interpreters = await pipenvService.getInterpreters(activeWorkspace.folderUri);
+        let interpreters = await pipenvService.getInterpreters(activeWorkspace.folderUri, true);
         if (interpreters.length > 0) {
             await this.pythonPathUpdaterService.updatePythonPath(interpreters[0].path, activeWorkspace.configTarget, 'load', activeWorkspace.folderUri);
             return;
         }
         // Now check virtual environments under the workspace root
         const virtualEnvInterpreterProvider = this.serviceContainer.get<IInterpreterLocatorService>(IInterpreterLocatorService, WORKSPACE_VIRTUAL_ENV_SERVICE);
-        interpreters = await virtualEnvInterpreterProvider.getInterpreters(activeWorkspace.folderUri);
+        interpreters = await virtualEnvInterpreterProvider.getInterpreters(activeWorkspace.folderUri, true);
         const workspacePathUpper = activeWorkspace.folderUri.fsPath.toUpperCase();
 
         const interpretersInWorkspace = interpreters.filter(interpreter => Uri.file(interpreter.path).fsPath.toUpperCase().startsWith(workspacePathUpper));

src/client/interpreter/locators/services/cacheableLocatorService.ts

@@ -29,11 +29,11 @@ export abstract class CacheableLocatorService implements IInterpreterLocatorServ
         return this.locating.event;
     }
     public abstract dispose();
-    public async getInterpreters(resource?: Uri): Promise<PythonInterpreter[]> {
+    public async getInterpreters(resource?: Uri, ignoreCache?: boolean): Promise<PythonInterpreter[]> {
         const cacheKey = this.getCacheKey(resource);
         let deferred = this.promisesPerResource.get(cacheKey);
 
-        if (!deferred) {
+        if (!deferred || ignoreCache) {
             deferred = createDeferred<PythonInterpreter[]>();
             this.promisesPerResource.set(cacheKey, deferred);
 

src/client/linters/linterAvailability.ts

@@ -6,8 +6,10 @@
 import { inject, injectable } from 'inversify';
 import { Uri } from 'vscode';
 import { IApplicationShell, IWorkspaceService } from '../common/application/types';
+import '../common/extensions';
 import { traceError } from '../common/logger';
 import { IConfigurationService, IInstaller, Product } from '../common/types';
+import { Linters } from '../common/utils/localize';
 import { IAvailableLinterActivator, ILinterInfo } from './types';
 
 @injectable()
@@ -75,7 +77,7 @@ export class AvailableLinterActivator implements IAvailableLinterActivator {
         ];
 
         // tslint:disable-next-line:messages-must-be-localized
-        const pick = await this.appShell.showInformationMessage(`Linter ${linterInfo.id} is available but not enabled.`, ...optButtons);
+        const pick = await this.appShell.showInformationMessage(Linters.installedButNotEnabled().format(linterInfo.id), ...optButtons);
         if (pick) {
             await linterInfo.enableAsync(pick.enabled);
             return true;

src/test/interpreters/interpreterService.unit.test.ts

@@ -512,9 +512,9 @@ suite('Interpreters service', () => {
         }
 
         function setupLocators(wks: PythonInterpreter[], pipenv: PythonInterpreter[]) {
-            pipenvLocator.setup(x => x.getInterpreters(TypeMoq.It.isAny())).returns(() => Promise.resolve(pipenv));
+            pipenvLocator.setup(x => x.getInterpreters(TypeMoq.It.isAny(), TypeMoq.It.isValue(true))).returns(() => Promise.resolve(pipenv));
             serviceManager.addSingletonInstance<IInterpreterLocatorService>(IInterpreterLocatorService, pipenvLocator.object, PIPENV_SERVICE);
-            wksLocator.setup(x => x.getInterpreters(TypeMoq.It.isAny())).returns(() => Promise.resolve(wks));
+            wksLocator.setup(x => x.getInterpreters(TypeMoq.It.isAny(), TypeMoq.It.isValue(true))).returns(() => Promise.resolve(wks));
             serviceManager.addSingletonInstance<IInterpreterLocatorService>(IInterpreterLocatorService, wksLocator.object, WORKSPACE_VIRTUAL_ENV_SERVICE);
 
         }

src/test/linters/linter.availability.unit.test.ts

@@ -136,7 +136,7 @@ suite('Linter Availability Provider tests', () => {
         }(Product.pylint, 'pylint', configServiceMock.object, ['.pylintrc', 'pylintrc']);
 
         appShellMock.setup(ap => ap.showInformationMessage(
-            TypeMoq.It.isValue(`Linter ${linterInfo.id} is available but not enabled.`),
+            TypeMoq.It.isValue(`Linter ${linterInfo.id} is installed but not enabled.`),
             TypeMoq.It.isAny(),
             TypeMoq.It.isAny())
         )
@@ -207,7 +207,7 @@ suite('Linter Availability Provider tests', () => {
         // arrange
         const [appShellMock, installerMock, workspaceServiceMock, configServiceMock, linterInfo] = getDependenciesForAvailabilityTests();
         appShellMock.setup(ap => ap.showInformationMessage(
-            TypeMoq.It.isValue(`Linter ${linterInfo.id} is available but not enabled.`),
+            TypeMoq.It.isValue(`Linter ${linterInfo.id} is installed but not enabled.`),
             TypeMoq.It.isAny(),
             TypeMoq.It.isAny())
         )