Jupyter NotebookでもBlackでコードフォーマット

コードの可読性を上げて保守性を高めたり、コードの属人化を防いで生産性を向上させるためのルール（コーディング規約）に則った開発を行うために、ファントムでは開発する際にBlackというコードフォーマッターを導入しています。

過去にもDockerとPyCharmでBlackを使ってコードフォーマットする記事を投稿しましたが、今回はデータ分析の際によく使うJupyter NotebookでBlackでコードフォーマットする方法を説明します。

PyCharm&DockerでもBlackでコードフォーマット

pipでインストールしたBlackはエラーが発生

pip install blackでインストールしたBlackを使ってblack FILENAME.ipynbを実行すると以下のエラーが発生します

Skipping .ipynb files as Jupyter dependencies are not installed.
You can fix this by running ``pip install black[jupyter]``
No Python files are present to be formatted. Nothing to do 😴

Jupyter Notebookに拡張機能としてインストール

pip install jupyter_contrib_nbextensions

jupyter nbextension install https://github.com/drillan/jupyter-black/archive/master.zip --user
jupyter nbextension enable jupyter-black-master/jupyter-black

Blackでコードフォーマット

元のコード（TOKEN前にスペースが入っていない、dataの値にインデントが入っていない）

赤枠の「Black」をクリック

コードフォーマット完了
TOKENの前にスペース、dataの値にインデントが入りました

---

株式会社ファントムへのお問い合わせ

群馬県でPythonを使ったAIやソフトウェアを開発している株式会社ファントムが運営しています。