Pythonのコードスタイルチェックツール autopep8 の導入方法

Pythonは正しいコードなら好きなように書いても良いとはいえ、一貫したコードスタイルに従うことは可読性の高いコードを書くことができます。
一般的にPEP8スタイルガイドに従うのが一番良さそうです。

PEP8

そんなコードスタイルをチェックしてくれる便利なツールが存在します。
今回はコードスタイルチェックツールの紹介です。

基本的なコードチェックツールの種類

基本的なコードチェックとして、pycodestyle、flake8、pylintがあります。
pycodestyleはpep8というツールがありますが、これがpycodestyleに名前変更されています。
コードチェックツールのpep8を使っていた場合はpycodestyleをインストールし直しましょう。

コードチェックのツールをインストールはそれぞれ次のコマンドです。

pip install pycodestyle
pip install flake8
pip install pylint

それぞれのコードチェックのポイント

例えばmanage.pyにコードを記述している場合を例にします。
軽めのチェックは pycodestyle がよいでしょう。

チェック例

pycodestyle manage.py

少し突っ込んでチェックがflake8です。

チェック例

flake8 manage.py

かなり詳細にチェックするのがpylintで、少しうるさいくらいです。
チェック例

pylint manage.py

manage.pyのコードの一部に、()の先頭と最後に空白を入れた場合の結果です。

os.environ.setdefault( 'DJANGO_SETTINGS_MODULE', 'todoproject.settings' )

VSCodeでチェックする方法

通常は何らかエディタを使用してコーディングするでしょう。
VSCodeで手軽にコードチェックする方法です。

autopep8はPEP8に自動でフォーマットしてくれる。便利ツールです。
autopep8 は pyflakes、pycodestyle、mccabe の３つのツールがまとめているものです。まずはautopep8をインストールします。

pip install autopep8

インストールできると、次はVSCodeの左側にある「Extensions」を開いて、検索窓でpythonと検索します。
そして、「Python extension for Visual Studio Code」をインストールしておきます。

autopep8インストールしていればコードスタイルチェックの設定は自動で行われているはずです。
確認をかねて Preferencess から Settings を開きます。

一番上の検索領域に「format」で検索するとformatの設定領域が出ます。
左側の領域にformatする言語が並んでいますので、Pythonを選ぶとPythonのフォーマット領域が出てきます。

Python › Formatting: Providerにautopep8が入っていたらOK。
入ってなければ「autopep8」選択します。

次に、 Settings の上の検索窓に「flake8」と検索するとflake8の設定領域が出てきます。
Python › Linting: Flake8 Enabledにチェックを入れます。

さらに、Python › Linting: Lint On Saveにチェックを入れておくと保存時にエラーチェックをしてくれます。

また、Editor: Format On Saveにチェックを入れておくと保存時に修正してくれます。