Pythonでのデバッグ方法について

Question

お世話になります。
Pythonでは、独自に定義した名前の呼び出し方を間違えた際、実行後にエラーが吐かれると思います。
実行開始後数分程度でエラーが出る分には構いませんが、場合によっては数時間後にエラーコードに行き当たるケースもあります。
実行前に全文エラー検知するような方法はありますか？

以上、よろしくお願いします。

Comments

[ikedas]

本番供用前に、普通に全文網羅テストを実施すればいいと思いますが……そういう話ではないのかな。

[takhub]

ありがとうございます。すみません、全文網羅テストとはどういうことでしょうか。

[ikedas]

ウェブ検索してみてください。

Answer 1

PythonやRubyのような動的言語では完全な事前検知は不可能だと思います。

例えば、下記のコードを見てください。

def f():
    print(abc.lower())

def g(x):
    print('--- called with %s ---' % x)
    try:
        f()
    except NameError:
        print('NameError')
    except AttributeError:
        print('AttributeError')

g(1)
exec('a%s = "ABC"' % 'BC'.lower())
g(2)
exec('%sc = 1' % 'AB'.lower())
g(3)

関数f()はグローバル変数abcが定義され、文字列(厳密にはlower()をメソッドとして持つ)である場合のみうまくいきます。g(2)は正常、g(1)やg(3)部分は異常、ということを事前に検知するにはどうしたらいいでしょうか？

グローバル変数abcが定義されるのかどうかを検知するにはexec自体の所を評価しないといけません。これは実際に評価しないとわかりません。さらに、abcが文字列であるかどうかなど、実際に評価されているときにどうなっているかです。これも実際に評価しないとわかりません。静的な構文だけでf(2)のみ正しいと判断は不可能です。逆に言えば、f()でabcd.pop('a')と書いてしまったとき、f(2)が失敗するかどうかを判断することも不可能です。もしかしたら、exec('a%sd = {"a": "ABC"}' % 'BC'.lower())と書いてあるのかも知れませんので、評価しないと間違っているかは判断できません。

よって、静的言語並の事前検知は動的言語では不可能というのが結論だと思います。

---

で、終わってはなんですので、それでもどうするのかを語ります。

###全部テストせよ
全ての関数の想定される動作について、全てのテストを書き、テストを実施します。いわゆるユニットテストというものです。テスト方法やライブラリはなんでもいいですが、全てをテストする事が大切です。

一般的に、動的言語は大規模開発には向かないと言われていました。理由はまさしくこのコーディングミスによる事前検知ができないためです。しかし、実際の現場では大規模なプログラムは存在します。それらはどうしているかというと、とにかくもれなくテストして、事前検知の代わりにしているからです。全ての関数の全ての分岐について、一度はテストされるのであれば、単純なスペルミスは全て駆逐できます。

これはかなり大変ですが、大規模開発で安定性や信頼性が高いプログラムを作るときは言語に関係無く必須と言われています。C/C++を使おうが、Javaを使おうが、どっちにしても必要なため、Pythonだからといって不利というわけではありません。

###Lintしよう
PEP8に従って書いてますでしょうか？ えっ、書いてない？ いやいや、今すぐ書きましょうよ。

PythonにはPEP8のようなコーディング規約と、それをチェックするツールがあります。他にもいくつか規約があるようです(後述の参考文献を参照)。これらは完全なチェックまでとは言えませんが、おかしな書き方を指摘してくれます。たとえば、使われていないローカル変数があるという指摘は、かなりの確率でスペルミスをしている可能性が高いです。これらのツールを使えば、ある程度はおかしな所の事前検知が可能です。Pythonがさらに見やすくてわかりやすくなると言うこともあり、このようなツールを使うことを推奨します。

参考文献: Python の Lint (文法チェッカ) まとめ - flake8 + hacking を使う - - Qiita

###夢の静的型
まずは、下記のQiitaの記事を読んでください。

[翻訳] Python の静的型、すごい mypy! - Qiita

めっちゃわくわくしませんか？ そう、問題の一つはPythonが「動的型付け」だからと言うことがあります。ダッグタイピングはある面でいいところもありますが、型チェックという面では、もうどしようもなく駄目です。ということで考えられているのが、タイプヒンティングです。既存のコードに一つ一つアノテーションを追加するのは面倒かと思いますが、その力は強力です。静的言語並みの事前チェックが可能になる(ような気がする)に違いありません。

タイプヒンティングは今後の動的言語での主流になっていくと思います。Perl6、PHPはすでに採用しています。JavaScriptはTypeScriptというaltJSを使えばできます。Rubyは次のメージャーバージョンである3あたりで入れたいなーってどっかの記事に載ってました。Pythonはmypyが実用的になった時点でもう敵無しです。ぜひ、お試しください。

※ タイプヒンティングは完璧ではありません。execやevalを使ったり、リフレクションを使って動的に構成を変えようとすると、無理が生じると思います。あくまで、静的にコーディングする場合のツールと思った方がいいでしょう。