エラー発生時の関数内の変数を捕捉する方法

Question

Pythonコンソール(PyCharm)でスクリプトを実行しています。

mainスクリプトで例外が発生した場合は変数を確認できるので（例えばfor文のどこで止まったかなど）、エラー箇所の特定ができますが、自作関数内処理での例外発生時に、どの変数のどの値で例外があったのか、例外内容だけではわからないことが多々あります（エラー発生後、関数内の変数が見えなくなっているため）。

このとき、エラー発生場所で処理を止めて、エラー直前の変数を確認する方法はデバッガを使う以外にありますでしょうか？デバッガも実際に使っているのですが、動作が遅いので多用できないこと、また、for文中でエラーが発生しているので、エラー発生時の変数を確認できたらより効率的にデバッグできると考えています。

デバッガに頼らない場合、try,exceptを使うのが定石でしょうか？もしくは、PyCharmに限らず、エラー時に関数内の変数を表示する方法があるものなのでしょうか？

Answer 1

PyCharmは使ったことないのですが、この際Visual Studio Codeに乗り換えるのはいかがでしょう。
VSCodeのデバッガは動作は遅くありませんし、ステップイン、ステップオーバーを使い分けて、ローカル関数やパッケージの中までデバッグしたり飛び越えたりできます。
デバッグ中は変数の上にマウスカーソルをのせると変数の値が表示されるのでとても便利ですよ。

Comments

[MagMag]

ありがとうございます。ただ、PyCharmの機能に慣れちゃっているので、当面はこのソフトでいきたいと思います（PyCharmでもステップイン等の機能は有しています）。

Answer 2

デバッガに頼らない場合、try,exceptを使うのが定石でしょうか？もしくは、PyCharmに限らず、エラー時に関数内の変数を表示する方法

pdbを利用すると良いです。
ちょっと古い記事ですが、今でも利用可能です。
http://python.matrix.jp/2013/02/10/debug.html

例外発生時にpdbを起動して状況が確認できるのと、デバッガで動作させるより軽快に動作します。pdbの使い方はググればそれなりに出てきます。

それ以外にも色々な手法が以下で紹介されているので、ご自身で良いと思う方法を確認されてみてはいかがでしょうか。
https://qiita.com/TakesxiSximada/items/45b6d71a44f2706798ed

Comments

[MagMag]

ありがとうございました。pdbは使ったことがないので、使えるように訓練したいと思います。

Answer 3

一応念の為、例外でブレークするようにしてますか？

例外ブレークポイント

例外ブレークポイントは、指定された例外がスローされたときに発生します。それらは例外条件にグローバルに適用され、特定のソースコード参照を必要としません。
ブレークポイント - 公式ヘルプ | PyCharm

一番原始的なデバッガのpdbだと

$ python -m pdb -c continue 実行したいスクリプト.py

という感じで例外が起きたときにデバッガを起動できます。

あるいは、例外時の挙動をフックしてデバッガを立ち上げるようにすることも可能です。

PythonコードのデバッグTips（１） — PythonMatrixJp

Comments

[MagMag]

ありがとうございます。例外ブレークポイントというのは使っていませんでした。
追加で質問になるのですが、例外ブレークポイントにおいて、例外だけでなく、Warning発生時に止めることは可能でしょうか？

[hayataka2049]

それは難しいはずですが、警告を例外として扱うことはできます。warningsモジュールを試してください。

[MagMag]

ありがとうございます。調べてみます。

Answer 4

デバッガを使わないということでしたら、関数内のローカル変数は関数内で確認するしかないので、try-exceptして print(vars()) でローカル変数をダンプするのが手っ取り早いと思います。

Comments

[MagMag]

わかりました。vars()は知らなかったので大変参考になりました！