【超簡単】pytestでloggingのログ出力をテストする方法!

当ページのリンクには広告が含まれています。
pytestでloggingのログ出力をテストする方法
いずみ

こんな悩みを解決できる記事を書きました!

僕は現役フリーランスエンジニア(歴年)で、資格は個保有しています。

結論、pytestでloggingのログ出力をテストするには「caplog」を使用します。

具体的なソースコード付きで分かりやすく解説するので安心してくださいね♪

本記事を読めば、pytestでloggingのログ出力をテストする方法が完全に理解できますよ。

いずみ

すぐ読み終わるので、ぜひ最後まで読んでくださいね♪

執筆者/監修者
  • フリーランスエンジニア(保有資格個)
  • ブログ・アフィリエイト歴5年
  • ブランドせどりで月利50万円⇨脱サラ
  • 投資歴5年(仮想通貨・FXが得意)
  • Twitterフォロワー約2,000人
  • 運営者情報はこちら
いずみです
目次

【結論】ログ出力のテストは「caplog」を使う

結論ですが、pytestでloggingのログ出力をテストするにはcaplogを使用します。

caplogは組み込みのfixtureなので、ログ出力のテストが簡単にできます。

いずみ

超簡単なので詳しく解説していきますね♪

pytestでloggingのログ出力をテストする方法

pytestでloggingのログ出力をテストする方法を解説します。

テスト対象の関数

from logging import getLogger

logger = getLogger(__name__)

def func():
    logger.debug("debug")
    logger.info("info")
    logger.warning("warning")
    logger.error("error")

テスト対象の関数では、各ログレベルのログを出力します。

テストコード

from logging import DEBUG, ERROR, INFO, WARNING

from _pytest.logging import LogCaptureFixture

from sample import func

def test_func(caplog: LogCaptureFixture):
    caplog.set_level(DEBUG)

    func()

    assert ("loggerの名前", DEBUG, "debug") in caplog.record_tuples
    assert ("loggerの名前", INFO, "info") in caplog.record_tuples
    assert ("loggerの名前", WARNING, "warning") in caplog.record_tuples
    assert ("loggerの名前", ERROR, "error") in caplog.record_tuples

caplogを使用してテストを行います。

caplog.record_tuplesには「loggerの名前ログレベルログ内容」が格納されています。

まとめ

今回は、pytestでloggingのログ出力をテストする方法について解説しました。

以下が本記事のまとめになります。

まとめ
  • pytestでloggingのログ出力をテストするには「caplog」を使用する。
  • caplog.record_tuplesには「loggerの名前ログレベルログ内容」が格納される。
まとめ♪
  • おすすめ本
¥2,970 (2023/07/25 22:48時点 | Amazon調べ)

Pythonの勉強なら「」が体系的に学べるのでおすすめですよ♪

いずみ

最後までお読みいただき、ありがとうございました!

  • クソおすすめ本
¥4,480 (2024/06/01 23:28時点 | Amazon調べ)
いずみ

海外のエンジニアがどういった思考で働いているかが理解できます。

海外に行く気はないけど海外エンジニアの動向が気になる雑魚エンジニアにおすすめです(本当におすすめな本しか紹介しないのでご安心を)。

pytestでloggingのログ出力をテストする方法

この記事が気に入ったら
フォローしてね!

シェアしてね!
  • URLをコピーしました!
目次