pythonVSCode/src/test/pythonEnvironments/base/common.ts at main · zashed/pythonVSCode · GitHub

History

239 lines (221 loc) · 7.82 KB

Raw

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

// Licensed under the MIT License.

import { expect } from 'chai';

import * as path from 'path';

import { Event, Uri } from 'vscode';

import { createDeferred, flattenIterator, iterable, mapToIterator } from '../../../client/common/utils/async';

import { getArchitecture } from '../../../client/common/utils/platform';

import { getVersionString } from '../../../client/common/utils/version';

import {

PythonDistroInfo,

PythonEnvInfo,

PythonEnvKind,

PythonEnvSource,

PythonExecutableInfo,

} from '../../../client/pythonEnvironments/base/info';

import { buildEnvInfo } from '../../../client/pythonEnvironments/base/info/env';

import { getEmptyVersion, parseVersion } from '../../../client/pythonEnvironments/base/info/pythonVersion';

import {

BasicEnvInfo,

IPythonEnvsIterator,

isProgressEvent,

Locator,

ProgressNotificationEvent,

ProgressReportStage,

PythonEnvUpdatedEvent,

PythonLocatorQuery,

} from '../../../client/pythonEnvironments/base/locator';

import { PythonEnvsChangedEvent } from '../../../client/pythonEnvironments/base/watcher';

import { noop } from '../../core';

export function createLocatedEnv(

locationStr: string,

versionStr: string,

kind = PythonEnvKind.Unknown,

exec: string | PythonExecutableInfo = 'python',

distro: PythonDistroInfo = { org: '' },

searchLocation?: Uri,

): PythonEnvInfo {

const location =

locationStr === ''

? '' // an empty location

: 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 =

versionStr === ''

? getEmptyVersion() // an empty version

: parseVersion(versionStr);

const env = buildEnvInfo({

kind,

executable,

location,

version,

searchLocation,

});

env.arch = getArchitecture();

env.distro = distro;

if (typeof exec !== 'string') {

env.executable = exec;

}

return env;

}

export function createBasicEnv(

kind: PythonEnvKind,

executablePath: string,

source?: PythonEnvSource[],

envPath?: string,

): BasicEnvInfo {

const basicEnv = { executablePath, kind, source, envPath };

if (!source) {

delete basicEnv.source;

}

if (!envPath) {

delete basicEnv.envPath;

}

return basicEnv;

}

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 {

public readonly providerId: string = 'SimpleLocator';

private deferred = createDeferred<void>();

constructor(

private envs: I[],

public callbacks: {

resolve?: null | ((env: PythonEnvInfo | string) => Promise<PythonEnvInfo | undefined>);

before?(): Promise<void>;

after?(): Promise<void>;

onUpdated?: Event<PythonEnvUpdatedEvent | ProgressNotificationEvent>;

beforeEach?(e: I): Promise<void>;

afterEach?(e: I): Promise<void>;

onQuery?(query: PythonLocatorQuery | undefined, envs: I[]): Promise<I[]>;

} = {},

private options?: { resolveAsString?: boolean },

) {

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): Promise<PythonEnvInfo | undefined> {

const envInfo: PythonEnvInfo = createLocatedEnv('', '', undefined, env);

if (this.callbacks.resolve === undefined) {

return envInfo;

}

if (this.callbacks?.resolve === null) {

return undefined;

}

return this.callbacks.resolve(this.options?.resolveAsString ? env : envInfo);

}

export async function getEnvs(iterator: IPythonEnvsIterator): Promise<I[]> {

return flattenIterator(iterator);

}

/**

* Unroll the given iterator into an array.

* This includes applying any received updates.

export async function getEnvsWithUpdates(

iterator: IPythonEnvsIterator,

iteratorUpdateCallback: () => void = noop,

): Promise<I[]> {

const envs: (I | undefined)[] = [];

const updatesDone = createDeferred<void>();

if (iterator.onUpdated === undefined) {

updatesDone.resolve();

} else {

const listener = iterator.onUpdated((event) => {

if (isProgressEvent(event)) {

if (event.stage !== ProgressReportStage.discoveryFinished) {

return;

}

updatesDone.resolve();

listener.dispose();

} else if (event.index !== undefined) {

const { index, update } = event;

// We don't worry about if envs[index] is set already.

envs[index] = update;

}

});

}

let itemIndex = 0;

for await (const env of iterator) {

// We can't just push because updates might get emitted early.

if (envs[itemIndex] === undefined) {

envs[itemIndex] = env;

}

itemIndex += 1;

}

iteratorUpdateCallback();

await updatesDone.promise;

// Do not return invalid environments

return envs.filter((e) => e !== undefined).map((e) => e!);

}

export function sortedEnvs(envs: PythonEnvInfo[]): PythonEnvInfo[] {

return envs.sort((env1, env2) => {

const env1str = `${env1.kind}-${env1.executable.filename}-${getVersionString(env1.version)}`;

const env2str = `${env2.kind}-${env2.executable.filename}-${getVersionString(env2.version)}`;

return env1str.localeCompare(env2str);

});

}

export function assertSameEnvs(envs: PythonEnvInfo[], expected: PythonEnvInfo[]): void {

expect(sortedEnvs(envs)).to.deep.equal(sortedEnvs(expected));

}

pythonVSCode/src/test/pythonEnvironments/base/common.ts at main · zashed/pythonVSCode · GitHub

Expand file tree

Breadcrumbs

common.ts

Latest commit

History

Breadcrumbs

common.ts

File metadata and controls