forked from microsoft/vscode-python-environments
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathenvManagersView.ts
More file actions
303 lines (267 loc) · 11.5 KB
/
envManagersView.ts
File metadata and controls
303 lines (267 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
import { Disposable, Event, EventEmitter, ProviderResult, TreeDataProvider, TreeItem, TreeView, window } from 'vscode';
import { DidChangeEnvironmentEventArgs, EnvironmentGroupInfo, PythonEnvironment } from '../../api';
import { ProjectViews } from '../../common/localize';
import { createSimpleDebounce } from '../../common/utils/debounce';
import {
DidChangeEnvironmentManagerEventArgs,
DidChangePackageManagerEventArgs,
EnvironmentManagers,
InternalDidChangeEnvironmentsEventArgs,
InternalDidChangePackagesEventArgs,
InternalEnvironmentManager,
InternalPackageManager,
} from '../../internal.api';
import { ITemporaryStateManager } from './temporaryStateManager';
import {
EnvInfoTreeItem,
EnvManagerTreeItem,
EnvTreeItem,
EnvTreeItemKind,
NoPythonEnvTreeItem,
PackageTreeItem,
PythonEnvTreeItem,
PythonGroupEnvTreeItem,
} from './treeViewItems';
const COPIED_STATE = 'copied';
const SELECTED_STATE = 'selected';
const ENV_STATE_KEYS = [COPIED_STATE, SELECTED_STATE];
export class EnvManagerView implements TreeDataProvider<EnvTreeItem>, Disposable {
private treeView: TreeView<EnvTreeItem>;
private treeDataChanged: EventEmitter<EnvTreeItem | EnvTreeItem[] | null | undefined> = new EventEmitter<
EnvTreeItem | EnvTreeItem[] | null | undefined
>();
private revealMap = new Map<string, PythonEnvTreeItem>();
private managerViews = new Map<string, EnvManagerTreeItem>();
private groupViews = new Map<string, PythonGroupEnvTreeItem>();
private selected: Map<string, string> = new Map();
private disposables: Disposable[] = [];
public constructor(
public providers: EnvironmentManagers,
private stateManager: ITemporaryStateManager,
) {
this.treeView = window.createTreeView<EnvTreeItem>('env-managers', {
treeDataProvider: this,
});
this.disposables.push(
new Disposable(() => {
this.revealMap.clear();
this.managerViews.clear();
this.groupViews.clear();
this.selected.clear();
}),
this.treeView,
this.treeDataChanged,
this.providers.onDidChangeEnvironments((e: InternalDidChangeEnvironmentsEventArgs) => {
this.onDidChangeEnvironments(e);
}),
this.providers.onDidChangeEnvironmentManager((m: DidChangeEnvironmentManagerEventArgs) => {
this.onDidChangeEnvironmentManager(m);
}),
this.providers.onDidChangePackages((p: InternalDidChangePackagesEventArgs) => {
this.onDidChangePackages(p);
}),
this.providers.onDidChangePackageManager((p: DidChangePackageManagerEventArgs) => {
this.onDidChangePackageManager(p);
}),
);
this.disposables.push(
this.stateManager.onDidChangeState(({ itemId }) => {
const view = this.revealMap.get(itemId);
if (view) {
this.fireDataChanged(view);
}
}),
);
}
dispose() {
this.disposables.forEach((d) => d.dispose());
}
private debouncedFireDataChanged = createSimpleDebounce(500, () => this.treeDataChanged.fire(undefined));
private fireDataChanged(item: EnvTreeItem | EnvTreeItem[] | null | undefined) {
if (item) {
this.treeDataChanged.fire(item);
} else {
this.debouncedFireDataChanged.trigger();
}
}
onDidChangeTreeData: Event<void | EnvTreeItem | EnvTreeItem[] | null | undefined> = this.treeDataChanged.event;
getTreeItem(element: EnvTreeItem): TreeItem | Thenable<TreeItem> {
if (element.kind === EnvTreeItemKind.environment && element instanceof PythonEnvTreeItem) {
const itemId = element.environment.envId.id;
const currentContext = element.treeItem.contextValue ?? '';
element.treeItem.contextValue = this.stateManager.updateContextValue(
itemId,
currentContext,
ENV_STATE_KEYS,
);
}
return element.treeItem;
}
async getChildren(element?: EnvTreeItem | undefined): Promise<EnvTreeItem[] | undefined> {
if (!element) {
const views: EnvTreeItem[] = [];
this.managerViews.clear();
this.groupViews.clear();
this.providers.managers.forEach((m) => {
const view = new EnvManagerTreeItem(m);
views.push(view);
this.managerViews.set(m.id, view);
});
return views;
}
if (element.kind === EnvTreeItemKind.manager) {
const manager = (element as EnvManagerTreeItem).manager;
const views: EnvTreeItem[] = [];
const envs = await manager.getEnvironments('all');
envs.filter((e) => !e.group).forEach((env) => {
const view = new PythonEnvTreeItem(env, element as EnvManagerTreeItem, this.selected.get(env.envId.id));
views.push(view);
this.revealMap.set(env.envId.id, view);
});
const groups: string[] = [];
const groupObjects: (string | EnvironmentGroupInfo)[] = [];
envs.filter((e) => e.group).forEach((env) => {
const name =
env.group && typeof env.group === 'string' ? env.group : (env.group as EnvironmentGroupInfo).name;
if (name && !groups.includes(name)) {
groups.push(name);
groupObjects.push(env.group as EnvironmentGroupInfo);
}
});
groupObjects.forEach((group) => {
const groupView = new PythonGroupEnvTreeItem(element as EnvManagerTreeItem, group);
const groupName = typeof group === 'string' ? group : group.name;
this.groupViews.set(`${manager.id}:${groupName}`, groupView);
views.push(groupView);
});
if (views.length === 0) {
views.push(new NoPythonEnvTreeItem(element as EnvManagerTreeItem));
}
return views;
}
if (element.kind === EnvTreeItemKind.environmentGroup) {
const groupItem = element as PythonGroupEnvTreeItem;
const manager = groupItem.parent.manager;
const views: EnvTreeItem[] = [];
const envs = await manager.getEnvironments('all');
const groupName =
typeof groupItem.group === 'string' ? groupItem.group : (groupItem.group as EnvironmentGroupInfo).name;
const grouped = envs.filter((e) => {
if (e.group) {
const name =
e.group && typeof e.group === 'string' ? e.group : (e.group as EnvironmentGroupInfo).name;
return name === groupName;
}
return false;
});
grouped.forEach((env) => {
const view = new PythonEnvTreeItem(env, groupItem, this.selected.get(env.envId.id));
views.push(view);
this.revealMap.set(env.envId.id, view);
});
return views;
}
if (element.kind === EnvTreeItemKind.environment) {
const pythonEnvItem = element as PythonEnvTreeItem;
const environment = pythonEnvItem.environment;
const envManager =
pythonEnvItem.parent.kind === EnvTreeItemKind.environmentGroup
? pythonEnvItem.parent.parent.manager
: pythonEnvItem.parent.manager;
const pkgManager = this.getSupportedPackageManager(envManager);
const parent = element as PythonEnvTreeItem;
const views: EnvTreeItem[] = [];
if (pkgManager) {
const packages = await pkgManager.getPackages(environment);
if (packages && packages.length > 0) {
views.push(...packages.map((p) => new PackageTreeItem(p, parent, pkgManager)));
} else {
views.push(new EnvInfoTreeItem(parent, ProjectViews.noPackages));
}
} else {
views.push(new EnvInfoTreeItem(parent, ProjectViews.noPackageManager));
}
return views;
}
}
getParent(element: EnvTreeItem): ProviderResult<EnvTreeItem> {
return element.parent;
}
/**
* Reveals and focuses on the given environment in the Environment Managers view.
*
* @param environment - The Python environment to reveal
*/
async reveal(environment?: PythonEnvironment): Promise<void> {
if (!environment) {
return;
}
const manager = this.providers.getEnvironmentManager(environment);
if (!manager) {
return;
}
if (!this.managerViews.has(manager.id)) {
await this.getChildren(undefined);
}
const managerView = this.managerViews.get(manager.id);
if (!managerView) {
return;
}
const groupName = typeof environment.group === 'string' ? environment.group : environment.group?.name;
if (groupName) {
if (!this.groupViews.has(`${manager.id}:${groupName}`)) {
await this.getChildren(managerView);
}
const groupView = this.groupViews.get(`${manager.id}:${groupName}`);
if (groupView) {
await this.getChildren(groupView);
}
} else {
await this.getChildren(managerView);
}
const view = this.revealMap.get(environment.envId.id);
if (view && this.treeView.visible) {
await this.treeView.reveal(view, { expand: false, focus: true, select: true });
}
}
private getSupportedPackageManager(manager: InternalEnvironmentManager): InternalPackageManager | undefined {
return this.providers.getPackageManager(manager.preferredPackageManagerId);
}
private onDidChangeEnvironmentManager(_args: DidChangeEnvironmentManagerEventArgs) {
this.fireDataChanged(undefined);
}
private onDidChangeEnvironments(args: InternalDidChangeEnvironmentsEventArgs) {
this.fireDataChanged(this.managerViews.get(args.manager.id));
}
private onDidChangePackages(args: InternalDidChangePackagesEventArgs) {
const view = Array.from(this.revealMap.values()).find(
(v) => v.environment.envId.id === args.environment.envId.id,
);
if (view) {
this.fireDataChanged(view);
}
}
private onDidChangePackageManager(_args: DidChangePackageManagerEventArgs) {
// Since we removed the packageRoots level, just refresh all environments
// This is a simplified approach that isn't as targeted but ensures packages get refreshed
this.fireDataChanged(undefined);
}
public environmentChanged(e: DidChangeEnvironmentEventArgs) {
const views = [];
if (e.old) {
this.selected.delete(e.old.envId.id);
const view: EnvTreeItem | undefined = this.revealMap.get(e.old.envId.id);
if (view) {
views.push(view);
}
}
if (e.new) {
this.selected.set(e.new.envId.id, e.uri === undefined ? 'global' : e.uri.fsPath);
const view: EnvTreeItem | undefined = this.revealMap.get(e.new.envId.id);
if (view && !views.includes(view)) {
views.push(view);
}
}
this.fireDataChanged(views);
}
}