Repository files navigation

Jupyterlab extension that shows currently used variables and their values.
Contributions in any form are welcome!

• Allows inspection of variables for both consoles and notebooks.
• Allows inspection of matrices in a datagrid-viewer. This might not work for large matrices.
• Allows an inline and interactive inspection of Jupyter Widgets.

• This extension is currently targetspython as a main language but also supports the following languages with different levels of feature completeness
  • R
  • scala via thealmond kernel

In order to allow variable inspection, all content that is displayed first need to be sent from the kernel to the front end.
Therefore, opening large data frames with the datagrid viewer can dramatically increase your occupied memory andsignificantly slow down your browser.
Use at your own risk.

• JupyterLab >= 3.0

• pandas andnumpy are required to enable matrix inspection.
• pyspark for spark support.
• tensorflow andkeras to allow inspection of tf objects.
• torch for PyTorch support.

• Therepr library.

The variable inspector can also display Jupyter interactive widgets:

The requirements for this functionality are:

• ipywidgets, which can be installed withpip install ipywidgets.

To install the extension, execute:

pip install lckr_jupyterlab_variableinspector

To remove the extension, execute:

pip uninstall lckr_jupyterlab_variableinspector

Note: You will need NodeJS to build the extension package.

Thejlpm command is JupyterLab's pinned version ofyarn that is installed with JupyterLab. You may useyarn ornpm in lieu ofjlpm below.

# Clone the repo to your local environment# Change directory to the lckr_jupyterlab_variableinspector directory# Install package in development modepip install -e"."# Link your development version of the extension with JupyterLabjupyter labextension develop. --overwrite# Rebuild extension Typescript source after making changesjlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when neededjlpm watch# Run JupyterLab in another terminaljupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, thejlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

pip uninstall lckr_jupyterlab_variableinspector

In development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension list to figure out where thelabextensionsfolder is located. Then you can remove the symlink named@lckr/jupyterlab_variableinspector within that folder.

This extension is usingJest for JavaScript code testing.

To execute them, execute:

jlpmjlpmtest

This extension usesPlaywright for the integration tests (aka user level tests).More precisely, the JupyterLab helperGalata is used to handle testing the extension in JupyterLab.

More information are provided within theui-tests README.

SeeRELEASE