VSCodeのBlackコードフォーマッター拡張機能

Black Formatterは、VSCodeの拡張機能として統合されています。バージョンは23.3.0で、Blackによるフォーマット機能はPython言語の全てのアクティブサポートされているバージョン（Python 3.7以降）に対応しています。ただし、選択したPython環境にBlackのインストールがない場合にのみ、バンドルされたBlack（23.3.0）が使用されます。また、この拡張機能によってサポートされるBlackの最小バージョンは22.3.0です。

実験的なステータスに関する注意事項

このフォーマッター拡張機能は現在（2023年6月10日）実験的なフェーズにあります。将来的には、この拡張機能がVSCodeのPython拡張機能に統合されているBlackフォーマッティング機能を置き換わる予定です。

インストール

まず、VSCodeのマーケットプレイスからBlack Formatter拡張機能をインストールします。インストールが完了すると、Pythonファイルのフォーマッターとして利用できるようになります。

使用方法

Blackフォーマッターをデフォルトに設定

インストール後、Pythonファイルのデフォルトフォーマッターとして「Black Formatter」を設定する必要があります。以下の2つの方法で設定できます。

• コンテキストメニューを使用（エディターで開いているPythonファイルを右クリック）し、「Format Document With...」を選択
• settings.jsonファイルに以下のスニペットを追加

"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
}

他のフォーマッターが設定されている場合は、次の設定を追加して上書きします。

"python.formatting.provider": "none"

自動フォーマットの有効化

より効率的なワークフローのために、ファイルを保存するたびにフォーマッターが自動的にコードを整形するように設定できます。次の設定をsettings.jsonファイルに含めることで、自動フォーマットを有効にすることができます。

"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.formatOnSave": true
}

参考

https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter