caplog for log messages in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of caplog in pytest?

caplog is used to capture log messages during test execution. It helps verify that the expected logs are generated by the code under test.

beginner

How do you access captured log messages using caplog?

You can access captured logs via caplog.records for log records or caplog.text for the full log output as a string.

intermediate

How can you set the log level when using caplog in a test?

Use caplog.set_level("LEVEL") to set the minimum log level to capture, for example caplog.set_level("INFO").

beginner

Write a simple pytest test snippet using caplog to check if a warning log message was emitted.

def test_warning_log(caplog):
    import logging
    logger = logging.getLogger()
    with caplog.at_level(logging.WARNING):
        logger.warning("This is a warning")
    assert "This is a warning" in caplog.text

beginner

Why is capturing logs useful in automated tests?

Capturing logs helps confirm that the code behaves as expected internally, especially for warnings, errors, or important info messages, improving test coverage and debugging.

What does caplog.records provide in pytest?

A The current log level setting

B The full log output as a single string

C A list of log record objects captured during the test

D The number of log messages emitted

caplog.records gives a list of log record objects, each representing a captured log message with details like level and message.

How do you change the log level to capture only warnings and above with caplog?

A caplog.set_level("INFO")

B caplog.set_level("WARNING")

C caplog.set_level("DEBUG")

D caplog.set_level("ERROR")

Setting caplog.set_level("WARNING") captures warnings and errors, ignoring info and debug logs.

Which pytest fixture is used to capture log messages?

A caplog

B logcapture

C logfixture

D capturelog

The correct fixture name is caplog.

What is the best way to check if a specific log message was emitted in a test?

A Assert the message is in <code>caplog.text</code>

B Print logs and check manually

C Use <code>print()</code> statements

D Check the console output after test

Using assert "message" in caplog.text is a direct and automated way to verify logs.

What does caplog.at_level(logging.WARNING) do?

A Filters out WARNING messages

B Disables log capturing

C Sets the global log level to WARNING permanently

D Temporarily sets the log capture level to WARNING within the block

This context manager temporarily sets the capture level to WARNING for the code inside the block.

Explain how to use caplog in pytest to verify that a specific log message was generated.

Think about capturing logs and checking their content.

Describe why capturing logs with caplog is helpful in automated testing.

Logs tell us what happened inside the code.