forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
223 lines (181 loc) · 5.26 KB
/
index.ts
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
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import {
Kernel, KernelMessage
} from '@jupyterlab/services';
import {
JSONObject
} from '@phosphor/coreutils';
import {
Widget
} from '@phosphor/widgets';
import {
JupyterLab, JupyterLabPlugin
} from '@jupyterlab/application';
import {
CodeEditor
} from '@jupyterlab/codeeditor';
import {
IConsoleTracker
} from '@jupyterlab/console';
import {
INotebookTracker
} from '@jupyterlab/notebook';
import {
ITooltipManager, TooltipWidget
} from '@jupyterlab/tooltip';
/**
* The command IDs used by the tooltip plugin.
*/
namespace CommandIDs {
export
const launchConsole = 'tooltip:launch-console';
export
const launchNotebook = 'tooltip:launch-notebook';
};
/**
* The main tooltip service.
*/
const service: JupyterLabPlugin<ITooltipManager> = {
id: 'jupyter.services.tooltip',
autoStart: true,
provides: ITooltipManager,
activate: (app: JupyterLab): ITooltipManager => {
let tooltip: TooltipWidget | null = null;
return {
invoke(options: ITooltipManager.IOptions): Promise<void> {
const detail: 0 | 1 = 0;
const { anchor, editor, kernel, rendermime } = options;
if (tooltip) {
tooltip.dispose();
tooltip = null;
}
return Private.fetch({ detail, editor, kernel }).then(bundle => {
tooltip = new TooltipWidget({ anchor, bundle, editor, rendermime });
Widget.attach(tooltip, document.body);
}).catch(() => { /* Fails silently. */ });
}
};
}
};
/**
* The console tooltip plugin.
*/
const consolePlugin: JupyterLabPlugin<void> = {
id: 'jupyter.extensions.tooltip-console',
autoStart: true,
requires: [ITooltipManager, IConsoleTracker],
activate: (app: JupyterLab, manager: ITooltipManager, consoles: IConsoleTracker): void => {
// Add tooltip launch command.
app.commands.addCommand(CommandIDs.launchConsole, {
execute: () => {
const parent = consoles.currentWidget;
if (!parent) {
return;
}
const anchor = parent.console;
const editor = anchor.promptCell.editor;
const kernel = anchor.session.kernel;
const rendermime = anchor.rendermime;
// If all components necessary for rendering exist, create a tooltip.
if (!!editor && !!kernel && !!rendermime) {
return manager.invoke({ anchor, editor, kernel, rendermime });
}
}
});
}
};
/**
* The notebook tooltip plugin.
*/
const notebookPlugin: JupyterLabPlugin<void> = {
id: 'jupyter.extensions.tooltip-notebook',
autoStart: true,
requires: [ITooltipManager, INotebookTracker],
activate: (app: JupyterLab, manager: ITooltipManager, notebooks: INotebookTracker): void => {
// Add tooltip launch command.
app.commands.addCommand(CommandIDs.launchNotebook, {
execute: () => {
const parent = notebooks.currentWidget;
if (!parent) {
return;
}
const anchor = parent.notebook;
const editor = anchor.activeCell.editor;
const kernel = parent.session.kernel;
const rendermime = parent.rendermime;
// If all components necessary for rendering exist, create a tooltip.
if (!!editor && !!kernel && !!rendermime) {
return manager.invoke({ anchor, editor, kernel, rendermime });
}
}
});
}
};
/**
* Export the plugins as default.
*/
const plugins: JupyterLabPlugin<any>[] = [
service, consolePlugin, notebookPlugin
];
export default plugins;
/**
* A namespace for private data.
*/
namespace Private {
/**
* A counter for outstanding requests.
*/
let pending = 0;
export
interface IFetchOptions {
/**
* The detail level requested from the API.
*
* #### Notes
* The only acceptable values are 0 and 1. The default value is 0.
* @see http://jupyter-client.readthedocs.io/en/latest/messaging.html#introspection
*/
detail?: 0 | 1;
/**
* The referent editor for the tooltip.
*/
editor: CodeEditor.IEditor;
/**
* The kernel against which the API request will be made.
*/
kernel: Kernel.IKernelConnection;
}
/**
* Fetch a tooltip's content from the API server.
*/
export
function fetch(options: IFetchOptions): Promise<JSONObject> {
let { detail, editor, kernel } = options;
let code = editor.model.value.text;
let position = editor.getCursorPosition();
let offset = editor.getOffsetAt(position);
// Clear hints if the new text value is empty or kernel is unavailable.
if (!code || !kernel) {
return Promise.reject(void 0);
}
let contents: KernelMessage.IInspectRequest = {
code,
cursor_pos: offset,
detail_level: detail || 0
};
let current = ++pending;
return kernel.requestInspect(contents).then(msg => {
let value = msg.content;
// If a newer request is pending, bail.
if (current !== pending) {
return Promise.reject(void 0) as Promise<JSONObject>;
}
// If request fails or returns negative results, bail.
if (value.status !== 'ok' || !value.found) {
return Promise.reject(void 0) as Promise<JSONObject>;
}
return Promise.resolve(value.data);
});
}
}