VSCodeでPythonのBlackフォーマッタを活用する方法

Pythonのコードを整形するためのツールとして、Blackが人気を博しています。特にVSCodeの拡張機能として利用できるようになったことで、より手軽に利用できるようになりました。

Blackフォーマッタのインストール

まずはBlackのインストールから始めます。以下のコマンドを実行してください。

pip install black

VSCodeの設定

次に、VSCodeの設定でBlackをデフォルトのフォーマッタとして設定します。VSCodeの設定を開き、「python formatting provider」を検索し、ドロップダウンメニューから「black」を選択します。

また、「format on save」を検索し、「Editor: Format on Save」オプションを有効にします。これにより、Pythonファイルを保存するたびにBlackが自動的にコードを整形します。

Blackの設定

Blackの設定は、VSCodeの設定ファイル(setting.json)に記述します。以下に設定例を示します。

{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter",
    "editor.formatOnSave": true
  },
  "black-formatter.args": ["--line-length=120"]
}

ここでは、editor.defaultFormatterにBlackのフォーマッタを指定し、editor.formatOnSaveをtrueに設定しています。これにより、Pythonファイルを保存するたびにBlackが自動的にコードを整形します。

また、black-formatter.argsにはBlackのオプション引数を指定します。ここでは、最大行長を120文字に設定しています。

以上で、VSCodeでPythonのBlackフォーマッタを活用する設定は完了です。これにより、Pythonのコードをより美しく、統一感のある形式で記述することが可能になります。