VSCodeでPython開発を進める場合に、コードの自動フォーマットが行われると便利です。
本記事ではPEP8に準拠したフォーマットを行うautopep8を紹介します。
前提
- VSCodeがインストールされていること。
VSCode起動
まず、VSCodeを起動します。
autopep8をインストール
「Ctrl + Shift + X」を押下して拡張機能を表示します。
拡張機能検索欄にautopep8を入力し、
VSCodeのプラグインautopep8をインストールします。
インストールが完了するまで待ちます。
以下のようにautopep8からインストールボタンが消えれば、インストール完了です。
autopep8の初期設定
インストール完了後、左下の歯車マークから設定を選択します。
設定が開くことを確認します。
設定の検索欄にeditor.defaultFormatterを入力し、Editor.defaultFormatter欄が表示されることを確認します。
Editor.defaultFormatter欄のプルダウンからautopep8を選択します。
Editor.defaultFormatter欄の設定がautopep8となったことをご確認ください。
設定の検索欄にeditor.formatOnSaveを入力し、Editor.formatOnSave欄が表示されることを確認します。
Editor.formatOnSave欄のチェックボックスにチェックを入れます。
設定が完了したら設定タブは閉じてOKです。
autopep8の動作確認
以下の通り、Pythonコードの整形が行われることを確認できました。
フォーマット前
フォーマットが行われる前のPythonコードです。
フォーマット後
「Ctrl + s」でファイルを上書きすると、row_long_listの部分がPEP8に準拠した形にフォーマットされます。
Pythonのコーディング規約(PEP8)の説明はこちらのリンク を参照してください。
以上で本記事の解説を終わります。
よいITライフを！