flake8を使ってpythonのコーディングスタイルをチェックする

2021年3月14日

flake8を使ってpythonのコーディングスタイルをチェックする

python推奨のコーディング規約をチェックするツール「flake8」を入れてみたのでメモとして残しておきたいと思います。
参考：
　　・【Python】Flake8を使ってコーディングスタイルを自動でチェックする
公式ドキュメント：
　　・コーディング規約
　　・エラー内容

インストール

「pip」を使って「flake8」をインストールします。


pip3 install flake8

コード

「sample.py」を作成し、下記通りコードを記載します。


import sys, math

a= 2
b = 10;
[1, 2,3]

コーディングスタイルチェック

「flake8」を使用して確認してみます。


sample.py:1:1: F401 'sys' imported but unused
# importしたモジュールが使われていない
sample.py:1:1: F401 'math' imported but unused
# importしたモジュールが使われていない
sample.py:1:11: E401 multiple imports on one line
# ひとつのラインで複数のモジュールをimportしている
sample.py:3:2: E225 missing whitespace around operator
# オペレータ（=オペレータ）の前後でスペースを入れていない
sample.py:4:7: E703 statement ends with a semicolon
# セミコロンを行末に入れている
sample.py:5:6: E231 missing whitespace after ','
# カンマの後にスペースを入れていない
sample.py:5:9: W292 no newline at end of file
# ファイルの最後に空行が入っていない

最後に

オプションを付ける事で統計出力、エラー無視が出来るみたいです。
また「autopep8」を導入することで自動補正も可能のようです。
flake8を使ってPythonプロジェクトを自動コードレビューする

2021年3月14日