forked from microsoft/vscode-python-environments
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathenvCommands.ts
562 lines (524 loc) · 20.1 KB
/
envCommands.ts
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
import { QuickInputButtons, TaskExecution, TaskRevealKind, Terminal, Uri, window } from 'vscode';
import {
EnvironmentManagers,
InternalEnvironmentManager,
InternalPackageManager,
ProjectCreators,
PythonProjectManager,
} from '../internal.api';
import { traceError, traceInfo, traceVerbose } from '../common/logging';
import { PythonEnvironment, PythonEnvironmentApi, PythonProject, PythonProjectCreator } from '../api';
import * as path from 'path';
import {
setEnvironmentManager,
setPackageManager,
addPythonProjectSetting,
removePythonProjectSetting,
getDefaultEnvManagerSetting,
getDefaultPkgManagerSetting,
EditProjectSettings,
} from './settings/settingHelpers';
import { getAbsolutePath } from '../common/utils/fileNameUtils';
import { runAsTask } from './execution/runAsTask';
import {
EnvManagerTreeItem,
PackageRootTreeItem,
PythonEnvTreeItem,
ProjectItem,
ProjectEnvironment,
ProjectPackageRootTreeItem,
GlobalProjectItem,
EnvTreeItemKind,
PackageTreeItem,
ProjectPackage,
} from './views/treeViewItems';
import { Common } from '../common/localize';
import { pickEnvironment } from '../common/pickers/environments';
import { pickEnvironmentManager, pickPackageManager, pickCreator } from '../common/pickers/managers';
import { pickPackageOptions } from '../common/pickers/packages';
import { pickProject, pickProjectMany } from '../common/pickers/projects';
import { TerminalManager } from './terminal/terminalManager';
import { runInTerminal } from './terminal/runInTerminal';
export async function refreshManagerCommand(context: unknown): Promise<void> {
if (context instanceof EnvManagerTreeItem) {
const manager = (context as EnvManagerTreeItem).manager;
await manager.refresh(undefined);
} else {
traceVerbose(`Invalid context for refresh command: ${context}`);
}
}
export async function refreshPackagesCommand(context: unknown) {
if (context instanceof ProjectPackageRootTreeItem) {
const view = context as ProjectPackageRootTreeItem;
const manager = view.manager;
await manager.refresh(view.environment);
} else if (context instanceof PackageRootTreeItem) {
const view = context as PackageRootTreeItem;
const manager = view.manager;
await manager.refresh(view.environment);
} else {
traceVerbose(`Invalid context for refresh command: ${context}`);
}
}
export async function createEnvironmentCommand(
context: unknown,
em: EnvironmentManagers,
pm: PythonProjectManager,
): Promise<PythonEnvironment | undefined> {
if (context instanceof EnvManagerTreeItem) {
const manager = (context as EnvManagerTreeItem).manager;
const projects = pm.getProjects();
if (projects.length === 0) {
const env = await manager.create('global');
if (env) {
await em.setEnvironments('global', env);
}
return env;
} else if (projects.length > 0) {
const selected = await pickProjectMany(projects);
if (selected) {
const scope = selected.length === 0 ? 'global' : selected.map((p) => p.uri);
const env = await manager.create(scope);
if (env) {
await em.setEnvironments(scope, env);
}
return env;
} else {
traceInfo('No project selected or global condition met for environment creation');
}
}
} else if (context instanceof Uri) {
const manager = em.getEnvironmentManager(context as Uri);
const project = pm.get(context as Uri);
if (project) {
return await manager?.create(project.uri);
} else {
traceError(`No project found for ${context}`);
}
} else {
traceError(`Invalid context for create command: ${context}`);
}
}
export async function createAnyEnvironmentCommand(
em: EnvironmentManagers,
pm: PythonProjectManager,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
options?: any,
): Promise<PythonEnvironment | undefined> {
const select = options?.selectEnvironment;
const projects = pm.getProjects();
if (projects.length === 0) {
const managerId = await pickEnvironmentManager(em.managers.filter((m) => m.supportsCreate));
const manager = em.managers.find((m) => m.id === managerId);
if (manager) {
const env = await manager.create('global');
if (select && env) {
await manager.set(undefined, env);
}
return env;
}
} else if (projects.length > 0) {
const selected = await pickProjectMany(projects);
if (selected && selected.length > 0) {
const defaultManagers: InternalEnvironmentManager[] = [];
selected.forEach((p) => {
const manager = em.getEnvironmentManager(p.uri);
if (manager && manager.supportsCreate && !defaultManagers.includes(manager)) {
defaultManagers.push(manager);
}
});
const managerId = await pickEnvironmentManager(
em.managers.filter((m) => m.supportsCreate),
defaultManagers,
);
const manager = em.managers.find((m) => m.id === managerId);
if (manager) {
const env = await manager.create(selected.map((p) => p.uri));
if (select && env) {
await em.setEnvironments(
selected.map((p) => p.uri),
env,
);
}
return env;
}
}
}
}
export async function removeEnvironmentCommand(context: unknown, managers: EnvironmentManagers): Promise<void> {
if (context instanceof PythonEnvTreeItem) {
const view = context as PythonEnvTreeItem;
const manager =
view.parent.kind === EnvTreeItemKind.environmentGroup ? view.parent.parent.manager : view.parent.manager;
await manager.remove(view.environment);
} else if (context instanceof Uri) {
const manager = managers.getEnvironmentManager(context as Uri);
const environment = await manager?.get(context as Uri);
if (environment) {
await manager?.remove(environment);
}
} else {
traceError(`Invalid context for remove command: ${context}`);
}
}
export async function handlePackagesCommand(
packageManager: InternalPackageManager,
environment: PythonEnvironment,
): Promise<void> {
const action = await pickPackageOptions();
try {
if (action === Common.install) {
await packageManager.install(environment);
} else if (action === Common.uninstall) {
await packageManager.uninstall(environment);
}
} catch (ex) {
if (ex === QuickInputButtons.Back) {
return handlePackagesCommand(packageManager, environment);
}
throw ex;
}
}
export async function handlePackageUninstall(context: unknown, em: EnvironmentManagers) {
if (context instanceof PackageTreeItem || context instanceof ProjectPackage) {
const moduleName = context.pkg.name;
const environment = context.parent.environment;
const packageManager = em.getPackageManager(environment);
await packageManager?.uninstall(environment, [moduleName]);
return;
}
traceError(`Invalid context for uninstall command: ${typeof context}`);
}
export async function setEnvironmentCommand(
context: unknown,
em: EnvironmentManagers,
wm: PythonProjectManager,
): Promise<void> {
if (context instanceof PythonEnvTreeItem) {
try {
const view = context as PythonEnvTreeItem;
const projects = wm.getProjects();
if (projects.length > 0) {
const selected = await pickProjectMany(projects);
if (selected && selected.length > 0) {
const uris = selected.map((p) => p.uri);
await em.setEnvironments(uris, view.environment);
}
} else {
await em.setEnvironments('global', view.environment);
}
} catch (ex) {
if (ex === QuickInputButtons.Back) {
await setEnvironmentCommand(context, em, wm);
}
throw ex;
}
} else if (context instanceof ProjectItem) {
const view = context as ProjectItem;
await setEnvironmentCommand([view.project.uri], em, wm);
} else if (context instanceof GlobalProjectItem) {
await setEnvironmentCommand(undefined, em, wm);
} else if (context instanceof Uri) {
await setEnvironmentCommand([context], em, wm);
} else if (context === undefined) {
try {
const projects = wm.getProjects();
if (projects.length > 0) {
const selected = await pickProjectMany(projects);
if (selected && selected.length > 0) {
const uris = selected.map((p) => p.uri);
await setEnvironmentCommand(uris, em, wm);
}
} else {
const globalEnvManager = em.getEnvironmentManager(undefined);
const recommended = globalEnvManager ? await globalEnvManager.get(undefined) : undefined;
const selected = await pickEnvironment(em.managers, globalEnvManager ? [globalEnvManager] : [], {
projects: [],
recommended,
showBackButton: false,
});
if (selected) {
await em.setEnvironments('global', selected);
}
}
} catch (ex) {
if (ex === QuickInputButtons.Back) {
await setEnvironmentCommand(context, em, wm);
}
throw ex;
}
} else if (Array.isArray(context) && context.length > 0 && context.every((c) => c instanceof Uri)) {
const uris = context as Uri[];
const projects = wm.getProjects(uris).map((p) => p);
const projectEnvManagers = em.getProjectEnvManagers(uris);
const recommended =
projectEnvManagers.length === 1 && uris.length === 1 ? await projectEnvManagers[0].get(uris[0]) : undefined;
const selected = await pickEnvironment(em.managers, projectEnvManagers, {
projects,
recommended,
showBackButton: uris.length > 1,
});
if (selected) {
await em.setEnvironments(uris, selected);
}
} else {
traceError(`Invalid context for setting environment command: ${context}`);
window.showErrorMessage('Invalid context for setting environment');
}
}
export async function resetEnvironmentCommand(
context: unknown,
em: EnvironmentManagers,
wm: PythonProjectManager,
): Promise<void> {
if (context instanceof ProjectItem) {
const view = context as ProjectItem;
return resetEnvironmentCommand(view.project.uri, em, wm);
} else if (context instanceof Uri) {
const uri = context as Uri;
const manager = em.getEnvironmentManager(uri);
if (manager) {
manager.set(uri, undefined);
} else {
window.showErrorMessage(`No environment manager found for: ${uri.fsPath}`);
traceError(`No environment manager found for ${uri.fsPath}`);
}
return;
} else if (context === undefined) {
const pw = await pickProject(wm.getProjects());
if (pw) {
return resetEnvironmentCommand(pw.uri, em, wm);
}
return;
}
traceError(`Invalid context for unset environment command: ${context}`);
window.showErrorMessage('Invalid context for unset environment');
}
export async function setEnvManagerCommand(em: EnvironmentManagers, wm: PythonProjectManager): Promise<void> {
const projects = await pickProjectMany(wm.getProjects());
if (projects && projects.length > 0) {
const manager = await pickEnvironmentManager(em.managers);
if (manager) {
await setEnvironmentManager(projects.map((p) => ({ project: p, envManager: manager })));
}
}
}
export async function setPackageManagerCommand(em: EnvironmentManagers, wm: PythonProjectManager): Promise<void> {
const projects = await pickProjectMany(wm.getProjects());
if (projects && projects.length > 0) {
const manager = await pickPackageManager(em.packageManagers);
if (manager) {
await setPackageManager(projects.map((p) => ({ project: p, packageManager: manager })));
}
}
}
export async function addPythonProject(
resource: unknown,
wm: PythonProjectManager,
em: EnvironmentManagers,
pc: ProjectCreators,
): Promise<PythonProject | PythonProject[] | undefined> {
if (wm.getProjects().length === 0) {
window.showErrorMessage('Please open a folder/project before adding a workspace');
return;
}
if (resource instanceof Uri) {
const uri = resource as Uri;
const envManagerId = getDefaultEnvManagerSetting(wm, uri);
const pkgManagerId = getDefaultPkgManagerSetting(
wm,
uri,
em.getEnvironmentManager(envManagerId)?.preferredPackageManagerId,
);
const pw = wm.create(path.basename(uri.fsPath), uri);
await addPythonProjectSetting([{ project: pw, envManager: envManagerId, packageManager: pkgManagerId }]);
return pw;
}
if (resource === undefined || resource instanceof ProjectItem) {
const creator: PythonProjectCreator | undefined = await pickCreator(pc.getProjectCreators());
if (!creator) {
return;
}
let results: PythonProject | PythonProject[] | undefined;
try {
results = await creator.create();
if (results === undefined) {
return;
}
} catch (ex) {
if (ex === QuickInputButtons.Back) {
return addPythonProject(resource, wm, em, pc);
}
throw ex;
}
if (!Array.isArray(results)) {
results = [results];
}
if (Array.isArray(results)) {
if (results.length === 0) {
return;
}
}
const projects: PythonProject[] = [];
const edits: EditProjectSettings[] = [];
for (const result of results) {
const uri = await getAbsolutePath(result.uri.fsPath);
if (!uri) {
traceError(`Path does not belong to any opened workspace: ${result.uri.fsPath}`);
continue;
}
const envManagerId = getDefaultEnvManagerSetting(wm, uri);
const pkgManagerId = getDefaultPkgManagerSetting(
wm,
uri,
em.getEnvironmentManager(envManagerId)?.preferredPackageManagerId,
);
const pw = wm.create(path.basename(uri.fsPath), uri);
projects.push(pw);
edits.push({ project: pw, envManager: envManagerId, packageManager: pkgManagerId });
}
await addPythonProjectSetting(edits);
return projects;
}
}
export async function removePythonProject(item: ProjectItem, wm: PythonProjectManager): Promise<void> {
await removePythonProjectSetting([{ project: item.project }]);
wm.remove(item.project);
}
export async function getPackageCommandOptions(
e: unknown,
em: EnvironmentManagers,
pm: PythonProjectManager,
): Promise<{
packageManager: InternalPackageManager;
environment: PythonEnvironment;
}> {
if (e === undefined) {
const project = await pickProject(pm.getProjects());
if (project) {
return getPackageCommandOptions(project.uri, em, pm);
}
}
if (e instanceof ProjectEnvironment) {
const environment = e.environment;
const packageManager = em.getPackageManager(e.parent.project.uri);
if (packageManager) {
return { environment, packageManager };
}
}
if (e instanceof PythonEnvTreeItem) {
const environment = e.environment;
const packageManager = em.getPackageManager(environment);
if (packageManager) {
return { environment, packageManager };
}
}
if (e instanceof Uri) {
const environment = await em.getEnvironmentManager(e)?.get(e);
const packageManager = em.getPackageManager(e);
if (environment && packageManager) {
return { environment, packageManager };
}
}
throw new Error(`Invalid context for package command: ${e}`);
}
export async function createTerminalCommand(
context: unknown,
api: PythonEnvironmentApi,
tm: TerminalManager,
): Promise<Terminal | undefined> {
if (context instanceof Uri) {
const uri = context as Uri;
const env = await api.getEnvironment(uri);
const pw = api.getPythonProject(uri);
if (env && pw) {
return await tm.create(env, { cwd: pw.uri });
}
} else if (context instanceof ProjectItem) {
const view = context as ProjectItem;
const env = await api.getEnvironment(view.project.uri);
if (env) {
const terminal = await tm.create(env, { cwd: view.project.uri });
terminal.show();
return terminal;
}
} else if (context instanceof GlobalProjectItem) {
const env = await api.getEnvironment(undefined);
if (env) {
const terminal = await tm.create(env, { cwd: undefined });
terminal.show();
return terminal;
}
} else if (context instanceof PythonEnvTreeItem) {
const view = context as PythonEnvTreeItem;
const pw = await pickProject(api.getPythonProjects());
if (pw) {
const terminal = await tm.create(view.environment, { cwd: pw.uri });
terminal.show();
return terminal;
}
}
}
export async function runInTerminalCommand(
item: unknown,
api: PythonEnvironmentApi,
tm: TerminalManager,
): Promise<void> {
if (item instanceof Uri) {
const uri = item as Uri;
const project = api.getPythonProject(uri);
const environment = await api.getEnvironment(uri);
if (environment && project) {
const terminal = await tm.getProjectTerminal(project, environment);
await runInTerminal(environment, terminal, {
cwd: project.uri,
args: [item.fsPath],
show: true,
});
}
}
throw new Error(`Invalid context for run-in-terminal: ${item}`);
}
export async function runInDedicatedTerminalCommand(
item: unknown,
api: PythonEnvironmentApi,
tm: TerminalManager,
): Promise<void> {
if (item instanceof Uri) {
const uri = item as Uri;
const project = api.getPythonProject(uri);
const environment = await api.getEnvironment(uri);
if (environment && project) {
const terminal = await tm.getDedicatedTerminal(item, project, environment);
await runInTerminal(environment, terminal, {
cwd: project.uri,
args: [item.fsPath],
show: true,
});
}
}
throw new Error(`Invalid context for run-in-terminal: ${item}`);
}
export async function runAsTaskCommand(item: unknown, api: PythonEnvironmentApi): Promise<TaskExecution | undefined> {
if (item instanceof Uri) {
const uri = item as Uri;
const project = api.getPythonProject(uri);
const environment = await api.getEnvironment(uri);
if (environment) {
return await runAsTask(
environment,
{
project,
args: [item.fsPath],
name: 'Python Run',
},
{ reveal: TaskRevealKind.Always },
);
}
} else if (item === undefined) {
const uri = window.activeTextEditor?.document.uri;
if (uri) {
return runAsTaskCommand(uri, api);
}
}
}