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

2024年1月13日

当ページのリンクには広告が含まれています。

この記事で解決できる悩み

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

いずみ

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

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

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

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

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

いずみ

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

執筆者／監修者

フリーランスエンジニア（保有資格13個）
ブログ・アフィリエイト歴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の名前・ログレベル・ログ内容」が格納されています。