Repository navigation
Expand file tree
/
Copy pathkernelProvider.ts
More file actions
276 lines (264 loc) · 12.3 KB
/
Copy pathkernelProvider.ts
File metadata and controls
276 lines (264 loc) · 12.3 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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import { inject, injectable } from 'inversify';
// tslint:disable-next-line: no-require-imports
import cloneDeep = require('lodash/cloneDeep');
import { CancellationToken, Event, EventEmitter, Uri } from 'vscode';
import {
NotebookCell,
NotebookDocument,
NotebookKernel as VSCNotebookKernel,
NotebookKernelProvider
} from '../../../../types/vscode-proposed';
import { IVSCodeNotebook } from '../../common/application/types';
import { IDisposableRegistry } from '../../common/types';
import { noop } from '../../common/utils/misc';
import { IInterpreterService } from '../../interpreter/contracts';
import { areKernelConnectionsEqual } from '../jupyter/kernels/helpers';
import { KernelSelectionProvider } from '../jupyter/kernels/kernelSelections';
import { KernelSelector } from '../jupyter/kernels/kernelSelector';
import { KernelSwitcher } from '../jupyter/kernels/kernelSwitcher';
import { getKernelConnectionId, IKernelProvider, KernelConnectionMetadata } from '../jupyter/kernels/types';
import { INotebookStorageProvider } from '../notebookStorage/notebookStorageProvider';
import { INotebook, INotebookProvider } from '../types';
import { getNotebookMetadata, isJupyterNotebook, updateKernelInNotebookMetadata } from './helpers/helpers';
class VSCodeNotebookKernelMetadata implements VSCNotebookKernel {
get preloads(): Uri[] {
return [];
}
get id() {
return getKernelConnectionId(this.selection);
}
constructor(
public readonly label: string,
public readonly description: string,
public readonly selection: Readonly<KernelConnectionMetadata>,
public readonly isPreferred: boolean,
private readonly kernelProvider: IKernelProvider
) {}
public executeCell(_: NotebookDocument, cell: NotebookCell) {
this.kernelProvider.getOrCreate(cell.notebook.uri, { metadata: this.selection })?.executeCell(cell); // NOSONAR
}
public executeAllCells(document: NotebookDocument) {
this.kernelProvider.getOrCreate(document.uri, { metadata: this.selection })?.executeAllCells(document); // NOSONAR
}
public cancelCellExecution(_: NotebookDocument, cell: NotebookCell) {
this.kernelProvider.get(cell.notebook.uri)?.interrupt(); // NOSONAR
}
public cancelAllCellsExecution(document: NotebookDocument) {
this.kernelProvider.get(document.uri)?.interrupt(); // NOSONAR
}
}
@injectable()
export class VSCodeKernelPickerProvider implements NotebookKernelProvider {
public get onDidChangeKernels(): Event<NotebookDocument | undefined> {
return this._onDidChangeKernels.event;
}
private readonly _onDidChangeKernels = new EventEmitter<NotebookDocument | undefined>();
private notebookKernelChangeHandled = new WeakSet<INotebook>();
constructor(
@inject(KernelSelectionProvider) private readonly kernelSelectionProvider: KernelSelectionProvider,
@inject(KernelSelector) private readonly kernelSelector: KernelSelector,
@inject(IKernelProvider) private readonly kernelProvider: IKernelProvider,
@inject(IVSCodeNotebook) private readonly notebook: IVSCodeNotebook,
@inject(INotebookStorageProvider) private readonly storageProvider: INotebookStorageProvider,
@inject(INotebookProvider) private readonly notebookProvider: INotebookProvider,
@inject(KernelSwitcher) private readonly kernelSwitcher: KernelSwitcher,
@inject(IDisposableRegistry) private readonly disposables: IDisposableRegistry,
@inject(IInterpreterService) private readonly interpreterService: IInterpreterService
) {
this.kernelSelectionProvider.onDidChangeSelections(
(e) => {
if (e) {
const doc = this.notebook.notebookDocuments.find((d) => d.uri.fsPath === e.fsPath);
if (doc) {
return this._onDidChangeKernels.fire(doc);
}
}
this._onDidChangeKernels.fire(undefined);
},
this,
disposables
);
this.notebook.onDidChangeActiveNotebookKernel(this.onDidChangeActiveNotebookKernel, this, disposables);
}
public async provideKernels(
document: NotebookDocument,
token: CancellationToken
): Promise<VSCodeNotebookKernelMetadata[]> {
const [preferredKernel, kernels, activeInterpreter] = await Promise.all([
this.getPreferredKernel(document, token),
this.kernelSelectionProvider.getKernelSelectionsForLocalSession(document.uri, 'raw', undefined, token),
this.interpreterService.getActiveInterpreter(document.uri)
]);
if (token.isCancellationRequested) {
return [];
}
// Default the interpreter to the local interpreter (if none is provided).
const withInterpreter = kernels.map((kernel) => {
const selection = cloneDeep(kernel.selection); // Always clone, so we can make changes to this.
selection.interpreter = selection.interpreter || activeInterpreter;
return { ...kernel, selection };
});
// Turn this into our preferred list.
const mapped = withInterpreter.map((kernel) => {
return new VSCodeNotebookKernelMetadata(
kernel.label,
kernel.description || kernel.detail || '',
kernel.selection,
areKernelConnectionsEqual(kernel.selection, preferredKernel),
this.kernelProvider
);
});
// If no preferred kernel set but we have a language, use that to set preferred instead.
if (!mapped.find((v) => v.isPreferred) && document.cells.length) {
const languages = document.cells.map((c) => c.language);
// Find the first that matches on language
const indexOfKernelMatchingDocumentLanguage = kernels.findIndex((k) =>
languages.find((l) => l === k.selection.kernelSpec?.language)
);
// If we have a preferred kernel, then add that to the list, & put it on top of the list.
const preferredKernelMetadata = this.createNotebookKernelMetadataFromPreferredKernel(preferredKernel);
if (preferredKernelMetadata) {
mapped.splice(0, 0, preferredKernelMetadata);
} else if (indexOfKernelMatchingDocumentLanguage >= 0) {
const kernel = kernels[indexOfKernelMatchingDocumentLanguage];
mapped.splice(
indexOfKernelMatchingDocumentLanguage,
1,
new VSCodeNotebookKernelMetadata(
kernel.label,
kernel.description || kernel.detail || '',
kernel.selection,
true,
this.kernelProvider
)
);
}
}
mapped.sort((a, b) => {
if (a.label > b.label) {
return 1;
} else if (a.label === b.label) {
return 0;
} else {
return -1;
}
});
return mapped;
}
private createNotebookKernelMetadataFromPreferredKernel(
preferredKernel?: KernelConnectionMetadata
): VSCodeNotebookKernelMetadata | undefined {
if (!preferredKernel) {
return;
} else if (preferredKernel.kind === 'startUsingDefaultKernel') {
return;
} else if (preferredKernel.kind === 'startUsingPythonInterpreter') {
return new VSCodeNotebookKernelMetadata(
preferredKernel.interpreter?.displayName || preferredKernel.interpreter.path,
preferredKernel.interpreter.path,
preferredKernel,
true,
this.kernelProvider
);
} else if (preferredKernel.kind === 'connectToLiveKernel') {
return new VSCodeNotebookKernelMetadata(
preferredKernel.kernelModel?.display_name || preferredKernel.kernelModel?.name,
preferredKernel.kernelModel?.name,
preferredKernel,
true,
this.kernelProvider
);
} else {
return new VSCodeNotebookKernelMetadata(
preferredKernel.kernelSpec.display_name,
preferredKernel.kernelSpec.name,
preferredKernel,
true,
this.kernelProvider
);
}
}
private async getPreferredKernel(document: NotebookDocument, token: CancellationToken) {
// If we already have a kernel selected, then return that.
const editor =
this.notebook.notebookEditors.find((e) => e.document === document) ||
(this.notebook.activeNotebookEditor?.document === document
? this.notebook.activeNotebookEditor
: undefined);
if (editor && editor.kernel && editor.kernel instanceof VSCodeNotebookKernelMetadata) {
return editor.kernel.selection;
}
return this.kernelSelector.getPreferredKernelForLocalConnection(
document.uri,
'raw',
undefined,
getNotebookMetadata(document),
true,
token,
true
);
}
private async onDidChangeActiveNotebookKernel({
document,
kernel
}: {
document: NotebookDocument;
kernel: VSCNotebookKernel | undefined;
}) {
// We're only interested in our Jupyter Notebooks & our kernels.
if (!kernel || !(kernel instanceof VSCodeNotebookKernelMetadata) || !isJupyterNotebook(document)) {
return;
}
const selectedKernelConnectionMetadata = kernel.selection;
const model = this.storageProvider.get(document.uri);
if (!model || !model.isTrusted) {
// tslint:disable-next-line: no-suspicious-comment
// TODO: https://github.com/microsoft/vscode-python/issues/13476
// If a model is not trusted, we cannot change the kernel (this results in changes to notebook metadata).
// This is because we store selected kernel in the notebook metadata.
return;
}
const existingKernel = this.kernelProvider.get(document.uri);
if (existingKernel && areKernelConnectionsEqual(existingKernel.metadata, selectedKernelConnectionMetadata)) {
return;
}
// Make this the new kernel (calling this method will associate the new kernel with this Uri).
// Calling `getOrCreate` will ensure a kernel is created and it is mapped to the Uri provided.
// This way other parts of extension have access to this kernel immediately after event is handled.
this.kernelProvider.getOrCreate(document.uri, {
metadata: selectedKernelConnectionMetadata
});
// Change kernel and update metadata.
const notebook = await this.notebookProvider.getOrCreateNotebook({
resource: document.uri,
identity: document.uri,
getOnly: true
});
// If we have a notebook, change its kernel now
if (notebook) {
if (!this.notebookKernelChangeHandled.has(notebook)) {
this.notebookKernelChangeHandled.add(notebook);
notebook.onKernelChanged(
(e) => {
if (notebook.disposed) {
return;
}
updateKernelInNotebookMetadata(document, e);
},
this,
this.disposables
);
}
// tslint:disable-next-line: no-suspicious-comment
// TODO: https://github.com/microsoft/vscode-python/issues/13514
// We need to handle these exceptions in `siwthKernelWithRetry`.
// We shouldn't handle them here, as we're already handling some errors in the `siwthKernelWithRetry` method.
// Adding comment here, so we have context for the requirement.
this.kernelSwitcher.switchKernelWithRetry(notebook, selectedKernelConnectionMetadata).catch(noop);
} else {
updateKernelInNotebookMetadata(document, selectedKernelConnectionMetadata);
}
}
}