forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathenv.ts
More file actions
235 lines (206 loc) · 8.12 KB
/
Copy pathenv.ts
File metadata and controls
235 lines (206 loc) · 8.12 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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import { cloneDeep } from 'lodash';
import * as path from 'path';
import {
FileInfo,
PythonDistroInfo,
PythonEnvInfo, PythonEnvKind, PythonVersion,
} from '.';
import { Architecture } from '../../../common/utils/platform';
import { arePathsSame } from '../../common/externalDependencies';
import { areEqualVersions, areEquivalentVersions } from './pythonVersion';
/**
* Checks if two environments are same.
* @param {string | PythonEnvInfo} left: environment to compare.
* @param {string | PythonEnvInfo} right: environment to compare.
* @param {boolean} allowPartialMatch: allow partial matches of properties when comparing.
*
* Remarks: The current comparison assumes that if the path to the executables are the same
* then it is the same environment. Additionally, if the paths are not same but executables
* are in the same directory and the version of python is the same than we can assume it
* to be same environment. This later case is needed for comparing windows store python,
* where multiple versions of python executables are all put in the same directory.
*/
export function areSameEnvironment(
left: string | PythonEnvInfo,
right: string | PythonEnvInfo,
allowPartialMatch?: boolean,
): boolean {
const leftFilename = typeof left === 'string' ? left : left.executable.filename;
const rightFilename = typeof right === 'string' ? right : right.executable.filename;
if (arePathsSame(leftFilename, rightFilename)) {
return true;
}
if (arePathsSame(path.dirname(leftFilename), path.dirname(rightFilename))) {
const leftVersion = typeof left === 'string' ? undefined : left.version;
const rightVersion = typeof right === 'string' ? undefined : right.version;
if (leftVersion && rightVersion) {
if (
areEqualVersions(leftVersion, rightVersion)
|| (allowPartialMatch && areEquivalentVersions(leftVersion, rightVersion))
) {
return true;
}
}
}
return false;
}
/**
* Returns a heuristic value on how much information is available in the given version object.
* @param {PythonVersion} version version object to generate heuristic from.
* @returns A heuristic value indicating the amount of info available in the object
* weighted by most important to least important fields.
* Wn > Wn-1 + Wn-2 + ... W0
*/
function getPythonVersionInfoHeuristic(version:PythonVersion): number {
let infoLevel = 0;
if (version.major > 0) {
infoLevel += 20; // W4
}
if (version.minor >= 0) {
infoLevel += 10; // W3
}
if (version.micro >= 0) {
infoLevel += 5; // W2
}
if (version.release.level) {
infoLevel += 3; // W1
}
if (version.release.serial || version.sysVersion) {
infoLevel += 1; // W0
}
return infoLevel;
}
/**
* Returns a heuristic value on how much information is available in the given executable object.
* @param {FileInfo} executable executable object to generate heuristic from.
* @returns A heuristic value indicating the amount of info available in the object
* weighted by most important to least important fields.
* Wn > Wn-1 + Wn-2 + ... W0
*/
function getFileInfoHeuristic(file:FileInfo): number {
let infoLevel = 0;
if (file.filename.length > 0) {
infoLevel += 5; // W2
}
if (file.mtime) {
infoLevel += 2; // W1
}
if (file.ctime) {
infoLevel += 1; // W0
}
return infoLevel;
}
/**
* Returns a heuristic value on how much information is available in the given distro object.
* @param {PythonDistroInfo} distro distro object to generate heuristic from.
* @returns A heuristic value indicating the amount of info available in the object
* weighted by most important to least important fields.
* Wn > Wn-1 + Wn-2 + ... W0
*/
function getDistroInfoHeuristic(distro:PythonDistroInfo):number {
let infoLevel = 0;
if (distro.org.length > 0) {
infoLevel += 20; // W3
}
if (distro.defaultDisplayName) {
infoLevel += 10; // W2
}
if (distro.binDir) {
infoLevel += 5; // W1
}
if (distro.version) {
infoLevel += 2;
}
return infoLevel;
}
/**
* Gets a prioritized list of environment types for identification.
* @returns {PythonEnvKind[]} : List of environments ordered by identification priority
*
* Remarks: This is the order of detection based on how the various distributions and tools
* configure the environment, and the fall back for identification.
* Top level we have the following environment types, since they leave a unique signature
* in the environment or * use a unique path for the environments they create.
* 1. Conda
* 2. Windows Store
* 3. PipEnv
* 4. Pyenv
* 5. Poetry
*
* Next level we have the following virtual environment tools. The are here because they
* are consumed by the tools above, and can also be used independently.
* 1. venv
* 2. virtualenvwrapper
* 3. virtualenv
*
* Last category is globally installed python, or system python.
*/
export function getPrioritizedEnvironmentKind(): PythonEnvKind[] {
return [
PythonEnvKind.CondaBase,
PythonEnvKind.Conda,
PythonEnvKind.WindowsStore,
PythonEnvKind.Pipenv,
PythonEnvKind.Pyenv,
PythonEnvKind.Poetry,
PythonEnvKind.Venv,
PythonEnvKind.VirtualEnvWrapper,
PythonEnvKind.VirtualEnv,
PythonEnvKind.OtherVirtual,
PythonEnvKind.OtherGlobal,
PythonEnvKind.MacDefault,
PythonEnvKind.System,
PythonEnvKind.Custom,
PythonEnvKind.Unknown,
];
}
/**
* Selects an environment based on the environment selection priority. This should
* match the priority in the environment identifier.
*/
export function sortEnvInfoByPriority(...envs: PythonEnvInfo[]): PythonEnvInfo[] {
// tslint:disable-next-line: no-suspicious-comment
// TODO: When we consolidate the PythonEnvKind and EnvironmentType we should have
// one location where we define priority and
const envKindByPriority:PythonEnvKind[] = getPrioritizedEnvironmentKind();
return envs.sort(
(a:PythonEnvInfo, b:PythonEnvInfo) => envKindByPriority.indexOf(a.kind) - envKindByPriority.indexOf(b.kind),
);
}
/**
* Merges properties of the `target` environment and `other` environment and returns the merged environment.
* if the value in the `target` environment is not defined or has less information. This does not mutate
* the `target` instead it returns a new object that contains the merged results.
* @param {PythonEnvInfo} target : Properties of this object are favored.
* @param {PythonEnvInfo} other : Properties of this object are used to fill the gaps in the merged result.
*/
export function mergeEnvironments(target: PythonEnvInfo, other: PythonEnvInfo): PythonEnvInfo {
const merged = cloneDeep(target);
const version = cloneDeep(
getPythonVersionInfoHeuristic(target.version) > getPythonVersionInfoHeuristic(other.version)
? target.version : other.version,
);
const executable = cloneDeep(
getFileInfoHeuristic(target.executable) > getFileInfoHeuristic(other.executable)
? target.executable : other.executable,
);
executable.sysPrefix = target.executable.sysPrefix ?? other.executable.sysPrefix;
const distro = cloneDeep(
getDistroInfoHeuristic(target.distro) > getDistroInfoHeuristic(other.distro)
? target.distro : other.distro,
);
merged.arch = merged.arch === Architecture.Unknown ? other.arch : target.arch;
merged.defaultDisplayName = merged.defaultDisplayName ?? other.defaultDisplayName;
merged.distro = distro;
merged.executable = executable;
// No need to check this just use preferred kind. Since the first thing we do is figure out the
// preferred env based on kind.
merged.kind = target.kind;
merged.location = merged.location ?? other.location;
merged.name = merged.name ?? other.name;
merged.searchLocation = merged.searchLocation ?? other.searchLocation;
merged.version = version;
return merged;
}