Pythonでは、loggingというライブラリを使ってログを出力するのが一般的です。ログはファイルとして出力することができ、任意のメッセージを記録できるほか、変数の中身を記録することもできます。
ログの区分
ログには様々な区分があります。例えば、プログラムが正常に動作したことを記録することもあれば、異常が起きたことを記録する場合もあります。これらを全て同じように扱うと、必要な時に欲しい情報が埋もれてしまう可能性があります。
Pythonにおけるloggingのレベルは５つあり、関数名と対応しています。
debug(): プログラミング工程で変数の値などを確認したい時info(): データを読み込んだ件数など、プログラムの運用に関する情報を出力したい時warning(): プログラムの運用中に、エラーの原因になりそうな事象が発生した時error(): プログラムの運用中に、一部の機能を実行できないエラーが発生した時critical(): プログラムの運用中に、プログラム全体の実行を続けられないような重大なエラーが発生した時
ログの出力
ログを出力するためには、以下のような関数を用いることが一般的です。
logging.info('メッセージ')
logging.warning('メッセージ')
logging.error('メッセージ')
例えば、以下のように使用します。
logging.warning('This is a warning message')
上記のコードを実行すると、”WARNING:root:This is a warning message”というメッセージが出力されます。
まとめ
Pythonでのログの出力方法を紹介しました。適切な箇所でログを吐くようにしておかないと、何かあったときにとても困ります。保守のことも考えて、しっかりログを残すようにしておきましょう。