Visual Studio Code (VSCode) は、PythonのコードをPEP8スタイルガイドに準拠するように自動整形するためのツール、autopep8とflake8をサポートしています。
autopep8とは
autopep8は、Pythonのコードを自動的にPEP8スタイルガイドに準拠するように整形するツールです。autopep8 --in-place <filename>というコマンドを実行すると、コードがPEP8に準拠した形式に整形されます。また、設定により、ファイルを保存するときに自動的に整形することも可能です。
flake8とは
flake8は、Pythonのコードチェックツールで、PEP8などのコーディング規約に違反したコードがないかをチェックします。
VSCodeでの設定方法
VSCodeでは、autopep8とflake8の設定が可能です。設定方法は以下の通りです。
- VSCodeの設定画面から
python.formatting.autopep8Pathを検索し、Python > Formatting: Autopep8 Path項目にautopep8を設定します。 - 続けて、VSCodeの設定画面から
python.formatting.providerを検索し、Python > Formatting: Provider項目でautopep8を選択設定します。 settings.jsonのpython.formatting.autopep8Argsとpython.linting.flake8Argsに設定した--ignore=のエラーコードが異なる場合、autopep8で自動整形してもflake8のエラー表示が消えず、二度手間のような状態になるので同じ値を推奨します。
以上で、PythonのコードをPEP8スタイルガイドに準拠するように自動整形する設定が完了します。これにより、VSCodeでPythonのコードを書く際に、コードが自動的にPEP8スタイルガイドに準拠した形式に整形され、コーディング規約に違反したコードがないかをチェックできます。