Pythonのtabnannyモジュールであいまいなインデントを検出する方法

インデントはPythonの構文において極めて重要な要素です。関数、クラス、ループなどで形成されるコードブロックでは、ブロック内のすべての文が同じインデントレベルに従う必要があります。しかし、タブとスペースが混在するなどの不統一なインデントは見た目では気づきにくく、予期しないエラーの原因となります。

Python標準ライブラリのtabnannyモジュールを使えば、こうしたインデント規約違反を自動的に検出できます。このモジュールは主に-mオプション付きでコマンドラインから使用することを想定していますが、インタプリタセッション内でインポートして利用することも可能です。

コマンドラインでの使い方

基本的な実行形式は次のとおりです。-qオプションを付けると、問題のあるファイル名だけが出力されます。

python -m tabnanny -q example.py

より詳しい情報（verbose出力）を表示したい場合は、-vオプションを使用します。

python -m tabnanny -v example.py

また、プログラムの中からインデントをチェックしたい場合は、tabnannyモジュールに定義されている以下の関数や属性を利用します。

check()

この関数は、指定したファイル内にあいまいなインデントの行が存在するかどうかをチェックします。引数としてディレクトリを渡すこともでき、その場合、配下のすべてのファイルが再帰的に検査されます。

使用例

import tabnanny
tabnanny.check('example.py')

tabnanny.verbose

このフラグは、詳細なメッセージを出力するかどうかを示します。スクリプトとして実行された場合は、-vオプションによって値がインクリメントされます。

tabnanny.filename_only

このフラグは、空白文字に関する問題を含むファイルについて、そのファイル名のみを出力するかどうかを制御します。スクリプトとして実行された場合は、-qオプションによってTrueに設定されます。

process_tokens()

この関数は、check()内部から呼び出され、tokenizeモジュールが生成したトークン列を処理するために使われます。あいまいなインデントが検出されるとNannyNag例外を送出し、この例外はcheck()側で捕捉・処理されます。つまり、独自のツールを作成する際にprocess_tokens()を直接利用すれば、例外を捕捉して独自のエラーメッセージを表示するといった柔軟な対応も可能です。

チーム開発では、エディタの設定（タブ幅やタブとスペースの変換）を統一するとともに、CIなどでtabnannyによるチェックを組み込んでおくと、インデント起因のトラブルを未然に防ぐことができます。