forked from microsoft/vscode-python-environments
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpythonApi.ts
More file actions
356 lines (337 loc) · 15.8 KB
/
pythonApi.ts
File metadata and controls
356 lines (337 loc) · 15.8 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
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
import { Uri, Disposable, Event, EventEmitter, Terminal, TaskExecution } from 'vscode';
import {
PythonEnvironmentApi,
PythonEnvironment,
EnvironmentManager,
PackageManager,
DidChangeEnvironmentEventArgs,
DidChangeEnvironmentsEventArgs,
DidChangePythonProjectsEventArgs,
GetEnvironmentsScope,
Package,
PythonEnvironmentInfo,
PythonProject,
RefreshEnvironmentsScope,
DidChangePackagesEventArgs,
PythonEnvironmentId,
CreateEnvironmentScope,
SetEnvironmentScope,
GetEnvironmentScope,
PackageInfo,
PackageId,
PythonProjectCreator,
ResolveEnvironmentContext,
PackageManagementOptions,
PythonProcess,
PythonTaskExecutionOptions,
PythonTerminalExecutionOptions,
PythonBackgroundRunOptions,
PythonTerminalCreateOptions,
DidChangeEnvironmentVariablesEventArgs,
CreateEnvironmentOptions,
} from '../api';
import {
EnvironmentManagers,
InternalEnvironmentManager,
ProjectCreators,
PythonEnvironmentImpl,
PythonPackageImpl,
PythonProjectManager,
} from '../internal.api';
import { createDeferred } from '../common/utils/deferred';
import { traceInfo } from '../common/logging';
import { pickEnvironmentManager } from '../common/pickers/managers';
import { handlePythonPath } from '../common/utils/pythonPath';
import { TerminalManager } from './terminal/terminalManager';
import { runAsTask } from './execution/runAsTask';
import { runInTerminal } from './terminal/runInTerminal';
import { runInBackground } from './execution/runInBackground';
import { EnvVarManager } from './execution/envVariableManager';
import { checkUri } from '../common/utils/pathUtils';
import { waitForAllEnvManagers, waitForEnvManager, waitForEnvManagerId } from './common/managerReady';
class PythonEnvironmentApiImpl implements PythonEnvironmentApi {
private readonly _onDidChangeEnvironments = new EventEmitter<DidChangeEnvironmentsEventArgs>();
private readonly _onDidChangeEnvironment = new EventEmitter<DidChangeEnvironmentEventArgs>();
private readonly _onDidChangePythonProjects = new EventEmitter<DidChangePythonProjectsEventArgs>();
private readonly _onDidChangePackages = new EventEmitter<DidChangePackagesEventArgs>();
private readonly _onDidChangeEnvironmentVariables = new EventEmitter<DidChangeEnvironmentVariablesEventArgs>();
constructor(
private readonly envManagers: EnvironmentManagers,
private readonly projectManager: PythonProjectManager,
private readonly projectCreators: ProjectCreators,
private readonly terminalManager: TerminalManager,
private readonly envVarManager: EnvVarManager,
private readonly disposables: Disposable[] = [],
) {
this.disposables.push(
this._onDidChangeEnvironment,
this._onDidChangeEnvironments,
this._onDidChangePythonProjects,
this._onDidChangePackages,
this._onDidChangeEnvironmentVariables,
this.envManagers.onDidChangeEnvironmentFiltered((e) => {
this._onDidChangeEnvironment.fire(e);
const location = e.uri?.fsPath ?? 'global';
traceInfo(
`Python API: Changed environment from ${e.old?.displayName} to ${e.new?.displayName} for: ${location}`,
);
}),
this.envVarManager.onDidChangeEnvironmentVariables((e) => this._onDidChangeEnvironmentVariables.fire(e)),
);
}
registerEnvironmentManager(manager: EnvironmentManager): Disposable {
const disposables: Disposable[] = [];
disposables.push(this.envManagers.registerEnvironmentManager(manager));
if (manager.onDidChangeEnvironments) {
disposables.push(manager.onDidChangeEnvironments((e) => this._onDidChangeEnvironments.fire(e)));
}
if (manager.onDidChangeEnvironment) {
disposables.push(
manager.onDidChangeEnvironment((e) => {
setImmediate(async () => {
// This will ensure that we use the right manager and only trigger the event
// if the user selected manager decided to change the environment.
// This ensures that if a unselected manager changes environment and raises events
// we don't trigger the Python API event which can cause issues with the consumers.
// This will trigger onDidChangeEnvironmentFiltered event in envManagers, which the Python
// API listens to, and re-triggers the onDidChangeEnvironment event.
await this.envManagers.getEnvironment(e.uri);
});
}),
);
}
return new Disposable(() => disposables.forEach((d) => d.dispose()));
}
createPythonEnvironmentItem(info: PythonEnvironmentInfo, manager: EnvironmentManager): PythonEnvironment {
const mgr = this.envManagers.managers.find((m) => m.equals(manager));
if (!mgr) {
throw new Error('Environment manager not found');
}
const randomStr = Math.random().toString(36).substring(2);
const envId: PythonEnvironmentId = {
managerId: mgr.id,
id: `${info.name}-${randomStr}`,
};
return new PythonEnvironmentImpl(envId, info);
}
async createEnvironment(
scope: CreateEnvironmentScope,
options: CreateEnvironmentOptions | undefined,
): Promise<PythonEnvironment | undefined> {
if (scope === 'global' || (!Array.isArray(scope) && scope instanceof Uri)) {
await waitForEnvManager(scope === 'global' ? undefined : [scope]);
const manager = this.envManagers.getEnvironmentManager(scope === 'global' ? undefined : scope);
if (!manager) {
throw new Error('No environment manager found');
}
if (!manager.supportsCreate) {
throw new Error(`Environment manager does not support creating environments: ${manager.id}`);
}
return manager.create(scope, options);
} else if (Array.isArray(scope) && scope.length === 1 && scope[0] instanceof Uri) {
return this.createEnvironment(scope[0], options);
} else if (Array.isArray(scope) && scope.length > 0 && scope.every((s) => s instanceof Uri)) {
await waitForEnvManager(scope);
const managers: InternalEnvironmentManager[] = [];
scope.forEach((s) => {
const manager = this.envManagers.getEnvironmentManager(s);
if (manager && !managers.includes(manager) && manager.supportsCreate) {
managers.push(manager);
}
});
if (managers.length === 0) {
throw new Error('No environment managers found');
}
const managerId = await pickEnvironmentManager(managers);
if (!managerId) {
throw new Error('No environment manager selected');
}
const manager = managers.find((m) => m.id === managerId);
if (!manager) {
throw new Error('No environment manager found');
}
const result = await manager.create(scope, options);
return result;
}
}
async removeEnvironment(environment: PythonEnvironment): Promise<void> {
await waitForEnvManagerId([environment.envId.managerId]);
const manager = this.envManagers.getEnvironmentManager(environment);
if (!manager) {
return Promise.reject(new Error('No environment manager found'));
}
return manager.remove(environment);
}
async refreshEnvironments(scope: RefreshEnvironmentsScope): Promise<void> {
const currentScope = checkUri(scope) as RefreshEnvironmentsScope;
if (currentScope === undefined) {
await waitForAllEnvManagers();
await Promise.all(this.envManagers.managers.map((manager) => manager.refresh(currentScope)));
return Promise.resolve();
}
await waitForEnvManager([currentScope]);
const manager = this.envManagers.getEnvironmentManager(currentScope);
if (!manager) {
return Promise.reject(new Error(`No environment manager found for: ${currentScope.fsPath}`));
}
return manager.refresh(currentScope);
}
async getEnvironments(scope: GetEnvironmentsScope): Promise<PythonEnvironment[]> {
const currentScope = checkUri(scope) as GetEnvironmentsScope;
if (currentScope === 'all' || currentScope === 'global') {
await waitForAllEnvManagers();
const promises = this.envManagers.managers.map((manager) => manager.getEnvironments(currentScope));
const items = await Promise.all(promises);
return items.flat();
}
await waitForEnvManager([currentScope]);
const manager = this.envManagers.getEnvironmentManager(currentScope);
if (!manager) {
return [];
}
const items = await manager.getEnvironments(currentScope);
return items;
}
onDidChangeEnvironments: Event<DidChangeEnvironmentsEventArgs> = this._onDidChangeEnvironments.event;
async setEnvironment(scope: SetEnvironmentScope, environment?: PythonEnvironment): Promise<void> {
const currentScope = checkUri(scope) as SetEnvironmentScope;
await waitForEnvManager(
currentScope ? (currentScope instanceof Uri ? [currentScope] : currentScope) : undefined,
);
return this.envManagers.setEnvironment(currentScope, environment);
}
async getEnvironment(scope: GetEnvironmentScope): Promise<PythonEnvironment | undefined> {
const currentScope = checkUri(scope) as GetEnvironmentScope;
await waitForEnvManager(currentScope ? [currentScope] : undefined);
return this.envManagers.getEnvironment(currentScope);
}
onDidChangeEnvironment: Event<DidChangeEnvironmentEventArgs> = this._onDidChangeEnvironment.event;
async resolveEnvironment(context: ResolveEnvironmentContext): Promise<PythonEnvironment | undefined> {
await waitForAllEnvManagers();
const projects = this.projectManager.getProjects();
const projectEnvManagers: InternalEnvironmentManager[] = [];
projects.forEach((p) => {
const manager = this.envManagers.getEnvironmentManager(p.uri);
if (manager && !projectEnvManagers.includes(manager)) {
projectEnvManagers.push(manager);
}
});
return await handlePythonPath(context, this.envManagers.managers, projectEnvManagers);
}
registerPackageManager(manager: PackageManager): Disposable {
const disposables: Disposable[] = [];
disposables.push(this.envManagers.registerPackageManager(manager));
if (manager.onDidChangePackages) {
disposables.push(manager.onDidChangePackages((e) => this._onDidChangePackages.fire(e)));
}
return new Disposable(() => disposables.forEach((d) => d.dispose()));
}
async managePackages(context: PythonEnvironment, options: PackageManagementOptions): Promise<void> {
await waitForEnvManagerId([context.envId.managerId]);
const manager = this.envManagers.getPackageManager(context);
if (!manager) {
return Promise.reject(new Error('No package manager found'));
}
return manager.manage(context, options);
}
async refreshPackages(context: PythonEnvironment): Promise<void> {
await waitForEnvManagerId([context.envId.managerId]);
const manager = this.envManagers.getPackageManager(context);
if (!manager) {
return Promise.reject(new Error('No package manager found'));
}
return manager.refresh(context);
}
async getPackages(context: PythonEnvironment): Promise<Package[] | undefined> {
await waitForEnvManagerId([context.envId.managerId]);
const manager = this.envManagers.getPackageManager(context);
if (!manager) {
return Promise.resolve(undefined);
}
return manager.getPackages(context);
}
onDidChangePackages: Event<DidChangePackagesEventArgs> = this._onDidChangePackages.event;
createPackageItem(info: PackageInfo, environment: PythonEnvironment, manager: PackageManager): Package {
const mgr = this.envManagers.packageManagers.find((m) => m.equals(manager));
if (!mgr) {
throw new Error('Package manager not found');
}
const randomStr = Math.random().toString(36).substring(2);
const pkg: PackageId = {
managerId: mgr.id,
environmentId: environment.envId.id,
id: `${info.name}-${randomStr}`,
};
return new PythonPackageImpl(pkg, info);
}
addPythonProject(projects: PythonProject | PythonProject[]): void {
this.projectManager.add(projects);
}
removePythonProject(pyWorkspace: PythonProject): void {
this.projectManager.remove(pyWorkspace);
}
getPythonProjects(): readonly PythonProject[] {
return this.projectManager.getProjects();
}
onDidChangePythonProjects: Event<DidChangePythonProjectsEventArgs> = this._onDidChangePythonProjects.event;
getPythonProject(uri: Uri): PythonProject | undefined {
return this.projectManager.get(checkUri(uri) as Uri);
}
registerPythonProjectCreator(creator: PythonProjectCreator): Disposable {
return this.projectCreators.registerPythonProjectCreator(creator);
}
async createTerminal(environment: PythonEnvironment, options: PythonTerminalCreateOptions): Promise<Terminal> {
return this.terminalManager.create(environment, options);
}
async runInTerminal(environment: PythonEnvironment, options: PythonTerminalExecutionOptions): Promise<Terminal> {
const terminal = await this.terminalManager.getProjectTerminal(
options.cwd instanceof Uri ? options.cwd : Uri.file(options.cwd),
environment,
);
await runInTerminal(environment, terminal, options);
return terminal;
}
async runInDedicatedTerminal(
terminalKey: Uri | string,
environment: PythonEnvironment,
options: PythonTerminalExecutionOptions,
): Promise<Terminal> {
const terminal = await this.terminalManager.getDedicatedTerminal(
terminalKey,
options.cwd instanceof Uri ? options.cwd : Uri.file(options.cwd),
environment,
);
await runInTerminal(environment, terminal, options);
return Promise.resolve(terminal);
}
runAsTask(environment: PythonEnvironment, options: PythonTaskExecutionOptions): Promise<TaskExecution> {
return runAsTask(environment, options);
}
runInBackground(environment: PythonEnvironment, options: PythonBackgroundRunOptions): Promise<PythonProcess> {
return runInBackground(environment, options);
}
onDidChangeEnvironmentVariables: Event<DidChangeEnvironmentVariablesEventArgs> =
this._onDidChangeEnvironmentVariables.event;
getEnvironmentVariables(
uri: Uri,
overrides?: ({ [key: string]: string | undefined } | Uri)[],
baseEnvVar?: { [key: string]: string | undefined },
): Promise<{ [key: string]: string | undefined }> {
return this.envVarManager.getEnvironmentVariables(checkUri(uri) as Uri, overrides, baseEnvVar);
}
}
let _deferred = createDeferred<PythonEnvironmentApi>();
export function setPythonApi(
envMgr: EnvironmentManagers,
projectMgr: PythonProjectManager,
projectCreators: ProjectCreators,
terminalManager: TerminalManager,
envVarManager: EnvVarManager,
) {
_deferred.resolve(
new PythonEnvironmentApiImpl(envMgr, projectMgr, projectCreators, terminalManager, envVarManager),
);
}
export function getPythonApi(): Promise<PythonEnvironmentApi> {
return _deferred.promise;
}