python

pythonのコードスタイルをチェックするツール

結論から言ってしまうと、pep8、flake8、pylintを使用してあげれば大丈夫です。

導入方法は、pipを使用してあげます。

pip install pep8 flake8 pylint

後はお使いのエディタで設定してあげれば自動的に反映されます。

例えば、VScodeであれば、左下に設定ボタンから設定をクリックして、settingsを開きます。そして、検索バーにpython.linting.pylintEnabledと入力するとチェックボックスにチェックが入っていますが、pylintを使用したくない場合には、チェックを外してあげれば問題ないです。

同様にflake8を有効にしたい場合には、python.linting.flake8Enabledと検索バーに入れてチェックを入れてあげれば大丈夫です。

他にもコマンドラインから実行してあげる方法もあります。

main.pyというファイルを実行したい場合には、python main.pyと実行してあげますが、代わりに、pep8 main.pyと実行してあげると、色々とチェックしてもらえます。

pep8とflake8の違いですが、pep8が軽めのチェック、flake8がもう少し厳密なチェックと言ったイメージです。pylintが一番厳しくチェックを行います。

会社によって、pep8は通すべきなどと言った規約が定まっていることがありますので、慣れておいて損はないと思います。ただ、関数名などの命名規則などはチェックしてもらえないので、そこは自身で補っていく必要があります。