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

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)の説明はこちらのリンク を参照してください。

Pythonユーザにお勧めの本

スッキリわかるPython入門 第2版 スッキリわかるシリーズ

Amazon 楽天

独習Python

Amazon 楽天

Python1年生 第2版 体験してわかる！会話でまなべる！プログラミングのしくみ

Amazon 楽天

VSCode学習者にお勧めの本

これ1冊でできる！Visual Studio Code 超入門

Amazon 楽天

Visual Studio Code完全入門　Webクリエイター&エンジニアの作業がはかどる新世代エディターの操り

Amazon 楽天

Visual Studio Codeパーフェクトマスター

Amazon 楽天