structlog 日志输出的临时抑制：测试与控制实践

import structlog
from structlog.testing import capture_logs

# 假设 structlog 已经配置好
# structlog.configure(...)

logger = structlog.get_logger(__name__)

print("--- 正常日志输出开始 ---")
logger.info("这是一条正常日志")

with capture_logs() as captured:
    logger.warning("这条日志会被捕获，但不会输出到控制台")
    logger.error("另一个在抑制区内的错误日志")

print("--- 正常日志输出恢复 ---")
logger.info("抑制区外的日志再次输出")

# 可以在这里检查 captured 列表，例如：
# assert len(captured) == 2
# assert captured[0]["event"] == "这条日志会被捕获，但不会输出到控制台"

from contextlib import contextmanager
from structlog.testing import capture_logs

@contextmanager
def suppress_logging():
    """
    一个上下文管理器，用于临时抑制 structlog 的日志输出。
    在测试场景中特别有用，可以避免预期错误产生的日志污染测试报告。
    """
    with capture_logs():
        yield

import structlog
import logging
from contextlib import contextmanager
from structlog.testing import capture_logs

# 确保 structlog 进行了基本配置，以便日志能够正常工作
structlog.configure(
    processors=[
        structlog.stdlib.add_logger_name,
        structlog.stdlib.add_log_level,
        structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
    ],
    logger_factory=structlog.stdlib.LoggerFactory(),
    wrapper_class=structlog.stdlib.BoundLogger,
    cache_logger_on_first_use=True,
)

# 配置标准库 logging，以便 structlog 可以输出
handler = logging.StreamHandler()
formatter = structlog.stdlib.ProcessorFormatter(
    processor=structlog.dev.ConsoleRenderer(),
    foreign_pre_chain=[
        structlog.stdlib.add_logger_name,
        structlog.stdlib.add_log_level,
    ],
)
handler.setFormatter(formatter)
root_logger = logging.getLogger()
root_logger.addHandler(handler)
root_logger.setLevel(logging.INFO) # 设置为INFO，以便看到正常日志

# 定义自定义的日志抑制上下文管理器
@contextmanager
def suppress_logging():
    """
    一个上下文管理器，用于临时抑制 structlog 的日志输出。
    在测试场景中特别有用，可以避免预期错误产生的日志污染测试报告。
    """
    with capture_logs():
        yield

# 获取一个 structlog logger 实例
logger = structlog.get_logger(__name__)

def make_error_happen():
    """模拟一个会产生日志错误的操作"""
    logger.error("这是一个预期的错误，不应在测试中输出", reason="故意触发")

print("\n--- 日志输出活跃区（开始）---")
logger.info("这是一个正常的信息日志")
make_error_happen() # 正常情况下会输出错误日志
print("--- 日志输出活跃区（结束）---")

print("\n--- 进入日志抑制区 ---")
with suppress_logging():
    print("在抑制区内调用 make_error_happen()，日志将被抑制。")
    make_error_happen() # 不会输出日志到控制台
    logger.warning("抑制区内的警告，也不会输出。")
    print("抑制区内操作完成。")

print("\n--- 退出日志抑制区，日志输出恢复活跃 ---")
logger.info("日志输出再次活跃，这是一条恢复后的信息日志。")
make_error_happen() # 日志输出再次活跃
print("--- 教程结束 ---")