Python unittest输出混入logging日志的原因排查及最佳实践咨询

嘿，这个问题我之前也碰到过，给你捋捋原因和解决办法哈～

为什么日志会混进unittest输出？ #

核心原因很简单：你在conf.py里配置的StreamHandler默认是输出到sys.stdout，而unittest的测试结果（比如... ok这类）也是输出到sys.stdout，两者的输出流重叠了，自然就混在一起。另外，如果你的LOG_LEVEL设置的是DEBUG，测试过程中触发的DEBUG日志就会直接被打印出来，干扰测试结果的可读性。

对了，顺便提一句：你代码里的Formatter有个小错误——(message)s应该改成%(message)s，不然日志里的消息部分会显示异常哦。

解决方案 #

这里给你几个实用的处理方式：

1. 测试时临时调整日志级别 #

在测试类的初始化和清理方法里，临时把日志级别调高，屏蔽掉DEBUG级别的输出，测试结束后再恢复原来的级别：

import unittest
import logging
from project.conf import lg

class TestReportData(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        # 保存原日志级别
        cls.original_log_level = lg.level
        # 临时将日志级别设为INFO，屏蔽DEBUG
        lg.setLevel(logging.INFO)

    @classmethod
    def tearDownClass(cls):
        # 测试结束后恢复原级别
        lg.setLevel(cls.original_log_level)

    # 你的测试方法...

2. 把日志输出转到stderr #

修改StreamHandler的输出目标为sys.stderr，这样日志就不会和unittest的stdout输出混在一起了：

import sys
from project.conf import lg

# 在测试文件开头执行这段代码
for handler in lg.handlers:
    if isinstance(handler, logging.StreamHandler):
        handler.stream = sys.stderr

3. 用unittest的assertLogs捕获日志 #

如果你需要验证日志是否正确输出，同时不想让日志污染控制台，可以用unittest自带的assertLogs上下文管理器，它会帮你捕获指定logger的日志：

def test_set_report(self):
    with self.assertLogs('logger', level='DEBUG') as log_context:
        # 执行触发日志的代码
        self.report_data.set_report({})
    # 验证日志内容是否符合预期
    self.assertIn('DEBUG - Report is {}', log_context.output[0])

这样日志只会被捕获用于断言，不会输出到控制台。

最佳实践建议 #

• 区分环境配置日志：开发、测试、生产环境用不同的日志配置。比如测试环境默认把控制台日志级别设为INFO及以上，避免DEBUG日志干扰测试结果。
• 测试中屏蔽非必要日志：如果不是专门测试日志功能，尽量把应用的日志输出关掉或者调高级别，让测试结果更简洁。
• 单独配置测试日志：可以在测试目录下写一个专用的日志配置文件，覆盖主配置的设置——比如只保留文件日志，或者把控制台输出转到stderr。
• 规范日志格式：记得修正你之前的Formatter错误，确保日志格式正确，避免后续排查问题时踩坑。

内容的提问来源于stack exchange，提问作者ilidream