Coding Styleを自動でチェック! - 初心者のためのpython入門

前書き

お久しぶりです。今回は、コーディングスタイルの自動チェックについて紹介したいと思います。

コーディングスタイルとは

コーディングスタイルとは、その名の通りコードを書く時のスタイルです。コードを書く時に一行に何文字書くべきなのかと迷ったことはないでしょうか？
このような疑問を解消するためにPythonコードを書くための標準スタイルが定義されました。詳しくはこちらPEP 8 -- Style Guide for Python Code | Python.orgをご覧ください。標準スタイルでは、

インデントはスペース4つ
タブよりスペースの方が好ましい
一行は79文字まで

などのスタイルガイドが定義されています。これらのガイドラインに従うことにより、他の人にも読みやすコードになります。しかし、自分で全ての規約を満たしているかを確認するのは大変です。そこで、自動でガイドラインに沿っているかをチェックするライブラリを紹介します。

pycodestyle

スタイルのチェックには、pycodestyleを使用します。インストールは、pipを使います。
pip install pycodestyle

実際に使っていきましょう。使い方は、非常に簡単です。コマンドラインからpycodestyle <.pyファイル>と実行することができます。

sample.pyを用いて例を確認してみましょう。

def sum(a, b):
  return a+b

# コマンドラインで実行
$ pycodestyle sample.py
sample.py:2:3: E111 indentation is not a multiple of four
sample.py:3:1: W391 blank line at end of file

上記のようにスタイルに違反してるところが報告されます。スタイルガイドで義務付けられているものに関する違反はエラーとみなされ、エラーコードがEから始まります。それほど重要ではないが直した方が良いものは警告としてエラーコードがWから始まります。今回の例では、1つ目がエラー、2つ目が警告です。エラーが出た場合は、エラーの説明に従って直すと良いでしょう！

後書き

お疲れ様でした。今回は、Coding Styleとそのチェック方法について紹介しました。標準スタイルを守って、他の人が読みやすいコードを書くことを心がけていきましょう！