forked from luabud/vscode-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommon.ts
More file actions
146 lines (135 loc) · 4.99 KB
/
common.ts
File metadata and controls
146 lines (135 loc) · 4.99 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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// tslint:disable: no-this-assignment
import * as path from 'path';
import { Event } from 'vscode';
import {
createDeferred, flattenIterator, iterable, mapToIterator,
} from '../../../client/common/utils/async';
import { Architecture } from '../../../client/common/utils/platform';
import {
PythonDistroInfo,
PythonEnvInfo,
PythonEnvKind,
PythonExecutableInfo,
} from '../../../client/pythonEnvironments/base/info';
import { buildEnvInfo } from '../../../client/pythonEnvironments/base/info/env';
import { parseVersion } from '../../../client/pythonEnvironments/base/info/pythonVersion';
import {
IPythonEnvsIterator,
Locator,
PythonEnvUpdatedEvent,
PythonLocatorQuery,
} from '../../../client/pythonEnvironments/base/locator';
import { PythonEnvsChangedEvent } from '../../../client/pythonEnvironments/base/watcher';
export function createLocatedEnv(
locationStr: string,
versionStr: string,
kind = PythonEnvKind.Unknown,
exec: string | PythonExecutableInfo = 'python',
distro: PythonDistroInfo = { org: '' },
): PythonEnvInfo {
const location = locationStr === '' ? '' : path.normalize(locationStr);
let executable: string | undefined;
if (typeof exec === 'string') {
const normalizedExecutable = path.normalize(exec);
executable = location === '' || path.isAbsolute(normalizedExecutable)
? normalizedExecutable
: path.join(location, 'bin', normalizedExecutable);
}
const version = parseVersion(versionStr);
const env = buildEnvInfo({
kind, executable, location, version,
});
env.arch = Architecture.x86;
env.distro = distro;
if (typeof exec !== 'string') {
env.executable = exec;
}
return env;
}
export function createNamedEnv(
name: string,
versionStr: string,
kind?: PythonEnvKind,
exec: string | PythonExecutableInfo = 'python',
distro?: PythonDistroInfo,
): PythonEnvInfo {
const env = createLocatedEnv('', versionStr, kind, exec, distro);
env.name = name;
return env;
}
export class SimpleLocator extends Locator {
private deferred = createDeferred<void>();
constructor(
private envs: PythonEnvInfo[],
public callbacks: {
resolve?: null | ((env: PythonEnvInfo) => Promise<PythonEnvInfo | undefined>);
before?: Promise<void>;
after?: Promise<void>;
onUpdated?: Event<PythonEnvUpdatedEvent | null>;
beforeEach?(e: PythonEnvInfo): Promise<void>;
afterEach?(e: PythonEnvInfo): Promise<void>;
onQuery?(query: PythonLocatorQuery | undefined, envs: PythonEnvInfo[]): Promise<PythonEnvInfo[]>;
} = {},
) {
super();
}
public get done(): Promise<void> {
return this.deferred.promise;
}
public fire(event: PythonEnvsChangedEvent): void {
this.emitter.fire(event);
}
public iterEnvs(query?: PythonLocatorQuery): IPythonEnvsIterator {
const { deferred } = this;
const { callbacks } = this;
let { envs } = this;
const iterator: IPythonEnvsIterator = (async function* () {
if (callbacks?.onQuery !== undefined) {
envs = await callbacks.onQuery(query, envs);
}
if (callbacks.before !== undefined) {
await callbacks.before;
}
if (callbacks.beforeEach !== undefined) {
// The results will likely come in a different order.
const mapped = mapToIterator(envs, async (env) => {
await callbacks.beforeEach!(env);
return env;
});
for await (const env of iterable(mapped)) {
yield env;
if (callbacks.afterEach !== undefined) {
await callbacks.afterEach(env);
}
}
} else {
for (const env of envs) {
yield env;
if (callbacks.afterEach !== undefined) {
await callbacks.afterEach(env);
}
}
}
if (callbacks?.after !== undefined) {
await callbacks.after;
}
deferred.resolve();
}());
iterator.onUpdated = this.callbacks?.onUpdated;
return iterator;
}
public async resolveEnv(env: string | PythonEnvInfo): Promise<PythonEnvInfo | undefined> {
const envInfo: PythonEnvInfo = typeof env === 'string' ? createLocatedEnv('', '', undefined, env) : env;
if (this.callbacks.resolve === undefined) {
return envInfo;
} if (this.callbacks?.resolve === null) {
return undefined;
}
return this.callbacks.resolve(envInfo);
}
}
export async function getEnvs(iterator: IPythonEnvsIterator): Promise<PythonEnvInfo[]> {
return flattenIterator(iterator);
}