pythonでのloggingの使い方とマナーについて

Question

スクレイピングツールを作成しております。
今まで、ログはprint()を使っていましたが、loggingを使って全部ファイル出力をしようとしています。

ファイルは2種類です。

1. ループごとに結果を出力
2. エラーが発生した場合

ここで質問なのですが、「2.エラーが発生した場合」を[error.log]に出力する場合は、全ての関数にtry,exceptを追加して、どこでエラーが起きたのかを記録するのでしょうか？

mian関数でtry,exceptを追加し、その中の一つの関数でわざとエラーを発生させました。当然ですが、%(funcName)sはmain関数でした。

プログラム全体にtry,exceptが蔓延るのはなんだか嫌ですので、一般的にはどうやってログをつけているのか教えて頂きたいです。

Answer 1

main 内でエラーを処理するということは、想定外のエラーが発生した場合ということになります。
この場合はプログラムの修正のためにスタックトレースを出力するのが一般的です。

設計時から発生が想定されるエラーは適切な階層で処理するようにする方がよいです。
(例:入力が不正な場合にその入力をスキップして処理を継続する)
その場合はスタックトレースは不要でエラー内容だけ出力すればよいでしょう。

スタックトレース付きでログ出力する方法

except 内で logging.exception() を使用すればスタックトレースがログ出力されます。

try:
    raise Exception('foo')
except Exception as e:
    logger.exception(f'Unhandled error: {e}')

2020-09-14 02:47:21,187 Unhandled error: foo
Traceback (most recent call last):
  File "example.py", line 2, in <module>
    raise Exception('foo')
Exception: foo