Python Tips: Sublime Text で pep8 のオートフォーマッタを使いたい

エディタ「 Sublime Text 」で pep8 のオートフォーマッタを利用する方法についてです。対象バージョンは Sublime Text 2 と 3 の両方です。

「方法」といっても手順はかんたんで、「 Python PEP8 Autoformat 」という Sublime Text パッケージをインストールするだけです。

  1. Sublime Text を開いてコマンドパレットを開く
  2. 「 Package Control: Install Package 」を選択
  3. 「 Python PEP8 Autoformat 」を選択
  4. インストール完了

Python PEP8 Autoformat にはオートフォーマッタの本体である Python の pep8 パッケージが同梱されているので、パッケージを別途インストールする必要などはありません。 Python PEP8 Autoformat をインストールしたらすぐに使いはじめることができます。

.py ファイルを保存したときに自動で走らせたい場合は設定ファイルにその旨を書き込めば OK です。

  1. ( Sublime Text 2 の場合) Preferences → Package Settings → Python PEP8 Autoformat → Settings User
  2. パッケージディレクトリの「 User 」ディレクトリ内の「 pep8_autoformat.sublime-settings 」というファイルが開く
  3. 以下の内容を記入して保存
{
    // autoformat code on save
    "autoformat_on_save": true
}

ファイルの保存後に .py ファイルを適当に保存すると、 pep8 でのオートフォーマット処理が走ることが確認できることと思います。

以上です。

(私は深掘りできていませんが)その他 pep8 パッケージが持つ各種オプションも利用できるようなので、カスタマイズして本格的に使用したい場合は公式のページをぜひ覗いてみてください。

こういうオートフォーマッタは強力で、一度使うととても便利なのでやめられなくなりますね。