Skip to main content

JupyterLab extension for profiling UI performance

Project description

jupyterlab-ui-profiler

Github Actions Status Binder Documentation Status

JupyterLab extension for profiling UI performance.

UI Profiler UI

You can find more information in our User Guide.

Note: when this extension is enabled, the server will return additional headers:

  • to allow high-precision performance.now() measurements in Firefox 79+:

    Cross-Origin-Opener-Policy: same-origin,
    Cross-Origin-Embedder-Policy: require-corp
    
  • to enable JavaScript self-profiling in Chrome:

    Document-Policy: js-profiling
    

If this is undesirable in your deployment, but you still want to use the profiler without these functions, you can disable the server extension which sets these headers with:

jupyter server extension disable jupyterlab_ui_profiler

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab-ui-profiler

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-ui-profiler

Contributing

Development install

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

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-ui-profiler directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm 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 needed
jlpm watch
# Run JupyterLab in another terminal
jupyter 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, the jlpm 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

Development uninstall

pip uninstall jupyterlab-ui-profiler

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named @jupyterlab/ui-profiler within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Documentation

To build locally:

make -C docs/ html SPHINXOPTS="-W"

To build in watch mode:

sphinx-autobuild docs/source docs/build/html

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_ui_profiler-0.1.8.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

jupyterlab_ui_profiler-0.1.8-py3-none-any.whl (141.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_ui_profiler-0.1.8.tar.gz.

File metadata

  • Download URL: jupyterlab_ui_profiler-0.1.8.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/5.1.0 pkginfo/1.7.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.6

File hashes

Hashes for jupyterlab_ui_profiler-0.1.8.tar.gz
Algorithm Hash digest
SHA256 a05fb218d09d59e4e5bc8b8401f6aaff0c0c9a71686680dc8793a2d66a908519
MD5 efa81808e9e3ff570e88b1ba3875bad3
BLAKE2b-256 b6e81832b74f3ba0d68875b371bed4e2a795c4bad94b6a135b718de19e37189c

See more details on using hashes here.

File details

Details for the file jupyterlab_ui_profiler-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_ui_profiler-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 141.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/5.1.0 pkginfo/1.7.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.6

File hashes

Hashes for jupyterlab_ui_profiler-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3875930811f556f9da9fb2995e86fdd3c6f9908c218c3f3e31f800c85f9cf04e
MD5 803f428a29f4bdd2d33220853a274dd4
BLAKE2b-256 be6eb3d0278fd74eaefb47fbb9be047ffa9e2d7f349500a9ee79b0d62704521e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page