Skip to content
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.

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

Remove all references to sysPrefix and version from old Python Api #15098

Merged
merged 2 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 2 additions & 6 deletions src/kernels/execution/helpers.unit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ suite(`UpdateNotebookMetadata`, () => {
id: Uri.file('/usr/bin/python36').fsPath,
sysPrefix: '/usr',
displayName: 'Python 3.6',
envType: EnvironmentType.Unknown,
sysVersion: '3.6.0',
version: { major: 3, minor: 6, patch: 0, raw: '3.6.0' }
envType: EnvironmentType.Unknown
};
const pythonDefaultKernelSpec: IJupyterKernelSpec = {
argv: ['python', '-f', '{connection_file}'],
Expand All @@ -37,9 +35,7 @@ suite(`UpdateNotebookMetadata`, () => {
id: Uri.file('/usr/bin/python37').fsPath,
sysPrefix: '/usr',
displayName: 'Python 3.7',
envType: EnvironmentType.Unknown,
sysVersion: '3.7.0',
version: { major: 3, minor: 7, patch: 0, raw: '3.7.0' }
envType: EnvironmentType.Unknown
};
let environments: PythonExtension['environments'];
let disposables: { dispose: () => void }[] = [];
Expand Down
2 changes: 1 addition & 1 deletion src/kernels/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ export const autoGeneratedKernelNameIdentifier = 'jvsc74a57bd0';
export async function getInterpreterKernelSpecName(interpreter?: PythonEnvironment): Promise<string> {
// Generate a name from a hash of the interpreter
// Note it must be prefixed with 'python' and the version number.
const version = interpreter?.sysVersion ? getTelemetrySafeVersion(interpreter.sysVersion) || '3' : '';
const version = getTelemetrySafeVersion(getCachedVersion(interpreter)) || '3';
const versionWithSafeStrings = version.replace(/\./g, '');
const prefix = interpreter ? `python${versionWithSafeStrings}` : '';
return interpreter
Expand Down
38 changes: 0 additions & 38 deletions src/kernels/helpers.unit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,6 @@ suite('Kernel Connection Helpers', () => {
id: Uri.file('pyPath').fsPath,
sysPrefix: 'sysPrefix',
envName: '',
version: undefined,
displayName: 'Something',
envType: EnvironmentType.Pipenv
}
Expand Down Expand Up @@ -338,12 +337,6 @@ suite('Kernel Connection Helpers', () => {
sysPrefix: 'sysPrefix',
envName: '',
displayName: 'Something 64-bit',
version: {
major: 9,
minor: 8,
patch: 1,
raw: '9.8.7.6-pre'
},
envType: EnvironmentType.Conda
}
})
Expand Down Expand Up @@ -379,12 +372,6 @@ suite('Kernel Connection Helpers', () => {
sysPrefix: 'sysPrefix',
envName: '.env',
displayName: 'Something 64-bit',
version: {
major: 9,
minor: 8,
patch: 7,
raw: '9.8.7.6-pre'
},
envType: EnvironmentType.Conda
}
})
Expand Down Expand Up @@ -420,12 +407,6 @@ suite('Kernel Connection Helpers', () => {
sysPrefix: 'sysPrefix',
envName: '.env',
displayName: 'Something 64-bit',
version: {
major: 9,
minor: 8,
patch: 7,
raw: '9.8.7.6-pre'
},
envType: EnvironmentType.Conda
}
})
Expand Down Expand Up @@ -507,7 +488,6 @@ suite('Kernel Connection Helpers', () => {
id: Uri.file('pyPath').fsPath,
sysPrefix: 'sysPrefix',
envName: '',
version: { major: 1, minor: 2, patch: 3, raw: '1.2.3' },
displayName: 'Something 64-bit',
envType: EnvironmentType.Unknown
}
Expand Down Expand Up @@ -567,12 +547,6 @@ suite('Kernel Connection Helpers', () => {
when(kernelSpec.language).thenReturn('python');
when(interpreter.id).thenReturn('xyz');
when(interpreter.envName).thenReturn('');
when(interpreter.version).thenReturn({
major: 9,
minor: 8,
patch: 1,
raw: '9.8.7.6-pre'
});
when(interpreter.displayName).thenReturn('Something 64-bit');
when(interpreter.envType).thenReturn(EnvironmentType.Pipenv);
when(environments.known).thenReturn([
Expand Down Expand Up @@ -603,12 +577,6 @@ suite('Kernel Connection Helpers', () => {
when(kernelSpec.language).thenReturn('python');
when(interpreter.id).thenReturn('xyz');
when(interpreter.envName).thenReturn('.env');
when(interpreter.version).thenReturn({
major: 9,
minor: 8,
patch: 7,
raw: '9.8.7.6-pre'
});
when(interpreter.displayName).thenReturn('Something');
when(interpreter.envType).thenReturn(EnvironmentType.Conda);
when(environments.known).thenReturn([
Expand Down Expand Up @@ -639,12 +607,6 @@ suite('Kernel Connection Helpers', () => {
when(kernelSpec.language).thenReturn('python');
when(interpreter.id).thenReturn('xyz');
when(interpreter.envName).thenReturn('.env');
when(interpreter.version).thenReturn({
major: 9,
minor: 8,
patch: 7,
raw: '9.8.7.6-pre'
});
when(interpreter.displayName).thenReturn('Something 64-bit');
when(interpreter.envType).thenReturn(EnvironmentType.Conda);
when(environments.known).thenReturn([
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ suite('Jupyter Interpreter Configuration', () => {
const pythonInterpreter: PythonEnvironment = {
uri: Uri.file(''),
id: Uri.file('').fsPath,
sysPrefix: '',
sysVersion: ''
sysPrefix: ''
};
let disposables: Disposable[] = [];
setup(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,12 @@ suite('Jupyter Interpreter Service', () => {
const pythonInterpreter: PythonEnvironment = {
uri: Uri.file('some path'),
id: Uri.file('some path').fsPath,
sysPrefix: '',
sysVersion: ''
sysPrefix: ''
};
const secondPythonInterpreter: PythonEnvironment = {
uri: Uri.file('second interpreter path'),
id: Uri.file('second interpreter path').fsPath,
sysPrefix: '',
sysVersion: ''
sysPrefix: ''
};
let disposables: IDisposable[] = [];

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// Licensed under the MIT License.

import { expect } from 'chai';
import { SemVer } from 'semver';
import { anything, instance, mock, when } from 'ts-mockito';
import * as typemoq from 'typemoq';
import { CancellationTokenSource, Disposable, EventEmitter, Uri } from 'vscode';
Expand Down Expand Up @@ -32,8 +31,6 @@ suite('Jupyter Server Provider', () => {
const workingPython: PythonEnvironment = {
uri: Uri.file('/foo/bar/python.exe'),
id: Uri.file('/foo/bar/python.exe').fsPath,
version: new SemVer('3.6.6-final'),
sysVersion: '1.0.0.0',
sysPrefix: 'Python'
};
let disposables: Disposable[] = [];
Expand Down
30 changes: 10 additions & 20 deletions src/kernels/jupyter/session/jupyterKernelService.unit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python3',
displayName: 'Python 3 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python3.exe' : '/usr/bin/python3'),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '0'
}),
Expand Down Expand Up @@ -125,8 +124,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python3',
displayName: 'Python 3 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python3.exe' : '/usr/bin/python3'),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '2'
}),
Expand Down Expand Up @@ -160,8 +158,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python',
displayName: 'Python 2 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python.exe' : '/usr/bin/python'),
sysPrefix: 'python',
version: { major: 2, minor: 7, raw: '2.7', patch: 0 }
sysPrefix: 'python'
},
id: '4'
}),
Expand Down Expand Up @@ -192,8 +189,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python3',
displayName: 'Python 3 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python3.exe' : '/usr/bin/python3'),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '5'
}),
Expand Down Expand Up @@ -227,8 +223,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python',
displayName: 'Python 2 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python.exe' : '/usr/bin/python'),
sysPrefix: 'python',
version: { major: 2, minor: 7, raw: '2.7', patch: 0 }
sysPrefix: 'python'
},
id: '7'
}),
Expand Down Expand Up @@ -259,8 +254,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python3',
displayName: 'Python 3 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python3.exe' : '/usr/bin/python3'),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '8'
}),
Expand Down Expand Up @@ -294,8 +288,7 @@ suite('JupyterKernelService', () => {
id: '/usr/bin/python',
displayName: 'Python 2 Environment',
uri: Uri.file(os.platform() === 'win32' ? '/usr/bin/python.exe' : '/usr/bin/python'),
sysPrefix: 'python',
version: { major: 2, minor: 7, raw: '2.7', patch: 0 }
sysPrefix: 'python'
},
id: '10'
}),
Expand Down Expand Up @@ -378,8 +371,7 @@ suite('JupyterKernelService', () => {
? '/usr/don/home/envs/sample/bin/python.exe'
: '/usr/don/home/envs/sample/bin/python'
),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '12'
}),
Expand Down Expand Up @@ -417,8 +409,7 @@ suite('JupyterKernelService', () => {
? '/usr/don/home/envs/sample/bin/python.exe'
: '/usr/don/home/envs/sample/bin/python'
),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '13'
}),
Expand Down Expand Up @@ -453,8 +444,7 @@ suite('JupyterKernelService', () => {
? '/usr/don/home/envs/sample/bin/python.exe'
: '/usr/don/home/envs/sample/bin/python'
),
sysPrefix: 'python',
version: { major: 3, minor: 8, raw: '3.8', patch: 0 }
sysPrefix: 'python'
},
id: '14'
})
Expand Down
31 changes: 23 additions & 8 deletions src/kernels/kernelDependencyService.unit.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import * as sinon from 'sinon';
import { assert } from 'chai';
import { anything, instance, mock, verify, when } from 'ts-mockito';
import { CancellationTokenSource, Memento, NotebookDocument, NotebookEditor, Uri } from 'vscode';
Expand All @@ -19,6 +20,9 @@ import { getResourceType } from '../platform/common/utils';
import { mockedVSCodeNamespaces, resetVSCodeMocks } from '../test/vscode-mock';
import { Disposable } from 'vscode';
import { dispose } from '../platform/common/utils/lifecycle';
import { PythonExtension } from '@vscode/python-extension';
import { resolvableInstance } from '../test/datascience/helpers';
import { setPythonApi } from '../platform/interpreter/helpers';

/* eslint-disable @typescript-eslint/no-explicit-any */

Expand All @@ -37,14 +41,7 @@ suite('Kernel Dependency Service', () => {
uri: Uri.file('abc')
});
let metadata: PythonKernelConnectionMetadata;
suiteSetup(async () => {
metadata = PythonKernelConnectionMetadata.create({
interpreter,
kernelSpec: await createInterpreterKernelSpec(interpreter, Uri.file('')),
id: '1'
});
});
setup(() => {
setup(async () => {
resetVSCodeMocks();
disposables.push(new Disposable(() => resetVSCodeMocks()));
installer = mock<IInstaller>();
Expand All @@ -65,6 +62,24 @@ suite('Kernel Dependency Service', () => {
instance(rawSupport),
instance(serviceContainer)
);

const mockedApi = mock<PythonExtension>();
sinon.stub(PythonExtension, 'api').resolves(resolvableInstance(mockedApi));
disposables.push({ dispose: () => sinon.restore() });
const environments = mock<PythonExtension['environments']>();
when(mockedApi.environments).thenReturn(instance(environments));
when(environments.known).thenReturn([]);
setPythonApi(instance(mockedApi));
disposables.push({ dispose: () => setPythonApi(undefined as any) });

metadata = PythonKernelConnectionMetadata.create({
interpreter,
kernelSpec: await createInterpreterKernelSpec(interpreter, Uri.file('')),
id: '1'
});
// when(environments.resolveEnvironment(jupyterInterpreter.id)).thenResolve({
// executable: { sysPrefix: '' }
// } as any);
});
teardown(() => (disposables = dispose(disposables)));
[undefined, Uri.file('test.py'), Uri.file('test.ipynb')].forEach((resource) => {
Expand Down
Loading
Loading