VS CodeでPythonの自動フォーマットを設定する方法

VS CodeはPythonのコードを自動的にフォーマットする機能を提供しています。この記事では、その設定方法を詳しく説明します。

フォーマッターの選択

VS Codeでは、いくつかのPythonフォーマッターが利用可能です。Microsoftが公開しているフォーマッターには、autopep8やBlack formatterなどがあります。また、コミュニティから提供されているフォーマッターには、Ruffやyapfなどがあります。

フォーマッターを選択したら、VS Codeの設定でそれをデフォルトのフォーマッターとして設定します。設定方法は次の通りです。

1. VS CodeでPythonファイルを開きます。
2. エディターを右クリックしてコンテキストメニューを表示します。
3. 「Format Document With…」を選択します。
4. 「Configure Default Formatter…」を選択します。
5. リストから選択したフォーマッターを選択します。

また、User settings.jsonファイルの「editor.defaultFormatter」を設定することで、すべてのPythonファイルに対してデフォルトのフォーマッターを設定することも可能です。

保存時の自動フォーマット

VS Codeでは、ファイルを保存するときに自動的にコードをフォーマットすることができます。これを有効にするには、User settings.jsonファイルに以下の設定を追加します。

"[python]": {
  "editor.formatOnSave": true
}

以上がVS CodeでPythonの自動フォーマットを設定する方法です。これにより、Pythonのコードをより読みやすく、一貫性を持たせることができます。