Skip to content

Correct pipenv activation provider when in discovery experiment #15319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 9, 2021
Merged

Correct pipenv activation provider when in discovery experiment #15319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cc1215
Correct pipenv activation provider when in discovery experiment
Feb 4, 2021
911c0e0
Fix ESLint errors
Feb 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,6 @@ src/test/common/terminals/service.unit.test.ts
src/test/common/terminals/helper.unit.test.ts
src/test/common/terminals/activation.unit.test.ts
src/test/common/terminals/shellDetectors/shellDetectors.unit.test.ts
src/test/common/terminals/environmentActivationProviders/pipEnvActivationProvider.unit.test.ts
src/test/common/terminals/environmentActivationProviders/terminalActivation.testvirtualenvs.ts
src/test/common/socketStream.test.ts
src/test/common/configSettings.test.ts
Expand Down Expand Up @@ -557,7 +556,6 @@ src/client/common/terminal/shellDetectors/vscEnvironmentShellDetector.ts
src/client/common/terminal/shellDetectors/terminalNameShellDetector.ts
src/client/common/terminal/shellDetectors/settingsShellDetector.ts
src/client/common/terminal/shellDetectors/baseShellDetector.ts
src/client/common/terminal/environmentActivationProviders/pipEnvActivationProvider.ts
src/client/common/terminal/environmentActivationProviders/baseActivationProvider.ts
src/client/common/terminal/environmentActivationProviders/condaActivationProvider.ts
src/client/common/terminal/environmentActivationProviders/commandPrompt.ts
Expand Down
40 changes: 23 additions & 17 deletions src/client/common/terminal/environmentActivationProviders/pipEnvActivationProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@

import { inject, injectable, named } from 'inversify';
import { Uri } from 'vscode';
import '../../../common/extensions';
import '../../extensions';
import { IInterpreterService } from '../../../interpreter/contracts';
import { isPipenvEnvironmentRelatedToFolder } from '../../../pythonEnvironments/discovery/locators/services/pipEnvHelper';
import { EnvironmentType } from '../../../pythonEnvironments/info';
import { IWorkspaceService } from '../../application/types';
import { inDiscoveryExperiment } from '../../experiments/helpers';
import { IFileSystem } from '../../platform/types';
import { IToolExecutionPath, ToolExecutionPath } from '../../types';
import { ITerminalActivationCommandProvider, TerminalShellType } from '../types';
import { IExperimentService, IToolExecutionPath, ToolExecutionPath } from '../../types';
import { ITerminalActivationCommandProvider } from '../types';

@injectable()
export class PipEnvActivationCommandProvider implements ITerminalActivationCommandProvider {
Expand All @@ -22,37 +24,41 @@ export class PipEnvActivationCommandProvider implements ITerminalActivationComma
private readonly pipEnvExecution: IToolExecutionPath,
@inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService,
@inject(IFileSystem) private readonly fs: IFileSystem,
@inject(IExperimentService) private readonly experimentService: IExperimentService,
) {}

public isShellSupported(_targetShell: TerminalShellType): boolean {
// eslint-disable-next-line class-methods-use-this
public isShellSupported(): boolean {
return false;
}

public async getActivationCommands(resource: Uri | undefined, _: TerminalShellType): Promise<string[] | undefined> {
public async getActivationCommands(resource: Uri | undefined): Promise<string[] | undefined> {
const interpreter = await this.interpreterService.getActiveInterpreter(resource);
if (!interpreter || interpreter.envType !== EnvironmentType.Pipenv) {
return;
return undefined;
}
// Activate using `pipenv shell` only if the current folder relates pipenv environment.
const workspaceFolder = resource ? this.workspaceService.getWorkspaceFolder(resource) : undefined;
if (
workspaceFolder &&
interpreter.pipEnvWorkspaceFolder &&
!this.fs.arePathsSame(workspaceFolder.uri.fsPath, interpreter.pipEnvWorkspaceFolder)
) {
return;
if (workspaceFolder) {
if (await inDiscoveryExperiment(this.experimentService)) {
if (!(await isPipenvEnvironmentRelatedToFolder(interpreter.path, workspaceFolder?.uri.fsPath))) {
return undefined;
}
} else if (
interpreter.pipEnvWorkspaceFolder &&
!this.fs.arePathsSame(workspaceFolder.uri.fsPath, interpreter.pipEnvWorkspaceFolder)
) {
return undefined;
}
}
const execName = this.pipEnvExecution.executable;
return [`${execName.fileToCommandArgument()} shell`];
}

public async getActivationCommandsForInterpreter(
pythonPath: string,
_targetShell: TerminalShellType,
): Promise<string[] | undefined> {
public async getActivationCommandsForInterpreter(pythonPath: string): Promise<string[] | undefined> {
const interpreter = await this.interpreterService.getInterpreterDetails(pythonPath);
if (!interpreter || interpreter.envType !== EnvironmentType.Pipenv) {
return;
return undefined;
}

const execName = this.pipEnvExecution.executable;
Expand Down
8 changes: 1 addition & 7 deletions src/client/pythonEnvironments/legacyIOC.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ const convertedKinds = new Map(
);

function convertEnvInfo(info: PythonEnvInfo): PythonEnvironment {
const { name, location, executable, arch, kind, searchLocation, version, distro } = info;
const { name, location, executable, arch, kind, version, distro } = info;
const { filename, sysPrefix } = executable;
const env: PythonEnvironment = {
sysPrefix,
Expand All @@ -102,12 +102,6 @@ function convertEnvInfo(info: PythonEnvInfo): PythonEnvironment {
}
// Otherwise it stays Unknown.

if (searchLocation !== undefined) {
if (kind === PythonEnvKind.Pipenv) {
env.pipEnvWorkspaceFolder = searchLocation.fsPath;
}
}

if (version !== undefined) {
const { release, sysVersion } = version;
if (release === undefined) {
Expand Down
11 changes: 10 additions & 1 deletion ...est/common/terminals/environmentActivationProviders/pipEnvActivationProvider.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ import * as TypeMoq from 'typemoq';
import { Uri } from 'vscode';
import { IWorkspaceService } from '../../../../client/common/application/types';
import { WorkspaceService } from '../../../../client/common/application/workspace';
import { DiscoveryVariants } from '../../../../client/common/experiments/groups';
import { FileSystem } from '../../../../client/common/platform/fileSystem';
import { IFileSystem } from '../../../../client/common/platform/types';
import { PipEnvActivationCommandProvider } from '../../../../client/common/terminal/environmentActivationProviders/pipEnvActivationProvider';
import { ITerminalActivationCommandProvider, TerminalShellType } from '../../../../client/common/terminal/types';
import { IToolExecutionPath } from '../../../../client/common/types';
import { IExperimentService, IToolExecutionPath } from '../../../../client/common/types';
import { getNamesAndValues } from '../../../../client/common/utils/enum';
import { IInterpreterService } from '../../../../client/interpreter/contracts';
import { InterpreterService } from '../../../../client/interpreter/interpreterService';
Expand All @@ -28,17 +29,22 @@ suite('Terminals Activation - Pipenv', () => {
let pipEnvExecution: TypeMoq.IMock<IToolExecutionPath>;
let workspaceService: IWorkspaceService;
let fs: IFileSystem;
let experimentService: IExperimentService;
setup(() => {
interpreterService = mock(InterpreterService);
fs = mock(FileSystem);
workspaceService = mock(WorkspaceService);
interpreterService = mock(InterpreterService);
experimentService = mock<IExperimentService>();
when(experimentService.inExperiment(DiscoveryVariants.discoverWithFileWatching)).thenResolve(false);
when(experimentService.inExperiment(DiscoveryVariants.discoveryWithoutFileWatching)).thenResolve(false);
pipEnvExecution = TypeMoq.Mock.ofType<IToolExecutionPath>();
activationProvider = new PipEnvActivationCommandProvider(
instance(interpreterService),
pipEnvExecution.object,
instance(workspaceService),
instance(fs),
instance(experimentService),
);

pipEnvExecution.setup((p) => p.executable).returns(() => pipenvExecFile);
Expand All @@ -60,6 +66,7 @@ suite('Terminals Activation - Pipenv', () => {
for (const interpreterType of nonPipInterpreterTypes) {
when(interpreterService.getActiveInterpreter(resource)).thenResolve({
type: interpreterType,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);

for (const shell of getNamesAndValues<TerminalShellType>(TerminalShellType)) {
Expand All @@ -72,6 +79,7 @@ suite('Terminals Activation - Pipenv', () => {
test('pipenv shell is returned for pipenv interpeter', async () => {
when(interpreterService.getActiveInterpreter(resource)).thenResolve({
envType: EnvironmentType.Pipenv,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);

for (const shell of getNamesAndValues<TerminalShellType>(TerminalShellType)) {
Expand All @@ -84,6 +92,7 @@ suite('Terminals Activation - Pipenv', () => {
pipenvExecFile = 'my pipenv';
when(interpreterService.getActiveInterpreter(resource)).thenResolve({
envType: EnvironmentType.Pipenv,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);

for (const shell of getNamesAndValues<TerminalShellType>(TerminalShellType)) {
Expand Down