Skip to content

Prevent writing settings to global scope for environment and package managers #1489

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
eleanorjboyd merged 3 commits into from
Apr 28, 2026
+84 −164
Merged

Prevent writing settings to global scope for environment and package managers #1489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c54972
Prevent writing settings to global scope for environment and package …
eleanorjboyd Apr 28, 2026
0a3ab62
Update docs/managing-python-projects.md
eleanorjboyd Apr 28, 2026
d2f08e2
address comments
eleanorjboyd Apr 28, 2026
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 docs/managing-python-projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,8 @@ You can set default managers that apply to all projects without explicit overrid
}
```

> **Important**: The extension never writes settings to the User (global) scope. All extension-managed settings are written at the Workspace or Workspace Folder level only. This prevents the extension from setting values that persist across unrelated projects and cause unexpected interference (see [#1468](https://github.com/microsoft/vscode-python-environments/issues/1468)). If a user wants a user-level default, they can set it manually in their User `settings.json`.

## Working with Multi-Root Workspaces

Multi-root workspaces contain multiple top-level folders. The extension handles these seamlessly:
Expand Down
122 changes: 48 additions & 74 deletions src/features/settings/settingHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as path from 'path';
import { ConfigurationScope, ConfigurationTarget, Uri, WorkspaceConfiguration, WorkspaceFolder } from 'vscode';
import { PythonProject } from '../../api';
import { DEFAULT_ENV_MANAGER_ID, DEFAULT_PACKAGE_MANAGER_ID } from '../../common/constants';
import { traceError, traceInfo, traceWarn } from '../../common/logging';
import { traceError, traceInfo, traceVerbose, traceWarn } from '../../common/logging';
import * as workspaceApis from '../../common/workspace.apis';
import { PythonProjectManager, PythonProjectSettings } from '../../internal.api';

Expand Down Expand Up @@ -81,8 +81,16 @@ export function getDefaultPkgManagerSetting(
return defaultManager;
}

function traceIgnoredGlobalManagerEdits(functionName: string, count: number): void {
if (count > 0) {
traceVerbose(
`[${functionName}] Ignoring ${count} edit(s) without a project because python-envs does not persist manager defaults to User/global settings.`,
);
}
}

export interface EditAllManagerSettings {
// undefined means global
// Edits without a project are ignored; python-envs does not persist manager defaults to User/global settings.
project?: PythonProject;
envManager: string;
packageManager: string;
Expand All @@ -95,24 +103,25 @@ interface EditAllManagerSettingsInternal {
export async function setAllManagerSettings(edits: EditAllManagerSettings[]): Promise<void> {
const noWorkspace: EditAllManagerSettingsInternal[] = [];
const workspaces = new Map<WorkspaceFolder, EditAllManagerSettingsInternal[]>();
edits
.filter((e) => !!e.project)
.map((e) => e as EditAllManagerSettingsInternal)
.forEach((e) => {
const w = workspaceApis.getWorkspaceFolder(e.project.uri);
if (w) {
workspaces.set(w, [
...(workspaces.get(w) || []),
{ project: e.project, envManager: e.envManager, packageManager: e.packageManager },
]);
} else {
noWorkspace.push({ project: e.project, envManager: e.envManager, packageManager: e.packageManager });
}
});
const projectEdits = edits.filter((e): e is EditAllManagerSettingsInternal => !!e.project);
traceIgnoredGlobalManagerEdits('setAllManagerSettings', edits.length - projectEdits.length);
projectEdits.forEach((e) => {
const w = workspaceApis.getWorkspaceFolder(e.project.uri);
if (w) {
workspaces.set(w, [
...(workspaces.get(w) || []),
{ project: e.project, envManager: e.envManager, packageManager: e.packageManager },
]);
} else {
noWorkspace.push({ project: e.project, envManager: e.envManager, packageManager: e.packageManager });
}
});

noWorkspace.forEach((e) => {
if (e.project) {
traceInfo(`Unable to find workspace for ${e.project.uri.fsPath}, will use global settings for this.`);
traceInfo(
`Unable to find workspace for ${e.project.uri.fsPath}, skipping settings update because no User/global fallback is written.`,
);
}
});

Expand Down Expand Up @@ -195,23 +204,11 @@ export async function setAllManagerSettings(edits: EditAllManagerSettings[]): Pr
}
});

const config = workspaceApis.getConfiguration('python-envs', undefined);
edits
.filter((e) => !e.project)
.forEach((e) => {
if (config.get('defaultEnvManager') !== e.envManager) {
promises.push(config.update('defaultEnvManager', e.envManager, ConfigurationTarget.Global));
}
if (config.get('defaultPackageManager') !== e.packageManager) {
promises.push(config.update('defaultPackageManager', e.packageManager, ConfigurationTarget.Global));
}
});

await Promise.all(promises);
}
Comment thread
eleanorjboyd marked this conversation as resolved.

export interface EditEnvManagerSettings {
// undefined means global
// Edits without a project are ignored; python-envs does not persist manager defaults to User/global settings.
project?: PythonProject;
envManager: string;
}
Expand All @@ -222,17 +219,16 @@ interface EditEnvManagerSettingsInternal {
export async function setEnvironmentManager(edits: EditEnvManagerSettings[]): Promise<void> {
const noWorkspace: EditEnvManagerSettingsInternal[] = [];
const workspaces = new Map<WorkspaceFolder, EditEnvManagerSettingsInternal[]>();
edits
.filter((e) => !!e.project)
.map((e) => e as EditEnvManagerSettingsInternal)
.forEach((e) => {
const w = workspaceApis.getWorkspaceFolder(e.project.uri);
if (w) {
workspaces.set(w, [...(workspaces.get(w) || []), { project: e.project, envManager: e.envManager }]);
} else {
noWorkspace.push({ project: e.project, envManager: e.envManager });
}
});
const projectEdits = edits.filter((e): e is EditEnvManagerSettingsInternal => !!e.project);
traceIgnoredGlobalManagerEdits('setEnvironmentManager', edits.length - projectEdits.length);
projectEdits.forEach((e) => {
const w = workspaceApis.getWorkspaceFolder(e.project.uri);
if (w) {
workspaces.set(w, [...(workspaces.get(w) || []), { project: e.project, envManager: e.envManager }]);
} else {
noWorkspace.push({ project: e.project, envManager: e.envManager });
}
});

noWorkspace.forEach((e) => {
if (e.project) {
Expand Down Expand Up @@ -269,20 +265,11 @@ export async function setEnvironmentManager(edits: EditEnvManagerSettings[]): Pr
}
});

const config = workspaceApis.getConfiguration('python-envs', undefined);
edits
.filter((e) => !e.project)
.forEach((e) => {
if (config.get('defaultEnvManager') !== e.envManager) {
promises.push(config.update('defaultEnvManager', e.envManager, ConfigurationTarget.Global));
}
});

await Promise.all(promises);
}

export interface EditPackageManagerSettings {
// undefined means global
// Edits without a project are ignored; python-envs does not persist manager defaults to User/global settings.
project?: PythonProject;
packageManager: string;
}
Expand All @@ -293,20 +280,16 @@ interface EditPackageManagerSettingsInternal {
export async function setPackageManager(edits: EditPackageManagerSettings[]): Promise<void> {
const noWorkspace: EditPackageManagerSettingsInternal[] = [];
const workspaces = new Map<WorkspaceFolder, EditPackageManagerSettingsInternal[]>();
edits
.filter((e) => !!e.project)
.map((e) => e as EditPackageManagerSettingsInternal)
.forEach((e) => {
const w = workspaceApis.getWorkspaceFolder(e.project.uri);
if (w) {
workspaces.set(w, [
...(workspaces.get(w) || []),
{ project: e.project, packageManager: e.packageManager },
]);
} else {
noWorkspace.push({ project: e.project, packageManager: e.packageManager });
}
});
const projectEdits = edits.filter((e): e is EditPackageManagerSettingsInternal => !!e.project);
traceIgnoredGlobalManagerEdits('setPackageManager', edits.length - projectEdits.length);
projectEdits.forEach((e) => {
const w = workspaceApis.getWorkspaceFolder(e.project.uri);
if (w) {
workspaces.set(w, [...(workspaces.get(w) || []), { project: e.project, packageManager: e.packageManager }]);
} else {
noWorkspace.push({ project: e.project, packageManager: e.packageManager });
}
});

noWorkspace.forEach((e) => {
if (e.project) {
Expand Down Expand Up @@ -343,15 +326,6 @@ export async function setPackageManager(edits: EditPackageManagerSettings[]): Pr
}
});

const config = workspaceApis.getConfiguration('python-envs', undefined);
edits
.filter((e) => !e.project)
.forEach((e) => {
if (config.get('defaultPackageManager') !== e.packageManager) {
promises.push(config.update('defaultPackageManager', e.packageManager, ConfigurationTarget.Global));
}
});

await Promise.all(promises);
}

Expand Down
Loading
Loading