forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 1
/
lab.ts
272 lines (235 loc) · 7.63 KB
/
lab.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
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
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { PageConfig } from '@jupyterlab/coreutils';
import { Base64ModelFactory } from '@jupyterlab/docregistry';
import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
import { Token } from '@phosphor/coreutils';
import { JupyterFrontEnd, JupyterFrontEndPlugin } from './frontend';
import { createRendermimePlugins } from './mimerenderers';
import { ILabShell, LabShell } from './shell';
import { LabStatus } from './status';
/**
* JupyterLab is the main application class. It is instantiated once and shared.
*/
export class JupyterLab extends JupyterFrontEnd<ILabShell> {
/**
* Construct a new JupyterLab object.
*/
constructor(options: JupyterLab.IOptions = { shell: new LabShell() }) {
super({ ...options, shell: options.shell || new LabShell() });
this.restored = this.shell.restored
.then(() => undefined)
.catch(() => undefined);
// Create an IInfo dictionary from the options to override the defaults.
const info = Object.keys(JupyterLab.defaultInfo).reduce((acc, val) => {
if (val in options) {
(acc as any)[val] = JSON.parse(JSON.stringify((options as any)[val]));
}
return acc;
}, {} as Partial<JupyterLab.IInfo>);
// Populate application info.
this._info = { ...JupyterLab.defaultInfo, ...info };
// Populate application paths override the defaults if necessary.
const defaultURLs = JupyterLab.defaultPaths.urls;
const defaultDirs = JupyterLab.defaultPaths.directories;
const optionURLs = (options.paths && options.paths.urls) || {};
const optionDirs = (options.paths && options.paths.directories) || {};
this._paths = {
urls: Object.keys(defaultURLs).reduce((acc, key) => {
if (key in optionURLs) {
const value = (optionURLs as any)[key];
(acc as any)[key] = value;
} else {
(acc as any)[key] = (defaultURLs as any)[key];
}
return acc;
}, {}),
directories: Object.keys(JupyterLab.defaultPaths.directories).reduce(
(acc, key) => {
if (key in optionDirs) {
const value = (optionDirs as any)[key];
(acc as any)[key] = value;
} else {
(acc as any)[key] = (defaultDirs as any)[key];
}
return acc;
},
{}
)
} as JupyterFrontEnd.IPaths;
if (this._info.devMode) {
this.shell.addClass('jp-mod-devMode');
}
// Add initial model factory.
this.docRegistry.addModelFactory(new Base64ModelFactory());
if (options.mimeExtensions) {
for (let plugin of createRendermimePlugins(options.mimeExtensions)) {
this.registerPlugin(plugin);
}
}
}
/**
* The name of the JupyterLab application.
*/
readonly name = PageConfig.getOption('appName') || 'JupyterLab';
/**
* A namespace/prefix plugins may use to denote their provenance.
*/
readonly namespace = PageConfig.getOption('appNamespace') || this.name;
/**
* A list of all errors encountered when registering plugins.
*/
readonly registerPluginErrors: Array<Error> = [];
/**
* Promise that resolves when state is first restored, returning layout
* description.
*/
readonly restored: Promise<void>;
/**
* The application busy and dirty status signals and flags.
*/
readonly status = new LabStatus(this);
/**
* The version of the JupyterLab application.
*/
readonly version = PageConfig.getOption('appVersion') || 'unknown';
/**
* The JupyterLab application information dictionary.
*/
get info(): JupyterLab.IInfo {
return this._info;
}
/**
* The JupyterLab application paths dictionary.
*/
get paths(): JupyterFrontEnd.IPaths {
return this._paths;
}
/**
* Register plugins from a plugin module.
*
* @param mod - The plugin module to register.
*/
registerPluginModule(mod: JupyterLab.IPluginModule): void {
let data = mod.default;
// Handle commonjs exports.
if (!mod.hasOwnProperty('__esModule')) {
data = mod as any;
}
if (!Array.isArray(data)) {
data = [data];
}
data.forEach(item => {
try {
this.registerPlugin(item);
} catch (error) {
this.registerPluginErrors.push(error);
}
});
}
/**
* Register the plugins from multiple plugin modules.
*
* @param mods - The plugin modules to register.
*/
registerPluginModules(mods: JupyterLab.IPluginModule[]): void {
mods.forEach(mod => {
this.registerPluginModule(mod);
});
}
private _info: JupyterLab.IInfo;
private _paths: JupyterFrontEnd.IPaths;
}
/**
* The namespace for `JupyterLab` class statics.
*/
export namespace JupyterLab {
/**
* The options used to initialize a JupyterLab object.
*/
export interface IOptions
extends JupyterFrontEnd.IOptions<LabShell>,
Partial<IInfo> {
paths?: Partial<JupyterFrontEnd.IPaths>;
}
/* tslint:disable */
/**
* The layout restorer token.
*/
export const IInfo = new Token<IInfo>('@jupyterlab/application:IInfo');
/* tslint:enable */
/**
* The information about a JupyterLab application.
*/
export interface IInfo {
/**
* Whether the application is in dev mode.
*/
readonly devMode: boolean;
/**
* The collection of deferred extension patterns and matched extensions.
*/
readonly deferred: { patterns: string[]; matches: string[] };
/**
* The collection of disabled extension patterns and matched extensions.
*/
readonly disabled: { patterns: string[]; matches: string[] };
/**
* The mime renderer extensions.
*/
readonly mimeExtensions: IRenderMime.IExtensionModule[];
/**
* Whether files are cached on the server.
*/
readonly filesCached: boolean;
}
/**
* The default JupyterLab application info.
*/
export const defaultInfo: IInfo = {
devMode: PageConfig.getOption('devMode').toLowerCase() === 'true',
deferred: { patterns: [], matches: [] },
disabled: { patterns: [], matches: [] },
mimeExtensions: [],
filesCached: PageConfig.getOption('cacheFiles').toLowerCase() === 'true'
};
/**
* The default JupyterLab application paths.
*/
export const defaultPaths: JupyterFrontEnd.IPaths = {
urls: {
base: PageConfig.getOption('baseUrl'),
notFound: PageConfig.getOption('notFoundUrl'),
app: PageConfig.getOption('appUrl'),
static: PageConfig.getOption('staticUrl'),
settings: PageConfig.getOption('settingsUrl'),
themes: PageConfig.getOption('themesUrl'),
tree: PageConfig.getOption('treeUrl'),
workspaces: PageConfig.getOption('workspacesUrl'),
hubHost: PageConfig.getOption('hubHost') || undefined,
hubPrefix: PageConfig.getOption('hubPrefix') || undefined,
hubUser: PageConfig.getOption('hubUser') || undefined,
hubServerName: PageConfig.getOption('hubServerName') || undefined
},
directories: {
appSettings: PageConfig.getOption('appSettingsDir'),
schemas: PageConfig.getOption('schemasDir'),
static: PageConfig.getOption('staticDir'),
templates: PageConfig.getOption('templatesDir'),
themes: PageConfig.getOption('themesDir'),
userSettings: PageConfig.getOption('userSettingsDir'),
serverRoot: PageConfig.getOption('serverRoot'),
workspaces: PageConfig.getOption('workspacesDir')
}
};
/**
* The interface for a module that exports a plugin or plugins as
* the default value.
*/
export interface IPluginModule {
/**
* The default export.
*/
default: JupyterFrontEndPlugin<any> | JupyterFrontEndPlugin<any>[];
}
}