jupyter lab上でPythonコードをフォーマットする

最近身の回りでjupyter lab + Pythonを使用する人が増えてきました。 jupyter labはその場で実行しながらスラスラとコードを書けるので非常に便利なのですが、その分コードが汚くなりがちです😓 少なくともコードの見た目はキレイにしておきたい...ということで今回はPythonのFormatterをjupyter labに導入する方法を紹介したいと思います。 jupyter labを使っていてFormatterをまだ使用していないという方は是非導入をオススメします💪

導入手順

1. Formatterのインストール

初めにFormatter自身をインストールします。 今現在の有名どころだとblack、yapf、autopep8、のどれかでしょうか🤔 どれがいいか分からない人はFormatterの中では比較的新しい、かつあまり設定をしなくて済むblackをオススメします。

$ pip install (black or yapf or autopep8)

2. jupyterlab_code_formatterのインストール

次にjupyter labのFormatterプラグインjupyterlab_code_formatterをインストールしましょう。

Pipの場合：

$ pip install jupyterlab_code_formatter

Condaの場合：

$ conda install -c conda-forge jupyterlab_code_formatter

※ version3.0.0未満のJupyterLabを使用している方は別途以下のコマンドを実行する必要があります。

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

3. jupyter labのデフォルトFormatterを設定

最後にjupyter lab上でデフォルトのFormatterを設定して終了です。 jupyterlab_code_formatterをインストールした状態でjupyter labを立ち上げます。 SettingsからAdvanced Settings Editorを選択します。

SettingsのEdit画面が開くので、menuからJupyterlab Code Formatterを選択します。

Edit画面の左側(System Defaults)がシステム側のデフォルト設定、右側(User Preferences)がユーザーの設定になります。 User Preferences側に以下のように記載し、デフォルトで使用したいFormatterを指定してあげます。

{
    "preferences": {
        "default_formatter": {
            "python": ["black"],
        }
    }
}

以上でjupyter labにおけるFormatterの設定は完了です。

使い方

Formatしたいファイルを開いた状態でEditのApply ~ Formatterを選択するか、下画像右上の赤枠アイコンをClickすることでFormatをかけることができます。

おわり

Formatは紳士の嗜み😎