Pythonのコードを自動整形するBlackの使い方

今回はPythonのコードをファイル保存時に自動整形するようにコードフォーマッターのBlackの導入方法を紹介します

環境

• VSCode

手順

ここからは手順を紹介します！

拡張機能のインストール

VSCodeで拡張機能のBlack Formatterを検索しインストールします

Black Formatter - Visual Studio Marketplace

Extension for Visual Studio Code - Formatting support for Python files using the Black formatter.

marketplace.visualstudio.com

setting.jsonの設定

WindowsならCtrl+Shift+P、MacならCommand+Shift+Pで表示される検索欄に「setting」と入力しワークスペースの設定を開きます

setting.jsonが開かれるので以下のコードを追記します

{
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter", // フォーマッターの指定
    "editor.formatOnSave": true // ファイル保存時に整形するか
  }
}

これでPythonファイルを保存時に整形されるようになれば成功です

もし期待通りに動かない場合はVSCode右下のインタプリンタの設定がPythonになっているか確認してください

まとめ

今回はPythonの自動整形ツールを導入する方法を紹介しました

可読性や作業の進めやすさにも繋がるので整形ツールの設定は必須だと思います

不具合等あればコメントで教えてください！