VSCodeでPythonコードの自動フォーマット（整形）を行う。

Amazonのアソシエイトとして、ITナレッジライフは適格販売により収入を得ています。

記事の文字数：988 ／総アクセス数：3,229 views

VSCodeでPythonコードのフォーマットを行うプラグインautopep8を紹介します。autopep8はPEP8に準拠しており、プラグインを導入することで、コーディング規約に沿った開発をスムーズに進められることが期待できます。

2024/7/13 2024/10/12 更新

VSCodeでPython開発を進める場合に、コードの自動フォーマットが行われると便利です。
本記事ではPEP8に準拠したフォーマットを行うautopep8を紹介します。

前提

VSCodeをインストールしていること。
※本記事では、以下バージョンで確認しました。

1
バージョン: 1.94.2 (user setup)
2
コミット: 384ff7382de624fb94dbaf6da11977bba1ecd427
3
日付: 2024-10-09T16:08:44.566Z
4
Electron: 30.5.1
5
ElectronBuildId: 10262041
6
Chromium: 124.0.6367.243
7
Node.js: 20.16.0
8
V8: 12.4.254.20-electron.0
9
OS: Windows_NT x64 10.0.22631

VSCode起動

まず、VSCodeを起動します。

autopep8をインストール

「Ctrl + Shift + X」を押下して拡張機能を表示します。

拡張機能検索欄にautopep8を入力し、 VSCodeのプラグインautopep8をインストールします。

インストールが完了するまで待ちます。
以下のようにautopep8からインストールボタンが消えれば、インストール完了です。

autopep8の初期設定

インストール完了後、VSCodeの画面左下「歯車マーク＞設定」を選択します。

設定が開くことを確認します。

設定の検索欄にeditor.defaultFormatterを入力し、Editor.defaultFormatter欄が表示されることを確認します。

Editor.defaultFormatter欄のプルダウンからautopep8を選択します。

Editor.defaultFormatter欄の設定がautopep8となったことをご確認ください。

設定の検索欄にeditor.formatOnSaveを入力し、Editor.formatOnSave欄が表示されることを確認します。

Editor.formatOnSave欄のチェックボックスにチェックを入れます。

設定が完了したら設定タブは閉じてOKです。

autopep8の動作確認

以下の通り、Pythonコードの整形が行われることを確認できました。

フォーマット前

フォーマットが行われる前のPythonコードです。

コード内容(整形前)

1
class hoge():
2

3
    def function_test():
4
        print('test')
5
        row_long_list = [100000000, 200000000, 300000000, 400000000, 500000000, 600000000, 700000000, 800000000]

フォーマット後

「Ctrl + s」でファイルを上書きすると、row_long_listの行が途中で改行されて、PEP8に準拠した形にフォーマットされます。

コード内容(整形後)

1
class hoge():
2

3
    def function_test():
4
        print('test')
5
        row_long_list = [100000000, 200000000, 300000000,
6
                         400000000, 500000000, 600000000, 700000000, 800000000]

Pythonのコーディング規約(PEP8)の説明はこちらのリンクを参照してください。

関連操作
VSCodeではPythonだけでなく、設定ファイル等でよく使われるJSONの自動整形も設定しておくと便利です。JSONやXMLのフォーマット方法については以下の記事を参考にしてください。

ITナレッジライフ

【VSCode】JSON・XMLを整形・最小化する方法

本記事では、Visual Studio Code（VS Code）で JSON や XML のファイルを効率よく整形・編集する方法を徹底解説します。標準の整形機能の使い方から、Prettier・JSON Tools・XML Tools などの拡張機能の活用、保存時の自動フォーマット設定まで、実践的なテクニックを網羅。