Flake8 - コードスタイルチェック

Flake8は、Pythonのコードスタイルをチェックするツールです。PEP 8(Pythonの公式スタイルガイド)に準拠しているかを検証します。

1. Flake8の実行

以下のコマンドで、Python がインストールされていることを確認します。

Windowsの場合:

python --version

以下のように Python のバージョンが表示されれば、インストールは確認できています。

Python 3.x.x

Macの場合:

python3 --version

以下のように Python のバージョンが表示されれば、インストールは確認できています。

Python 3.x.x

バージョンが表示されない場合は、Pythonのインストール を先に実施してください。

インストールが確認できたら、以下のコマンドでFlake8を実行します。

Windowsの場合:

flake8 src/

Macの場合:

python3 -m flake8 src/

実行すると、以下のようなエラーが表示されます。

src/calculator.py:1:1: F401 'os' imported but unused
src/calculator.py:2:1: F401 'sys' imported but unused
src/calculator.py:4:1: E302 expected 2 blank lines, found 1
src/calculator.py:4:10: E231 missing whitespace after ','
src/calculator.py:7:1: E302 expected 2 blank lines, found 1
src/calculator.py:7:14: E201 whitespace after '('
src/calculator.py:7:19: E202 whitespace before ')'
src/calculator.py:10:1: E302 expected 2 blank lines, found 1
src/calculator.py:14:1: E302 expected 2 blank lines, found 1
src/calculator.py:19:1: E305 expected 2 blank lines after class or function definition, found 1
src/calculator.py:21:1: E302 expected 2 blank lines, found 1
src/user_service.py:5:1: E302 expected 2 blank lines, found 1
src/user_service.py:9:1: E302 expected 2 blank lines, found 1

出力の読み方は以下の通りです。

  • ファイル名:行番号:列番号: エラーコード メッセージ
  • Fで始まるコードは、pyflakes由来のエラー(未使用のインポートや変数など)を示します
  • Eで始まるコードは、PEP 8のスタイル違反を示します
  • Wで始まるコードは、PEP 8のスタイル警告を示します

検出された各エラーについて解説します。

F401 'os' imported but unused

import osでインポートしていますが、コード内でosが一度も使われていません。未使用のインポートはコードの可読性を下げるため、削除すべきです。sysも同様です。

E302 expected 2 blank lines, found 1

PEP 8では、トップレベルの関数定義の前には2行の空行を入れるルールがあります。このコードでは空行が1行しかないため、エラーが検出されています。

E231 missing whitespace after ','

def add(a,b):のカンマの後にスペースがありません。PEP 8では、カンマの後にはスペースを入れるルールがあります。正しくはdef add(a, b):です。

E225 missing whitespace around operator

return a+bの演算子+の前後にスペースがありません。PEP 8では、演算子の前後にはスペースを入れるルールがあります。正しくはreturn a + bです。

E201 whitespace after '('

def subtract( a, b )のカッコ(の直後に不要なスペースがあります。PEP 8では、カッコの内側にスペースを入れないルールがあります。

E202 whitespace before ')'

同じくdef subtract( a, b )のカッコ)の直前に不要なスペースがあります。正しくはdef subtract(a, b)です。

E305 expected 2 blank lines after class or function definition, found 1

関数定義の直後に別のコード(unused_variable = ...)が続いていますが、PEP 8では関数定義の後にも2行の空行を空けるルールがあります。前方向(E302)と後方向(E305)の両方でチェックが働きます。

2. Flake8の設定ファイル

Flake8はデフォルトのルールでチェックを行いますが、プロジェクトによっては「1行の文字数を緩めたい」「特定のディレクトリはチェック対象外にしたい」といったカスタマイズが必要になります。設定ファイルを作成することで、プロジェクト全体で統一したルールを適用できます。

プロジェクトのルートに.flake8ファイルを作成します。Visual Studio Codeのエクスプローラーでpython-static-analysisフォルダを右クリックし、「新しいファイル」を選択して.flake8という名前で作成してください。

python-static-analysis
├── src
│   ├── __init__.py
│   ├── calculator.py
│   └── user_service.py
├── .flake8  ← このファイルを作成
└── requirements.txt

作成したファイルに以下の内容を記述して保存します。

[flake8]
max-line-length = 120
max-complexity = 10
exclude =
    .git,
    __pycache__,
    .venv
ignore = E203, W503, E302

各設定項目について解説します。

max-line-length = 120

1行の最大文字数を120文字に変更しています。PEP 8のデフォルトは79文字ですが、現代のモニタは横幅が広いため、多くのプロジェクトでは100〜120文字に緩和しています。今回のサンプルコードには79文字を超える行がないため、この設定による出力の変化はありません。

max-complexity = 10

関数の循環的複雑度(条件分岐やループの多さを示す指標)の上限を10に設定しています。これを超える複雑な関数がある場合、C901エラーが報告されます。Flake8はデフォルトでは循環的複雑度をチェックしないため、先ほどの実行結果にはC901が含まれていませんでした。この設定を追加することで、evaluate_score関数のように条件分岐が多い関数が新たに検出されるようになります。

exclude =
    .git,
    __pycache__,
    .venv

チェック対象から除外するディレクトリを指定しています。.git(Gitの管理ファイル)、__pycache__(Pythonのキャッシュ)、.venv(仮想環境)はプロジェクトのソースコードではないため、チェック対象外にしています。今回のプロジェクトにはこれらのディレクトリがないため、この設定による出力の変化はありません。

ignore = E203, W503, E302

特定のエラーコードを無視する設定です。

エラーコード 説明 無視する理由
E203 スライス記法のスペース 次のセクションで紹介する自動フォーマットツールのルールと競合するため
W503 演算子の前での改行 同上
E302 関数定義前の空行不足 次のセクションで自動修正されるため

先ほどの実行結果ではE302が7件検出されていました。ignoreにE302を追加することで、これらのエラーが出力されなくなります。

設定ファイルを作成した後、再度Flake8を実行して変化を確認してみましょう。

Windowsの場合:

flake8 src/

Macの場合:

python3 -m flake8 src/

以下のように、先ほどの結果からE302のエラーがすべて消え、代わりにC901のエラーが新たに検出されていることが確認できます。

src/calculator.py:1:1: F401 'os' imported but unused
src/calculator.py:2:1: F401 'sys' imported but unused
src/calculator.py:4:10: E231 missing whitespace after ','
src/calculator.py:5:13: E226 missing whitespace around arithmetic operator
src/calculator.py:7:14: E201 whitespace after '('
src/calculator.py:7:19: E202 whitespace before ')'
src/calculator.py:19:1: E305 expected 2 blank lines after class or function definition, found 1
src/calculator.py:21:1: C901 'evaluate_score' is too complex (11)

ignoreに指定したE302が出力されなくなった一方で、max-complexity = 10の設定により、evaluate_score関数の複雑度が11と判定され、新たにC901エラーが検出されました。このように、設定ファイルを使うことで不要なチェックを抑制しつつ、新しいチェックを追加することができます。

max-line-lengthやexcludeの設定は、今回のサンプルコードでは出力に影響しませんが、実際のプロジェクトでは長い行やチェック不要なディレクトリが出てくるため、あらかじめ設定しておくことが一般的です。