Skip to content

Commit dec91f5

Browse files
martinRenoumartinRenou
committed
Add settings
1 parent 5c907bf commit dec91f5

File tree

6 files changed

+131
-27
lines changed

6 files changed

+131
-27
lines changed

‎package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
"yjs": "^13.5.40"
9797
},
9898
"jupyterlab": {
99+
"schemaDir": "schema",
99100
"extension": true,
100101
"outputDir": "lckr_jupyterlab_variableinspector/labextension",
101102
"sharedPackages": {

‎schema/jupyterlab-variableInspector-settings.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"title": "jupyterlab-variableInspector settings",
3+
"description": "Settings for the jupyterlab-variableInspector extension.",
4+
"type": "object",
5+
"properties": {
6+
"maxItems": {
7+
"type": "number",
8+
"title": "Maximum number of items",
9+
"description": "The maximum number of items to show in lists/dicts etc",
10+
"default": 10
11+
}
12+
}
13+
}

‎src/handler.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import { ISessionContext } from '@jupyterlab/apputils';
22

3+
import { ISettingRegistry } from '@jupyterlab/settingregistry';
4+
35
import { IExecuteResult } from '@jupyterlab/nbformat';
46

57
import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
@@ -100,8 +102,12 @@ export class VariableInspectionHandler extends AbstractHandler {
100102
private _matrixQueryCommand: string;
101103
private _widgetQueryCommand: string;
102104
private _deleteCommand: string;
105+
private _changeSettingsCommand:
106+
| ((settings: IVariableInspector.ISettings) => string)
107+
| undefined;
103108
private _ready: Promise<void>;
104109
private _id: string;
110+
private _setting: ISettingRegistry.ISettings;
105111

106112
constructor(options: VariableInspectionHandler.IOptions) {
107113
super(options.connector);
@@ -110,11 +116,14 @@ export class VariableInspectionHandler extends AbstractHandler {
110116
this._queryCommand = options.queryCommand;
111117
this._matrixQueryCommand = options.matrixQueryCommand;
112118
this._widgetQueryCommand = options.widgetQueryCommand;
119+
this._changeSettingsCommand = options.changeSettingsCommand;
113120
this._deleteCommand = options.deleteCommand;
114121
this._initScript = options.initScript;
122+
this._setting = options.setting;
115123

116124
this._ready = this._connector.ready.then(() => {
117125
this._initOnKernel().then((msg: KernelMessage.IExecuteReplyMsg) => {
126+
this.performSettingsChange();
118127
this._connector.iopubMessage.connect(this._queryCall);
119128
return;
120129
});
@@ -131,12 +140,20 @@ export class VariableInspectionHandler extends AbstractHandler {
131140

132141
this._ready = kernelReady.then(() => {
133142
this._initOnKernel().then((msg: KernelMessage.IExecuteReplyMsg) => {
143+
this.performSettingsChange();
134144
this._connector.iopubMessage.connect(this._queryCall);
135145
this.performInspection();
136146
});
137147
});
138148
};
139149

150+
this._setting.changed.connect(async () => {
151+
await this._ready;
152+
153+
this.performSettingsChange();
154+
this.performInspection();
155+
});
156+
140157
this._connector.kernelRestarted.connect(onKernelReset);
141158
this._connector.kernelChanged.connect(onKernelReset);
142159
}
@@ -232,6 +249,27 @@ export class VariableInspectionHandler extends AbstractHandler {
232249
this._connector.fetch(content, this._handleQueryResponse);
233250
}
234251

252+
/**
253+
* Send a kernel request to change settings
254+
*/
255+
performSettingsChange(): void {
256+
if (!this._changeSettingsCommand) {
257+
return;
258+
}
259+
260+
const settings: IVariableInspector.ISettings = {
261+
maxItems: this._setting.get('maxItems').composite as number
262+
};
263+
264+
const content: KernelMessage.IExecuteRequestMsg['content'] = {
265+
code: this._changeSettingsCommand(settings),
266+
stop_on_error: false,
267+
store_history: false
268+
};
269+
270+
this._connector.fetch(content, this._handleQueryResponse);
271+
}
272+
235273
/**
236274
* Initializes the kernel by running the set up script located at _initScriptPath.
237275
*/
@@ -344,9 +382,11 @@ export namespace VariableInspectionHandler {
344382
queryCommand: string;
345383
matrixQueryCommand: string;
346384
widgetQueryCommand: string;
385+
changeSettingsCommand?(settings: IVariableInspector.ISettings): string;
347386
deleteCommand: string;
348387
initScript: string;
349388
id: string;
389+
setting: ISettingRegistry.ISettings;
350390
}
351391
}
352392

‎src/index.ts

Lines changed: 45 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import { IConsoleTracker } from '@jupyterlab/console';
1111

1212
import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
1313

14+
import { ISettingRegistry } from '@jupyterlab/settingregistry';
15+
1416
import { listIcon } from '@jupyterlab/ui-components';
1517

1618
import { DummyHandler, VariableInspectionHandler } from './handler';
@@ -30,6 +32,9 @@ namespace CommandIDs {
3032
export const open = 'variableinspector:open';
3133
}
3234

35+
const SETTINGS_ID =
36+
'@lckr/jupyterlab_variableinspector:jupyterlab-variableInspector-settings';
37+
3338
/**
3439
* A service providing variable introspection.
3540
*/
@@ -110,17 +115,24 @@ const variableinspector: JupyterFrontEndPlugin<IVariableInspectorManager> = {
110115
*/
111116
const consoles: JupyterFrontEndPlugin<void> = {
112117
id: '@lckr/jupyterlab-variableinspector:consoles',
113-
requires: [IVariableInspectorManager, IConsoleTracker, ILabShell],
118+
requires: [
119+
IVariableInspectorManager,
120+
IConsoleTracker,
121+
ILabShell,
122+
ISettingRegistry
123+
],
114124
autoStart: true,
115-
activate: (
125+
activate: async (
116126
app: JupyterFrontEnd,
117127
manager: IVariableInspectorManager,
118128
consoles: IConsoleTracker,
119-
labShell: ILabShell
120-
): void => {
129+
labShell: ILabShell,
130+
settings: ISettingRegistry
131+
): Promise<void> => {
121132
const handlers: {
122133
[id: string]: Promise<IVariableInspector.IInspectable>;
123134
} = {};
135+
const setting = await settings.load(SETTINGS_ID);
124136

125137
/**
126138
* Subscribes to the creation of new consoles. If a new notebook is created, build a new handler for the consoles.
@@ -150,15 +162,18 @@ const consoles: JupyterFrontEndPlugin<void> = {
150162
const matrixQueryCommand = result.matrixQueryCommand;
151163
const widgetQueryCommand = result.widgetQueryCommand;
152164
const deleteCommand = result.deleteCommand;
165+
const changeSettingsCommand = result.changeSettingsCommand;
153166

154167
const options: VariableInspectionHandler.IOptions = {
155-
queryCommand: queryCommand,
156-
matrixQueryCommand: matrixQueryCommand,
168+
queryCommand,
169+
matrixQueryCommand,
157170
widgetQueryCommand,
158-
deleteCommand: deleteCommand,
159-
connector: connector,
160-
initScript: initScript,
161-
id: session.path //Using the sessions path as an identifier for now.
171+
deleteCommand,
172+
connector,
173+
initScript,
174+
changeSettingsCommand,
175+
id: session.path, //Using the sessions path as an identifier for now.
176+
setting
162177
};
163178
const handler = new VariableInspectionHandler(options);
164179
manager.addHandler(handler);
@@ -222,15 +237,22 @@ const consoles: JupyterFrontEndPlugin<void> = {
222237
*/
223238
const notebooks: JupyterFrontEndPlugin<void> = {
224239
id: '@lckr/jupyterlab-variableinspector:notebooks',
225-
requires: [IVariableInspectorManager, INotebookTracker, ILabShell],
240+
requires: [
241+
IVariableInspectorManager,
242+
INotebookTracker,
243+
ILabShell,
244+
ISettingRegistry
245+
],
226246
autoStart: true,
227-
activate: (
247+
activate: async (
228248
app: JupyterFrontEnd,
229249
manager: IVariableInspectorManager,
230250
notebooks: INotebookTracker,
231-
labShell: ILabShell
232-
): void => {
251+
labShell: ILabShell,
252+
settings: ISettingRegistry
253+
): Promise<void> => {
233254
const handlers: { [id: string]: Promise<VariableInspectionHandler> } = {};
255+
const setting = await settings.load(SETTINGS_ID);
234256

235257
/**
236258
* Subscribes to the creation of new notebooks. If a new notebook is created, build a new handler for the notebook.
@@ -256,16 +278,19 @@ const notebooks: JupyterFrontEndPlugin<void> = {
256278
const matrixQueryCommand = result.matrixQueryCommand;
257279
const widgetQueryCommand = result.widgetQueryCommand;
258280
const deleteCommand = result.deleteCommand;
281+
const changeSettingsCommand = result.changeSettingsCommand;
259282

260283
const options: VariableInspectionHandler.IOptions = {
261-
queryCommand: queryCommand,
262-
matrixQueryCommand: matrixQueryCommand,
284+
queryCommand,
285+
matrixQueryCommand,
263286
widgetQueryCommand,
264-
deleteCommand: deleteCommand,
265-
connector: connector,
287+
deleteCommand,
288+
connector,
266289
rendermime,
267-
initScript: initScript,
268-
id: session.path //Using the sessions path as an identifier for now.
290+
initScript,
291+
changeSettingsCommand,
292+
id: session.path, //Using the sessions path as an identifier for now.
293+
setting
269294
};
270295
const handler = new VariableInspectionHandler(options);
271296
manager.addHandler(handler);

‎src/inspectorscripts.ts

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
import { IVariableInspector } from './tokens';
2+
13
export namespace Languages {
24
export type LanguageModel = {
35
initScript: string;
46
queryCommand: string;
57
matrixQueryCommand: string;
68
widgetQueryCommand: string;
79
deleteCommand: string;
10+
changeSettingsCommand?: (settings: IVariableInspector.ISettings) => string;
811
};
912
}
1013

@@ -26,6 +29,8 @@ _jupyterlab_variableinspector_nms = NamespaceMagics()
2629
_jupyterlab_variableinspector_Jupyter = get_ipython()
2730
_jupyterlab_variableinspector_nms.shell = _jupyterlab_variableinspector_Jupyter.kernel.shell
2831
32+
_jupyterlab_variableinspector_maxitems = 10
33+
2934
__np = None
3035
__pd = None
3136
__pyspark = None
@@ -56,6 +61,12 @@ def _check_imported():
5661
__xr = _attempt_import('xarray')
5762
5863
64+
def _jupyterlab_variableinspector_changesettings(maxitems, **kwargs):
65+
global _jupyterlab_variableinspector_maxitems
66+
67+
_jupyterlab_variableinspector_maxitems = maxitems
68+
69+
5970
def _jupyterlab_variableinspector_getsizeof(x):
6071
if type(x).__name__ in ['ndarray', 'Series']:
6172
return x.nbytes
@@ -106,15 +117,18 @@ def _jupyterlab_variableinspector_getcontentof(x):
106117
if isinstance(x, (bool, str, int, float, type(None))):
107118
content = str(x)
108119
elif isinstance(x, (list, tuple)):
109-
if len(x) < 10:
120+
if len(x) <= _jupyterlab_variableinspector_maxitems:
110121
content = str(x)
111122
else:
112-
content = f"[{x[0]}, {x[1]}, {x[2]}, ..., {x[-1]}]"
123+
content = "["
124+
for i in range(_jupyterlab_variableinspector_maxitems):
125+
content += f"{x[i]}, "
126+
content += "...]"
113127
elif isinstance(x, collections.abc.Mapping):
114-
if len(x.keys()) < 10:
128+
if len(x.keys()) <= _jupyterlab_variableinspector_maxitems:
115129
content = str(x)
116130
else:
117-
first_ten_keys = list(islice(x.keys(), 10))
131+
first_ten_keys = list(islice(x.keys(), _jupyterlab_variableinspector_maxitems))
118132
content = "{"
119133
for idx, key in enumerate(first_ten_keys):
120134
if idx > 0:
@@ -331,21 +345,27 @@ def _jupyterlab_variableinspector_deletevariable(x):
331345
queryCommand: '_jupyterlab_variableinspector_dict_list()',
332346
matrixQueryCommand: '_jupyterlab_variableinspector_getmatrixcontent',
333347
widgetQueryCommand: '_jupyterlab_variableinspector_displaywidget',
334-
deleteCommand: '_jupyterlab_variableinspector_deletevariable'
348+
deleteCommand: '_jupyterlab_variableinspector_deletevariable',
349+
changeSettingsCommand: (settings: IVariableInspector.ISettings) =>
350+
`_jupyterlab_variableinspector_changesettings(maxitems=${settings.maxItems})`
335351
},
336352
python2: {
337353
initScript: Languages.py_script,
338354
queryCommand: '_jupyterlab_variableinspector_dict_list()',
339355
matrixQueryCommand: '_jupyterlab_variableinspector_getmatrixcontent',
340356
widgetQueryCommand: '_jupyterlab_variableinspector_displaywidget',
341-
deleteCommand: '_jupyterlab_variableinspector_deletevariable'
357+
deleteCommand: '_jupyterlab_variableinspector_deletevariable',
358+
changeSettingsCommand: (settings: IVariableInspector.ISettings) =>
359+
`_jupyterlab_variableinspector_changesettings(maxitems=${settings.maxItems})`
342360
},
343361
python: {
344362
initScript: Languages.py_script,
345363
queryCommand: '_jupyterlab_variableinspector_dict_list()',
346364
matrixQueryCommand: '_jupyterlab_variableinspector_getmatrixcontent',
347365
widgetQueryCommand: '_jupyterlab_variableinspector_displaywidget',
348-
deleteCommand: '_jupyterlab_variableinspector_deletevariable'
366+
deleteCommand: '_jupyterlab_variableinspector_deletevariable',
367+
changeSettingsCommand: (settings: IVariableInspector.ISettings) =>
368+
`_jupyterlab_variableinspector_changesettings(maxitems=${settings.maxItems})`
349369
},
350370
R: {
351371
initScript: Languages.r_script,

‎src/tokens.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ export namespace IVariableInspector {
5353
performDelete(varName: string): void;
5454
}
5555

56+
export interface ISettings {
57+
maxItems: number;
58+
}
59+
5660
export interface IVariableInspectorUpdate {
5761
title: IVariableTitle;
5862
payload: Array<IVariable>;
@@ -67,6 +71,7 @@ export namespace IVariableInspector {
6771
isMatrix: boolean;
6872
isWidget: boolean;
6973
}
74+
7075
export interface IVariableTitle {
7176
kernelName?: string;
7277
contextName?: string; //Context currently reserved for special information.

0 commit comments

Comments
 (0)