forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Detect if VSCode is launched from an activated environment and select…
… it (#20526) Closes #10668 In case of base conda environments, show a prompt to select it instead, as getting configs is required in that case which can take time.
- Loading branch information
Kartik Raj
authored
Jan 23, 2023
1 parent
bebf05d
commit e9edfc0
Showing
15 changed files
with
801 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
160 changes: 160 additions & 0 deletions
160
src/client/interpreter/virtualEnvs/activatedEnvLaunch.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import { inject, injectable, optional } from 'inversify'; | ||
| import { ConfigurationTarget } from 'vscode'; | ||
| import * as path from 'path'; | ||
| import { IApplicationShell, IWorkspaceService } from '../../common/application/types'; | ||
| import { IProcessServiceFactory } from '../../common/process/types'; | ||
| import { sleep } from '../../common/utils/async'; | ||
| import { cache } from '../../common/utils/decorators'; | ||
| import { Common, Interpreters } from '../../common/utils/localize'; | ||
| import { traceError, traceLog, traceWarn } from '../../logging'; | ||
| import { Conda } from '../../pythonEnvironments/common/environmentManagers/conda'; | ||
| import { sendTelemetryEvent } from '../../telemetry'; | ||
| import { EventName } from '../../telemetry/constants'; | ||
| import { IPythonPathUpdaterServiceManager } from '../configuration/types'; | ||
| import { IActivatedEnvironmentLaunch, IInterpreterService } from '../contracts'; | ||
|
|
||
| @injectable() | ||
| export class ActivatedEnvironmentLaunch implements IActivatedEnvironmentLaunch { | ||
| public readonly supportedWorkspaceTypes = { untrustedWorkspace: false, virtualWorkspace: true }; | ||
|
|
||
| private inMemorySelection: string | undefined; | ||
|
|
||
| constructor( | ||
| @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService, | ||
| @inject(IApplicationShell) private readonly appShell: IApplicationShell, | ||
| @inject(IPythonPathUpdaterServiceManager) | ||
| private readonly pythonPathUpdaterService: IPythonPathUpdaterServiceManager, | ||
| @inject(IInterpreterService) private readonly interpreterService: IInterpreterService, | ||
| @inject(IProcessServiceFactory) private readonly processServiceFactory: IProcessServiceFactory, | ||
| @optional() public wasSelected: boolean = false, | ||
| ) {} | ||
|
|
||
| @cache(-1, true) | ||
| public async _promptIfApplicable(): Promise<void> { | ||
| const baseCondaPrefix = getPrefixOfActivatedCondaEnv(); | ||
| if (!baseCondaPrefix) { | ||
| return; | ||
| } | ||
| const info = await this.interpreterService.getInterpreterDetails(baseCondaPrefix); | ||
| if (info?.envName !== 'base') { | ||
| // Only show prompt for base conda environments, as we need to check config for such envs which can be slow. | ||
| return; | ||
| } | ||
| const conda = await Conda.getConda(); | ||
| if (!conda) { | ||
| traceWarn('Conda not found even though activated environment vars are set'); | ||
| return; | ||
| } | ||
| const service = await this.processServiceFactory.create(); | ||
| const autoActivateBaseConfig = await service | ||
| .shellExec(`${conda.shellCommand} config --get auto_activate_base`) | ||
| .catch((ex) => { | ||
| traceError(ex); | ||
| return { stdout: '' }; | ||
| }); | ||
| if (autoActivateBaseConfig.stdout.trim().toLowerCase().endsWith('false')) { | ||
| await this.promptAndUpdate(baseCondaPrefix); | ||
| } | ||
| } | ||
|
|
||
| private async promptAndUpdate(prefix: string) { | ||
| this.wasSelected = true; | ||
| const prompts = [Common.bannerLabelYes, Common.bannerLabelNo]; | ||
| const telemetrySelections: ['Yes', 'No'] = ['Yes', 'No']; | ||
| const selection = await this.appShell.showInformationMessage(Interpreters.activatedCondaEnvLaunch, ...prompts); | ||
| sendTelemetryEvent(EventName.ACTIVATED_CONDA_ENV_LAUNCH, undefined, { | ||
| selection: selection ? telemetrySelections[prompts.indexOf(selection)] : undefined, | ||
| }); | ||
| if (!selection) { | ||
| return; | ||
| } | ||
| if (selection === prompts[0]) { | ||
| await this.setInterpeterInStorage(prefix); | ||
| } | ||
| } | ||
|
|
||
| public async selectIfLaunchedViaActivatedEnv(doNotBlockOnSelection = false): Promise<string | undefined> { | ||
| if (this.wasSelected) { | ||
| return this.inMemorySelection; | ||
| } | ||
| return this._selectIfLaunchedViaActivatedEnv(doNotBlockOnSelection); | ||
| } | ||
|
|
||
| @cache(-1, true) | ||
| private async _selectIfLaunchedViaActivatedEnv(doNotBlockOnSelection = false): Promise<string | undefined> { | ||
| if (this.workspaceService.workspaceFile) { | ||
| // Assuming multiroot workspaces cannot be directly launched via `code .` command. | ||
| return undefined; | ||
| } | ||
| const prefix = await this.getPrefixOfSelectedActivatedEnv(); | ||
| if (!prefix) { | ||
| this._promptIfApplicable().ignoreErrors(); | ||
| return undefined; | ||
| } | ||
| this.wasSelected = true; | ||
| this.inMemorySelection = prefix; | ||
| traceLog( | ||
| `VS Code was launched from an activated environment: '${path.basename( | ||
| prefix, | ||
| )}', selecting it as the interpreter for workspace.`, | ||
| ); | ||
| if (doNotBlockOnSelection) { | ||
| this.setInterpeterInStorage(prefix).ignoreErrors(); | ||
| } else { | ||
| await this.setInterpeterInStorage(prefix); | ||
| await sleep(1); // Yield control so config service can update itself. | ||
| } | ||
| this.inMemorySelection = undefined; // Once we have set the prefix in storage, clear the in memory selection. | ||
| return prefix; | ||
| } | ||
|
|
||
| private async setInterpeterInStorage(prefix: string) { | ||
| const { workspaceFolders } = this.workspaceService; | ||
| if (!workspaceFolders || workspaceFolders.length === 0) { | ||
| await this.pythonPathUpdaterService.updatePythonPath(prefix, ConfigurationTarget.Global, 'load'); | ||
| } else { | ||
| await this.pythonPathUpdaterService.updatePythonPath( | ||
| prefix, | ||
| ConfigurationTarget.WorkspaceFolder, | ||
| 'load', | ||
| workspaceFolders[0].uri, | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private async getPrefixOfSelectedActivatedEnv(): Promise<string | undefined> { | ||
| const virtualEnvVar = process.env.VIRTUAL_ENV; | ||
| if (virtualEnvVar !== undefined && virtualEnvVar.length > 0) { | ||
| return virtualEnvVar; | ||
| } | ||
| const condaPrefixVar = getPrefixOfActivatedCondaEnv(); | ||
| if (!condaPrefixVar) { | ||
| return undefined; | ||
| } | ||
| const info = await this.interpreterService.getInterpreterDetails(condaPrefixVar); | ||
| if (info?.envName !== 'base') { | ||
| return condaPrefixVar; | ||
| } | ||
| // Ignoring base conda environments, as they could be automatically set by conda. | ||
| if (process.env.CONDA_AUTO_ACTIVATE_BASE !== undefined) { | ||
| if (process.env.CONDA_AUTO_ACTIVATE_BASE.toLowerCase() === 'false') { | ||
| return condaPrefixVar; | ||
| } | ||
| } | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function getPrefixOfActivatedCondaEnv() { | ||
| const condaPrefixVar = process.env.CONDA_PREFIX; | ||
| if (condaPrefixVar && condaPrefixVar.length > 0) { | ||
| const condaShlvl = process.env.CONDA_SHLVL; | ||
| if (condaShlvl !== undefined && condaShlvl.length > 0 && condaShlvl > '0') { | ||
| return condaPrefixVar; | ||
| } | ||
| } | ||
| return undefined; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.