2021年10月27日 更新

JupyterLabでコードを自動整形

どうも、クラゲジュニアです。

JupyterLabの拡張機能を使って、コードを自動整形することができます。

自動整形ツールをインストール

pipの場合

pip install jupyterlab_code_formatter
pip install black isort

condaの場合

conda install -c conda-forge jupyterlab_code_formatter
conda install black isort

JupyterLabのバージョン3.0.0より古い場合、以下も入力。

jupyter serverextension enable --py jupyterlab_code_formatter
jupyter labextension install @ryantam626/jupyterlab_code_formatter

ショートカットキーの登録

  1. JupyterLabを再起動。
  2. Adovanced Settings Editorをクリック。

  1. Keyboard Shortcutsをクリック。
  2. User Preferencesに以下を入力。 Ctrl E部分は、各自お好みのコマンドキーを登録し、保存。
{
    "shortcuts": 
    [
        {
            "command": "jupyterlab_code_formatter:black",
            "keys": [
                "Ctrl E"
            ],
            "selector": ".jp-Notebook.jp-mod-editMode"
        },
    ]
}

登録したコマンドキーを入力すると、コード自動整形ができます。

以上です。