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.

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

[Fixes #2459] Do not use a variable substitution when updating python.pythonPath. #2685

Merged
merged 16 commits into from
Sep 27, 2018
Merged

[Fixes #2459] Do not use a variable substitution when updating python.pythonPath. #2685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
53776a6
Add unit tests for WorkspacePythonPathUpdaterService.updatePythonPath().
ericsnowcurrently Sep 25, 2018
aa5fecd
Parameterize some of the tests.
ericsnowcurrently Sep 25, 2018
0f1359d
Factor out setExpected().
ericsnowcurrently Sep 25, 2018
5adde4e
Add unit tests for WorkspaceFolderPythonPathUpdaterService.updatePyth…
ericsnowcurrently Sep 25, 2018
921e092
Do not set python.pythonPath to a value with variable substitution.
ericsnowcurrently Sep 25, 2018
568a5dd
Add a NEWS entry.
ericsnowcurrently Sep 25, 2018
42f697b
Drop two system tests that expect the old behavior.
ericsnowcurrently Sep 25, 2018
afa83a3
Do not add copyright to existing files.
ericsnowcurrently Sep 25, 2018
7761615
Keep pythonPath relative when possible.
ericsnowcurrently Sep 25, 2018
2d16f10
Combine the workspace updaters into one file.
ericsnowcurrently Sep 26, 2018
4f14402
Add getSetting() and matchSetting() helpers.
ericsnowcurrently Sep 26, 2018
269982b
Use matchSetting().
ericsnowcurrently Sep 26, 2018
b296399
Factor out WorkspacePythonPathUpdater.
ericsnowcurrently Sep 26, 2018
40d47ec
Drop normalizeFilename().
ericsnowcurrently Sep 26, 2018
2fd344e
Fix some unrelated tests.
ericsnowcurrently Sep 26, 2018
3e7923d
Drop the refactoring and extra unit tests.
ericsnowcurrently Sep 27, 2018
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: 2 additions & 0 deletions news/2 Fixes/2459.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Do not use variable substitution when updating python.pythonPath. This matters
because VS Code does not do variable substitution in settings values.
3 changes: 1 addition & 2 deletions src/client/interpreter/configuration/services/workspaceFolderUpdaterService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ export class WorkspaceFolderPythonPathUpdaterService implements IPythonPathUpdat
return;
}
if (pythonPath.startsWith(this.workspaceFolder.fsPath)) {
// tslint:disable-next-line:no-invalid-template-strings
pythonPath = path.join('${workspaceFolder}', path.relative(this.workspaceFolder.fsPath, pythonPath));
pythonPath = path.relative(this.workspaceFolder.fsPath, pythonPath);
}
await pythonConfig.update('pythonPath', pythonPath, ConfigurationTarget.WorkspaceFolder);
}
Expand Down
3 changes: 1 addition & 2 deletions src/client/interpreter/configuration/services/workspaceUpdaterService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ export class WorkspacePythonPathUpdaterService implements IPythonPathUpdaterServ
return;
}
if (pythonPath.startsWith(this.workspace.fsPath)) {
// tslint:disable-next-line:no-invalid-template-strings
pythonPath = path.join('${workspaceFolder}', path.relative(this.workspace.fsPath, pythonPath));
pythonPath = path.relative(this.workspace.fsPath, pythonPath);
}
await pythonConfig.update('pythonPath', pythonPath, false);
}
Expand Down
8 changes: 4 additions & 4 deletions src/test/interpreters/pythonPathUpdater.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@ suite('Python Path Settings Updater', () => {
await updater.updatePythonPath(pythonPath);
workspaceConfig.verify(w => w.update(TypeMoq.It.isValue('pythonPath'), TypeMoq.It.isValue(pythonPath), TypeMoq.It.isValue(ConfigurationTarget.WorkspaceFolder)), TypeMoq.Times.once());
});
test('Python Path should be updated with ${workspaceFolder} for relative paths', async () => {
test('Python Path should be truncated for worspace-relative paths', async () => {
const workspaceFolderPath = path.join('user', 'desktop', 'development');
const workspaceFolder = Uri.file(workspaceFolderPath);
const updater = updaterServiceFactory.getWorkspaceFolderPythonPathConfigurationService(workspaceFolder);
const pythonPath = Uri.file(path.join(workspaceFolderPath, 'env', 'bin', 'python')).fsPath;
const expectedPythonPath = path.join('${workspaceFolder}', 'env', 'bin', 'python');
const expectedPythonPath = path.join('env', 'bin', 'python');
const workspaceConfig = setupConfigProvider(workspaceFolder);
workspaceConfig.setup(w => w.inspect(TypeMoq.It.isValue('pythonPath'))).returns(() => undefined);

Expand Down Expand Up @@ -115,12 +115,12 @@ suite('Python Path Settings Updater', () => {
await updater.updatePythonPath(pythonPath);
workspaceConfig.verify(w => w.update(TypeMoq.It.isValue('pythonPath'), TypeMoq.It.isValue(pythonPath), TypeMoq.It.isValue(false)), TypeMoq.Times.once());
});
test('Python Path should be updated with ${workspaceFolder} for relative paths', async () => {
test('Python Path should be truncated for workspace-relative paths', async () => {
const workspaceFolderPath = path.join('user', 'desktop', 'development');
const workspaceFolder = Uri.file(workspaceFolderPath);
const updater = updaterServiceFactory.getWorkspacePythonPathConfigurationService(workspaceFolder);
const pythonPath = Uri.file(path.join(workspaceFolderPath, 'env', 'bin', 'python')).fsPath;
const expectedPythonPath = path.join('${workspaceFolder}', 'env', 'bin', 'python');
const expectedPythonPath = path.join('env', 'bin', 'python');
const workspaceConfig = setupConfigProvider(workspaceFolder);
workspaceConfig.setup(w => w.inspect(TypeMoq.It.isValue('pythonPath'))).returns(() => undefined);

Expand Down