Frequently Asked Questions

Error when writing grammar tables?

You might see some errors about writing grammar tables when using the black formatter, simply manually create the directory by running: python -c "import black; black.CACHE_DIR.mkdir(parents=True, exist_ok=True)". For more information see here.

Why are the commands not showing up in the command pallete? (I)

Make sure you really have one of the formatters properly installed.

And also make sure you have a suitable notebook/script opened for the formatters to work on when checking if the commands are there.

Why are the commands not showing up in the command pallete? (II)

Recently, there is another common mode of failure. This usually manifest itself after an attempt to upgrade the plugin.

Symptoms of such failure is the presence of such message:

$ jupyter labextension list

JupyterLab v2.1.5
Known labextensions:
app dir: env/share/jupyter/lab
@ryantam626/jupyterlab_code_formatter v1.3.4 enabled OK

Uninstalled core extensions:
@ryantam626/jupyterlab_code_formatter

Note the confusing enabled and yet uninstalled core extension.

To fix this, follow this comment.

404 POST

You might not have formatters installed, the default formatters are black and isort for Python and formatR for R. (You might also need to restart Jupyter Lab after you install them)

404 POST on Jupyterhub

Due to the difference in how Jupyterhub starts the Jupyter Lab insance, one would need to enable the server exntesion with the --sys-prefix flag, that is:

jupyter serverextension enable --py jupyterlab_code_formatter --sys-prefix

Version Mismatch Issue

On upgrade of this plugin, you might see plugin version mismatch.

Steps to solve this:

  1. Try to update the lab extension first with jupyter labextension update @ryantam626/jupyterlab_code_formatter
  2. Work out what version of the lab extension you have with jupyter labextension list | grep jupyterlab-code-formatter
  3. Install a matching server extension with pip install jupyterlab_code_formatter==x.x.x (replace x.x.x with version you observe in step 2
  4. Work out what version of the server plugin you have with pip freeze | grep jupyterlab-code-formatter and confirm it matches what you installed step 3 optionally
  5. Restart jupyterlab